ABP(現代ASP.NET樣板開發框架)系列之九、ABP設置管理

時間 2019-12-07

標籤 abp 現代 asp.net asp 樣板開發框架系列之九設置管理欄目 ASP 简体版

原文原文鏈接

點這裏進入ABP系列文章總目錄javascript

基於DDD的現代ASP.NET開發框架--ABP系列之九、ABP設置管理
html

ABP是「ASP.NET Boilerplate Project (ASP.NET樣板項目)」的簡稱。java

ABP的官方網站：http://www.aspnetboilerplate.comgit

ABP在Github上的開源項目：https://github.com/aspnetboilerplategithub

本文由山東-李偉提供翻譯數據庫

介紹

每一個應用程序須要存儲一些設置並在應用程序的某個地方使用這些設置。ABP框架提供強大的基礎架構，咱們能夠在服務端或者客戶端設置，來存儲/獲取應用程序、租戶和用戶級別的配置。緩存

設置一般是存儲在數據庫（或另外一個來源）中，用名稱-值（name-value）字符串對應的結構來表示。咱們能夠把非字符串值轉換成字符串值來存儲。服務器

注意：關於ISettingStore接口

爲了使用設置管理必須實現 ISettingStore 接口。你能夠用本身的方式實現它，在module-zero項目中有完整的實現能夠參考。架構

定義設置

使用設置以前必需要先定義。ABP框架是模塊化設計，因此不一樣的模塊能夠有不一樣的設置。爲了定義模塊本身的設置，每一個模塊都應該建立繼承自SettingProvider 的派生類。設置提供程序示例以下所示：框架

public class MySettingProvider : SettingProvider
{
    public override IEnumerable<SettingDefinition> GetSettingDefinitions(SettingDefinitionProviderContext context)
    {
        return new[]
                {
                    new SettingDefinition(
                        "SmtpServerAddress",
                        "127.0.0.1"
                        ),

                    new SettingDefinition(
                        "PassiveUsersCanNotLogin",
                        "true",
                        scopes: SettingScopes.Application | SettingScopes.Tenant
                        ),

                    new SettingDefinition(
                        "SiteColorPreference",
                        "red",
                        scopes: SettingScopes.User,
                        isVisibleToClients: true
                        )
                };
    }
}

GetSettingDefinitions 方法返回 SettingDefinition 對象。SettingDefinition 類的構造函數中有以下參數：

Name (必填):必須具備全系統惟一的名稱。比較好的辦法是定義字符串常量來設置Name。
Default value: 設置一個默認值。此值能夠是null 或空字符串。
Scopes: 定義設置的範圍 (見下文)。
Display name: 一個可本地化的字符串，用於之後在UI中顯示設置的名稱。
Description: 一個可本地化的字符串，用於之後在UI中顯示設置的描述。
Group: 可用於設置組。這僅僅是UI使用，不用於設置管理。
IsVisibleToClients: 設置爲 true 將使設置在客戶端可用。

在建立設置提供程序(SettingProvider)以後，咱們應該在預初始化(PreIntialize)方法中註冊咱們的模塊:

Configuration.Settings.Providers.Add<MySettingProvider>();

設置提供程序會自動註冊依賴注入。因此，設置提供程序能夠注入任何依賴項 (如存儲庫) 來生成設置定義的一些其它來源。

設置範圍

有三個設置範圍 (或級別) 在 SettingScopes 枚舉中定義:

Application：應用程序範圍設置用於用戶/租戶獨立的設置。例如，咱們能夠定義一個名爲"SmtpServerAddress"的設置，當發送電子郵件時，獲取服務器的 IP 地址。若是此設置有一個單一的值 (不基於用戶改變)，那麼咱們能夠定義它爲應用程序範圍。
Tenant：若是應用程序是多租戶的，咱們能夠定義特定於租戶的設置。
User：咱們能夠使用的用戶範圍的設置來爲每一個用戶存儲/獲取設置的值。

SettingScopes 枚舉具備Flags屬性，因此咱們能夠定義一個具備多個做用域的設置。

設置範圍是分層的。例如，若是咱們定義設置範圍爲"Application | Tenant | User"並嘗試獲取當前設置的值;

咱們獲取特定用戶的值，若是它定義 (重寫) User。
若是沒有，咱們獲取特定的租戶值，若是它定義 (重寫) Tenant。
若是沒有，咱們獲取應用的值，若是它定義Application。
若是沒有，咱們獲得的默認值。

默認值能夠是 null 或空字符串。若是能夠，建議爲設置提供一個默認值。

獲取設置值

定義設置後，咱們能夠在服務器和客戶端獲取到它的當前值。

(1)服務器端（Server side）

ISettingManager 用於執行設置操做。咱們能夠在應用程序中任何地方注入和使用它。ISettingManager 定義了不少獲取設置值方法。

最經常使用的方法是 GetSettingValue (或GetSettingValueAsync 爲異步調用)。它將返回當前設置的基於默認值、應用程序、租戶和用戶設置範圍的值(如設置範圍以前的一段中所述)。例子:

//Getting a boolean value (async call)
var value1 = await SettingManager.GetSettingValueAsync<bool>("PassiveUsersCanNotLogin");
//Getting a string value (sync call)
var value2 = SettingManager.GetSettingValue("SmtpServerAddress");

GetSettingValue 有泛型和異步版本，如上所示。也有方法來獲取特定的租戶或用戶的設置值或全部設置值的列表。

因爲ISettingManager使用普遍，一些特定的基類 (如 ApplicationService、 DomainService 和 AbpController) 有一個名爲 SettingManager的屬性。若是咱們從這些類繼承，就無需顯式地注入它。

(2)客戶端

若是定義設置時將 IsVisibleToClients 設置爲 true，就能夠在客戶端使用 javascript獲得它的當前值。abp.setting 命名空間定義所需的函數和對象。示例:

var currentColor = abp.setting.get("SiteColorPreference");

也有 getInt 和 getBoolean 這樣的方法。你能夠使用 abp.setting.values 對象獲取全部值。請注意，若是你在服務器端更改設置，客戶端不會知道這種變化，除非刷新頁面或者以某種方式從新加載頁面或者經過代碼手動更新。

更改設置

ISettingManager 定義了 ChangeSettingForApplicationAsync，ChangeSettingForTenantAsync 和 ChangeSettingForUserAsync 方法（以及同步版本）來更改應用程序，租戶和用戶分別的設置。