前言
目标
本文打算以一个简单的 Serverless 函数计算项目为例,尝试使用 typescript + nodejs 进行开发,搭建一个简单的工程项目,实现如下小目标:
-
使用 typescript 编写业务代码
-
可以通过 Serverless VSCode 插件本地调试 typescript 代码
-
通过插件将项目代码部署到云端
项目示例图
实践
1. 前期准备 (可选)
前期准备的目的是为了方便开发和调试,目前阿里云 Function Compute 提供了命令行工具 Funcraft 以及图形化 VSCode 插件。安装 Docker 是为了在本地模拟线上环境进行调试,如果想快速浏览下 nodejs + typescript 工程项目的搭建,可以跳过。
2. 环境搭建
{ "compilerOptions": { "target": "es5", "module": "commonjs", "noImplicitAny": true, "outDir": "./dist/", "sourceMap": true }, "include": [ "./src" ] }
{ "name": "fc-ts", "version": "1.0.0", "description": "Function Compute + Typescript", "main": "index.js", "scripts": { "compile": "tsc -p ./" } }
export const handler = ( event: any, context: any, callback: (err: any, data: any) => void, ) => { console.log(new String(event)); callback(null, 'hello world'); }
至此,我们搭建了一个常规的 typescript 项目,有
tsconfig.json、
package.json、
src 源码目录、
dist 结果目录。其中,
src/index.ts 文件中定义了一个 handler 方法,该方法符合函数计算中函数入口方法的定义。
3. 结合函数计算
-
在项目根目录新建
index.js 文件,文件内容如下:
const { handler } = require('./dist/index'); module.exports.handler = (event, context, callback) => { handler(event, context, callback); }
这里又定义了一个 handler 方法,该方法中调用了编译后 js 文件中的 handler 方法。
-
在项目根目录新建
template.yml 文件,文件内容如下:
ROSTemplateFormatVersion: '2015-09-01' Transform: 'Aliyun::Serverless-2018-04-03' Resources: demo: # service name Type: 'Aliyun::Serverless::Service' Properties: Description: This is FC service func01: # function name Type: 'Aliyun::Serverless::Function' Properties: Handler: index.handler Runtime: nodejs8 CodeUri: ./ MemorySize: 1024 Timeout: 15
该文件中对我们的资源(即函数计算中的服务以及函数)进行了定义,具体内容可以参考:
Fun 规范文档。
如果安装了 Serverless VSCode 插件,那么可以尝试下插件的智能提示,效果如图:
至此,我们就成功的将 typescript 项目结合到了函数计算中。我们的做法是:将 typescript 源码文件放置在 src 目录,将编译后的 js 文件放置在 dist 目录,最后在项目根目录中编写了 index.js 文件,文件中的 handler 处理函数调用了编译后 index 文件的入口函数。
4. 本地调试与部署
-
本地调试
-
在
index.js 以及
src/index.ts 文件中插入一些断点。
-
点击 VSCode 左侧栏目中的函数计算图标,展开本地资源树
-
点击函数名右侧的调试按钮,即可调试 ts 源代码。
-
部署函数
-
点击 VSCode 左侧栏目中的函数计算图标
-
右键本地资源树中的函数名,点击部署按钮
-
远端调用函数
-
点击远端资源树中函数名右侧的调用按钮
总结
目前阿里云 Function Compute 没有原生支持 Typescript,但是通过本文的方式可以做到在本地开发调试时使用 Typescript。接下来总结下这种实践方法的优点和不足:
-
使用 Typescript 进行开发
-
支持本地调试 Typescript 代码
-
项目部署到云端后,可以在云端查看 Typescript 源码
-
本地调试时需要在项目根目录的 index.js 文件中插入一个断点。
-
更新代码后,在调试以及部署前需要手工进行一次 Typescript 代码到 js 代码的编译。
本文中介绍的实践方式只是一种思路,欢迎大家提供其他的思路。
来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/69947441/viewspace-2668518/
,如需转载,请注明出处,否则将追究法律责任。