uni-config-center插件的下载地址:https://ext.dcloud.net.cn/plugin?id=4425 (opens new window)

# 需求背景

实际开发中很多插件/云函数/公共模块需要配置文件才可以正常运行,比如各种appkey、secret。存放在数据库里的话,拖累云函数性能,并且增加数据库请求。如果每个都单独进行配置的话就会产生下面这样的目录结构。

cloudfunctions
  ├─cf1 // cf1云函数
  │  │─index.js
  │  └─config.json // cf1使用的配置文件
  └─cf2 // cf2云函数
     │─index.js
     └─config.json // cf2使用的配置文件

可以看到这样有很多问题:

  1. 配置文件分散在各个地方,无法统一维护
  2. 配置和代码没有分离。更新云函数会覆盖配置。如果使用插件,插件作者更新云函数后,那么用户侧的配置会被覆盖
  3. 多个云函数之间无法共享配置

uni-config-center解决了上述问题。通过独立了公共模块,统一管理配置文件,做到配置和代码分离,更新代码不会覆盖配置,并且可以在多个云函数之间共享配置。

使用uni-config-center后的目录结构如下

cloudfunctions
  ├─common
  │  ├─uni-config-center
  │  │  ├─cf1 // 插件配置目录
  │  │  │   └─config.json // 插件配置文件
  │  │  └─cf2 // 插件配置目录
  │  │      └─config.json // 插件配置文件
  ├─cf1 // cf1云函数
  └─cf2 // cf2云函数

# 用法

# 导入和创建配置

例如,在云函数cf2内使用uni-config-center,步骤如下:

  1. 导入uni-config-center公共模块到项目内

存放路径是 uniCloud/cloudfunctions/common/uni-config-center。 一般uniCloud项目创建时会自动导入这个基础插件,如项目没有该插件,请在插件市场下载https://ext.dcloud.net.cn/plugin?id=4425 (opens new window)

  1. 给云函数添加公共模块依赖

在云函数cf2上右键选择管理公共模块依赖,弹窗中勾选uni-config-center公共模块

  1. 新建插件配置目录

cloudfunctions/common/uni-config-center目录新建插件配置目录,在本示例中我们使用share-config作为插件配置目录名(uni-config-center下不同的配置,被称为插件配置。这个插件的概念容易和插件市场的插件混淆,请注意区分)

  1. 新建插件配置文件

在上一步创建的share-config目录下创建配置文件config.json(这个文件的名称不能自定义),在config.json里编写基于json的配置内容。

至此多云函数/公共模块共享的配置就创建完成了,目录结构如下

cloudfunctions
  ├─common
  │  └─uni-config-center
  │     └─share-config // 插件配置目录
  │         └─config.json // 配置文件
  └─cf2 // 引用share-config的云函数

注意

  • 推荐插件配置名称(也就是上述示例中的share-config)尽量无歧义。如果只为一个云函数提供配置,那么这个配置的名称建议和云函数的名称一致。尤其是插件作者,更要注意插件配置名称包含插件前缀,防止和用户代码冲突。
  • 如需在不同项目使用同一服务空间,请务必注意两个项目的uni-config-center在上传时会互相覆盖。建议将云端代码放在同一个项目内,其他项目关联存放云端代码的项目的服务空间。

# 云函数中读取配置

以上述目录结构为例,在云函数cf2内获取share-config配置目录下的配置内容,示例代码如下

// cf2/index.js
const createConfig = require('uni-config-center')
const shareConfig = createConfig({ // 获取配置实例
    pluginId: 'share-config' // common/uni-config-center下的插件配置目录名
})
const Config = shareConfig.config() // 获取common/uni-config-center/share-config/config.json的内容
exports.main = async function(event, context) {
	console.log(Config) //打印配置
}

注意

  • uni-config-center下的配置不隔离。一个云函数或公共模块,引入了uni-config-center后,下面的所有插件配置都可以访问到
  • uni-config-center的配置是只读的。除非重新上传更新uniCloud服务空间,否则不会变化。如需在代码运行期间修改配置,那么需要改用redis (opens new window)

详细接口说明请阅读下方文档。

# 获取配置实例

通过createConfig接口即可获取配置实例,此实例上有一些方法如:获取配置内容、拼接目录路径等

接口形式

const createConfig = require('uni-config-center')
createConfig({
	pluginId,
	defaultConfig,
	customMerge
})

参数说明

参数名 类型 必填 说明
pluginId string common/uni-config-center下的配置目录名
defaultConfig Object 默认配置
customMerge Function 自定义默认配置和用户配置的合并规则,不设置的情况下会对默认配置和用户配置进行深度合并

代码示例

const createConfig = require('uni-config-center')

const shareConfig = createConfig({
    pluginId: 'share-config', // 同common/uni-config-center下的配置目录名
    defaultConfig: { // 默认配置
        tokenExpiresIn: 7200,
        tokenExpiresThreshold: 600,
    },
    customMerge: function(defaultConfig, userConfig) { // 自定义默认配置和用户配置的合并规则,不设置的情况下会对默认配置和用户配置进行深度合并
        // defaudltConfig 默认配置
        // userConfig config-center内的配置文件内容
        return Object.assign(defaultConfig, userConfig)
    }
})

# 获取配置内容

获取配置内容接口有以下几种形式,如果在createConfig时传入了defaultConfig,会和配置目录下的config.json合并作为完整的配置文件。

// 获取配置
shareConfig.config() // 获取全部配置,没有获取到配置时返回空对象
shareConfig.config('tokenExpiresIn') // 传入参数名获取指定配置
shareConfig.config('service.sms.codeExpiresIn') // 传入参数路径获取指定配置
shareConfig.config('tokenExpiresThreshold', 600) // 获取指定配置,如果不存在则取传入的默认值

# 获取配置目录下的文件的绝对路径

shareConfig.resolve('custom-token.js') // 获取uni-config-center/share-config/custom-token.js文件的路径

# 引用配置目录下的js、json文件

shareConfig.requireFile('custom-token.js') // 使用require方式引用uni-config-center/share-config/custom-token.js文件。文件不存在时返回undefined,文件内有其他错误导致require失败时会抛出错误。

# 判断配置目录下是否存在指定文件

shareConfig.hasFile('custom-token.js') // 配置目录是否包含某文件,true: 文件存在,false: 文件不存在