乐趣区

关于springboot:Spring-Boot-240正式发布全新的配置文件加载机制不向下兼容

jiezi

千里之行，始于足下。关注公众号【BAT 的乌托邦 】，有 Spring 技术栈、MyBatis、JVM、中间件等小而美的 原创专栏 供以收费学习。分享、成长，回绝浅尝辄止。本文已被 https://www.yourbatman.cn 收录。

✍前言

你好，我是 YourBatman。

北京工夫 2020-11-12，Spring Boot 2.4.0正式公布。2.4.0 是第一个应用 新版本计划 的 Spring Boot 发行版本。

留神：2.4.0 版本号没有 .RELEASE 后缀，没有 .RELEASE 后缀，没有 .RELEASE 后缀。应用的是 Spring 最新的版本公布规定。此规定详解请参考上篇文章：Spring 扭转版本号命名规定：此举对非英语国家很敌对

还记得 Spring Boot 2.3.0.RELEASE 版本公布时那会麽？前后相差将好半年：

中转电梯：Spring Boot 2.3.0 正式公布：优雅停机、配置文件地位通配符新个性一览

一般来说，次版本号的降级会有点料，依据之前的爆料此次降级据说是做了大量的更新和改良。那么老规矩，作为小白鼠的我先代你玩一玩，初体验吧。

也可参见官网的更新日志：Spring Boot 2.4.0 Release Notes

✍注释

除了刚公布的 Spring Boot 2.4.0，Spring Boot 2.3.x/2.2.x 仍旧是 沉闷的 保护的版本。Spring Boot 遵循的是 Pivotal OSS 反对策略，从公布日期起反对次要版本 3 年（留神：是次要版本）。上面是详情：

  • 2.3.x：反对的版本。2020.05 公布，是当初的沉闷的骨干
  • 2.2.x：反对的版本。2019.10 公布，是当初的沉闷的骨干
  • 2.1.x：2018.10 公布，反对到 2020.10 月底，倡议尽快降级

EOL 分支：

  • 2.0.x：2018.3 公布，2019.4.3 进行保护
  • 1.5.x：生命已终止的版本。2017.1 公布，是最初一个 1.x 分支，2019.8.1 进行保护

回顾 2.3 版本的新个性

可能大部分小伙伴都还没用过 2.3.x 分支，没想到 2.4.x 就已公布。因而这里先对 2.3.x 版本的新个性，来波简略回顾：

  1. 优雅停机。这是 2.3.x 主打的新个性：在敞开时，web 服务器将不再容许新的申请，并将期待实现的申请给个宽限期让它实现。这个宽限期是能够设置的：能够应用spring.lifecycle.timeout-per-shutdown-phase=xxx 来配置，默认值是 30s。

  2. 配置文件地位反对通配符。简略的说，如果你有 MySql 的配置和 Redis 配置的话，你就能够把他们离开来搁置，这个新个性也是棒棒哒。隔离性更好目录也更加清晰了（留神：此格局只反对放在 classpath 内部）：

    1. mysql：/config/mysql/application.properties
    2. redis：/config/redis/application.properties

  3. 外围依赖降级。

    1. Spring Data Neumann。备注：很显著这个还是旧的命名形式。在 Spirng 新的版本规定下，Spring Data 最新版本为 Spring Data 2020.0.0
    2. Spring Session Dragonfruit（很显著这个也还是旧的命名形式）
    3. Spring Security 5.3

    4. Spring Framework 没有降级，应用的仍旧是和 Spring Boot 2.2 雷同的 5.2.x 版本

      1. 阐明：小版本号的降级对于新个性来说个别选择性疏忽

    5. 对于 Bean Validation：从此版本开始，spring-boot-starter-web 不会再把 validation 带进来，所以若应用到，你须要本人增加这个 spring-boot-starter-validation 依赖

      1. 一般来说倡议你手动引入，毕竟 Bean Validation 的应用还是很宽泛，并且真的十分十分好用

做足功课后，就开始最新的 Spring Boot 2.4.0 之旅吧。

2.4.0 次要新个性

全新的配置文件解决(properties/yaml)

这个扭转 最为重磅 ，本次扭转了配置文件的加载逻辑，旨在 简化 和合理化 内部配置的加载形式，它可能具备不向下兼容性。

