uni-cloud-router
v0.0.11
Published
> 基于 koa 风格的 uniCloud 云函数路由库，同时支持 uniCloud 客户端及 URL 化访问
Downloads
17
Readme
uni-cloud-router
基于 koa 风格的 uniCloud 云函数路由库，同时支持 uniCloud 客户端及 URL 化访问
云函数端
安装
npm install --save uni-cloud-router目录结构
├── package.json
├── index.js // 云函数入口文件
├── config.js // 用于配置 router 应用根目录、中间件等
├── controller // 用于解析用户的输入，处理后返回相应的结果
| ├── user.js
├── service (可选) //用于编写业务逻辑层，建议使用
| ├── user.js// index.js (通常无需改动)
const Router = require('uni-cloud-router').Router // 引入 Router
const router = new Router(require('./config.js')) // 根据 config 初始化 Router
exports.main = async (event, context) => {
return router.serve(event, context) // 由 Router 接管云函数
}// config.js
module.exports = {
debug: true, // 调试模式时，将返回 stack 错误堆栈
baseDir: __dirname, // 必选，应用根目录
middleware: [], // 自定义中间件
}// controller/user.js
const uniID = require('uni-id')
const Controller = require('uni-cloud-router').Controller
// 必须继承 Controller
module.exports = class UserController extends Controller {
async login() {
const { username, password } = this.ctx.data // 获取请求参数
// 使用 uni-id 登录
return uniID.login({
username,
password,
})
}
}控制器（Controller）
负责解析用户的输入，处理后返回相应的结果。
推荐 Controller 层主要对用户的请求参数进行处理（校验、转换），然后调用对应的 service 方法处理业务，得到业务结果后封装并返回：
- 获取用户传递过来的请求参数。
- 校验、组装参数。
- 调用 Service 进行业务处理，必要时处理转换 Service 的返回结果，让它适应用户的需求。
- 将结果响应给用户。
如何编写 Controller
所有的 Controller 文件都必须放在 controller 目录下，可以支持多级目录，访问的时候可以通过目录名级联访问。
// controller/post.js
const Controller = require('uni-cloud-router').Controller
// 必须继承 Controller 类
module.exports = class PostController extends Controller {
async create() {
const { ctx, service } = this
// 校验参数
ctx.validate({
title: { type: 'string' },
content: { type: 'string' },
})
// 组装参数
const author = ctx.auth.uid
const post = Object.assign(ctx.data, { author })
// 调用 Service 进行业务处理
return service.post.create(post)
}
}定义的 Controller 类，会在每一个请求访问时实例化一个全新的对象，会有下面几个属性挂在 this 上。
this.ctx：当前请求的上下文对象的实例，通过它我们可以拿到各种便捷属性和方法。this.service：应用定义的 service，通过它我们可以访问到抽象出的业务层，等同于this.ctx.service。this.db：等同于uniCloud.database()。this.curl：等同于uniCloud.httpclient.request。this.throw：抛出异常信息，等同于this.ctx.throw。
获取请求参数
通过在 Controller 上绑定的 Context 实例的 data 属性，获取请求发送过来的参数
class PostController extends Controller {
async listPosts() {
const data = this.ctx.data
// {
// username: 'demo',
// password: 'demo',
// }
}
}调用 Service
通过 Service 层进行业务逻辑的封装，不仅能提高代码的复用性，同时可以让业务逻辑更好测试。
Controller 中可以调用任何一个 Service 上的任何方法，同时 Service 是懒加载的，只有当访问到它的时候才会去实例化它。
class PostController extends Controller {
async create() {
const { ctx, service } = this
const author = ctx.auth.uid
const post = Object.assign(ctx.data, { author })
// 调用 service 进行业务处理
return service.post.create(post)
}
}Service 的具体写法，请查看 Service 章节。
定制 URL 化返回的状态码
class PostController extends Controller {
async create() {
// 设置状态码为 201
this.ctx.status = 201 // 仅当使用 HTTP/HTTPS 请求时生效
}
}服务（Service）
业务逻辑封装的一个抽象层，有以下几个好处：
- 保持 Controller 中的逻辑更加简洁。
- 保持业务逻辑的独立性，抽象出来的 Service 可以被多个 Controller 重复调用。
- 将逻辑和展现分离，更容易编写测试用例。
使用场景
- 复杂数据的处理，比如要展现的信息需要从数据库获取，还要经过一定的规则计算，才能返回用户显示。或者计算完成后，更新到数据库。
- 第三方服务的调用，比如 微信模板消息推送 等。
如何编写 Service
所有的 Service 文件都必须放在 service 目录下，可以支持多级目录，访问的时候可以通过目录名级联访问。
// service/post.js
const Service = require('uni-cloud-router').Service
// 必须继承 Service
module.exports = class PostService extends Service {
async create(data) {
return this.db.add(data)
}
}定义的 Service 类是懒加载的，只有当访问到它的时候才会去实例化它，会有下面几个属性挂在 this 上。
this.ctx：当前请求的上下文对象的实例，通过它我们可以拿到各种便捷属性和方法。this.service：应用定义的 service，通过它我们可以访问到抽象出的业务层，等同于this.ctx.service。this.db：等同于uniCloud.database()。this.curl：等同于uniCloud.httpclient.request。this.throw：抛出异常信息，等同于this.ctx.throw。
使用 Service
中间件（Middleware）
在路由请求前，后添加处理逻辑，实现一些特定功能，如：用户登录，权限校验等
开发中间件
与 koa 保持一致，参考：koa 中间件
// middleware/auth.js
const uniID = require('uni-id')
module.exports = (options) => {
// 初始化 uniID 配置
uniID.init(options)
// 返回中间件函数
return async function auth(ctx, next) {
// 校验 token
const auth = await uniID.checkToken(ctx.event.uniIdToken)
if (auth.code) {
// 校验失败，抛出错误信息
throw { code: auth.code, message: auth.message }
}
ctx.auth = auth // 设置当前请求的 auth 对象
await next() // 执行后续中间件
}
}示例：
使用中间件
- 通过 config.js 配置
const auth = require('./middleware/auth.js') // 引入 auth 中间件
module.exports = {
debug: true, // 调试模式时，将返回 stack 错误堆栈
baseDir: __dirname, // 指定应用根目录
middleware: [
[
//数组格式，第一个元素为中间件，第二个元素为中间件生效规则配置
auth({ tokenSecret: 'tokenSecret-demo' }), // 注册中间件
{ enable: true, ignore: /\/login$/ }, // 配置当前中间件生效规则，该规则表示以`/login`结尾的路由不会执行 auth 中间件校验 token
],
],
}- 中间件配置项
enable 控制中间件是否开启。
match 设置只有符合某些规则的请求才会经过这个中间件。
支持类型：
- 字符串：当参数为字符串类型时，配置的是一个 action 前缀，所有以该字符串作为前缀的 action 都会匹配上。
- 正则：当参数为正则时，直接匹配满足正则验证的 action。
- 函数：当参数为一个函数时，会将请求上下文传递给这个函数，根据函数结果（true/false）来判断是否匹配。
- 数组：可以由字符串，正则，函数组成，任意一个匹配到即可
ignore 设置符合某些规则的请求不经过这个中间件。
支持类型：同 match
Context
Context 是一个请求级别的对象，在每一次收到用户请求时，会实例化一个 Context 对象，这个对象封装了这次用户请求的信息，并提供了许多便捷的方法来获取请求参数或者设置响应信息。框架会将所有的 Service 挂载到 Context 实例上
获取方式
最常见的 Context 实例获取方式是在 Middleware, Controller 以及 Service 中。
// 在 Controller 中通过 this.ctx 获取 Context 实例
module.exports = class UserController extends Controller {
async login() {
const data = this.ctx.data // 从 Context 实例上获取请求参数
}
}// 在 Service 中通过 this.ctx 获取 Context 实例
module.exports = class PostService extends Service {
async create(data) {
const auth = this.ctx.auth // 从 Context 实例上获取 auth(需要启用 uni-id 中间件)
}
}// 在 Middleware 中通过 ctx 参数获取 Context 实例
module.exports = (options) => {
// 返回中间件函数
return async function auth(ctx, next) {
const data = ctx.data // 从 Context 实例上获取请求参数
await next()
}
}客户端
发送请求
// 使用 uniCloud 访问
uniCloud.callFunction({
name: 'router', // 要调用的云函数名称
data: {
action: 'user/login', // 路由地址，对应 controller 下 user.js 的 login 方法
// 参数列表
data: {
// controller 通过 this.ctx.data 获取
username: 'demo',
password: 'demo',
},
},
})// 使用 URL 化 request 访问
uni.request({
url: 'xxxxx/router/user/login', // 路由地址，对应 controller 下 user.js 的 login 方法
data: {
// controller 通过 this.ctx.data 获取
username: 'demo',
password: 'demo',
},
})返回结果
{
"code": "", // 异常 code，如："INVOKE_FUNCTION_FAILED"
"message": "", // 异常信息
"stack": "" // 当 config.js 中配置 debug 为 true 时，返回发生异常的堆栈信息
// 其他信息
}