开发函数计算的正确姿势 —— Fun validate 语法校验排错指南

本文涉及的产品
Serverless 应用引擎免费试用套餐包,4320000 CU,有效期3个月
函数计算FC,每月15万CU 3个月
简介: 1. 前言 首先介绍下在本文出现的几个比较重要的概念: 函数计算(Function Compute): 函数计算是一个事件驱动的服务,通过函数计算,用户无需管理服务器等运行情况,只需编写代码并上传。

1. 前言

首先介绍下在本文出现的几个比较重要的概念:

函数计算(Function Compute): 函数计算是一个事件驱动的服务,通过函数计算,用户无需管理服务器等运行情况,只需编写代码并上传。函数计算准备计算资源,并以弹性伸缩的方式运行用户代码,而用户只需根据实际代码运行所消耗的资源进行付费。函数计算更多信息 参考

Fun: Fun 是一个用于支持 Serverless 应用部署的工具,能帮助您便捷地管理函数计算、API 网关、日志服务等资源。它通过一个资源配置文件(template.yml),协助您进行开发、构建、部署操作。Fun 的更多文档 参考

template.yml: template.yml 用于定义 serverless 应用的模型。无论是使用 fun local 还是 fun deploy 等功能,都是通过解析 tempalte.yml 的内容,构建出用户定义的云资源模型,进而实现本地云资源的运行调试以及发布等功能。template.yml 支持的规范文档可以参考

template.yml 所描述的 Serverless 模型,是 Fun 所有功能的基石。template.yml 的正确性对后续能够顺利使用 Fun 的各项功能无疑是非常关键的。为了帮助用户更快速的修正 template.yml 中错误的描述,我们在 Fun 2.14.0 优化了语法校验的错误信息,可以达到更精准定位报错并修复的目的。

下面我们就通过一个示例,学习如何根据报错信息纠正 template.yml 中的错误语法描述。

备注:请确保 Fun 工具版本在 2.14.0+

2. 错误的 template.yml 示例


ROSTemplateFormatVersion: '2015-09-01'
Transform: 'Aliyun::Serverless-2018-04-03'
Resources:
  local-http-demo:
    Type: 'Aliyun::Serverless::InvalidService'
    Properties:
      Description: 'local invoke demo'
    nodejs8:
      Type: 'Aliyun::Serverless::InvalidFunction'
      Properties:
        Handler: index.handler
        CodeUri: nodejs8/
        Description: 'http trigger demo with nodejs8!'
      Events:
        http-test:
          Type: HTTP
          Properties:
            AuthType: ANONYMOUS
            Method: ['GET', 'POST', 'PUT']

在上面的示例中,我们原意是想要描述一个叫做 local-http-demo 的服务,并在服务下定义了一个名为 nodejs8 的函数,同时为该函数配置一个匿名的 HTTP 触发器,支持 GET、POST、PUT 的 HTTP 请求。

但遗憾的是,上面的示例描述有几处比较隐蔽的问题。下面,我们就动手实践,看如何发现上面示例中包含的错误语法描述并将其修正。

3. 语法错误发现并修复

3.1 修复第一个错误

我们可以执行 fun validate 对 tempalte.yml 进行校验(其他的命令比如 deploy、local 等也会隐式的执行 fun validate,保证在语法描述正确的情况下才执行指定的功能)。

当执行完 fun validate 后,会看到错误信息:

[
  {
    "keyword": "enum",
    "dataPath": "/Resources/local-http-demo/Type",
    "params": {
      "allowedValues": [
        "Aliyun::Serverless::Service",
        "Aliyun::Serverless::TableStore",
        "Aliyun::Serverless::Api",
        "Aliyun::Serverless::Log",
        "Aliyun::Serverless::CustomDomain",
        "Aliyun::Serverless::MNSTopic"
      ]
    },
    "message": "should be equal to one of the allowed values"
  }
]

错误信息会以 json 的格式输出,其中的 message 就是我们的本次的错误原因,dataPath 是遇到的错误在 template.yml 中的具体位置,params 中的内容是对 message 的进一步的补充。