Spring Boot 2.4 扭转了解决 application.properties 和application.yml文件的形式：

  • 若你只是简略的文件 application.properties/yaml，那么降级对你是 无缝 的，你感触不到任何变动
  • 若你应用了比较复杂的文件，如 application-profile.properties/yaml 这种（或者应用了 Spirng Cloud 的配置核心、（带有分隔符 —- 的）多 yaml 文件），那么默认是不向下兼容的，须要你显式的做出些更改

因为配置文件隶属于程序的一部分，特地是咱们当初简直都会应用到配置核心。因而上面针对于老版本升级到 Spring Boot 2.4.0 做个简略的迁徙领导。

阐明：因配置文件加载逻辑齐全进行了重写，因而具体版本我放到了下文专文解说，有趣味可放弃关注

老版本版本配置属性迁徙指南

老版本：2.4.0 之前的版本都叫老版本。

Spring Boot 2.4 对 application.poperties/yaml 的解决做了更新 / 降级。旨在简化和合理化内部配置的加载形式。它还提供了新性能：spring.config.import反对。所以呢，对于 Spring Boot 2.4.0 之前的版本（老版本）若降级到 2.4.0 须要做些批改，领导倡议如下：

形式一：复原旧模式（不举荐）

如果你还未筹备好做配置迁徙的批改，Spring Boot 也帮你思考到了，提供了 一键切换 到旧模式的“按钮”。具体做法是：只须要在 Environment 里减少一个属性 spring.config.use-legacy-processing = true 就搞定。最简的形式就是把这个属性放在 application.poperties/yaml 里即可。

spring.config.use-legacy-processing = true

减少此配置后，Spring Boot 对配置文件的解析复原到原来模式：仍旧应用 ConfigFileApplicationListener 去解析。

ConfigFileApplicationListener属于 Spring Boot 十分外围的底层代码，这次做了不向下兼容的改良，可见它对进击云原生的信心

值得注意的是：此 API 在 2.4.0 已被标记为过期：

// @since 1.0.0
// @deprecated since 2.4.0 in favor of {@link ConfigDataEnvironmentPostProcessor}
@Deprecated
public class ConfigFileApplicationListener implements EnvironmentPostProcessor, SmartApplicationListener, Ordered {...}

依照 Spring Boot 的版本策略，此类将在 Spring Boot 2.6.0 版本被移除。因而：若不是无可奈何（工夫紧急），并不倡议你用兼容手法这么去做，因为这将成为技术债，迟早要还的。

阐明：很多 RD 其实只会看到以后的不便，取得利益（比方疾速上线获奖），坑交给前人。我集体认为作为程序员应该有肯定自我涵养，自我谋求，不为一时的爽而继续给团队积攒债权，毕竟积重难返。

形式二：按新规定迁徙（举荐）

若你对配置文件的应用有如下情行，那么你须要做迁徙：

  1. 多文档的 yaml 文件（带有 —- 分隔符的文件）
  2. 在 Jar 外应用配置文件，或者应用形如 application-{xxx}.properties/yaml 这种配置
  3. 若在多文档 yaml 中应用到了 spring.profiles 配置项
  4. …

Spring Boot 2.4.0 降级对配置文件的改变是最大的，并且还 不具备向下兼容性，简略的说就是从此版本开始要把 Spring Boot 的配置文件加载机制重学一遍（比方还减少了spring.config.import，减少了对 kubernetes 配置的反对等等），并且还要学会如何迁徙。

为了更好的形容好这个十分十分重要的知识点，下篇文章我会用专文来全面介绍 Spring Boot 这套全新的配置文件加载机制，并且辅以原理，以及和过来形式的比拟，帮忙你更全面、更疾速、更劳的把握它，欢送继续关注。

阐明：Spring Boot 的配置文件加载机制十分十分重要，因为你也晓得你平时开发中很大水平实际上是在跟它的配置项打交道。新的配置加载形式比老的更加优良，适应倒退，敬请期待

从 spring-boot-starter-test 中删除 Vintage Engine

Spring Boot 2.2.0版本开始就引入 JUnit 5 作为单元测试 默认库，在此之前，spring-boot-starter-test 蕴含的是 JUnit 4 的依赖，Spring Boot 2.2.0 版本之后替换成了 Junit Jupiter（Junit5）。

Vintage Engine 属于 Junit5 的一个模块，它的作用是：容许用 JUnit 5 运行用 JUnit 4 编写的测试，从而提供了向下兼容的能力。

