设置管理模块

设置管理模块实现了 ISettingStore (参阅 设置系统) 将设置值存储在数据库中, 并提供 ISettingManager 管理 (更改) 数据库中设置值的功能.

启动模板默认安装并配置了设置管理模块. 大部分情况下你不需要手动的添加该到模块到应用程序中.

ISettingManager

ISettingManager 用于获取和设定设置值. 示例:

  1. using System;
  2. using System.Threading.Tasks;
  3. using Volo.Abp.DependencyInjection;
  4. using Volo.Abp.SettingManagement;
  6. namespace Demo
  7. {
  8.     public class MyService : ITransientDependency
  9.     {
  10.         private readonly ISettingManager _settingManager;
  12.         //Inject ISettingManager service
  13.         public MyService(ISettingManager settingManager)
  14.         {
  15.             _settingManager = settingManager;
  16.         }
  18.         public async Task FooAsync()
  19.         {
  20.             Guid user1Id = ...;
  21.             Guid tenant1Id = ...;
  23.             //Get/set a setting value for the current user or the specified user
  25.             string layoutType1 =
  26.                 await _settingManager.GetOrNullForCurrentUserAsync("App.UI.LayoutType");
  27.             string layoutType2 =
  28.                 await _settingManager.GetOrNullForUserAsync("App.UI.LayoutType", user1Id);
  30.             await _settingManager.SetForCurrentUserAsync("App.UI.LayoutType", "LeftMenu");
  31.             await _settingManager.SetForUserAsync(user1Id, "App.UI.LayoutType", "LeftMenu");
  33.             //Get/set a setting value for the current tenant or the specified tenant
  35.             string layoutType3 =
  36.                 await _settingManager.GetOrNullForCurrentTenantAsync("App.UI.LayoutType");
  37.             string layoutType4 =
  38.                 await _settingManager.GetOrNullForTenantAsync("App.UI.LayoutType", tenant1Id);
  40.             await _settingManager.SetForCurrentTenantAsync("App.UI.LayoutType", "LeftMenu");
  41.             await _settingManager.SetForTenantAsync(tenant1Id, "App.UI.LayoutType", "LeftMenu");
  43.             //Get/set a global and default setting value
  45.             string layoutType5 =
  46.                 await _settingManager.GetOrNullGlobalAsync("App.UI.LayoutType");
  47.             string layoutType6 =
  48.                 await _settingManager.GetOrNullDefaultAsync("App.UI.LayoutType");
  50.             await _settingManager.SetGlobalAsync("App.UI.LayoutType", "TopMenu");
  51.         }
  52.     }
  53. }

你可以从不同的设置值提供程序中(默认,全局,用户,租户…等)中获取或设定设置值.

如果只需要读取设置值,建议使用 ISettingProvider 而不是ISettingManager,因为它实现了缓存并支持所有部署场景. 如果要创建设置管理UI,可以使用ISettingManager.

Setting Cache

设置值缓存在 分布式缓存 系统中. 建议始终使用 ISettingManager 更改设置值.

Setting Management Providers

设置管理模块是可扩展的,像设置系统一样. 你可以通过自定义设置管理提供程序进行扩展. 有5个预构建的设置管理程序程序按以下顺序注册:

  • DefaultValueSettingManagementProvider: 从设置定义的默认值中获取值,由于默认值是硬编码在设置定义上的,所以无法更改默认值.
  • ConfigurationSettingManagementProvider:从 IConfiguration 服务中获取值. 由于无法在运行时更改配置值,所以无法更改配置值.
  • GlobalSettingManagementProvider: 获取或设定设置的全局 (系统范围)值.
  • TenantSettingManagementProvider: 获取或设定租户的设置值.
  • UserSettingManagementProvider: 获取或设定用户的设置值.

ISettingManager 在 get/set 方法中使用设置管理提供程序. 通常每个设置程序提供程序都在 ISettingManagement 服务上定义了模块方法 (比如用户设置管理程序提供定义了 SetForUserAsync 方法).