如何只使用一个云函数搞定一个庞大而复杂的系统
吐槽
翻遍社区的文章,关于云开发的干货,少之又少,大部分都还是官方文档的搬来搬去,没啥营养,是时候放出一点技术"干货"了(有经验的开发者都能想到的方案)!
正题
小程序云开发的云函数的最大限制是 [代码]50[代码] 个,假设每个接口都使用 [代码]1[代码] 个云函数的话,有 [代码]10[代码] 张表,每张表都有 [代码]增删改查[代码] 四个接口,那么就会有 [代码]40[代码] 个接口,再加上一些其他接口,差不多刚刚好够用,那如果有 [代码]20[代码] 张表,甚至更多的表、更多的接口呢?对于中小型的小程序来说足够使用,那如果一个非常庞大而复杂的系统该怎么办呢?
而且每一个云函数的运行环境是独立的,想要共享一些数据也不是特别方便,那么有没有什么办法突破这样的限制呢?
其实解决方案很简单,只需要一点点的 [代码]OOP[代码] 思想和利用 [代码]JavaScript[代码] 的特性,一个云函数就可以搞定所有的接口。
具体的实现请往下看。
思路
云函数的运行环境是 [代码]Nodejs[代码] , 那么使用的语言就是 [代码]JavaScript[代码] ,可以充分的利用 [代码]JavaScript[代码] 的特性。
[代码]JavaScript[代码] 中的 [代码]属性访问表达式[代码] 有两种语法
[代码]expression . identifier
expression [ expression ]
[代码]
第一种写法是一个表达式后跟随一个句点 [代码].[代码] 和一个标识符。表达式指定对象,标识符则指定需要访问的属性的名称。
第二种写法是使用方括号 [代码][][代码],方括号内是另一个表达式(这种方法适用于对象和数组)。第二个表达式指定要访问的属性的名称或者代表要访问数组元素的索引。
不管使用哪种形式的属性访问表达式,在 [代码].[代码] 和 [代码][][代码] 之前的表达式总是会首先计算。
虽然 [代码].[代码] 的写法更加简单,但这种方式只适用于要访问的属性名称的合法标识符,并需要准确知道访问的属性的名字,如果属性的名称是一个保留字或者包含空格和标点符号,或者是一个数字(对于数组来说),则必须使用方括号 [代码][][代码] 的写法。当属性名是通过运算得出的值而不是固定值的时候,这时也必须使用方括号 [代码][][代码] 写法。
感谢社区大神 @卢霄霄 提供参考资料,详见 [代码]JavaScript权威指南[代码] (犀牛书)4.4章节。
可以使用 [代码][][代码] 的形式来完成动态的属性访问。具体实现请往下看。
实现
上面说了太多废话了,下面直接开干吧。
新建云函数
在云开发目录中新建一个云函数,我这里命名为 [代码]cloud[代码]。
打开 [代码]index.js[代码] 文件你会看到下面这段代码
[代码]// 云函数入口文件
const cloud = require('wx-server-sdk')
// 初始化 cloud
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV
})
// 云函数入口函数
exports.main = async (event, context) => {
const wxContext = cloud.getWXContext()
return {
event,
openid: wxContext.OPENID,
appid: wxContext.APPID,
unionid: wxContext.UNIONID,
}
}
[代码]
这个云函数仅作为入口使用,上面提到了云函数的运行环境是 [代码]Nodejs[代码] 那么 [代码]Nodejs[代码] 的特性也是可以使用的,这里主要用到的是全局对象 [代码]global[代码],详见文档
在文件中,写入一些必要的全局变量,主要还是云数据库方面的,方便后面使用。
在初始化后面插入代码
[代码]global.cloud = cloud
global.db = cloud.database()
global._ = db.command
global.$ = _.aggregate
[代码]
这样就可以在同一个云函数环境中直接访问这些全局变量。
创建公共类
然后新建一个文件夹,我这里命名为 [代码]controllers[代码] ,这个文件夹用于存放所有的接口。
在 [代码]controllers[代码] 中新建一个 [代码]base-controller.js[代码] 文件,创建一个叫做 [代码]BaseController[代码] 的类,用于提供一些公用的方法。
内容如下:
[代码]class BaseController {
/**
* 调用成功
*/
success (data) {
return { code: 0, data }
}
/**
* 调用失败
*/
fail (erroCode = 0, msg = '') {
return { erroCode, msg, code: -1 }
}
}
module.exports = BaseController
[代码]
看到这里大家可能有点没看懂在做什么,那么请继续往下看。
创建接口
假设创建一些要操作用户相关的的接口,可以在 [代码]controllers[代码] 文件夹中新建一个 [代码]user-controller.js[代码] 的文件,创建一个名为 [代码]UserController[代码] 的类,并继承上面的 [代码]BaseController[代码] 类,内容如下:
[代码]const BaseController = require('./base-controller.js')
class UserController extends BaseController {
// ...
}
module.exports = UserController
[代码]
可以在这个类中编写所有关于 [代码]user[代码] 的接口方法。
编写接口
假设要分页查询用户信息,可以在 [代码]UserController[代码] 类中创建一个 [代码]list[代码] 方法。
代码如下:
[代码]async list (data) {
const { pageIndex, pageSize } = data
let result = await db.collection('users')
.skip((pageIndex - 1) * pageSize)
.limit(pageSize)
.get()
.then(result => this.success(result.data))
.catch(() => this.fail([]))
return result
}
[代码]
由于上面已经定义了全局变量 [代码]db[代码] 所以在 [代码]UserController[代码] 中无需引入 [代码]wx-server-sdk[代码]
引入接口类
写到这里接口已经完成了,还需要再引入这些接口类才可以进行访问。在 [代码]index.js[代码] 中引入 [代码]user-controller.js[代码]
[代码]const User = require('./controllers/user-controller.js')
[代码]
然后创建一个 [代码]api[代码] 变量,[代码]new[代码] 一个 [代码]User[代码] 实例
[代码]const api = {
user: new User()
}
[代码]
在 [代码]main[代码] 方法中调用 [代码]UserController[代码] 中的方法。
[代码]exports.main = async (event, context) => {
const { data } = event
let result = await api['user']['list'](data)
return result
}
[代码]
写到这里基本已经完成了接口的调用,但想要一个云函数动态调用所有接口还需要做一些改动。
动态调用接口
刚开始的时候介绍了 [代码]属性访问表达式[代码],限制稍微改动一下 [代码]main[代码] 方法
[代码]exports.main = async (event, context) => {
const { controller, action, data } = event
const result = await api[controller][action](data)
return result
}
[代码]
在小程序调用云函数时,需要传入 [代码]controller[代码]、[代码]action[代码] 和 [代码]data[代码] 参数即可
[代码]const result = await wx.cloud.callFunction({
name: 'cloud',
data: { controller, action, data }
})
[代码]
完整 [代码]index.js[代码] 文件的代码
[代码]// 云函数入口文件
const cloud = require('wx-server-sdk')
const User = require('./controllers/user-controller.js')
const api = {
user: new User()
}
// 初始化 cloud
cloud.init({
env: cloud.DYNAMIC_CURRENT_ENV
})
global.cloud = cloud
global.db = cloud.database()
global._ = db.command
global.$ = _.aggregate
// 云函数入口
exports.main = async (event, context) => {
exports.main = async (event, context) => {
const { controller, action, data } = event
const result = await api[controller][action](data)
return result
}
}
[代码]
其他实现
云开发官方团队打造的轮子 tcb-router