Serverless 实战 —— 移植 spring-petclinic 到函数计算

2022-03-02 01:29:19

前言

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

函数计算（Function Compute）：函数计算是一个事件驱动的服务，通过函数计算，用户无需管理服务器等运行情况，只需编写代码并上传。函数计算准备计算资源，并以弹性伸缩的方式运行用户代码，而用户只需根据实际代码运行所消耗的资源进行付费。函数计算更多信息参考。
Funcraft：Funcraft 是一个用于支持 Serverless 应用部署的工具，能帮助您便捷地管理函数计算、API 网关、日志服务等资源。它通过一个资源配置文件（template.yml），协助您进行开发、构建、部署操作。Fun 的更多文档参考。
spring-petclinic：Petclinic 是一个 Spring Boot 、Spring MVC 和 Spring Data 结合使用的示例项目，是学习 Spring Boot 经典案例。

备注: 本文介绍的技巧需要 Funcraft 版本大于等于 3.1.0 。

环境准备

该教程依赖如下工具：

Funcraft
Git
Maven

Funcraft 的安装文档里介绍的方法将 Funcraft 安装到本机。安装完成后，可以执行 fun --version 检查 Fun 是否安装成功。

初始化项目

首先在本地运行 Petclinic 项目，Petclinic 是一个使用 Maven 构建的 Spring Boot 应用。您可以使用命令行构建出 Jar 文件并在本地运行。

git clone https://github.com/spring-projects/spring-petclinic.git
cd spring-petclinic
./mvnw package
java -jar target/*.jar

然后您可以访问本地地址：http://localhost:8080/

移植到函数计算

本示例中，我们打算使用函数计算的 Custom Runtime 来移植 Petclinic 项目。顾名思义， Custom Runtime 就是自定义的执行环境，用户基于 Custom Runtime 可以完成以下目标：

可以随心所欲持定制个性化语言执行环境（例如 Golang、Lua、Ruby）以及各种语言的小版本（例如Python3.7、Nodejs12 )等，打造属于自己的自定义 Runtime
现有的 Web 应用或基于传统开发 Web 项目基本不用做任何改造，即可将项目一键迁移到函数计算平台

在阅读 Custom Runtime 的技术文档后，我们要将 Petclinic 移植到函数计算，需要解决如下两个问题：

通过创建函数并启动服务
将 Petclinic 启动在 9000 端口

于是在 spring-petclinic 项目根目录新增如下三个文件：

template.yml 用于声明函数和 HTTP Trigger
bootstrap 用于启动服务
.funignore 用于忽略运行时无关的文件，减小部署文件的尺寸。

template.yml

template.yml 文件内容如下：

ROSTemplateFormatVersion: '2015-09-01'
Transform: 'Aliyun::Serverless-2018-04-03'
Resources:
  springboot: # service name
    Type: 'Aliyun::Serverless::Service'
    Properties:
      Description: This is a FC service for springboot
    petclinic: # function name
      Type: 'Aliyun::Serverless::Function'
      Properties:
        Handler: com.example.demo.DemoApplication::main
        Runtime: custom
        CodeUri: ./
        MemorySize: 1024
        Timeout: 15
      Events:
        httpTrigger:
          Type: HTTP
          Properties:
            AuthType: ANONYMOUS
            Methods: ['HEAD', 'GET', 'POST', 'PUT', 'DELETE']
  petclinic.codelife.me: # domain name
    Type: 'Aliyun::Serverless::CustomDomain'
    Properties:
      Protocol: HTTP
      RouteConfig:
        routes:
          '/*':
            ServiceName: springboot
            FunctionName: petclinic

其中 Runtime 指定为 custom。Handler 对于 custom 类型的运行时是多余的，任意写一个符合语法的就 OK 了。这里还注册了一个 HTTP 类型的触发器，开启了匿名验证，支持 5 种常见的 HTTP 方法。

bootstrap

bootstrap 文件是 custom 运行时约定的引导文件可以是二进制也可以是脚本，打包上传的时要保证该文件具备可执行权限。bootstrap 文件内容如下：

#!/usr/bin/env bash
java  -Dserver.port=9000 \
        -jar target/spring-petclinic-2.1.0.BUILD-SNAPSHOT.jar

其中

-Dserver.port=9000 将 Spring Boot 的启动端口改为 9000
-jar target/spring-petclinic-2.1.0.BUILD-SNAPSHOT.jar 指定要启动的 jar 包，这个 jar 是 spring-petclinic 项目通过 maven 构建的结果文件。

.funignore

.funignore 文件的作用是 fun deploy 的时候会忽略掉运行时不相关的文件（比如构建时依赖，某些编译过程产物，源码文件等）以减少打包文件的体积。

.idea/
.mvn/
.vscode/
push-to-pws/
src/
*.yml
mvnw*
*.xml
*.md
target/*
!target/*.jar

本地预览

$ fun local start petclinic.codelife.me
using template: template.yml
CustomDomain petclinic.codelife.me of springboot/petclinic was registered
        url: http://localhost:8000/*
        methods: [ 'HEAD', 'GET', 'POST', 'PUT', 'DELETE' ]
        authType: ANONYMOUS

function compute app listening on port 8000!

这里 fun local start + domain_name，会在本地端口启动该 domain 的路径映射关系，免去直接调试函数时长长的 contextPath ( /2016-08-15/proxy/springboot/petclinic/ ) ,注意该功能依赖 3.1.0 以上版本的 funcraft。

然后浏览器打开 http://localhost:8000/ 即可本地预览 petclinic 应用。

打包并部署

$ mvn package -Dmaven.test.skip=true && fun deploy

....
[INFO] Replacing main artifact with repackaged archive
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  30.612 s
[INFO] Finished at: 2019-11-01T11:23:40+08:00
[INFO] ------------------------------------------------------------------------
using template: template.yml
using region: cn-hongkong
using accountId: ***********4733
using accessKeyId: ***********EUz3
using timeout: 600

Waiting for service springboot to be deployed...
        Waiting for function petclinic to be deployed...
                Waiting for packaging function petclinic code...
                The function petclinic has been packaged. A total of 12 files files were compressed and the final size was 39.91 MB
                Waiting for HTTP trigger httpTrigger to be deployed...
                triggerName: httpTrigger
                methods: HEAD,GET,POST,PUT,DELETE
                url: https://1751705494334733.cn-hongkong.fc.aliyuncs.com/2016-08-15/proxy/springboot/petclinic/
                function httpTrigger deploy success
        function petclinic deploy success
service springboot deploy success

Waiting for custom domain petclinic.codelife.me to be deployed...
custom domain petclinic.codelife.me deploy success

这里选择了 cn-hongkong region，这是因为要想正常的显示 http 服务，需要绑定域名，否则 html 文件会默认下载而不是显示。而海外的 region 可以免去域名备份的繁琐事宜。

其中域名 petclinic.codelife.me 请换成您自己的，并将 DNS 的 cname 记录指向 <accountID>.<region>.fc.aliyuncs.com

浏览器打开 http://petclinic.codelife.me

FAQ

如何使用 MySQL 数据库

spring-petclinic 默认使用的是内存数据 hsqldb，而函数之间内存不共享，所以在多次请求可能出现访问到不同的函数实例，出现数据不一致的情况。对于真实的系统可以通过给函数配置 VPC，然后创建一个阿里云的 RDS 服务，所有的函数都访问同一个 RDS 服务。

码农公寓

前言