基于 Laf 的单文件云函数实践

小海 · 2023-06-23T12:57:08+00:00

顾名思义，就是把所有逻辑放在一个云函数中。优缺点这种方式有很多优点：多项目可以放在一个实例中，互不影响，又可以相互访问。多项目可以放在一个实例中，共享资源，降低成本。方便迁移，一个项目就只有1个（或几个）文件，一个复制粘贴就可以搞定。同样，也会有一些缺点：如果没有良好的结构和约定，最终真的...

小海

顾名思义，就是把所有逻辑放在一个云函数中。

优缺点

这种方式有很多优点：

多项目可以放在一个实例中，互不影响，又可以相互访问。
多项目可以放在一个实例中，共享资源，降低成本。
方便迁移，一个项目就只有1个（或几个）文件，一个复制粘贴就可以搞定。

同样，也会有一些缺点：

如果没有良好的结构和约定，最终真的会堆出屎山。
一旦有一个方法崩了，可能会影响整个项目的健康状态。
安全性降低，如果有前端直接操作数据库，那访问策略一定要搞好。

另外，还有一些不确定的内容：

实例的内存占用是否会增加。毕竟随便一个请求，都会加载整个函数。

约定

为了防止屎山不那么快的出现，做以下约定：

基于 GET 中的 query.action 参数区分请求。所以这是个必传参数。
根据实际需求选择 GET 或 POST 或其它请求方式，同时传递所需参数。
制定一套合理的状态码。我这里是在 http 状态码的基础上增加两位方便扩充，如200=>20000。

约定一个功能函数的 interface（初次尝试ts，若有问题请指正）：

    interface Action {
        [key: string]: {
            methods: ('GET' | 'POST')[]	// 请求方式
            auth: boolean	// 是否需要鉴权
            handler: Function	// 实际处理逻辑
        }
    }

实现

给项目起个代号firefly 然后创建它，把前面的 interface 放进去。

import cloud from '@lafjs/cloud'

interface Action {
    [key: string]: {
        methods: ('GET' | 'POST')[]
        auth: boolean
        handler: Function
    }
}

const actions: Action = {}

export default async function (ctx: FunctionContext) {
  console.log('Hello World')
  return { data: 'hi, laf' }
}

补一下前置处理，也就是拦截器。

注意：这里的拦截器是当前云函数的拦截器。如果需要全局的拦截器，请编写__interceptor__函数。文档在这里：https://doc.laf.run/guide/function/interceptor.html

...

export default async function (ctx: FunctionContext) {
    const { action } = ctx.query
  
    // 黑名单处理和访问频率处理，此处省去。见帖子：https://forum.laf.run/d/130/7
    // 顺便说一下，黑名单的处理可以放在`__interceptor__`中，这里仅处理频率问题即可。
    
    // 没有 action 或没找到 action 报错
    if (!action || !actions[action]) {
        return {code: 40000}
    }
    
   const { methods, auth, handler } = actions[action]
   
    // method 不符
    if (!methods.includes(ctx.method)) {
        return {code: 40000}
    }
    
    // 鉴权
    if (auth && ctx.user === null) {
        return {code: 40100}
    }
    
    // 执行
    if (handler) {
        return handler(ctx)
    }
    
    // 能执行到这里肯定哪儿写错了
  	return {code: 50000}
}

然后定义第一个处理函数 GET https://appId.laf.run/firefly?action=test

...

actions.test = {
    methods: ['GET'],
    auth: false,
    handler() {
        return {
            hello: 'world'
        }
    }
}

...

至此，单文件函数的框架就搭建好了。然后，补一下配置项，和几个常用方法。

// 配置项
const config = {
    name: 'firefly',	// 当前应用名称
    collectionPrefix: 'firefly', // 数据库前缀
    sharedPrefix: 'firefly' // 全局缓存前缀
}

// 统一数据库集合的名称
// 使用 collection('user') 访问数据库时，则会去访问 firefly_user 数据集合。
// 保证各项目之间数据库独立，且不容易混淆。
const collection = (name) => {
    return cloud.database().collection(`${config.collectionPrefix}_${name}`)
}

