更新记录

0.0.2(2021-04-16)

  • 修改插件package信息

0.0.1(2021-03-15)

  • 初始化项目
查看更多

平台兼容性

阿里云 腾讯云

云函数类插件通用教程

使用云函数类插件的前提是:使用HBuilderX 2.9+


为什么使用uni-config-center

实际开发中很多插件需要配置文件才可以正常运行,如果每个插件都单独进行配置的话就会产生下面这样的目录结构

cloudfunctions
  ├─common
  │  └─user-utils // user-utils公共模块
  │      ├─custom-token.js // user-utils依赖的其他文件
  │      └─config.json // user-utils使用的配置文件
  ├─payment-config-test // payment-config-test云函数
  │  └─config.json // payment-config-test使用的配置文件
  └─user-config-test // 引用user-utils的云函数

假设插件作者要发布一个项目模板,里面使用了很多需要配置的插件,无论是作者发布还是用户使用都是一个大麻烦。

uni-config-center就是用了统一管理这些配置文件的,使用uni-config-center后的目录结构如下

cloudfunctions
  ├─common
  │  ├─uni-config-center
  │  │  ├─payment // 插件配置目录
  │  │  │   └─config.json // 插件配置文件
  │  │  └─user-utils // 插件配置目录
  │  │      ├─custom-token.js // 插件依赖的其他文件
  │  │      └─config.json // 插件配置文件
  │  └─user-utils // user-utils公共模块,此公共模块内使用user-utils插件的配置
  ├─payment-config-test // payment-config-test云函数,此云函数内使用payment插件的配置
  └─user-config-test // 引用user-utils的云函数

使用uni-config-center后的优势

  • 配置文件统一管理,分离插件主体和配置信息,更新插件更方便
  • 支持对config.json设置schema,插件使用者在HBuilderX内编写config.json文件时会有更好的提示(后续HBuilderX会提供支持)

用法

在要使用uni-config-center的公共模块或云函数内引入uni-config-center依赖,请参考:使用公共模块

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

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

// 以如下配置为例
// {
//   "tokenExpiresIn": 7200,
//   "passwordErrorLimit": 6,
//   "bindTokenToDevice": false,
//   "passwordErrorRetryTime": 3600,
//   "app-plus": {
//     "tokenExpiresIn": 2592000
//   },
//   "service": {
//     "sms": {
//       "codeExpiresIn": 300
//     }
//   }
// }

// 获取配置
userUtilsConfig.config() // 获取全部配置,注意:uni-config-center内不存在对应插件目录时会返回空对象
userUtilsConfig.config('tokenExpiresIn') // 指定键值获取配置,返回:7200
userUtilsConfig.config('service.sms.codeExpiresIn') // 指定键值获取配置,返回:300
userUtilsConfig.config('tokenExpiresThreshold', 600) // 指定键值获取配置,如果不存在则取传入的默认值,返回:600

// 获取文件绝对路径
userUtilsConfig.resolve('custom-token.js') // 获取uni-config-center/uni-id/custom-token.js文件的路径

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

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

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

MIT协议

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问