写点什么

SOFABoot 4.0 正式发布,多项新特性等你来体验!

作者:SOFAStack
  • 2023-08-09
    浙江
  • 本文字数:6209 字

    阅读完需:约 20 分钟

SOFABoot 4.0 正式发布,多项新特性等你来体验!

Part.1 「亿点点」新特性

基于 Java 17

SOFABoot 4.0 依赖 Java 17 作为最小支持的 JDK 版本。如果你的应用目前使用 Java 8 或 11,你需要先将自己的 JDK 版本升级到 17 才能基于 SOFABoot 4.0 进行开发。

二方库升级

SOFABoot 4.0 基于 Spring Boot 3.0 与 Spring Framework 6 构建。在 Spring Boot 3.0 与 Spring Framework 6 引入的二方库升级列表可参考文档👉 Spring Boot 3.0 Release Notes


在 SOFABoot 4.0 引入的二方库升级列表如下


  • Spring Boot 3.0.5

  • Spring Cloud 4.0.0

  • Spring Cloud Stream 3.2.6

  • SOFA Common tools 2.0.0

  • SOFATracer 4.0.0

  • SOFARPC 5.10.0

  • FastJson 1.2.83

  • Guava 31.1-jre

  • Grpc 1.51.1

  • Grpc common protos 2.11.0

  • Druid 1.2.16

  • ASM 9.4

  • Javassist 3.29.2-GA

  • Curator 4.3.0

  • Dubbo 3.1.8

  • Nacos 2.0.3

  • Swagger 1.6.7

  • Swagger2 2.2.8

基于 Jakarta EE

Spring Boot 3.0 中依赖 Jakarta EE 规范的部分已经升级到了 Jakarta EE 10 版本。例如,使用 Servlet 6.0 和 JPA 3.1 规范。因此,部分包的命名空间也进行了替换,例如你应该使用:


jakarta.servlet.Filter


而不是 javax.servlet.Filter


同时,如果你使用了自己的依赖提供 Jakarta EE 规范的 API,需注意进行对应的依赖升级,例如你应该使用:


jakarta.servlet:jakarta.servlet-api


而不是 javax.servlet:javax.servlet-api


可参考文档:Migrate to Jakarta EE 9 来修改 Jakarta 相关的包名以及依赖。

支持 SOFAArk 2.0

SOFAArk 2.0 模式是 SOFAArk 框架的整体优化版本,相较于 SOFAArk 1.0 模式,它的整体优化思路和原则是 Ark Master Biz 保持和原生 SOFABoot 保持一致,弱化复杂的 Ark Plugin 类管控机制,将 Ark Plugin 与 Master Biz 合并。使得 Ark Master Biz 和原生 SOFABoot 应用的启动方式、类加载方式保持一致,大大降低了 Master Biz 应用的编程难度。


SOFABoot 4.0 版本不再支持 SOFAArk 1.0 模式,如果你想要在 SOFABoot 应用中使用 SOFAArk 2.0 模式,可以按照以下步骤进行操作:


1、在项目中引入 SOFAArk 组件依赖


<dependency>  <groupId>com.alipay.sofa</groupId>  <artifactId>ark-sofa-boot-starter</artifactId></dependency>
复制代码


2、添加 Spring Boot 的 Package 插件


<build>    <plugins>        <plugin>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-maven-plugin</artifactId>
<configuration> <outputDirectory>target</outputDirectory> <classifier>ark-biz</classifier> </configuration> <executions> <execution> <id>package</id> <goals> <goal>repackage</goal> </goals> </execution> </executions> </plugin> </plugins></build>
复制代码


3、启动应用


  • 方式一:


IDEA 启动,注意需要添加启动参数:-Dsofa.ark.embed.enable=true -Dcom.alipay.sofa.ark.master.biz=${bizName}


  • 方式二:


命令行启动,先运行 mvn clean package 命令进行打包,生成 {bizVersion}-ark-biz.jar 的可执行文件,然后在终端运行以下启动参数:


java -jar -Dsofa.ark.embed.enable=true -Dcom.alipay.sofa.ark.master.biz=${bizName} ${bizName}-${bizVersion}-ark-biz.jar

支持场景化的按配置加载能力

