自定义设置接口

功能描述

设置管理器接口提供全局性自定义设置的查询、修改与删除能力，支持单条或批量获取设置值、从远程服务器直接查询设置以及设置默认值等功能。适用于管理系统级配置，自定义代码可使用该接口设置功能开关或边界值。

接口列表

获得自定义设置的值（无默认值）

功能描述

根据设置名称查询对应的自定义设置值，若设置不存在或值为空，返回 null 或空字符串（具体取决于底层实现）。

接口定义

string GetCustomSetting(string settingName);

参数

参数名称	是否必填	类型	描述
settingName	是	string	自定义设置的唯一名称（如 FlowNo.Format 表示流水号格式）。

返回值

类型	描述
string	若设置存在且有值，返回对应的设置值；若设置不存在或值为空，返回 null 或空字符串。

示例

string settingName = "demoSettingName";
string value = this.Engine.SettingManager.GetCustomSetting(settingName);

获得自定义设置的值（含默认值）

功能描述

根据设置名称查询自定义设置值，若设置不存在或值为空，返回指定的默认值，避免空值处理问题。

接口定义

string GetCustomSetting(string settingName, string defaultValue);

参数

参数名称	是否必填	类型	描述
settingName	是	string	自定义设置的唯一名称。
defaultValue	是	string	当设置不存在或值为空时，返回的默认值（如 yyyyMMdd 作为日期格式默认值）。

返回值

类型	描述
string	若设置存在且有值，返回设置值；否则返回 defaultValue。

示例

string settingName = "demoSettingName";
string value = this.Engine.SettingManager.GetCustomSetting(settingName, "默认值");

直接从远程服务器获得自定义设置的值

功能描述

绕过本地缓存（若存在），直接从远程服务器查询指定设置的最新值。适用于需要实时获取最新配置的场景。

接口定义

string GetCustomSettingFromServer(string settingName);

参数

参数名称	是否必填	类型	描述
settingName	是	string	自定义设置的唯一名称。

返回值

类型	描述
string	远程服务器上该设置的最新值；若服务器上无此设置或查询失败，返回 null 或空字符串。

示例

string settingName = "demoSettingName";
string value = this.Engine.SettingManager.GetCustomSettingFromServer(settingName);

批量获得自定义设置的值

功能描述

一次性查询多个设置名称对应的设置值，返回键值对集合，减少查询开销。

接口定义

Dictionary<string, string> GetCustomSettings(string[] settingNames);

参数

参数名称	是否必填	类型	描述
settingNames	是	string[]	待查询的自定义设置名称数组；若数组为空，返回空字典。

返回值

类型	描述
Dictionary<string, string>	键为设置名称，值为对应的设置值；对于不存在或值为空的设置，键仍保留，值为 null 或空字符串。

示例

Dictionary<string, string> valueTable = this.Engine.SettingManager.GetCustomSettings(new string[] {"key1", "key2"});

设置自定义设置的值

功能描述

新增或更新自定义设置（若设置已存在则覆盖原有值，若不存在则创建新设置），返回操作是否成功。

接口定义

bool SetCustomSetting(string settingName, string settingValue);

参数

参数名称	是否必填	类型	描述
settingName	是	string	自定义设置的唯一名称（不可为空或空白字符串）。
settingValue	否	string	待设置的值（可为空，空值表示将设置置空）。

返回值

类型	描述
bool	true 表示设置新增或更新成功；false 表示失败（如参数无效、权限不足、存储异常等）。

示例

bool result = this.Engine.SettingManager.SetCustomSetting("key1", "value1");

删除自定义设置

功能描述

根据设置名称删除对应的自定义设置（物理删除或逻辑删除，取决于底层实现），返回删除是否成功。

接口定义

bool RemoveCustomSetting(string settingName);

参数

参数名称	是否必填	类型	描述
settingName	是	string	待删除的自定义设置唯一名称。

返回值

类型	描述
bool	true 表示设置删除成功；false 表示失败（如设置不存在、权限不足、删除异常等）。

示例

bool result = this.Engine.SettingManager.RemoveCustomSetting("key1");