记一次SpringCloudAlibaba升级踩坑记录

妖狐艹你老母 2023-09-26 20:24 28阅读 0赞

## 前言 ##

本文主要介绍在升级`SpringCloudAlibaba`版本的时候遇到的两个坑：一是`bootstrap`配置文件不生效问题，二是如何不使用`bootstrap`配置文件来与`Nacos`整合。

## 正文 ##

公司项目技术框架用的是`SpringCloudAlibaba`系列，最近要启动一个新项目，想着既然是新项目就用一些新版本的组件，于是开始了版本升级折腾之旅。

### 版本问题 ###

公司目前其他项目使用的版本如下：

*  SpringBoot：2.3.12.RELEASE
 *  SpringCloud：2.2.9.RELEASE
 *  SpringCloudAlibaba：2.2.7.RELEASE

由于之前有客户要求指定项目使用`SpringBoot`的版本为`2.5.6`，所以先把`SpringBoot`的版本定下了暂定为`2.5.6`。于是打开项目脚手架打算生成一个项目框架，结果打开网页傻眼了，为啥`SpringBoot`版本没有`2.5.x`呢？？

![format_png][]

然后，打开`SpringCloudAlibaba`的`GitHub`的版本说明，嗯？也是没有`SpringBoot2.5.x`的版本。

![format_png 1][]

后来，查看Spring的官网，发现SpringBoot2.5.x和SpringBoot2.4.x对应SpringCloud的版本都是2020.0.x。通过这个网址也可以查到[start.spring.io/actuator/in…][start.spring.io_actuator_in]。

最后，因为这个项目比较小，也不太重要，就用了SpringCloudAlibaba GitHub上2021.x分支的最新版本，最终引入版本如下：

![format_png 2][]

### bootstrap配置文件 ###

基本的`Jar`版本弄好了，把原来项目的`bootstrap.yaml`文件复制一份改一改，启动项目试试吧，配置文件内容如下：

spring:
      application:
        name: example
      cloud:
        nacos:
          username: nacos
          password: nacos
          server-addr: 127.0.0.1:8848
          config:
            namespace: test
            file-extension: yaml
            extension-configs:
              - data-id: common-redis.yaml
          discovery:
            namespace: test
    复制代码

不出意外的话，就要出意外了，项目无法启动，还给出了提示没有spring.config.import属性：

![format_png 3][]

嗯？什么鬼？于是面向`ChatGPT`编程，得知在`SpringBoot 2.4.x`的版本之后，对于`bootstrap.properties`/`bootstrap.yaml`配置文件的支持，需要导入`spring-cloud-starter-bootstrap`依赖。

![format_png 4][]

废话不多说，加上以下依赖启动项目，嗯？居然可以了。这么神奇吗？什么原理？难道这个依赖包里做了什么解析配置的东西？

implementation 'org.springframework.cloud:spring-cloud-starter-bootstrap:3.1.5'
    复制代码

找到这个依赖包，打开看看里面有神奇的处理，打开之后发现只有一个`Marker`类而且还是一个抽象的，难道是这个依赖包又依赖了其他的依赖？打开`pom`，发现也只是依赖了`spring-cloud-starter`。

随后，看到了`Marker`类上面有一段注释，意思是这是一个标记类，如果存在的话就会启用`bootstrap`，效果和`spring.cloud.bootstrap.enabled=true`一样。也就是如果有`spring.cloud.bootstrap.enabled=true`这个配置的话，也可以不用加上这个依赖。

![format_png 5][]

来，再来试一次，加上启动参数`-Dspring.cloud.bootstrap.enabled=true`，然后去掉`spring-cloud-starter-bootstrap`依赖，启动项目，效果是一样的。

到底什么原理呢？`debug`走一下流程，发现在这里有个判断`BootstrapApplicationListener#onApplicationEvent`，是否启用`bootstrap`，启用的条件是`spring.cloud.bootstrap.enabled`属性为`true`，或者存在`org.springframework.cloud.bootstrap.marker.Marker`这个标记类，啊！终于明白了。

![format_png 6][]

![format_png 7][]

### application配置文件 ###

原本到这里就可以结束了，又想到，如果不使用`bootstrap`配置文件的话，该如何改呢？换成`application.yaml`试试。

发现还是报`No spring.config.import property has been defined`这个错误，那就加上这个属性试试。那么值是什么呢？查了下`SpringCloudAlibaba`的官方示例，需要把`nacos`中的配置通过`import`导入进来，修改如下：

spring:
      application:
        name: example
      cloud:
        nacos:
          username: nacos
          password: nacos
          server-addr: 127.0.0.1:8848
          config:
            namespace: test
            file-extension: yaml
          discovery:
            namespace: test
      config:
        import:
          - nacos:example   
          - nacos:common-redis.yaml
    复制代码

再次运行项目就可以了。

## 总结 ##

本次升级`SpringCloudAlibaba`版本遇到的几个问题，记录一下，虽然折腾但还是有些收货的，最后，还是没有弄清楚问什么`SpringCloud`把`bootstrap`配置文件从默认启用改成不启用了呢，有没有小伙伴知道的给说下？

[format_png]: https://img-blog.csdnimg.cn/img_convert/dd6d27e569550f6e02a976b9bfbd3556.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/660262274e8f5679bbc4dfcc752ff82c.webp?x-oss-process=image/format,png
[start.spring.io_actuator_in]: https://link.juejin.cn?target=https%3A%2F%2Fstart.spring.io%2Factuator%2Finfo
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/e795cde762e0d14601ee8c5474e00330.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/1745e04110e369d46ee58fe36a21b77b.webp?x-oss-process=image/format,png
[format_png 4]: https://img-blog.csdnimg.cn/img_convert/f29b71c3a9dc71c484ef100844057fd9.webp?x-oss-process=image/format,png
[format_png 5]: https://img-blog.csdnimg.cn/img_convert/2bf74386612a892868557f41a6619d1e.webp?x-oss-process=image/format,png
[format_png 6]: https://img-blog.csdnimg.cn/img_convert/4dcb1e5286de4bf0717eed7919130070.webp?x-oss-process=image/format,png
[format_png 7]: https://img-blog.csdnimg.cn/img_convert/3bdd340c94a360c409fac09f19a00f23.webp?x-oss-process=image/format,png