{"id":18248165,"url":"https://github.com/serverless-components/tencent-springboot","last_synced_at":"2025-04-04T15:32:13.428Z","repository":{"id":50154470,"uuid":"323836872","full_name":"serverless-components/tencent-springboot","owner":"serverless-components","description":"Tencent Cloud Java Spring Boot Serverless Component","archived":false,"fork":false,"pushed_at":"2021-06-03T02:31:06.000Z","size":18069,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-20T15:01:38.278Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serverless-components.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-23T07:44:35.000Z","updated_at":"2022-09-09T22:53:37.000Z","dependencies_parsed_at":"2022-09-13T00:32:17.445Z","dependency_job_id":null,"html_url":"https://github.com/serverless-components/tencent-springboot","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless-components%2Ftencent-springboot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless-components%2Ftencent-springboot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless-components%2Ftencent-springboot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serverless-components%2Ftencent-springboot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serverless-components","download_url":"https://codeload.github.com/serverless-components/tencent-springboot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247203030,"owners_count":20900899,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T09:36:07.071Z","updated_at":"2025-04-04T15:32:08.420Z","avatar_url":"https://github.com/serverless-components.png","language":"JavaScript","readme":"[![Serverless Components](https://main.qcloudimg.com/raw/ee412a92d931554cea5f626838c5170f.png)](http://serverless.com)\n\n\u003c/br\u003e\n\n**腾讯云 SpringBoot 组件** ⎯⎯⎯ 通过使用 [Tencent Serverless Framework](https://github.com/serverless/components/tree/cloud)，基于云上 Serverless 服务（如网关、云函数等），实现“0”配置，便捷开发，极速部署你的 SpringBoot 应用，SpringBoot 组件支持丰富的配置扩展，提供了目前最易用、低成本并且弹性伸缩的 SpringBoot 项目开发/托管能力。\n\n\u003c/br\u003e\n\n特性介绍：\n\n- [x] **按需付费** - 按照请求的使用量进行收费，没有请求时无需付费\n- [x] **\"0\"配置** - 只需要关心项目代码，之后部署即可，Serverless Framework 会搞定所有配置。\n- [x] **极速部署** - 仅需几秒，部署你的整个 SpringBoot 应用。\n- [x] **实时日志** - 通过实时日志的输出查看业务状态，便于直接在云端开发应用。\n- [x] **便捷协作** - 通过云端的状态信息和部署日志，方便的进行多人协作开发。\n- [x] **自定义域名** - 支持配置自定义域名及 HTTPS 访问\n\n\u003cbr/\u003e\n\n快速开始：\n\n1. [**安装**](#1-安装)\n2. [**创建**](#2-创建)\n3. [**部署**](#3-部署)\n4. [**配置**](#4-配置)\n5. [**开发调试**](#5-开发调试)\n6. [**查看状态**](#6-查看状态)\n7. [**移除**](#7-移除)\n\n更多资源：\n\n- [**架构说明**](#架构说明)\n- [**账号配置**](#账号配置)\n\n\u0026nbsp;\n\n### 1. 安装\n\n通过 npm 安装最新版本的 Serverless Framework\n\n```bash\n$ npm install -g serverless\n```\n\n### 2. 创建\n\n通过如下命令和模板链接，快速创建一个 SpringBoot 应用：\n\n```bash\n$ serverless init springboot-starter --name example\n$ cd example\n```\n\n### 3. 部署\n\n在 `serverless.yml` 文件所在的项目根目录，运行以下指令进行部署：\n\n```bash\n$ serverless deploy\n```\n\n部署时需要进行身份验证，如您的账号未 [登陆](https://cloud.tencent.com/login) 或 [注册](https://cloud.tencent.com/register) 腾讯云，您可以直接通过 `微信` 扫描命令行中的二维码进行授权登陆和注册。\n\n\u003e 注意: 如果希望查看更多部署过程的信息，可以通过`serverless deploy --debug` 命令查看部署过程中的实时日志信息。\n\n\u003e **说明**：如果鉴权失败，请参考 [权限配置](https://cloud.tencent.com/document/product/1154/43006) 进行授权。\n\n### 4. 配置\n\nSpringBoot 组件支持 0 配置部署，也就是可以直接通过配置文件中的默认值进行部署。但你依然可以修改更多可选配置来进一步开发该 SpringBoot 项目。\n\n以下是 SpringBoot 组件的 `serverless.yml`配置示例：\n\n```yml\n# serverless.yml\n\ncomponent: springboot # (required) name of the component. In that case, it's springboot.\nname: springbootDemo # (required) name of your springboot component instance.\norg: orgDemo # (optional) serverless dashboard org. default is the first org you created during signup.\napp: appDemo # (optional) serverless dashboard app. default is the same as the name property.\nstage: dev # (optional) serverless dashboard stage. default is dev.\n\ninputs:\n  src: ./ # path to the source folder. default is a hello world app.\n  functionName: springbootDemo\n  region: ap-guangzhou\n  runtime: Java8 # (optional) only Java8 is currently available\n  projectJarName: 'my-springboot.jar' # application jar file name\n  functionConfig:\n    handler: 'example.MyHandler::mainHandler' # app entry execute file \u0026 main function name\n    timeout: 30 # (optional) Java app needs to be set for more than 25 seconds\n    memorySize: 256 # (optional) Java app usually require a larger memory size\n  apigatewayConf:\n    protocols:\n      - http\n      - https\n    environment: release\n```\n\n点此查看[全量配置及配置说明](https://github.com/serverless-components/tencent-springboot/tree/master/docs/configure.md)\n\n当你根据该配置文件更新配置字段后，再次运行 `serverless deploy` 或者 `serverless` 就可以更新配置到云端。\n\n**若使用自己的 SpringBoot 项目代码进行部署需要进行如下的改造**\n\n1. 在项目 `pom.xml` 中新增腾讯云函数（需为 0.0.4 版本）和 fastjson 的依赖（若自身项目有所用版本可不修改，若无则请依赖最新版本）。\n\n```\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.tencentcloudapi\u003c/groupId\u003e\n    \u003cartifactId\u003escf-java-events\u003c/artifactId\u003e\n    \u003cversion\u003e0.0.4\u003c/version\u003e\n\u003c/dependency\u003e\n\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.alibaba\u003c/groupId\u003e\n    \u003cartifactId\u003efastjson\u003c/artifactId\u003e\n    \u003cversion\u003e1.2.73\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n2. 在项目的根目录的 `src/main/java` 的任意目录下新增一个执行方法入口，例如：在 src/main/java/example 目录下新建 MyHandler.java 文件。\n   如果需要自定义响应数据转换成 Base64 的指定 MediaType 请复写 `getBinaryTypes` 方法并返回 MediaType 列表。\n\n```java\npackage example;\n\nimport com.qcloud.scf.runtime.AbstractSpringHandler;\n\npublic class MyHandler extends AbstractSpringHandler {\n\n    /*\n       自定义需要转换成Base64的MediaType列表，默认为MediaType.ALL\n    */\n//    @Override\n//    public List\u003cMediaType\u003e getBinaryTypes() {\n//        return Arrays.asList(MediaType.IMAGE_PNG, MediaType.IMAGE_JPEG);\n//    }\n\n    @Override\n    public void startApp() {\n        System.out.println(\"start app\");\n        // 修改为springboot项目的入口主函数，例如: 入口为DemoApplication class下的main函数\n        DemoApplication.main(new String[]{\"\"});\n    }\n}\n```\n\n3. 将代码用 Maven 创建 `jar` 部署包或者用 Gradle 创建 zip 部署包。\n\n需要将项目所有的依赖包一起打包，例如使用`Maven`则推荐用`maven-shade-plugin`进行打包，修改`pom.xml`中的`plugin`：\n\n\u003e 若复杂项目下该配置打包无效，请参考完整版配置(注释部分)。[样例代码](https://github.com/serverless-components/tencent-springboot/blob/master/example/my-springboot-sourcecode/pom.xml#L68)\n\n```\n\u003cplugin\u003e\n    \u003cgroupId\u003eorg.apache.maven.plugins\u003c/groupId\u003e\n    \u003cartifactId\u003emaven-shade-plugin\u003c/artifactId\u003e\n    \u003cversion\u003e3.1.1\u003c/version\u003e\n    \u003cconfiguration\u003e\n        \u003ccreateDependencyReducedPom\u003efalse\u003c/createDependencyReducedPom\u003e\n    \u003c/configuration\u003e\n    \u003cexecutions\u003e\n        \u003cexecution\u003e\n            \u003cphase\u003epackage\u003c/phase\u003e\n            \u003cgoals\u003e\n                \u003cgoal\u003eshade\u003c/goal\u003e\n            \u003c/goals\u003e\n        \u003c/execution\u003e\n    \u003c/executions\u003e\n\u003c/plugin\u003e\n```\n\n- 云函数关于 Maven 部署包的说明：[点此查看](https://cloud.tencent.com/document/product/583/12217)\n- 云函数关于 Gradle 部署包的说明：[点此查看](https://cloud.tencent.com/document/product/583/12216)\n\n4. 修改 serverless.yml 文件中的 `projectJarName` 配置为打包后的 .jar/.zip 文件名，.jar/.zip 文件需要放与 serverless.yml 同级。\n\n\u003e 如：使用 Maven 打包后生成了 code.jar 文件，则 projectJarName 为 `code.jar`\n\n5. 修改 serverless.yml 文件中的 `functionConfig` 的 `handler` 配置，格式为 `[package].[class]::mainHandler` 其中 package 为更多层时用 `.` 连接。\n\n\u003e 如：步骤 2 中新建的 MyHandler.java 放在了 src/main/java/example 中，则 handler 为 `example.MyHandler::mainHandler`\n\n### 5. 开发调试\n\n部署了 SpringBoot 应用后，可以通过开发调试能力对该项目进行二次开发，从而开发一个生产应用。在本地修改和更新代码后，不需要每次都运行 `serverless deploy` 命令来反复部署。你可以直接通过 `serverless dev` 命令对本地代码的改动进行检测和自动上传。\n\n可以通过在 `serverless.yml`文件所在的目录下运行 `serverless dev` 命令开启开发调试能力。\n\n`serverless dev` 同时支持实时输出云端日志，每次部署完毕后，对项目进行访问，即可在命令行中实时输出调用日志，便于查看业务情况和排障。\n\n### 6. 查看状态\n\n在`serverless.yml`文件所在的目录下，通过如下命令查看部署状态：\n\n```\n$ serverless info\n```\n\n### 7. 移除\n\n在`serverless.yml`文件所在的目录下，通过以下命令移除部署的 SpringBoot 服务。移除后该组件会对应删除云上部署时所创建的所有相关资源。\n\n```\n$ serverless remove\n```\n\n和部署类似，支持通过 `serverless remove --debug` 命令查看移除过程中的实时日志信息。\n\n## 架构说明\n\nSpringBoot 组件将在腾讯云账户中使用到如下 Serverless 服务：\n\n- [x] **API 网关** - API 网关将会接收外部请求并且转发到 SCF 云函数中。\n- [x] **SCF 云函数** - 云函数将承载 SpringBoot 应用。\n- [x] **CAM 访问控制** - 该组件会创建默认 CAM 角色用于授权访问关联资源。\n- [x] **COS 对象存储** - 为确保上传速度和质量，云函数压缩并上传代码时，会默认将代码包存储在特定命名的 COS 桶中。\n- [x] **SSL 证书服务** - 如果你在 yaml 文件中配置了 `apigatewayConf.customDomains` 字段，需要做自定义域名绑定并开启 HTTPS 时，也会用到证书管理服务和域名服务。Serverless Framework 会根据已经备案的域名自动申请并配置 SSL 证书。\n\n## 账号配置\n\n当前默认支持 CLI 扫描二维码登录，如您希望配置持久的环境变量/秘钥信息，也可以本地创建 `.env` 文件\n\n```console\n$ touch .env # 腾讯云的配置信息\n```\n\n在 `.env` 文件中配置腾讯云的 SecretId 和 SecretKey 信息并保存\n\n如果没有腾讯云账号，可以在此[注册新账号](https://cloud.tencent.com/register)。\n\n如果已有腾讯云账号，可以在[API 密钥管理](https://console.cloud.tencent.com/cam/capi)中获取 `SecretId` 和`SecretKey`.\n\n```\n# .env\nTENCENT_SECRET_ID=123\nTENCENT_SECRET_KEY=123\n```\n\n## License\n\nMIT License\n\nCopyright (c) 2020 Tencent Cloud, Inc.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverless-components%2Ftencent-springboot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserverless-components%2Ftencent-springboot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserverless-components%2Ftencent-springboot/lists"}