腾讯云函数 SCF
本篇介绍如何使用 Malagu 框架部署到腾讯云函数 SCF 平台。
我们可以使用@malagu/scf-adapter和@malagu/scf-plugin组件把应用部署到腾讯云函数计算平台，其中@malagu/scf-adapter适配平台运行时接口，比如函数入口；@malagu/scf-plugin负责适配平台部署接口。基于约定大于配置原则，零配置，开箱即用。
云资源
适配器组件有一套默认的部署规则，该规则可以被覆盖。适配器组件在执行部署任务的时候，使用平台提供的 SDK，根据部署规则，创建需要的云资源。如果发现云资源已经存在，则差异更新云资源。**适配器组件总是以尽可能安全的方式，创建或更新我们的云资源。比如，当我们配置了自定义域名，适配器组件则尝试创建或更新该自定义域名资源。
适配器组件将应用部署到一个函数中，也就是说一个应用对应着一个函数，如果我们的应用很大，我们应该将大应用拆解成一个个小的微应用或者微服务。就像微服务架构的粒度拆分原则一样，合理的粒度拆分，对我们的应用管理是有很多好处的。框架会保证一个应用在一个函数中运行的性能。
环境隔离
在 Malagu 框架中，提供了一个顶级配置属性stage表示环境。而在@malagu/scf-plugin组件约定的部署规则中，使用mode属性映射stage属性。默认提供了三套环境：测试、预发和生产。表达式规则如下：
stage: "${'test' in mode ? 'test' : 'pre' in mode ? 'pre' : 'prod' in mode ? 'prod' : cliContext.prod ? 'prod' : 'test'}" # test, pre, prod
stage 取值规则如下：
test测试环境。当mode属性包含 test 模式，或者mode都不包含 test、pre、prod，且命令行参数-p,--prod没有被指定pre预发环境。当mode属性包含 pre 模式prod生产环境。当mode属性包含 prod 模式，或者命令行参数-p,--prod被指定
通过指定特殊的 mode 表示不同的部署环境：
# 部署到测试环境
malagu deploy -m test # 或者 malagu deploy
# 部署到预发环境，我们也可以直接跳过预发环境的部署，直接部署到生产环境
malagu deploy -m pre
# 部署到生成环境
malagu deploy -m prod
隔离级别
环境的隔离级别是可控制的。 我们可以使用账号隔离环境：不同环境对于不同配置文件，不同配置文件分别配置不同的云账号。同理，我们也可以使用 Region、服务别名来隔离环境。框架默认提供的是服务别名隔离环境。隔离方式可以互相叠加。
stage 属性值与服务别名关联（以下是默认规则，无需配置）：
malagu:
cloud:
alias:
name: ${stage}
部署模式
适配器组件通过 mode 属性定义部署模式，支持的部署模式如下：
http:基于 API 网关 + Web 函数的部署模式。部署过程中，创建或更新 API 网关、命名空间、函数等云资源timer:基于定时触发器 + 事件函数的部署模式。部署过程中，创建或更新定时触发器、命名空间、函数等云资源api-gateway:基于 API 网关 + 事件函数的部署模式。部署过程中，创建或更新 API 网关、命名空间、函数等云资源api-gateway-basic：基于默认 API 网关 + 事件函数的部署模式。部署过程中，创建或更新 默认 API 网关等云资源, 本模式下, API 网关调用次数不计费。
mode:
- http
自定义部署规则
我们可以通过同名覆盖自定义部署规则。
默认规则
默认规则定义在 @malagu/scf-plugiin 组件的 malagu-*.yml 配置文件中。
自定义部署模式
mode:
- http # 默认值是 http，目前支持 http、timer、api-gateway、api-gateway-basic
自定义命名空间
malagu:
cloud:
namespace:
name: xxxx # 默认值是 default
命名空间的其他属性也是类似的方式配置。
自定义函数名
malagu:
cloud:
function:
name: xxxx # 默认值是 ${pkg.name}
函数的其他属性也是类似的方式配置。
自定义域名
malagu:
cloud:
customDomain:
name: xxx # 待绑定的自定义的域名
certificateId: lX***HT # 域名SSL证书唯一 ID,protocol设置成为http时无需配置
protocol: https # 服务支持协议，可选值为http、https、http&https
netType: OUTER # 网络类型，可选值为OUTER、INNER
isDefaultMapping: false # 是否使用默认路径映射，默认为 true。为 false 时，表示自定义路径映射，此时 pathMappingSet 必填
pathMappingSet: # 最多输入三个Environment，并且只能分别取值“test”、 ”prepub“、”release“
- path: /
environment: release
属性配置
malagu:
cloud:
namespace:
name:
description:
function:
name: ""
namespace:
handler:
publish:
l5Enable:
type:
codeSource:
description:
memorySize:
timeout:
runtime:
role:
clsLogsetId:
ClsTopicId:
env:
vpcConfig:
vpcId:
subnetId:
layers:
name:
version:
deadLetterConfig:
type:
name:
filterType:
publicNetConfig:
PublicNetStatus:
eipConfig:
eipStatus:
alias:
name:
functionName:
namespace:
description:
routingConfig:
additionalVersionWeights:
version:
weight:
addtionVersionMatchs:
version:
key:
method:
expression:
apiGateway:
usagePlan:
name:
environment:
desc:
maxRequestNum:
maxRequestNumPreSec:
strategy:
name:
environmentName:
strategy:
api:
name:
serviceTimeout:
protocol:
desc:
authType:
enableCORS:
businessType:
serviceScfFunctionName:
serviceWebsocketTransportFunctionName:
serviceScfFunctionNamespace:
serviceScfFunctionQualifier:
serviceWebsocketTransportFunctionNamespace:
serviceWebsocketTransportFunctionQualifier:
isDebugAfterCharge:
serviceScfIsIntegratedResponse:
isDeleteResponseErrorCodes:
responseSuccessExample:
responseFailExample:
authRelationApiId:
userType:
oauthConfig:
publicKey:
tokenLocation:
loginRedirectUrl:
responseErrorCodes:
code:
msg:
desc:
convertedCode:
needConvert:
requestConfig:
ApiRequestConfig:
path:
method:
requestParameters:
name:
desc:
position:
type:
defaultValue:
required:
RequestParameter:
service:
exclusiveSetName:
name:
protocol:
description:
netTypes:
ipVersion:
setServerName:
appIdType:
release:
environmentName:
desc:
customDomain:
name:
isDefaultMapping:
certificateId:
protocol:
netType:
pathMappingSet:
path:
Environment: