Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TencentCloudBase/tcb-router
小程序·云开发 云函数类 koa 路由工具
https://github.com/TencentCloudBase/tcb-router
Last synced: about 1 month ago
JSON representation
小程序·云开发 云函数类 koa 路由工具
- Host: GitHub
- URL: https://github.com/TencentCloudBase/tcb-router
- Owner: TencentCloudBase
- License: mit
- Archived: true
- Created: 2018-07-26T04:30:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:35:28.000Z (almost 2 years ago)
- Last Synced: 2024-10-02T14:38:52.127Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 1.27 MB
- Stars: 385
- Watchers: 14
- Forks: 32
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tcb - tcb-router
README
# tcb-router
[![NPM version][npm-image]][npm-url]
[](https://travis-ci.org/TencentCloudBase/tcb-router)
[![npm download][download-image]][download-url]
[![npm license][license-image]][download-url]
[](https://coveralls.io/github/TencentCloudBase/tcb-router?branch=master)
[npm-image]: https://img.shields.io/npm/v/tcb-router.svg?style=flat-square
[npm-url]: https://npmjs.org/package/tcb-router
[david-image]: https://img.shields.io/david/673800357/tcb-router.svg?style=flat-square
[download-image]: https://img.shields.io/npm/dm/tcb-router.svg?style=flat-square
[download-url]: https://npmjs.org/package/tcb-router
[license-image]: https://img.shields.io/npm/l/tcb-router.svg
> 基于 koa 风格的小程序·云开发云函数轻量级类路由库，主要用于优化服务端函数处理逻辑
## 云函数端
使用
```bash
npm install --save tcb-router
```
```javascript
// 云函数的 index.js
const TcbRouter = require('./router');
exports.main = (event, context) => {
const app = new TcbRouter({ event });
// app.use 表示该中间件会适用于所有的路由
app.use(async (ctx, next) => {
ctx.data = {};
await next(); // 执行下一中间件
});
// 路由为数组表示，该中间件适用于 user 和 timer 两个路由
app.router(['user', 'timer'], async (ctx, next) => {
ctx.data.company = 'Tencent';
await next(); // 执行下一中间件
});
// 路由为字符串，该中间件只适用于 user 路由
app.router('user', async (ctx, next) => {
ctx.data.name = 'heyli';
await next(); // 执行下一中间件
}, async (ctx, next) => {
ctx.data.sex = 'male';
await next(); // 执行下一中间件
}, async (ctx) => {
ctx.data.city = 'Foshan';
// ctx.body 返回数据到小程序端
ctx.body = { code: 0, data: ctx.data};
});
// 路由为字符串，该中间件只适用于 timer 路由
app.router('timer', async (ctx, next) => {
ctx.data.name = 'flytam';
await next(); // 执行下一中间件
}, async (ctx, next) => {
ctx.data.sex = await new Promise(resolve => {
// 等待500ms，再执行下一中间件
setTimeout(() => {
resolve('male');
}, 500);
});
await next(); // 执行下一中间件
}, async (ctx)=> {
ctx.data.city = 'Taishan';
// ctx.body 返回数据到小程序端
ctx.body = { code: 0, data: ctx.data };
});
return app.serve();
}
```
tips: 小程序云函数的 node 环境默认支持 async/await 语法，推荐涉及到的异步操作时像 demo 中那样使用
## 小程序端
```javascript
// 调用名为 router 的云函数，路由名为 user
wx.cloud.callFunction({
// 要调用的云函数名称
name: "router",
// 传递给云函数的参数
data: {
$url: "user", // 要调用的路由的路径，传入准确路径或者通配符*
other: "xxx"
}
});
```
## 接口
### 构造函数
* 参数
- Object，存入云函数的 `event` 参数
* 示例
```js
const TcbRouter = require('./router');
exports.main = (event, context) => {
const app = new TcbRouter({ event });
};
```
### app.use
* 参数
- Function, 应用于所有路由的中间件
* 示例
```js
app.use(async (ctx, next) => {
ctx.data = {};
await next(); // 执行下一中间件
});
```
### app.router
* 参数
- Array|String，路由或路由数组
- Function, 应用于对应路由的中间伯
* 示例
```js
app.router(['user', 'timer'], async (ctx, next) => {
ctx.data = {}；
ctx.data.company = 'Tencent';
await next(); // 执行下一中间件
});
// 路由为字符串，该中间件只适用于 user 路由
app.router('user', async (ctx, next) => {
ctx.data.name = 'heyli';
ctx.body = {code: 0, data: ctx.data}; // 将数据返回给云函数，用ctx.body
});
```
## 测试
```bash
npm run test
```