从 2.2.0 到当初通过了 2 个版本的迭代，到 Spring Boot 2.4.0 这个版本决定了把 Vintage Engine 从 spring-boot-starter-test 正式移除。因而：若你的工程仍须要对 JUnit4 反对，那么请手动引入依赖项（如果工程量不大，强烈建议应用 JUnit5，比 4 好用太多）：

<dependency>
    <groupId>org.junit.vintage</groupId>
    <artifactId>junit-vintage-engine</artifactId>
    <scope>test</scope>
    <exclusions>
        <exclusion>
            <groupId>org.hamcrest</groupId>
            <artifactId>hamcrest-core</artifactId>
        </exclusion>
    </exclusions>
</dependency>

阐明：其实在 2.4.0 之前，若你是从 https://start.spring.io 生成的我的项目其实也是不会带有 vintage-engine 的。只不过它是通过显式的在 pom 里通过 exclusion 标签来排除的

嵌入式数据库检测

改良嵌入式数据库检测机制：仅当数据库在 内存中 时才将其视为嵌入式数据库。所以如果应用 H2、HSQL 等产品，然而 你是基于文件的持久性或应用的是服务器模式，那么将不会检测为内存数据库。而对于 非内存 数据库，你可能须要额定做如下动作：

  1. sa 用户名将不会再被被动设置。所以如果你的数据库须要用户名，请减少配置项：spring.datasource.username = sa
  2. 这种数据库将不会再被主动初始化，若要应用请依据须要更改 spring.datasource.initialization-mode 的值

Logback 配置属性

Logback 一些配置项改名了，更加表名了它是 logback 的配置项。

新增了配置类 LogbackLoggingSystemProperties 用于对应，它继承自之前的LoggingSystemProperties

之前的配置项有些被废除（此版本还未删除，后续版本必定会删除的），对应关系如下：

老(已废除) 新
logging.pattern.rolling-file-name logging.logback.rollingpolicy.file-name-pattern
logging.file.clean-history-on-start logging.logback.rollingpolicy.clean-history-on-start
logging.file.max-size logging.logback.rollingpolicy.max-file-size
logging.file.total-size-cap logging.logback.rollingpolicy.total-size-cap
logging.file.max-history logging.logback.rollingpolicy.max-history

一些属性是被放到 system environment 外面的：

老(已废除) 新
ROLLING_FILE_NAME_PATTERN LOGBACK_ROLLINGPOLICY_FILE_NAME_PATTERN
LOG_FILE_CLEAN_HISTORY_ON_START LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START
LOG_FILE_MAX_SIZE LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE
LOG_FILE_TOTAL_SIZE_CAP LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP
LOG_FILE_MAX_HISTORY LOGBACK_ROLLINGPOLICY_MAX_HISTORY

不再注册 DefaultServlet

从 Spring Boot 2.4 开始，默认将不会再注册 DefaultServlet。因为在绝大多数的利用中，Spring MVC 提供的DispatcherServlet 是惟一 须要被注册的 Servlet。从源码处感触下这次改变：

AbstractServletWebServerFactory：// 2.4.0 之前版本，默认值是 true
private boolean registerDefaultServlet = true;
// 2.4.0 以及之后版本，默认值是 false
private boolean registerDefaultServlet = false;

当然喽，若你的工程强依赖于此 Servelt，那么能够通过此配置项 server.servlet.register-default-servlet = true 把它注册下来。

补课：什么是 DefaultServlet？

它是 Java EE 提供的规范技术，如 Tomcat、Jetty 等都提供了这个类。简而言之它的作用就是兜底（拦挡 /），当别的 servlet 都没匹配上时就交给它来解决，个别用于解决动态资源如.jpg,.html,.js 这类的动态文件。

DefaultServlet在传统 web 容器里，会被配置在 tomcat 目录（此处以 tomcat 为例）下的 conf/web.xml 里：

<servlet>
    <servlet-name>default</servlet-name>
    <servlet-class>org.apache.catalina.servlets.DefaultServlet</servlet-class>
    <init-param>
        <param-name>debug</param-name>
        <param-value>0</param-value>
    </init-param>
    <init-param>
        <param-name>listings</param-name>
        <param-value>false</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>default</servlet-name>
    <url-pattern>/</url-pattern>
