Skip to main content

租户配置文件

Chameleon 平台提供了租户配置文件能力，方便开发人员在系统中预置一些固定的配置项，例如：API 密钥、自定义数据库连接字符串等。

租户配置​

开发人员可通过 开发设置 菜单进入租户配置页，租户配置页面提供了 JSON 格式的文本编辑器。

配置示例​

{
    "key": "value1",
    "step": {
        "key2": "value2"
    }
}

获取配置值​

Chameleon 平台提供了 SDK 可以方便地获取到租户配置 JSON，并自动解析为符合现代化 .NET 配置文件标准的 IConfiguration 类型。

使用示例​

using System;
using System.Linq;
using System.Collections.Generic;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using Chameleon.Common;
using Chameleon.Common.Context;
using Chameleon.Common.Exceptions;
using Chameleon.Common.Models;
using Chameleon.Database;
using Chameleon.SDK;

public class ChameleonCSharpScript
{
    public async Task<object> ExecuteAsync(ComponentContext context, ChameleonSDK sdk)
    {
        // 获取租户配置
        var config = sdk.TenantSettingHelper.GetTenantConfig();
        
        // 获取某个值（IConfiguration 如果路径错误会返回 null）
        var value = config["step:key2"];
        // value = "value2"
        
        return value;
    }
}

配置路径说明​

IConfiguration 使用冒号 : 作为分隔符来访问嵌套的配置值：

配置路径对应值
keyvalue1
step:key2value2
tip

如果配置路径不存在，IConfiguration 会返回 null，不会抛出异常。

使用场景​

  • API 密钥管理：存储第三方服务的 API 密钥
  • 数据库连接：自定义数据库连接字符串
  • 服务地址：配置外部服务的地址
  • 功能开关：控制功能的启用和禁用
  • 业务参数：存储业务相关的配置参数

相关文档​