bkdevops-projects/devops-framework

devops boot framework

DevOps Boot

基于Spring Boot的微服务快速开发框架

中文文档地址

---

DevOps Boot 是什么？

devops-boot提炼自腾讯DevOps团队内部多个项目，使用约定优于配置的设计理念，帮助我们专注于DevOps业务快速开发，它具有以下优势:

• 简单 ：几乎零配置快速开发微服务，低成本上手
• 易用 ：采用Spring Boot组件化**，易于学习理解
• 统一 ：目前已集成了微服务开发常用组件和统一配置
• 扩展 ：组件之间低耦合，高内聚，扩展十分方便

查看快速开始了解详情。

DevOps Boot 能解决什么问题？

• 统一项目配置 ： 免去繁琐的项目配置，gradle插件帮您解决烦恼
• 统一依赖版本管理 ： 多个项目统一jdk和三方依赖版本，避免版本冲突
• 统一微服务治理解决方案： 解决多个项目技术方案参差不齐，架构不统一问题
• 统一常用工具类 ： 避免代码重复

功能特性

• 提供gradle快速开发插件devops-boot-gradle-plugin
• 提供gradle快速发布插件devops-publish-gradle-plugin
• 提供统一版本依赖管理devops-boot-dependencies
• 提供多个开箱即用的starter组件
  • starter-api
  • starter-logging
  • starter-web
  • starter-service
  • ...

核心依赖

依赖	版本
JDK	1.8+
Kotlin	1.6.21
Gradle	6.8.3
Spring Boot	2.4.5
Spring Cloud	2020.0.2

示例

可以查看 sample 来了解如何优雅集成devops-boot框架。

devops-framework's Issues

SpringBoot升级2.5+

feat: 日志路径支持自定义

framework 要支持自定义 日志路径， 对于一个已有项目接入改造，但比如已经线上运行的，或者是社区用户已经部署好的，都是一个隐性成本，可能影响已有的监控采集，存在上线后不可控，服务接入改造成本过高

对于新接入framework的项目可以使用我们默认推荐的方式，让他们开箱即用

合并pr后才触发publish snapshot

ktlint升级版本到0.41.0

支持k8s云原生编译打包方式

开发api公共组件

• 定义公共POJO类
• 统一swagger版本

优化devops-boot-gradle-plugin

1. 只对以boot-开头的模块应用spring-boot-gradle-plugin，加快速度
2. 添加copyToRelease任务

仓库列表优化

DevOpsBoot gradle插件支持指定jvm语言

1. java
2. kotlin
3. java + kotlin

升级springboot版本到2.3.4

devops-boot-gradle-plugin 仓库列表添加mavenLocal

feature: 集成detekt

补全README文档

copyToRelease支持不带版本号

自动扫描包含MainClass类的模块

自动扫描包含MainClass类的模块，应用SpringBoot Gradle插件

publish插件修改sonatype release仓库地址

目前设置的地址https://oss.sonatype.org/service/local/
正确的地址为https://oss.sonatype.org/service/local/staging/deploy/maven2/

插件化组件plugin-starter

服务注册instance-id使用hostname

consul注册服务时，默认的serviceName为spring.application.name，instanceId为-<server.port>，导致instanceId不唯一，在某些情况下可能出现异常，所以使用hostname来确定唯一性，格式为-<server.port>-

bug: feign 10.10.1自动在header的value的逗号后面加空格, 导致获取到的值不符合预期

gradle插件自动过滤空模块

devops-boot插件添加ktlint支持

gradle插件代码拆分

kotlin编译增加-java-parameters参数

-java-parameters用于Java 1.8反射生成方法参数名称的元数据信息，在某些情况下会使用到，如Actuator Endpoint的@Selector注解获取方法参数名称

支持服务名称前缀后缀

当多个项目使用同一个注册中心时，可能出现服务名称冲突，如A项目和B项目同时包含名称为repository的服务，如果使用同一个注册中心会出现问题，所以通过添加服务名称前缀后缀来解决。

假设spring.application.name=repository，

1. 默认情况，服务注册名称以及配置名称都为repository
2. 配置service.prefix=prefix-，服务注册名称以及配置名称变为prefix-repository
3. 配置service.suffix=-suffix，服务注册名称以及配置名称变为repository-suffix
4. 配置service.prefix=prefix- & service.suffix=-suffix，服务注册名称以及配置名称变为prefix-repository-suffix

feat : 升级logback版本

升级logback版本

添加公共依赖版本管理

repository移除mavenLocal

