Skip to content

Commit 83e5b2f

Browse files
committed
Update: 新增文章《SpringBoot常见错误及解决方法》
1 parent edc4757 commit 83e5b2f

18 files changed

+219
-101
lines changed

README.md

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,8 @@
4545

4646
### 3. 事后诊断
4747
#### 3.1 系统诊断
48-
##### 3.1.1 CPU
4948
###### [So Hot?快给 CPU 降降温](docs/diagnosis/system/cpu/SoHot?快给CPU降降温.md)
50-
##### 3.1.2 Load 高
51-
##### 3.1.3 网络诊断
52-
##### 3.1.4 磁盘诊断
53-
49+
###### [记一次线上内存报警排查过程](docs/diagnosis/system/memory/case/记一次线上内存报警排查过程.md)
5450

5551
#### 3.2 JVM 诊断
5652
##### 3.2.1 异常诊断
@@ -69,14 +65,9 @@
6965

7066

7167
#### 3.3 组件诊断
72-
##### 3.3.1 数据库诊断
73-
##### 3.3.2 缓存诊断
74-
##### 3.3.3 消息诊断
75-
##### 3.3.4 RPC 诊断
7668
###### [Dubbo 常见错误及解决方法](docs/diagnosis/plugin/rpc/系统稳定性——Dubbo常见错误及解决方法.md)
77-
##### 3.3.5 流计算诊断
78-
##### 3.3.6 软负载诊断
79-
###### [Nacos常见问题及解决方法](docs/diagnosis/plugin/slb/Nacos常见问题及解决方法.md)
69+
###### [Nacos 常见问题及解决方法](docs/diagnosis/plugin/slb/Nacos常见问题及解决方法.md)
70+
###### [Spring Boot 常见错误及解决方法](docs/diagnosis/plugin/microservice/SpringBoot常见错误及解决方法.md)
8071