通常情况下,应用在不同的场景下可能需要开启或者关闭不同的功能,Spring Boot 提供了丰富的 Configuration 动态配置能力[4] 能力以支持应用在不同的场景下加载不同的 Bean。


SOFABoot 在此基础上,对 org.springframework.context.ApplicationContextInitializer 等扩展点进行了增强,支持通过统一风格的配置定制各类 Bean 以及扩展点的开启与关闭,并提供了定制模版配置的开启方式以降低应用配置项的复杂度。


  • 通过:


com.alipay.sofa.boot.autoconfigure.condition.ConditionalOnSwitch 注解为 Bean 添加按配置开启能力:


@Configuration(proxyBeanMethods = false)@ConditionalOnSwitch(id="sample")public class SampleConfiguration {
@Bean public SampleBean sampleBean() { return new SampleBean(); }}
复制代码


添加:


sofa.boot.switch.bean.sample.enabled=false 配置后,SampleConfiguration 配置类将不再加载。


  • 通过继承:


com.alipay.sofa.boot.Initializer.SwitchableApplicationContextInitializer 类为:


ApplicationContextInitializer 添加按配置开启能力:


public class SampleSwitchSpringContextInitializer extends                                                     SwitchableApplicationContextInitializer {    @Override    protected void doInitialize(ConfigurableApplicationContext applicationContext) {        applicationContext.getEnvironment().addActiveProfile("sampleswitchtest");    }
@Override protected String switchKey() { return "sample"; }
}
复制代码


添加:


sofa.boot.switch.initializer.sample.enabled=false 配置后,


SampleSwitchSpringContextInitializer 类将不再执行 doInitialize 方法。


  • 通过继承:


com.alipay.sofa.boot.listener.SwitchableApplicationListener 类为:


ApplicationListener 添加添加按配置开启能力:


public class SampleSwitchApplicationListener                                                 extends                                                 SwitchableApplicationListener<ContextRefreshedEvent> {
@Override protected void doOnApplicationEvent(ContextRefreshedEvent event) { SampleBean sampleBean = event.getApplicationContext().getBean(SampleBean.class); sampleBean.setTrigger(true); }
@Override protected String switchKey() { return "sample"; }
}
复制代码


添加:


sofa.boot.switch.listener.sample.enabled=false 配置后,


SampleSwitchApplicationListener 类将不再执行 doOnApplicationEvent 方法。


在使用上述扩展点为你的 Bean 和扩展点添加按配置开启能力后,你可以在 /sofa-boot/scenens 目录下添加指定场景名 scene-key 前缀的配置文件 (支持 application 及 yaml 格式) ,在配置文件中添加该场景下的配置文件模版,例如:


sofa.boot.switch.bean.a.enabled=falsesofa.boot.switch.bean.b.enabled=truesofa.boot.switch.initializer.a.enabled=falsesofa.boot.switch.initializer.b.enabled=falsesofa.boot.switch.initializer.c.enabled=false
复制代码


当你的应用打包后,你只需要添加配置 sofa.boot.scenens=scene-key 便可以生效 /sofa-boot/scenens/scene-key.properites 配置文件中的开关配置。该配置项同时支持配置多个场景名,可以同时生效多个场景配置文件。

启动耗时统计能力增强

SOFABoot 在 3.6.0 版本提供了 /actuator/startup 能力用于查询应用启动过程中的耗时细节。后来,Spring Boot 在 2.4 版本也提供了官方的 /actuator/startup 能力用于展示应用启动耗时详情。在 SOFA Boot 4.0 版本中,我们整合了 SOFA Boot 与 Spring Boot 提供的启动耗时统计能力:


  • 保留了 SOFABoot 特有的阶段耗时统计能力,例如 SOFA 模块化刷新耗时统计、健康检查耗时统计等;

  • 使用 Spring Framework 提供的 org.springframework.boot.context.metrics.buffering.BufferingApplicationStartup 统计 Applicaiton Context 的启动耗时详情。


你可以通过下述方式使用 SOFABoot 增强的 /actuator/startup 能力:


1、在项目中引入 actuator 组件依赖:


<dependency>  <groupId>com.alipay.sofa</groupId>  <artifactId>actuator-sofa-boot-starter</artifactId></dependency>
复制代码


2、使用:


com.alipay.sofa.boot.startup.StartupSpringApplication 作为启动类启动应用:


