Where to store application settings?

Pretzel picture Pretzel · Oct 20, 2010 · Viewed 10.1k times · Source

Recently, I discovered that the "Web.Config" file contains an <appSettings> section which seemed good for storing one's Application Settings. Heck, it even has a programmatic way to access the file thru a standard System library. So being all clever, I wrote an Interface to access it and then a Concrete implementation of the interface, shown here:

public interface IAppSettings
{
    IEnumerable<string> GetValues(string componentName, string settingName);
    IEnumerable<KeyValuePair<string, string>> GetValuePairs(string componentName, string settingName);
    void SetValues(string componentName, string settingName, IEnumerable<string> valueList, bool append);
    void SetValuePairs(string componentName, string settingName, IEnumerable<KeyValuePair<string, string>> pairList, bool append);
}

Then I came to discover that saving settings back to "web.config" while the application is running causes the entire application to re-start. This seems completely unreasonable to me because if I'm writing back to web.config a lot and the application is restarting each time, then things like HttpRuntime.Cache get completely emptied effectively making my Cache useless because it's constantly emptying and repopulating.

So I'm wondering: Where should I store my Application Settings?

Is there a good solution out there for this so that I don't have to roll my own?

EDIT:

Okay, thanks to everyone who suggested using a DB and a potential table schema. I think I'm going to go with the following schema:

settings:
    index NUMBER NOT NULL AUTO_INCREMENT   <== Primary Key
    component NVARCHAR(255) NOT NULL
    setting NVARCHAR(255) NOT NULL
    key   NVARCHAR(255)
    value NVARCHAR(255) NOT NULL

Though I don't think I'll make the "setting" the P-Key, but use an Auto-Incr Index instead. This way if I have an application that needs to mail something to multiple managers, I can store many:

index     component       setting        value
1         RequestModule   ManagerEmail   manager1@someplace
2         RequestModule   ManagerEmail   manager2@someplace

And then I can use:

IEnumerable<string> GetValues(string componentName, string settingName);

And it will return a list of email addresses, rather than just a single value.

Does this make sense?

Answer

Arseni Mourzenko picture Arseni Mourzenko · Oct 20, 2010

web.config is generally used for read-only settings, ie. the settings set during deployment of the application by the system administrator.

If you want to read and write the settings, the most obvious way is to use the database. By the way, this has an advantage: an application can be hosted on several servers and will still read and write the settings correctly,

You can also implement your custom storage for the settings, but it will be probably more difficult to implement and not much faster.


To answer your second question, the structure of your database depends on the type of settings you want to store.

If you need to store heterogeneous unique entries like this:

  • Mail address of an administrator,
  • Maximum number of entries to display on home page of the website,
  • Text to display on "About us" page,
  • Boolean value indicating whether public comments are enabled or not,

then you have to use varchars or other more or less friendly types as keys to identify the entries (rather than to refer to them by their index).

On the other hand, if your purpose is to store the mail addresses of several managers, you should create a Manager table containing their mail addresses, names, datetime of their last connection, etc.

You really shouldn't mix both. In theory, you can refer to the entry in settings by component/setting pair. In practice, it makes things harder and creates a bunch of problems:

  • What if, further, you will need, for every manager, to store a boolean value indicating whether she/he wants to receive alerts from you? With your current structure, this will be impossible.
  • Since the same setting can have multiple values, how do you intend to handle the settings which must be unique? For example, there must be only a single value of text to display on "About us" page. What if there are two values stored in database?