AppSettingsJsonConfigRepository

[namespace: Serenity.Configuration, assembly: Serenity.Data]

Most web applications store configuration settings in web.config file, under appSettings section.

Serenity provides a default implementation of IConfigurationRepository that uses appSettings as configuration store.

  1. public class AppSettingsJsonConfigRepository : IConfigurationRepository
  2. {
  3.     public void Save(Type settingType, object value)
  4.     {
  5.         throw new NotImplementedException();
  6.     }
  8.     public object Load(Type settingType)
  9.     {
  10.         return LocalCache.Get("ApplicationSetting:" + settingType.FullName,
  11.             TimeSpan.Zero, delegate()
  12.         {
  13.             var keyAttr = settingType.GetCustomAttribute<SettingKeyAttribute>();
  14.             var key = keyAttr == null ? settingType.Name : keyAttr.Value;
  15.             return JSON.Parse(ConfigurationManager.AppSettings[key].TrimToNull() ??
  16.                 "{}", settingType);
  17.         });
  18.     }
  19. }

To register this provider manually:

  1. var registrar = Dependency.Resolve<IDependencyRegistrar>();
  2. RegisterInstance<IConfigurationRepository>("Application",
  3.     new AppSettingsJsonConfigRepository())

When you call Serenity.Web.CommonInitialization.Run(), it registers this class as the default provider for IConfigurationRepository (in Application scope), if another one is not already registered.

This provider expects settings to be defined in web.config / app.config file in JSON format:

  1.   <appSettings>
  2.     <add key="Logging" value="{  File: '~\\App_Data\\Log\\App_{0}_{1}.log',
  3.         FlushTimeout: 0,  Level: 'Debug' }" />
  4.   </appSettings>

Out of the box, Serenity contains this configuration provider only. You may take it as a sample, and write another one for your setup (load from database etc.).

It is a good idea to cache returned objects in your implementation to avoid deserialization costs every time settings are read.