8172
#### 3.4 在线诊断
8273
##### Arthas
@@ -114,10 +105,12 @@
114105
* [Nacos常见问题及解决方法](docs/diagnosis/plugin/slb/Nacos常见问题及解决方法.md)@敦谷
115106
* [数据一致性检测应用场景与最佳实践](docs/processing/lostprevention/数据一致性检测应用场景与最佳实践.md)@龙多
116107
* [链路追踪(Tracing)其实很简单——初识](docs/diagnosis/tracing/链路追踪(Tracing)其实很简单——初识.md)@涯海
117-
* 2019-10-10
108+
* 2019-11-07
118109
* [链路追踪(Tracing)其实很简单——单链路诊断](docs/diagnosis/tracing/链路追踪(Tracing)其实很简单——单链路诊断.md)@涯海
110+
* [Spring Boot 常见错误及解决方法](docs/diagnosis/plugin/microservice/SpringBoot常见错误及解决方法.md),@洛夜
111+
* [记一次线上内存报警排查过程](docs/diagnosis/system/memory/case/记一次线上内存报警排查过程.md)@神帅
112+
* 待定
119113
* SchedulerX 常见问题及解决方法,@学仁
120-
* SpringCloud 常见问题及解决方法,@洛夜
121114
* RocketMQ 常见问题及解决方法,@丁磊
122115
* 流计算诊断,@云邪
123116
* 慢 SQL 常见原因及解决方法,@长源
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Spring Boot 常见错误及解决方法
2+
3+
> 作者:方剑(洛夜)
4+
> 创作日期:2019-10-28
5+
> 专栏地址:[【稳定大于一切】](https://github.com/StabilityMan/StabilityGuide)
6+
> PDF 格式:[Spring Boot 常见错误及解决方法](https://github.com/StabilityMan/StabilityGuide/blob/master/docs/diagnosis/jvm/microservice/pdf/SpringBoot常见错误及解决方法.pdf)
7+
8+
Spring Boot 作为 Java 生态中最流行的开发框架,意味着被数以万计的开发者所使用。下面根据我们自身遇到的问题,加上用户提供的一些反馈,来大致梳理下 Spring Boot 的常见错误及解决方法。
9+
10+
## 目录
11+
- [找不到配置?配置不对?配置被覆盖?](#找不到配置配置不对配置被覆盖)
12+
- [Jar 包启动不了](#jar-包启动不了)
13+
- [自动化配置类没有被加载](#自动化配置类没有被加载)
14+
- [定义的 Component 没有被扫描到](#定义的-component-没有被扫描到)
15+
- [推荐项目](#推荐项目)
16+
- [加入我们](#加入我们)
17+
18+
19+
## 找不到配置?配置不对?配置被覆盖?
20+
21+
Spring Boot 配置加载过程解析:
22+
23+
- Spring Boot 配置的加载有着约定俗成的步骤: 从 resources 目录下加载 application.properties/application.yml; 再根据里面的  `spring.profiles.active` 来加载不同 profile 的配置文件 application-dev.properties/application-dev.yml (比如加载 profile 为 dev 的配置文件)
24+
- Spring Boot 所有的配置来源会被构造成 PropertySource,比如 -D 参数, -- 参数, 系统参数, 配置文件配置等等。这些 PropertySource 最终会被添加到 List 中,获取配置的时候会遍历这个 List,直到第一次获取对应 key 的配置,所以会存在优先级的问题。具体配置的优先级参考: [https://stackoverflow.com/a/45822571](https://stackoverflow.com/a/45822571)
25+
26+
配置覆盖案例:
27+
28+
Nacos 服务注册的 IP 可以通过 `spring.cloud.nacos.discovery.ip` 设置,当我们打成 JAR 包之后,如需修改注册 IP,可以通过 `-Dspring.cloud.nacos.discovery.ip=xxx`(-D 参数配置的优先级比配置文件要高)。
29+
30+
配置问题排查:
31+
32+
查看 Stackoverflow 中的各个数据来源,确定配置的属于哪个 PropertySource 或者 Debug 查看 Environment 中的各个 PropertySource 中的配置。
33+
34+
思考: 其实 Spring Boot 可以实现  ConfigurationEndpoint 通过暴露 Endpoint 来查看用户侧到底配置了哪些配置内容。
35+
36+
37+
## Jar 包启动不了
38+
39+
执行 Spring Boot 构建的 jar 包后,返回 "my.jar中没有主清单属性" 错误。
40+
41+
错误分析: Spring Boot 的正常 jar 包运行方是通过 spring-boot-loader 这个模块里的 JarLauncher 完成的,该类内部提供了一套运行的规范。
42+
43+
解决方案: 在 pom 里加上 spring-boot-maven-plugin 的 maven 插件配置(该插件会在 jar 里加入 spring-boot-loader 的代码,并在 MANIFEST.MF 中的 Main-Class 里写入 JarLauncher):
44+
45+
```xml
46+
<plugin>
47+
<groupId>org.springframework.boot</groupId>
48+
<artifactId>spring-boot-maven-plugin</artifactId>
49+
</plugin>
50+
```
51+
52+
## 自动化配置类没有被加载
53+
54+
条件注解是 Spring Boot 的核心特性之一,第三方的 starter 或我们自定义的 starter 内部都会加载一些 AutoConfiguration,有时候会存在一些 AutoConfiguration 没有被加载的情况。导致出现 NoSuchBeanDefinitionException, UnsatisfiedDependencyException 等异常
55+
56+
排查步骤(两种方式):
57+
58+
1. 把 spring 的日志级别跳到 debug: `logging.level.org.springframework: debug`
59+
2. 从 ApplicationContext 中获取 `ConditionEvaluationReport`,得到内部的 `ConditionEvaluationReport.ConditionAndOutcomes` 类中的输出信息
60+
61+
这是日志打印的不满足条件的 AutoConfiguratoin:
62+
63+
```bash
64+
Unconditional classes:
65+
----------------------
66+
67+
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration
68+
69+
org.springframework.cloud.client.ReactiveCommonsClientAutoConfiguration
70+
71+
org.springframework.boot.actuate.autoconfigure.info.InfoContributorAutoConfiguration
72+
73+
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration
74+
75+
org.springframework.cloud.client.discovery.simple.SimpleDiscoveryClientAutoConfiguration
76+
77+
org.springframework.cloud.client.CommonsClientAutoConfiguration
78+
79+
org.springframework.cloud.commons.httpclient.HttpClientConfiguration
80+
81+
org.springframework.boot.actuate.autoconfigure.endpoint.EndpointAutoConfiguration
82+
83+
org.springframework.cloud.loadbalancer.config.BlockingLoadBalancerClientAutoConfiguration
84+
```
85+
86+
## 定义的 Component 没有被扫描到
87+
88+
@SpringBootApplication 注解内部也会使用 [@ComponentScan ](/ComponentScan ) 注解用于扫描 Component。默认情况下会扫描@SpringBootApplication 注解修饰的入口类的包以及它下面的子包中所有的 Component。
89+
90+
这是推荐的包结构中项目的结构:
91+
92+
![](https://intranetproxy.alipay.com/skylark/lark/0/2019/png/64647/1572239559904-983942e7-4e18-41cd-8c80-dfb8255c53e1.png#alt=undefined)
93+
94+
exclude 包下的类不会被扫描到,card 包下的类会被扫描到。
95+
96+
97+
## 推荐项目
98+
* [Spring Cloud Alibaba 开源项目地址](https://github.com/alibaba/spring-cloud-alibaba)
99+
100+
101+
## 加入我们
102+
【稳定大于一切】打造国内稳定性领域知识库,**让无法解决的问题少一点点,让世界的确定性多一点点**
103+
104+
* [GitHub 地址](https://github.com/StabilityMan/StabilityGuide)
105+
* 钉钉群号:23179349
106+
* 如果阅读本文有所收获,欢迎分享给身边的朋友,期待更多同学的加入!
Binary file not shown.

0 commit comments

Comments
 (0)