抛砖引玉(3): 微信云开发最佳实践

概览

微信云开发是一个打通了微信生态的BaaS (后端即服务)平台，开发方便，快捷，计费友好，适合个人开发者，以及小团队使用。

它主要由 云数据库,云存储,云函数,用户身份验证还有 云托管 组成，其中 云函数/云托管就是我们的后端服务了。

这篇文章也主要聊一聊它们工程化的最佳实践。

云函数

微信云开发里的云函数，本质上是拥有微信天然鉴权 SCF。它也属于腾讯云 serverless 体系。所以 SCF 的最佳实践，部分也是通用的。

这里可以关注一下笔者的serverless专栏 Serverless之我见 , 里面有许多基于SCF的最佳实践。

wx-server-sdk

使用云函数，基本一定会装这个包，它解锁了BaaS下的那些额外的能力。

从安装后的 npm 包代码来看，它是一个 cloudbase 功能的场景定制版。

比如我们的 WXContext 的获取，就是仰仗 serverless 容器环境中的 WX_CONTEXT_KEYS 环境变量，解析它来获取的。

那么从这点出发，我们就能够自己去 mock 云函数里的微信的上下文机制。

小程序想要跨多个平台的，建议预先对wx-server-sdk里的 cloud.getWXContext() 上下文获取机制进行抽象，不然随着业务迭代，对微信上下文依赖加深，会造成一定的迁移困难。

cloudbase 能力解锁

我们知道 微信开发者工具 开发小程序的体验一直不是很好。所以为了提升开发体验，我们通常会在 vscode 里写代码，然后再把工具当成一个模拟器和调试器来使用。

云开发亦是如此 (笑~)，这里我们直接使用 @cloudbase/cli 来运维我们的云函数，有了它，我们就能脱离微信IDE和配置的限制 , 来帮助我们更好的实现工程化。

具体操作，可以进入微信开发者工具 > 云开发 > 费用管理 > 代金券 > 充值与账单，能够打开腾讯云的登录界面。在这个页面，就可以把云开发默认创建的腾讯云账号，和你自己的微信做关联。
关联成功后，我们既可以在微信IDE 里管理云开发 , 也能够在腾讯云控制台 云开发 Cloudbase 这个功能中进行管理。
这样除了微信自己的用户管理需要在小程序IDE内查看，其他都可以去腾讯云控制台进行操作。

云函数项目的目录结构

这里我给大家一个示例。

抛砖引玉(3): 微信云开发最佳实践

目录结构

图中几点提及一下:

cloudbaserc.json 是 cloudbase cli 的配置文件。为什么会有一个 cloudbaserc.js呢？这个文件是笔者自定义的脚本，它会扫描 dist 下的函数代码，来生成 cloudbaserc.json。
这么做的原因是因为 json,yml 这类数据格式作为配置文件的表现力，比起代码，还是偏弱的，所以我们需要动态生成的配置文件。
.env,.env.dev,.env.prod 用来声明在不同mode中，生效的变量。
比如 tcb fn deploy --mode dev 这样一条部署命令，它使用的就是.env,.env.dev 文件merge后的变量。这个机制与 vue cli 的 mode是类似的。
此时我们就能够在 .env.dev,.env.prod 里声明自己的云环境ID ENV_ID=dev-xxxxx ,再在 cloudbaserc.json 声明 "envId": "{{env.ENV_ID}}",，这样就能通过切换 mode 的方式去快速管理不同的环境了。

src 与 dist

这个目录结构，前端的朋友们很熟悉了, src 存放着我们的源代码，dist 是打包后实际生效的运行时代码。

2个内部的结构和转化如图所示:

抛砖引玉(3): 微信云开发最佳实践

结构

这套机制算是这三期 抛砖引玉 文章的一个总结。

它的优势在于，让多个云函数处于一种 '游离态', 这种状态既保证多个云函数之间，公共逻辑代码的复用，又保证了每一个云函数，作为一个单独的 Nodejs 应用的独立性。

比如在图上可知：

单个函数，能够决定自己的openapi 权限 (config.json)。
也能保证，在共用 node_module 的基础上，一个云函数有权决定，哪些npm包是自己特殊私有的 (依靠自己pkg.json声明与node_module 递归向上查找) 。
也有权决定函数中，哪些需要打包，哪些不需要。并在云端把缺失的依赖安装好(依靠独立的external选项)。

打包serverless源码

关于serverless为什么需要打包，和怎么打包这2个问题，这里笔者之前写了一篇文章:

serverless 降低冷启动时间的探索 - 服务端打包 node_modules

阐释了打包服务端Nodejs的必要性和可行性，以及遇到打包后启动失败的情况应该如何去做。

因为这里的云函数本质上也是SCF, 所以在方案上也是通用的。