按照我们刚才的解释,大概就可以明白,/Resources/local-http-demo/Type 这个资源定义出了问题,原因是这个值应该是 Aliyun::Serverless::ServiceAliyun::Serverless::TableStoreAliyun::Serverless::ApiAliyun::Serverless::LogAliyun::Serverless::CustomDomainAliyun::Serverless::MNSTopic 中的一个。

再看下我们的描述(限于篇幅只列出了 template.yml 的部分内容):

Resources:
  local-http-demo:
    Type: 'Aliyun::Serverless::InvalidService'

很明显,我们描述的 Aliyun::Serverless::InvalidService 并不在上面允许的值中。

我们将其修改正确,也就是把 Aliyun::Serverless::InvalidService 修改为 Aliyun::Serverless::Service 即可。

Resources:
  local-http-demo:
-    Type: 'Aliyun::Serverless::InvalidService'
+    Type: 'Aliyun::Serverless::Service'

3.2 重新进行语法校验并修复

通常情况下,我们建议的方式是修复完一个问题,就重新使用 fun validate 进行校验。

我们将上面问题修复后,重新执行 fun validate 后,可以发现,依旧有报错:

[
  {
    "keyword": "const",
    "dataPath": "/Resources/local-http-demo/nodejs8/Type",
    "params": {
      "allowedValue": "Aliyun::Serverless::Function"
    },
    "message": "should be equal to constant"
  },
  {
    "keyword": "required",
    "dataPath": "/Resources/local-http-demo/nodejs8/Properties",
    "params": {
      "missingProperty": "Runtime"
    },
    "message": "should have required property 'Runtime'"
  },
  {
    "keyword": "additionalProperties",
    "dataPath": "/Resources/local-http-demo/nodejs8/Events/http-test/Properties",
    "params": {
      "additionalProperty": "Method"
    },
    "message": "should NOT have additional properties"
  },
  {
    "keyword": "required",
    "dataPath": "/Resources/local-http-demo/nodejs8/Events/http-test/Properties",
    "params": {
      "missingProperty": "Methods"
    },
    "message": "should have required property 'Methods'"
  }
]

这一次与上一次不同,同时出现了 4 个报错。但具体的修复步骤与上一步是一致的,即先找到第一个问题进行修复就可以了。

第一个报错如下:

{
  "keyword": "const",
  "dataPath": "/Resources/local-http-demo/nodejs8/Type",
  "params": {
    "allowedValue": "Aliyun::Serverless::Function"
  },
  "message": "should be equal to constant"
}

这个和我们刚才修过的问题是一样的,意思就是 /Resources/local-http-demo/nodejs8/Type 的定义不对,这个值只被允许设定为 Aliyun::Serverless::Function

我们按照提示的将其修正(限于篇幅只列出了 template.yml 的部分内容):

Resources:
  local-http-demo:
    nodejs8:
-      Type: 'Aliyun::Serverless::InvalidFunction'
+      Type: 'Aliyun::Serverless::Function'

这时候,我们可以重新执行下 fun validate,然后再挑选第一个进行修复,我们这里限于篇幅,就继续挑选下一个报错进行修复了。

{
  "keyword": "required", 
  "dataPath": "/Resources/local-http-demo/nodejs8/Properties",
  "params": {
    "missingProperty": "Runtime"
  },
  "message": "should have required property 'Runtime'"
}

这里 message 的含义是,缺少了必要的属性 Runtime,检查下我们的规范文档对 Function 资源的描述,可以发现,Runtime 确实是必选的。

我们按照提示的将其修正(限于篇幅只列出了 template.yml 的部分内容):

Resources:
  local-http-demo:
    Type: 'Aliyun::Serverless::Service'
    nodejs8:
      Type: 'Aliyun::Serverless::Function'
      Properties:
+            Runtime: nodejs8

最后的两个错误,我们可以一起看:

{
  "keyword": "additionalProperties",
  "dataPath": "/Resources/local-http-demo/nodejs8/Events/http-test/Properties",
  "params": {
    "additionalProperty": "Method"
  },
  "message": "should NOT have additional properties"
},
{
  "keyword": "required",
  "dataPath": "/Resources/local-http-demo/nodejs8/Events/http-test/Properties",
  "params": {
    "missingProperty": "Methods"
  },
  "message": "should have required property 'Methods'"
}

这两个的错误含义是,我们在 /Resources/local-http-demo/nodejs8/Events/http-test/Properties 这个路径下,定义了一个不被允许的属性 Method,并且同样是在这个路径下,缺少了一个必选的属性 Methods。结合这两个报错,我们就可以判断出,我们将 Methods 错写成了 Method。

我们按照提示的将其修正(限于篇幅只列出了 template.yml 的部分内容):

Resources:
  local-http-demo:
    nodejs8:
      Events:
        http-test:
          Properties:
            AuthType: ANONYMOUS
-           Method: ['GET', 'POST', 'PUT']
+           Methods: ['GET', 'POST', 'PUT']

当将所有的错误修复完成后,我们再重新执行 fun validate,即可发现,我们的所有错误都被修正啦。

接下来,我们就使用这个 template.yml 完成后续的 fun local、fun deploy 等功能就可以了。

3.3 修改记录汇总

我们将上面所有的改错记录记录如下:

ROSTemplateFormatVersion: '2015-09-01'
Transform: 'Aliyun::Serverless-2018-04-03'
Resources:
  local-http-demo:
-   Type: 'Aliyun::Serverless::InvalidService'
+   Type: 'Aliyun::Serverless::Service'
    Properties:
      Description: 'local invoke demo'
    nodejs8:
-     Type: 'Aliyun::Serverless::InvalidFunction'
+     Type: 'Aliyun::Serverless::Function'
      Properties:
        Handler: index.handler
        CodeUri: nodejs8/
        Description: 'http trigger demo with nodejs8!'
+       Runtime: nodejs8
      Events:
        http-test:
          Type: HTTP
          Properties:
            AuthType: ANONYMOUS
-           Method: ['GET', 'POST', 'PUT']
+           Methods: ['GET', 'POST', 'PUT']

4. 总结

虽然 Fun 的规范文档描述的比较详细了,而且在 Fun 的 repo 首页,我们给出了非常多的示例文章,但依旧存在很大可能性会遇到各种各样的类似上面示例的书写错误。

因此,Fun 提供了比较强大的语法校验功能,并通过精准的报错信息,让用户可以方便的将其修正。