public static void main(String[] args) {    StartupSpringApplication startupSpringApplication = new StartupSpringApplication(Sofaboot4DemoApplication.class);    startupSpringApplication.run(args);}
复制代码


3、启动应用后,访问:


localhost:8080/actuator/startup 查看启动耗时详情信息。

更丰富的 SPI

SOFABoot 4.0 版本中新增了大量 SPI ,你可以通过这些 SPI 定制 SOFABoot 框架的运行逻辑。


  • 添加自定义的启动耗时阶段信息


com.alipay.sofa.boot.startup.StartupReporterAware 接口的使用方式与 org.springframework.context.ApplicationContextAware 接口的使用方法使用类似,当你的 Bean 实现了该接口时,你可以感知到应用中的:com.alipay.sofa.boot.startup.StartupReporter 实例。


com.alipay.sofa.boot.startup.StartupReporter 类用于管理 SOFABoot 提供的 /actuator/startup 耗时信息,你可以通过 com.alipay.sofa.boot.startup.StartupReporter#addCommonStartupStat 方法添加你定制的耗时阶段信息。


  • 添加自定义的 Bean 启动耗时信息


com.alipay.sofa.boot.startup.BeanStatCustomizer 接口用于定制 SOFABoot 提供的 /actuator/startup 耗时信息中的 Bean 启动耗时特征。如果你想注册自定义的 com.alipay.sofa.boot.startup.BeanStatCustomizer 接口实现类,需要在 META-INF/spring.factories 文件注册 Spring Factories 形式的 SPI。你可以参考框架内置的 com.alipay.sofa.runtime.startup.ComponentBeanStatCustomizer 类用于提取 ServiceFactoryBean 类型的 Bean 的 Interface 字段用于展示。


  • 定制 BeanPostProcessor 与 BeanFactoryPostProcessor 在 SOFA 上下文中的共享模式


在开启模块化隔离特性时,你在 Spring Boot 上下文中注册的 BeanPostProcessor 以及 BeanFactoryPostProcessor 将 BeanDefinition 将被共享至所有的 SOFA 模块中,每个 SOFA 模块的上下文中都会创建一个 PostProcessor 类的实例。你可以通过以下方式,修改指定的 BeanPostProcessor 或者BeanFactoryPostProcessor 的共享方式:


  • 在 PostProcessor 类上添加:


com.alipay.sofa.boot.context.processor.UnshareSofaPostProcessor 注解,PostProcessor 将不会被共享至 SOFA 模块中。


  • 在 PostProcessor 类上添加:


com.alipay.sofa.boot.context.processor.SingletonSofaPostProcessor 注解,SOFA Boot 框架会获取其在 Spring Boot 上下文中的 Singleton 实例注册至 SOFA 模块中,而不是注册 BeanDefinition,这将确保 PostProcessor 类在整个应用中保持单例。


  • 自定义:


com.alipay.sofa.boot.context.processor.SofaPostProcessorShareFilter 接口的实现类并将其注册至 Spring Boot 上下文中,通过 bean name 或 bean class 指定 PostProcessor 的共享方式。


  • 添加感知 SOFA 模块刷新的扩展点


在开启模块化隔离特性时,你可以自定义 com.alipay.sofa.boot.context.ContextRefreshInterceptor 接口的实现类并将其注册至 Spring Boot 上下文中,当每个 SOFA 模块的 Spring 上下文开始刷新前以及刷新完成后,都会触发该接口的 beforeRefresh 以及 afterRefresh 方法。


你可以参考框架内置的:com.alipay.sofa.runtime.context.ComponentContextRefreshInterceptor 类,它用于在 SOFA 模块中的 Spring 上下文刷新成功后,将其注为 SpringContextComponent,在 SOFA 模块中的 Spring 上下文刷新失败后取消注册的 ComponentInfo


  • 支持注解参数的占位符替换


在一些情况下,我们希望自定义注解中的属性使用非固定值,通过 Spring 配置进行定制。SOFABoot 提供了:


com.alipay.sofa.boot.annotation.WrapperAnnotation 工具类,用于快速实现上述功能。例如,你自定义了一个注解类 DemoAnnotation,并在某个类上使用了该注解:


@Retention(RetentionPolicy.RUNTIME)@Target({ ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER })public @interface DemoAnnotation {
String key() default "";}
复制代码