gradle官方建议避免使用mavenLocal，文档

1. maven将本地仓库作为缓存，而不是maven仓库
2. gradle本身有自己的缓存逻辑
3. maven本地仓库的数据不可信，可能被篡改

在实践过程中，我们也遇到了添加mavenLocal后，引入了莫名其妙的缓存问题导致依赖无法正确下载，因此从将mavanLocal从仓库列表中移除

开发devops-publish-gradle-plugin插件

开发devops-publish-gradle-plugin插件，提供如下能力：

• 添加maven-publish和signing插件
• 配置javaSource、javaDoc等publications
• 自动配置签名信息
• 自动配置发布仓库信息repositories，根据版本号自动选择repository
• 自动补全manifest信息

升级SpringBoot和SpringCloud版本

• Spring Boot 2.3.4 -> 2.3.7
• Spring Cloud Hoxton.SR8 -> Hoxton.SR9

feat: 整理仓库配置

1. framework里面配置aliyun的仓库可能有问题, 拉不到最新的SNAPSHOT
2. 仓库的配置得理一下，有的依赖腾讯云的仓库也识别不了

feature: 提供分布式调度中心组件

开发service组件

配置阿里云仓库时，引ci的包会报找不到

需要配置artifacturl，否则引入ci包时，会报关联的二级依赖找不到

完善jar包**仓库发布流程

kotlin版本升级到1.4.32

logback日志文件和行号有时会报问号

如题

feat: 升级log4j到2.15.0

升级log4j到2.15.0

是否可以支持Spring Initializr快速创建项目

如题，目前创建项目再接入devops-framework的过程还是较为繁琐，且容易出问题。
是否可以使用Spring Initializr对新项目的创建接入进行简化。
Spring Initializr：https://github.com/spring-io/initializr

copyToRelease任务依赖bootJar任务

devops-publish-gradle-plugin插件优化

集成gradle-nexus插件

开发web公共组件

发布文档页面

集成google jib打包docker镜像

Google Jib Docs

开发logger公共组件

• 统一日志格式
• 统一日志输出位置
• 统一日志切割策略
• 规范日志分类
• 规范日志框架
• 提供默认logback配置

【服务治理】客户端负载均衡&服务间灰度调用能力

SpringCloud 2020.0移除了对Ribbon的依赖，官方实现了客户端负载均衡组件spring-cloud-starter-loadbalancer，引入该组件以实现客户端的负载均衡，同时研究其扩展能力，微服务间调用支持按照metadata进行灰度调用

ref: spring-cloud-loadbalancer docs

【服务治理】客户端断路器&限流组件

早在之前Netflix官方宣布了Hystrix进入维护模式，SpringCloud 2020.0.0 也移除了对Hystrix的依赖，推荐使用resilience4j作为断路器组件，同时resilience4j也提供了一定的限流能力。
初期先引入官方推荐的resilience4j组件进行统一配置，之后再尝试接入功能更丰富的sentinel组件。

ref:

• resilience4j-circuit-breakers
• Resilience4J Spring Boot 2 Configuration

升级springboot+springcloud版本

1.升级 spring boot 到 2.4.5
2.升级 spring cloud 到 2020.0.2

bug: dependencies自定义的版本没有生效

dependencies自定义的版本没有生效
constraints的生成的dependency总会在platform之前 , 导致优先级更低
使用enforcedPlatform替换constraints声明的版本, 使自定义版本生效

解决jooq项目model模块没有应用java插件问题

devops-boot插件根据模块是否为空来判读是否应用java和kotlin插件，判断依据是模块是否包含src目录。这带来了两个问题：

1. 对使用了jooq的项目来说，model模块是不包含src目录的，导致生成的java类无法编译
2. 在父模块中无法方便地使用api、implementation等关键词，因为这些是java插件引入的

解决办法：
对于所有模块都默认应用java、kotlin（按需）插件

期望devops-boot-gradle-plugin插件支持哪些功能？

devops-boot-gradle-plugin目前提供了如下自动化配置：

• 配置kotlin默认版本、编译选项
• 默认添加kotlin jvm插件
• 配置默认maven仓库列表，添加了腾讯源
• 默认添加spring kotlin插件
• 默认添加spring boot插件
• 默认添加依赖管理插件，并引入本项目的devops-boot-dependenciesbom文件
• 默认添加kotlin-stdlib-jdk8和korlin-stdlib-reflect依赖

除此之外，你还期望devps-boot-gradle-plugin插件支持哪些功能？