介紹

每個應用程序需要存儲一些設置並在應用程序的某個地方使用這些設置。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 方法（以及同步版本）來更改應用程序，租戶和用戶分別的設置。

關於緩存

緩存在服務器端設置管理，所以，我們不應直接使用存儲庫或數據庫更新語句改變設置的值。

希望更多國內的架構師能關注到ABP這個項目，也許這其中有能幫助到您的地方，也許有您的參與，這個項目可以發展得更好。

歡迎加ABP架構設計交流QQ群：134710707

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

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。