@DemoAnnotation(key = "${spring.annotation.config}")public class TestClass {}
复制代码


通过以下方式获取的 key 字段数值将转换为你在 Spring Envrionment 中定义的 spring.annotation.config 配置值:


public String getAnnotationKey(Environment environment, DemoAnnotation demoAnnotation) {    AnnotationWrapper<DemoAnnotation> serviceAnnotationWrapper = AnnotationWrapper.create(DemoAnnotation.class)        .withEnvironment(environment)        .withBinder(DefaultPlaceHolderBinder.INSTANCE);    return serviceAnnotationWrapper.wrap(demoAnnotation).key();}
复制代码

Part.2 注意有重命名哦!

请先留意以下信息!


  • 通过 actuator-sofa-boot-starter 引入的 SOFABoot 增强的 actuator 能力,通过配置项定制开启的 actuator。

  • 依赖 health-sofa-boot-starter 与 startup-sofa-boot-starter 已被废弃,请使用 actuator-sofa-boot-starter 替换。

  • 依赖 log-sofa-boot-starter 已被废弃,如果你引入了其他的 sofa boot starter,可以直接删除该依赖。如果你没有引入任何其他 sofa boot starter,使用 sofa-boot-starter 代替它。

  • 依赖 rpc-sofa-boot-plugin、runtime-sofa-boot-plugin、tracer-sofa-boot-plugin 已被废弃,可使用 ark-sofa-boot-starter 代替它们。


我们对下表中包名下的类进行了重命名,如果你使用了对应的类,则需要修改为新的包名:



SOFABoot 提供的以下 API 类进行了重命名,如果你使用了对应的类,则需要修改为新的类名:



Part.3 废弃特性

再见啦,SOFAArk 1.0


SOFABoot 4.0 不再支持 SOFAArk 1.0 模式,用于支持 Ark 测试的相关工具类已被移除,SOFAArk 2.0 模式下你不再需要这些类:


  • com.alipay.sofa.test.annotation.DelegateToRunner

  • com.alipay.sofa.test.runner.SofaBootRunner

  • com.alipay.sofa.test.runner.SofaJUnit4Runner

Part.4 请收下这份升级指南🙆🏻‍♂️

Before You Start

升级 SOFABoot 至 最新的 3.x 版本

在开始升级之前,请确保升级到最新可用的 3.x 版本。这将确保你正在针对该行的最新依赖项进行构建。

检查依赖列表

迁移到 SOFABoot 4.0 将升级许多依赖项 (包括 Spring Boot 3.0 升级的依赖项) ,请确认依赖项升级对你的应用的影响。请参考:


检查已废弃的特性

SOFABoot 3 以及 Spring Boot 2 中弃用的类、方法和属性,请确保在升级之前没有调用已弃用的功能。详情请参考上方「Part.3 废弃特性|再见啦,SOFAArk 1.0」章节。

检查系统配置

SOFABoot 4.0 依赖 Java 17 或者更高的版本,不再支持 Java 8。同时依赖 Spring Boot 3.0。

升级至 SOFA Boot 4.0

修改重命名的配置项

请参考下方「Part.5 附录|配置变更」章节以及文档 Spring Boot 2 -> 3 配置变更

修改重命名的类与依赖

参考上方「Part.2 注意有重命名哦! 」章节

升级 Spring Boot 3.0

参考文档: Spring Boot 3.0 升级文档

Part.5 附录|配置变更

注:配置属性对比基于 3.16.3 与 4.0 版本。


  • 在 4.0 版本中废弃的配置


  • 在 4.0 版本中新增的配置


  • 在 4.0 版本中重命名的配置


runtime properties


isle properties


actuator properties


tracer properties


rpc properties





了解更多...


SOFABoot Star 一下✨:


https://github.com/sofastack/sofa-boot


发布于: 刚刚阅读数: 3
用户头像

SOFAStack

关注

致力于打造一流的分布式技术交流平台。 2021-04-26 加入

SOFAStack™(Scalable Open Financial Architecture Stack)是一套用于快速构建金融级云原生架构的中间件,也是在金融场景里锤炼出来的最佳实践,并且具备以下特点:开放、金融级、云原生

评论

发布
暂无评论
SOFABoot 4.0 正式发布,多项新特性等你来体验!_springboot_SOFAStack_InfoQ写作社区