Skip to main content
Version: 3.0.0

腾讯云 SCF

云函数(Serverless Cloud Function,SCF)是腾讯云为企业和开发者们提供的无服务器执行环境,帮助您在无需购买和管理服务器的情况下运行代码。您只需使用平台支持的语言编写核心代码并设置代码运行的条件,即可在腾讯云基础设施上弹性、安全地运行代码。云函数是实时文件处理和数据处理等场景下理想的计算平台。

下面是常见的函数触发器的使用和测试方法。

触发器代码

API 网关在腾讯云函数体系中类似于 HTTP 函数,我们通过它将函数发布为 HTTP 服务。

import { Provide, Inject, ServerlessTrigger, ServerlessTriggerType } from '@midwayjs/decorator';
import { Context } from '@midwayjs/faas';

@Provide()
export class HelloTencentService {
@Inject()
ctx: Context;

@ServerlessTrigger(ServerlessTriggerType.API_GATEWAY, {
path: '/api_gateway_tencent',
method: 'post',
})
async handleAPIGatewayEvent(@Body() name) {
return `hello ${name}`;
}
}

npm run deploy 后即可通过控制台输出的链接访问。

本地开发

API 网关类型可以通过本地 npm run dev 和传统应用类似的开发方式进行本地开发,其他类型的触发器本地无法使用 dev 开发,只能通过运行 npm run test 进行测试执行。

本地测试

和传统应用 HTTP 测试相同,通过 createFunctionApp 创建函数 app,通过 createHttpRequest 方式进行测试。

import { Framework } from '@midwayjs/serverless-app';
import { createFunctionApp, createHttpRequest } from '@midwayjs/mock';

describe('test/hello_tencent.test.ts', () => {
let app: Application;
let instance: HelloTencentService;

beforeAll(async () => {
// create app
app = await createFunctionApp<Framework>();
});

afterAll(async () => {
await close(app);
});

it('should get result from http trigger', async () => {
const result = await createHttpRequest(app).post('api_gateway_tencent').send({
name: 'zhangting',
});

expect(result.text).toEqual('hello zhangting');
});
});

发布到腾讯云 SCF

在项目根目录的 f.ymlprovider 段落处确保为 tencent

service:
name: midway-faas-examples

provider:
name: tencent

配置运行时

service:
name: midway-faas-examples

provider:
name: tencent
runtime: nodejs12

配置函数超时

service:
name: midway-faas-examples

provider:
name: tencent
timeout: 60 # 单位秒

复用 HTTP 网关

腾讯云在每次部署 HTTP 类型时,都会创建一个新的网关绑定,对于开发时,我们可以复用同一个 id

service:
name: midway-faas-examples

provider:
name: tencent
serviceId: ********

具体写法可以参考 复用网关 id

执行 npm run deploy 即可,Deploy 命令会自动打包,并调用腾讯云官方部署工具发布。

视频流程如下:

屏幕录制 2021-03-25 下午 4.47.41.mov

常见问题

1、用户鉴权

腾讯云在部署时,如果是首次部署,则控制台会展示相应二维码,扫码即可完成认证,单项目后续会默认复用该配置。

鉴权文件保存在部署的根目录下的 .env 文件,如果要修改,可以删除该文件重新扫码。

也可以修改其中的内容,格式如下:

TENCENT_APP_ID=xxxxxx     #授权账号的 AppId
TENCENT_SECRET_ID=xxxxxx #授权账号的 SecretId
TENCENT_SECRET_KEY=xxxxxx #授权账号的 SecretKey
TENCENT_TOKEN=xxxxx #临时 token

如果需要使用子账号发布,请查询 子账号权限配置文档

2、发布区域切换

腾讯云配置支持发布到不同的区域。

service: fc-qinyue-test

provider:
name: tencent
runtime: nodejs10
region: ap-shanghai

常见的 region 值有:

  • ap-shanghai 上海
  • ap-guangzhou 广州
  • ap-beijing 北京
  • ap-hongkong 香港

完整的地区列表请查看 腾讯云文档

3、复用 API 网关

如果正式发布 HTTP 函数,每发布一次腾讯云都将自动创建一个标识网关的 serviceId,长期就会出现很多个,为了每次能复用,在第一次发布后,记录下 serviceId 让后面的代码复用,是比较好的习惯(或者提前申请好网关)。

service: fc-qinyue-test

provider:
name: tencent
runtime: nodejs10
serviceId: service-xxxxxx # <---- 把 id 填在这里复用

获取 API 网关 id

方式一,从平台获取。

方式二,在每次发布后获取。

4、绑定域名

腾讯云发布后会自动给一个网关地址来访问云函数,比如 http://service-xxxxx-xxxxxxxx.gz.apigw.tencentcs.com:80,同时针对环境,会自动映射三套环境名,加载 path 上。

  • 测试环境 /test
  • 预发 /prepub
  • 线上 /release

在函数的触发管理和 API 网关处都可以看到这个地址。

网关处。

如果我们想移除这个环境,那么就得绑定自定义域名。

在 API 网关的自定义域名处,点“新建”。

配置自定义路径映射,比如将 / 映射到正式的发布环境,这样在用域名访问的时候,就不会带有环境后缀了。

5、额外计费

使用本地工具时,由于使用了腾讯云提供的 SDK,可能会创建一个 COS Bucket 用于代码包的存储,由于 COS 是付费使用,会产生一定的费用费用。请及时关注自己的 COS 情况避免扣费。

6、删除腾讯云网关服务

在试玩一段时间的腾讯云服务之后,由于不是每次复用 API 网关,会导致出现很多非重用的网关示例,如下。

这个时候由于网关有绑定的函数,删除按钮是灰色的,我们需要手动将资源一一删除。

先进入一个 API 网关实例。

进入管理 API,删除底下的通用 API。

进入环境管理,将环境下线。

再回到最开始的列表,就可以点删除了。