Spring Boot 作為 Java 生態(tài)中最流行的開(kāi)發(fā)框架，意味著被數(shù)以萬(wàn)計(jì)的開(kāi)發(fā)者所使用。 下面根據(jù)我們自身遇到的問(wèn)題，加上用戶提供的一些反饋，來(lái)大致梳理下 Spring Boot 的常見(jiàn)錯(cuò)誤及解決方法。

找不到配置？配置不對(duì)？配置被覆蓋?

Spring Boot 配置加載過(guò)程解析:

1、Spring Boot 配置的加載有著約定俗成的步驟: 從 resources 目錄下加載  application.properties/application.yml ; 再根據(jù)里面的  spring.profiles.active  來(lái)加載不同 profile 的配置文件 application-dev.properties/application-dev.yml  (比如加載 profile 為 dev 的配置文件)。

2、Spring Boot 所有的配置來(lái)源會(huì)被構(gòu)造成 PropertySource，比如 -D 參數(shù), -- 參數(shù), 系統(tǒng)參數(shù), 配置文件配置等等。 這些 PropertySource 最終會(huì)被添加到 List 中，獲取配置的時(shí)候會(huì)遍歷這個(gè) List ，直到第一次獲取對(duì)應(yīng) key 的配置，所以會(huì)存在優(yōu)先級(jí)的問(wèn)題。 具體配置的優(yōu)先級(jí)參考:

  https://stackoverflow.com/a/45822571

配置覆蓋案例:

Nacos 服務(wù)注冊(cè)的 IP 可以通過(guò) spring.cloud.nacos.discovery.ip 設(shè)置，當(dāng)我們打成 JAR 包之后，如需修改注冊(cè) IP，可以通過(guò) -Dspring.cloud.nacos.discovery.ip=xxx(-D 參數(shù)配置的優(yōu)先級(jí)比配置文件要高)。

配置問(wèn)題排查:

進(jìn)入  http://host:port/actuator/env   這個(gè) endpoint 查看具體的配置項(xiàng)屬于哪個(gè) PropertySource。

Jar 包啟動(dòng)不了

執(zhí)行 Spring Boot 構(gòu)建的 jar 包后，返回 "my.jar中沒(méi)有主清單屬性" 錯(cuò)誤。

錯(cuò)誤分析: Spring Boot 的正常 jar 包運(yùn)行方是通過(guò) spring-boot-loader 這個(gè)模塊里的 JarLauncher 完成的，該類內(nèi)部提供了一套運(yùn)行的規(guī)范。

解決方案: 在 pom 里加上 spring-boot-maven-plugin 的 maven 插件配置(該插件會(huì)在 jar 里加入 spring-boot-loader 的代碼，并在 MANIFEST.MF 中的 Main-Class 里寫(xiě)入 JarLauncher):

<plugin>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-maven-plugin</artifactId>

</plugin>

自動(dòng)化配置類沒(méi)有被加載

條件注解是 Spring Boot 的核心特性之一，第三方的 starter 或我們自定義的 starter 內(nèi)部都會(huì)加載一些 AutoConfiguration，有時(shí)候會(huì)存在一些 AutoConfiguration 沒(méi)有被加載的情況。 導(dǎo)致出現(xiàn) NoSuchBeanDefinitionException, UnsatisfiedDependencyException 等異常

排查步驟(三種方式):

1、把 spring 的日志級(jí)別調(diào)到 debug 級(jí)別:

 logging.level.org.springframework: debug。

2、從 ApplicationContext 中獲取 ConditionEvaluationReport，得到內(nèi)部的 ConditionEvaluationReport.ConditionAndOutcomes 類中的輸出信息。

3、進(jìn)入  http://host:port/actuator/conditions  這個(gè) endpoint 查看條件注解的 match 情況。

這是日志打印的不滿足條件的 AutoConfiguratoin:

Unconditional classes:

----------------------

org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration

org.springframework.cloud.client.ReactiveCommonsClientAutoConfiguration

org.springframework.boot.actuate.autoconfigure.info.InfoContributorAutoConfiguration

org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration

org.springframework.cloud.client.discovery.simple.SimpleDiscoveryClientAutoConfiguration

org.springframework.cloud.client.CommonsClientAutoConfiguration

org.springframework.cloud.commons.httpclient.HttpClientConfiguration

org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration

org.springframework.cloud.loadbalancer.config.BlockingLoadBalancerClientAutoConfiguration

定義的 Component 沒(méi)有被掃描到

@SpringBootApplication 注解內(nèi)部也會(huì)使用 @ComponentScan 注解用于掃描 Component 。默認(rèn)情況下會(huì)掃描 @SpringBootApplication 注解修飾的入口類的包以及它下面的子包中所有的 Component 。

@ComponentScan：

https://github.com/StabilityMan/StabilityGuide/blob/master/ComponentScan

這是推薦的包結(jié)構(gòu)中項(xiàng)目的結(jié)構(gòu):

exclude 包下的類不會(huì)被掃描到，card 包下的類會(huì)被掃描到。

Actuator Endpoint 訪問(wèn)不了

訪問(wèn) Actuator，出現(xiàn) 404 錯(cuò)誤。

解決方案:

1、Spring Boot 2.x 版本對(duì) Actuator 做了大量的修改，其中訪問(wèn)的路徑從 

http://host:port/endpointid  

變成了

  http://host:port/actuator/endpointid  。

確保訪問(wèn)的路徑正確。

2、Endpoint 有 Security 要求，

在配置里加上 management.endpoints.web.exposure.include=* 即可。

本文作者：

方劍，花名洛夜，GitHub ID @fangjian0423，開(kāi)源愛(ài)好者，阿里巴巴高級(jí)開(kāi)發(fā)工程師，阿里云產(chǎn)品 EDAS 開(kāi)發(fā)，Spring Cloud Alibaba 開(kāi)源項(xiàng)目負(fù)責(zé)人。