</servlet-mapping>

阐明：tomcat 下的 web.xml 对其加载的所有的 Application 都失效，并且最终和 Application 本人的 web.xml 内容合并，遇雷同的话后者优先级更高

在 Spring Boot 嵌入式容器 里配置是这样的（齐全等价于 xml 配置）：

private void addDefaultServlet(Context context) {Wrapper defaultServlet = context.createWrapper();
    defaultServlet.setName("default");
    defaultServlet.setServletClass("org.apache.catalina.servlets.DefaultServlet");
    defaultServlet.addInitParameter("debug", "0");
    defaultServlet.addInitParameter("listings", "false");
    defaultServlet.setLoadOnStartup(1);
    // Otherwise the default location of a Spring DispatcherServlet cannot be set
    defaultServlet.setOverridable(true);
    context.addChild(defaultServlet);
    context.addServletMappingDecoded("/", "default");
}

值得注意的是：Spring Boot 注册的 DispatcherServlet 的 path 也是 /（笼罩掉了DefaultServelt）。在 Spring MVC 环境下假使是动态资源，也不必 DefaultServelt 费神，Spring MVC 专门提供了一个DefaultServletHttpRequestHandler 用于解决动态资源（尽管最终还是 Dispatcher 给 defaultServlet 去搞定）。

当初的 Spring Boot 服务大都是 REST 服务，并无动态资源须要提供，因而就没有必要启用 DefaultServletHttpRequestHandler 和注册 DefaultServlet 来减少不必要的开销喽。

HTTP traces 不再蕴含 cookie 头

Http traces 默认将不再蕴含申请头 Cookie 以及响应头Set-Cookie。源码处感受一下：

org.springframework.boot.actuate.trace.http.Include：// 2.4.0 版本之前：蕴含 COOKIE_HEADERS 这个头
static {Set<Include> defaultIncludes = new LinkedHashSet<>();
    defaultIncludes.add(Include.REQUEST_HEADERS);
    defaultIncludes.add(Include.RESPONSE_HEADERS);
    defaultIncludes.add(Include.COOKIE_HEADERS);
    defaultIncludes.add(Include.TIME_TAKEN);
    DEFAULT_INCLUDES = Collections.unmodifiableSet(defaultIncludes);
}
// 2.4.0 版本以及之后：不蕴含 COOKIE_HEADERS 这个头
static {Set<Include> defaultIncludes = new LinkedHashSet<>();
    defaultIncludes.add(Include.REQUEST_HEADERS);
    defaultIncludes.add(Include.RESPONSE_HEADERS);
    defaultIncludes.add(Include.TIME_TAKEN);
    DEFAULT_INCLUDES = Collections.unmodifiableSet(defaultIncludes);
}

若你仍旧想保留老的习惯，那么请用配置项 management.trace.http.include = cookies, errors, request-headers, response-headers 自行管制。

Neo4j

这个版本对 Neo4j 的反对进行了重大调整。间接用源码来阐明差别：

Spring Boot 2.4.0 之前版本：

@ConfigurationProperties(prefix = "spring.data.neo4j")
public class Neo4jProperties implements ApplicationContextAware {...}
// 无 Neo4jDataProperties 配置类

Spring Boot 2.4.0 以及之后版本：

@ConfigurationProperties(prefix = "spring.neo4j")
public class Neo4jProperties {...}
@ConfigurationProperties(prefix = "spring.data.neo4j")
public class Neo4jDataProperties {...}

其它降级关注点

  • Spring Framework 5.3：Spring Boot 2.4.0 应用的是 5.3.0 主线分支（之前应用的 5.2.x 或更低）

    • Spring Framework 5.3 的新个性应该 重点关注，请移步我上篇文章：Spring Framework 5.3.0 正式公布，在云原生路上持续发力

  • Spring Data 2020.0：Spring Boot 2.4.0 应用的是最新公布的 Spring Data 2020.0

    • 此版本的命名形式不同于之前，是因为应用了 Spirng 最新的 release train 命名形式。Spring 在 2020 年 4 月份公布了最新的版本命名形式，可参考后面这篇文章：Spring 扭转版本号命名规定：此举对非英语国家很敌对
  • 反对 Java 15：此版本的 Spring Boot 齐全反对 Java 15，最小反对仍旧是 Java 8
  • 自定义属性名反对：当应用 构造函数绑定 时，属性的名称须要和参数名称放弃一样。如果您想应用 Java 保留关键字，这可能是一个问题。如下例子：
