文档首页/ 函数工作流 FunctionGraph/ 开发指南/ 开发工具/ Serverless Framework/ 使用指南/ 服务
更新时间：2023-11-22 GMT+08:00
查看PDF
分享

服务

service就像一个项目，您可以在服务中定义华为云函数工作流的函数和触发它们的events，所有这些都在一个名为serverless.yml的文件中。

若您要构建第一个Serverless Framework项目，请先创建一个service。

组织

在最初使用应用时，建议您可以使用单个服务来定义该项目的所有函数和事件。 
myService/
  serverless.yml  # Contains all functions and infrastructure resources
但是，随着应用增多，您可以将其拆分为多个服务。大多数用户按工作流或数据模型组织他们的服务，并在服务中将与这些工作流和数据模型相关的函数进行分组。 
users/
  serverless.yml # Contains 4 functions that do Users CRUD operations and the Users database
posts/
  serverless.yml # Contains 4 functions that do Posts CRUD operations and the Posts database
comments/
  serverless.yml # Contains 4 functions that do Comments CRUD operations and the Comments database

这是有意义的，因为相关函数通常使用公共基础设施资源，并且用户希望将这些函数和资源作为单个部署单元放在一起，以便更好地组织和分离关注点。

创建

使用create命令创建服务。您可以输入路径创建目录并将服务自动命名： 
# Create service with Node.js template in the folder ./my-service
serverless create --template-url https://github.com/zy-linn/examples/tree/v3/legacy/huawei-nodejs --path my-service

huawei-nodejs是华为云函数工作流的可用运行时。

有关所有详细信息和选项，请查看创建。

目录

您将在工作目录中看到以下文件：

  • serverless.yml
  • src/index.js

serverless.yml

每个service配置都在serverless.yml文件中管理。本文件的主要用途是：

  • 声明Serverless服务。
  • 在服务中定义一个或多个函数：
    • 定义服务将被部署到的提供商（如果有运行时，也要定义）。
    • 定义要使用的任何自定义插件。
    • 定义触发每个函数执行的事件（如HTTP请求）。
    • 允许“events”部分中列出的事件在部署时自动创建事件所需的资源。
    • 允许使用Serverless变量进行灵活配置。
您可以看到服务名称、提供商配置，以及functions定义中的第一个函数。任何后续的服务配置都将在此文件中完成。 
# serverless.yml
service: my-fc-service

provider:
  name: huawei
  runtime: Node.js14.18
  credentials: ~/.fg/credentials # path must be absolute

plugins:
  - serverless-huawei-functions

functions:
  hello_world:
    handler: index.handler

index.js

index.js文件包含您导出的函数。

部署

部署服务时，serverless.yml中的所有函数和事件都会转换为对华为云API的调用，用于动态定义这些资源。

使用deploy命令部署服务：

serverless deploy

查看部署指南，了解有关部署的更多信息及其工作原理。有关所有详细信息和选项，请查看deploy命令文档。

移除

为了方便地在华为云上移除您的服务，可以使用remove命令。

运行serverless remove触发移除进程。

Serverless开始移除时，会在控制台中通知您进程。移除整个服务后，打印成功消息。

移除过程将仅移除提供商基础设施上的服务。服务目录仍将保留在本地计算机上，因此您仍可以在稍后修改并（重新）将其部署到另一个环境、区域或提供商。

版本固定

Serverless Framework通常通过npm install -g serverless全局安装。因此，您的所有服务都可以使用Serverless CLI。

全局安装工具的缺点是无法将版本固定在package.json内部。如果升级Serverless，但您的同事或CI系统不升级，这可能会导致问题。您可以在serverless.yml中使用某个特性，而不必担心CI系统会使用旧版本的Serverless进行部署。

  • 固定版本

    要配置版本固定，请在serverless.yml中定义frameworkVersion属性。每当您从CLI运行Serverless命令时，它都会检查当前Serverless版本是否匹配frameworkVersion的范围。CLI使用语义化版本，因此您可以将其固定为明确的版本或提供版本范围。一般来说，建议固定到明确的版本，以确保团队中的每个人都有完全相同的设置，并且不会发生意想不到的问题。

    示例

    明确的版本。

    # serverless.yml

frameworkVersion: '2.1.0'
    版本范围。 
    # serverless.yml

frameworkVersion: ^2.1.0 # >=2.1.0 && <3.0.0

在现有服务中安装Serverless

如果您已经有Serverless服务，并且更愿意使用package.json锁定框架版本，那么您可以按以下方式安装Serverless：

# from within a service
npm install serverless --save-dev
  • 本地调用Serverless
    要执行本地安装的Serverless，您必须引用node_ modules目录中的二进制文件，示例如下： 
    node ./node_modules/serverless/bin/serverless deploy
父主题： 使用指南