相关实践学习
【文生图】一键部署Stable Diffusion基于函数计算
本实验教你如何在函数计算FC上从零开始部署Stable Diffusion来进行AI绘画创作,开启AIGC盲盒。函数计算提供一定的免费额度供用户使用。本实验答疑钉钉群:29290019867
建立 Serverless 思维
本课程包括: Serverless 应用引擎的概念, 为开发者带来的实际价值, 以及让您了解常见的 Serverless 架构模式
目录
相关文章
|
29天前
|
监控 Serverless 云计算
探索Serverless架构:开发实践与优化策略
本文深入探讨了Serverless架构的核心概念、开发实践及优化策略。Serverless让开发者无需管理服务器即可运行代码,具有成本效益、高可扩展性和提升开发效率等优势。文章还详细介绍了函数设计、安全性、监控及性能和成本优化的最佳实践。
|
1月前
|
监控 安全 Serverless
"揭秘D2终端大会热点技术:Serverless架构最佳实践全解析,让你的开发效率翻倍,迈向技术新高峰!"
【10月更文挑战第23天】D2终端大会汇聚了众多前沿技术,其中Serverless架构备受瞩目。它让开发者无需关注服务器管理,专注于业务逻辑,提高开发效率。本文介绍了选择合适平台、设计合理函数架构、优化性能及安全监控的最佳实践,助力开发者充分挖掘Serverless潜力,推动技术发展。
80 1
|
2月前
|
监控 Serverless 云计算
探索Serverless架构:开发的未来趋势
【10月更文挑战第5天】Serverless架构,即无服务器架构,正逐渐成为云计算领域的热点。它允许开发者构建和运行应用程序而无需管理底层服务器。本文介绍了Serverless架构的基本概念、核心优势及挑战,并展示了其在事件驱动编程、微服务架构和数据流处理等场景中的应用。通过优化冷启动、使用外部存储等实战技巧,开发者可以更好地利用Serverless架构提升开发效率和应用性能。随着技术的成熟,Serverless将在未来软件开发中扮演重要角色。
|
4月前
|
前端开发 大数据 数据库
🔥大数据洪流下的决战:JSF 表格组件如何做到毫秒级响应?揭秘背后的性能魔法!💪
【8月更文挑战第31天】在 Web 应用中,表格组件常用于展示和操作数据,但在大数据量下性能会成瓶颈。本文介绍在 JavaServer Faces(JSF)中优化表格组件的方法,包括数据处理、分页及懒加载等技术。通过后端分页或懒加载按需加载数据,减少不必要的数据加载和优化数据库查询,并利用缓存机制减少数据库访问次数,从而提高表格组件的响应速度和整体性能。掌握这些最佳实践对开发高性能 JSF 应用至关重要。
78 0
|
4月前
|
存储 设计模式 运维
Angular遇上Azure Functions:探索无服务器架构下的开发实践——从在线投票系统案例深入分析前端与后端的协同工作
【8月更文挑战第31天】在现代软件开发中,无服务器架构因可扩展性和成本效益而备受青睐。本文通过构建一个在线投票应用,介绍如何结合Angular前端框架与Azure Functions后端服务,快速搭建高效、可扩展的应用系统。Angular提供响应式编程和组件化能力,适合构建动态用户界面;Azure Functions则简化了后端逻辑处理与数据存储。通过具体示例代码,详细展示了从设置Azure Functions到整合Angular前端的全过程,帮助开发者轻松上手无服务器应用开发。
38 0
|
4月前
|
监控 Serverless Go
Golang 开发函数计算问题之Go 语言中切片扩容时需要拷贝原数组中的数据如何解决
Golang 开发函数计算问题之Go 语言中切片扩容时需要拷贝原数组中的数据如何解决
|
4月前
|
Java Serverless Go
Golang 开发函数计算问题之在 Golang 中避免 "concurrent map writes" 异常如何解决
Golang 开发函数计算问题之在 Golang 中避免 "concurrent map writes" 异常如何解决
|
3月前
|
人工智能 自然语言处理 Serverless
阿里云函数计算 x NVIDIA 加速企业 AI 应用落地
阿里云函数计算与 NVIDIA TensorRT/TensorRT-LLM 展开合作,通过结合阿里云的无缝计算体验和 NVIDIA 的高性能推理库,开发者能够以更低的成本、更高的效率完成复杂的 AI 任务,加速技术落地和应用创新。
179 13
|
8天前
|
人工智能 Serverless API
尽享红利,Serverless构建企业AI应用方案与实践
本次课程由阿里云云原生架构师计缘分享,主题为“尽享红利,Serverless构建企业AI应用方案与实践”。课程分为四个部分:1) Serverless技术价值,介绍其发展趋势及优势;2) Serverless函数计算与AI的结合,探讨两者融合的应用场景;3) Serverless函数计算AIGC应用方案,展示具体的技术实现和客户案例;4) 业务初期如何降低使用门槛,提供新用户权益和免费资源。通过这些内容,帮助企业和开发者快速构建高效、低成本的AI应用。
50 12
|
4月前
|
Serverless API 异构计算
函数计算产品使用问题之修改SD模版应用的运行环境
函数计算产品作为一种事件驱动的全托管计算服务,让用户能够专注于业务逻辑的编写,而无需关心底层服务器的管理与运维。你可以有效地利用函数计算产品来支撑各类应用场景,从简单的数据处理到复杂的业务逻辑,实现快速、高效、低成本的云上部署与运维。以下是一些关于使用函数计算产品的合集和要点,帮助你更好地理解和应用这一服务。

相关产品

  • 函数计算