@ConfigurationProperties(prefix = "sample")
public class SampleConfigurationProperties {

  private final String importValue;

  // import 是 Java 关键字
  public SampleConfigurationProperties(@Name("import") String importValue) {this.importValue = importValue;}

}

@Name 注解是 Spring Boot 2.4.0 新增的注解，能标注在 ElementType.PARAMETER 上

  • 反对导入无扩展名的配置文件：如果您有这样的需要，当初就能够通过向 Spring Boot 疏导提供对于内容类型的提醒来导入这些文件

    • 此版本对 Spring Boot 的配置文件加载进行了齐全从新革新，并且不向下兼容，具体参见 下篇文章

  • 新增 StartupEndpoint：显示无关应用程序启动的信息。此端点能够帮忙您辨认启动工夫超过预期的 bean

    • 此端点依赖于 Spring Framework 5.3.0 新提供的利用启动追踪新个性。具体可参考 ApplicationStartup 和StartupStep这个两个 API 是如何做追踪的

  • 新增 RedisCacheMetrics：用于监控应用 redis 时的 puts、gets、deletes 以及缓存命中率等信息

    • 此指标信息默认不开启，需你减少配置spring.cache.redis.enable-statistics = true

  • 新增些 Web 配置项：spring.web.locale、spring.web.locale-resolver、spring.web.resources.*、management.server.base-path，这些属性既反对 Servlet 也反对 WebFlux

    • 对应的 只能用于 Spring MVC 或 servelt 下配置项spring.mvc.locale/spring.mvc.locale-resolver/spring.resources.*/management.server.servlet.context-path 均以标注为过期
  • 反对 Flyway 7：这个版本升级到 Flyway 7，带来了一些额定的属性。如：spring.flyway.url/user/password（开源版本）；spring.flyway.cherry-pick/jdbc-properties...（团队版本）
  • H2 数据库控制台反对配置明码 ：可通过spring.h2.console.settings.web-admin-password 属性配置通过明码拜访 H2 控制台
  • 加强的谬误分析器 FailureAnalizers：当初即便你还没有创立 ApplicationContext，FailureAnalizers 都会失效来帮你定位谬误地位
  • 解决 / 标注 Spring Boot 2.2 和 2.3 中过期项 ：依照 Spring Boot 的 版本兼容性政策 ，在 2.2 版本已被标记为@Deprecated 的在 2.4.0 版本会被删除，在 2.3 版本中被标记为 @Deprecated 的打算在 2.5.0 版本中将其移除

✍总结

这是 A 哥奉给大家的，对 Spring Boot2.4.0 版本新个性的介绍，心愿对你有些帮忙。

Spring Boot 2.4.0 版本的降级指标，根本和 Spring Framework 5.3.0 保持一致：为云原生做致力 。体现在除了删除些无用类，禁止不须要的类的加载外，重点还会体现在它对 配置文件加载机制 的重构上，这将是下文的内容，也是本次降级的重头戏，敬请关注。

Spring Boot 重写了对配置文件的加载机制，并且新引入了近 40 个类来解决（老形式仅有区区几个类），可见其器重、重要水平。因而，为了适应将来的倒退，你肯定要把握，并且越早越好，下篇将为你揭晓。

✔举荐浏览：
  • 如果程序员和产品经理都用凡尔赛文学对话 ……
  • Spring Framework 5.3.0 正式公布，在云原生路上持续发力
  • Spring 扭转版本号命名规定：此举对非英语国家很敌对
  • JDK15 正式公布，划时代的 ZGC 同时发表转正
  • IntelliJ IDEA 2020.2 正式公布，诸多亮点总有几款能助你提效
  • Spring Boot 2.3.0 正式公布：优雅停机、配置文件地位通配符新个性一览
  • 搞事件？Spring Boot 明天一口气公布三个版本

♥关注 A 哥♥

Author A 哥(YourBatman)
集体站点 www.yourbatman.cn
E-mail yourbatman@qq.com
微 信 fsx1056342982
沉闷平台
公众号 BAT 的乌托邦（ID：BAT-utopia）
常识星球 BAT 的乌托邦
每日文章举荐 每日文章举荐

退出移动版