// 统一缓存前缀
// 同样保证各项目之间缓存独立，不易混淆。
const shared = {
    get(key) {
        return cloud.shared.get(`${config.sharedPrefix || ''}_${key}`)
    },
    set(key, value) {
        return cloud.shared.set(`${config.sharedPrefix || ''}_${key}`, value)
    }
}

再尝试写个处理函数 POST https://appId.laf.run/firefly?action=user&id=1

...

actions.user = {
    method: ['POST'],
    auth: true,
    async handler(ctx){
        const { id } = ctx.query
        if(!id){
            return {code: 40000}
        }
        // 保证操作的数据集合是 firefly_user
        const userInfo = await collection('user').doc(id).get()
        if(!userInfo.ok || userInfo.data === null){
            return {code: 50000}
        }
        return {
            code: 20000,
            message: '',
            data: userInfo.data
        }
    }
}
...

完整代码

import cloud from '@lafjs/cloud'

interface Action {
    [key: string]: {
        methods: ('GET' | 'POST')[]
        auth: boolean
        handler: Function
    }
}

// 配置项
const config = {
    name: 'firefly',	// 当前应用名称
    collectionPrefix: 'firefly', // 数据库前缀
    sharedPrefix: 'firefly' // 全局缓存前缀
}

// 统一数据库集合的名称
// 使用 collection('user') 访问数据库时，则会去访问 firefly_user 数据集合。
// 保证各项目之间数据库独立，且不容易混淆。
const collection = (name) => {
    return cloud.database().collection(`${config.collectionPrefix}_${name}`)
}

// 统一缓存前缀
// 同样保证各项目之间缓存独立，不易混淆。
const shared = {
    get(key) {
        return cloud.shared.get(`${config.sharedPrefix || ''}_${key}`)
    },
    set(key, value) {
        return cloud.shared.set(`${config.sharedPrefix || ''}_${key}`, value)
    }
}

const actions: Action = {}

// 第一个处理函数
actions.test = {
    methods: ['GET'],
    auth: false,
    handler() {
        return {
            hello: 'world'
        }
    }
}

// 第二个处理函数
actions.user = {
    method: ['POST'],
    auth: true,
    async handler(ctx){
        const { id } = ctx.query
        if(!id){
            return {code: 40000}
        }
        // 保证操作的数据集合是 firefly_user
        const userInfo = await collection('user').doc(id).get()
        if(!userInfo.ok || userInfo.data === null){
            return {code: 50000}
        }
        return {
            code: 20000,
            message: '',
            data: userInfo.data
        }
    }
}

// 入口，拦截器
export default async function (ctx: FunctionContext) {
    const { action } = ctx.query
  
    // 黑名单处理和访问频率处理，此处省去。见帖子：https://forum.laf.run/d/130/7
    // 顺便说一下，黑名单的处理可以放在`__interceptor__`中，这里仅处理频率问题即可。
    
    // 没有 action 或没找到 action 报错
    if (!action || !actions[action]) {
        return {code: 40000}
    }
    
   const { methods, auth, handler } = actions[action]
   
    // method 不符
    if (!methods.includes(ctx.method)) {
        return {code: 40000}
    }
    
    // 鉴权
    if (auth && ctx.user === null) {
        return {code: 40100}
    }
    
    // 执行
    if (handler) {
        return handler(ctx)
    }
    
    // 能执行到这里肯定哪儿写错了
  	return {code: 50000}
}

最后

简单介绍一下实现这个单文件云函数的项目：

一个给孩子创造压力的小工具，也是解放宝爸宝妈的小工具。一键生成各种数学题，字帖。

地址在这里：https://www.dayin.page/

它本来是一个纯前端工具。借助 Laf 的能力，现在接入了微信小程序，扫一扫即可查看答案。

感谢 Laf，希望单文件云函数能给你带来启发，也希望你喜欢 dayin.page 。

—
原文：https://www.muyi.dev/posts/20230622

update：20230706
已发布至云函数市场：https://laf.run/market/templates/649ccff79622c81462953d74