設定管理

介紹

　　每個應用都需要儲存設定，並且在應用的某些地方需要使用這些設定。ABP提供了一個強大的在服務端和客戶端都可以使用的基礎設施儲存/獲取應用、租戶和使用者級別的設定。

　　一個設定是一個名稱-值字串對，一般存放在資料庫(或其他源)。我們可以儲存非字串值，但需要把他們轉換成字串。

關於 ISettingStore

為了使用設定系統，ISettingStore介面必須實現。雖然可以用自己的方式實現，但是module-zero工程已經完整的實現了它。如果沒有實現的話，將會從應用的配置檔案(web.config或app.config)讀取配置，但是不能改變任何設定。設定範圍也不會起作用。

定義設定

　　設定在使用前必須先定義。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(需要)：一個設定必須有一個系統範圍的唯一名稱。建議為設定名稱定義一個常量字串而不是魔力字串。
• Default Value：設定應該有預設值。預設值可以為null或空字串。
• Scopes：設定應該有範圍(參見下面部分)。
• Display Name：本地化的字串，可以用來在UI中顯示的設定名稱。
• Description：本地化的字串，可以用來在UI中顯示設定的描述資訊。
• Group：用來進行組設定。僅對UI使用，在設定管理中沒有用。
• IsVisibleToClients：設定為true可以使設定在客戶端可用。
• IsInherited：用來決定設定是否通過租戶或使用者繼承的(參見設定範圍部分)。
• CustomData：用來設定自定義資料。

　　建立一個設定提供者之後，我們應該在模組的PreInitialize方法中註冊：

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

　　設定提供者自動註冊到依賴注入系統。所以，設定提供者可以注入任何依賴項(比如倉儲)，使用其他資源來建造設定定義。

設定範圍

有三種設定範圍(或級別)，定義在SettingScopes列舉裡：

• Application：應用級別用來設定使用者/租戶無關的設定。例如，我們可以頂一個名為“SmtpServerAddress”的設定，當傳送電郵的時候來獲取伺服器IP地址。如果這個設定只有一個值(不隨使用者改變)，那麼這個設定可以定義為應用級別。
• Tenant：如果應用是多租戶的，我們可以定義特定租戶的設定。
• User：我們可以使用使用者範圍的設定來儲存/獲取每一個特定使用者的設定值。

　　SettingScopes列舉有Flags特性，所以我們可以定義多餘一種級別的設定。

　　設定範圍預設是分級的(除非設定isInherited為false)。例如，如果我們定義了一個設定的範圍為“Application | Tenant | User”並且嘗試獲取這個設定的當前值：

• 如果它定義(重寫)為使用者級別的，將得到特定使用者的值。
• 如果不是，將得到特定租戶的值，如果它定義(重寫)為租戶級別的。
• 如果不是，將得到應用值，如果定義了的話。
• 如果不是，將得到預設值。

　　預設值可以為null或空字串。建議儘可能為設定提供預設值。

重寫設定定義

context.Manager可以用來獲取設定定義並可改變設定值。使用這種方式，可以用來操作依賴模組的設定定義。

獲取設定值

定義一個設定之後，我們可以在服務端和客戶端獲取設定的當前值。

服務端

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的屬性。如果我們派生自這些類，就不需要顯示的注入了。

客戶端

如果當定義設定時，將IsVisileToClients置為true，就可以在客戶端使用javascript獲取它的當前值。abp.setting名稱空間定義了需要的函式和物件。例如：

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

　　還有getInt和getBoolean方法。可以使用abp.setting.values物件獲取所有的值。注意，如果在服務端更改了設定，客戶端不會知道更改，除非頁面重新整理，設定可以以某種方式重新載入或者使用程式碼手動更新。

更改設定

ISettingManager定義了ChangeSettingForApplicationAsync、ChangeSettingForTenantAsync和ChangeSettingForUserAsync 方法(和非同步版本)用來更改應用、租戶、使用者的設定。

關於快取

設定管理器在服務端快取設定。所以，我們可以使用倉儲或資料庫更新查詢直接更改設定值。

返回主目錄