01｜Spring Bean 定义常见错误

傅健

你好，我是傅健。
从导读中我们已知，Spring 的核心是围绕 Bean 进行的。不管是 Spring Boot 还是 Spring Cloud，只要名称中带有 Spring 关键字的技术都脱离不了 Bean，而要使用一个 Bean 少不了要先定义出来，所以定义一个 Bean 就变得格外重要了。
当然，对于这么重要的工作，Spring 自然给我们提供了很多简单易用的方式。然而，这种简单易用得益于 Spring 的“约定大于配置”，但我们往往不见得会对所有的约定都了然于胸，所以仍然会在 Bean 的定义上犯一些经典的错误。
接下来我们就来了解下那些经典错误以及它们背后的原理，你也可以对照着去看看自己是否也曾犯过，后来又是如何解决的。
案例 1：隐式扫描不到 Bean 的定义在构建 Web 服务时，我们常使用 Spring Boot 来快速构建。例如，使用下面的包结构和相关代码来完成一个简易的 Web 版 HelloWorld：
其中，负责启动程序的 Application 类定义如下：
package com.spring.puzzle.class1.example1.application
//省略 import
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
提供接口的 HelloWorldController 代码如下：
package com.spring.puzzle.class1.example1.application
//省略 import
@RestController
public class HelloWorldController {
    @RequestMapping(path = "hi", method = RequestMethod.GET)
    public String hi(){
         return "helloworld";
    };
}
上述代码即可实现一个简单的功能：访问http://localhost:8080/hi 返回 helloworld。两个关键类位于同一个包（即 application）中。其中 HelloWorldController 因为添加了 @RestController，最终被识别成一个 Controller 的 Bean。

公开

同步至部落

取消

完成

0/2000

荧光笔

直线

曲线

笔记

复制

AI

深入了解
翻译
英语
中文简体
中文繁体
法语
德语
日语
韩语
俄语
西班牙语
阿拉伯语
解释
总结

Spring框架中Bean定义常见错误及修正方法 Spring框架的核心围绕着Bean展开，而定义一个Bean变得格外重要。然而，由于Spring的“约定大于配置”，在Bean的定义上往往会犯一些经典的错误。本文通过两个案例展示了常见的错误及其原理。第一个案例介绍了隐式扫描不到Bean的定义的问题。作者通过分析Spring Boot的默认扫描规则，解释了在调整包结构后，原本有效的Web应用失效的原因，并提出了显式配置@ComponentScan或使用@ComponentScans修复问题的方式。第二个案例讲解了定义的Bean缺少隐式依赖的问题。通过分析Spring创建Bean实例的过程，解释了为什么在定义Bean时缺少隐式依赖会导致装配失败的问题。另外，文章还介绍了关于原型Bean被固定的问题，并提出了两种修正方式：自动注入ApplicationContext或使用Lookup注解。总的来说，本文通过具体案例分析了Spring Bean定义中的常见错误，并深入解释了错误背后的原理。读者可以从中了解到Spring Bean定义中的一些容易忽略的细节，以及如何避免这些错误。文章深入浅出地解释了Spring框架中的一些潜规则，以及通过反射来完成的实现方式，对于理解Spring框架的源码实现有很大帮助。通过这些案例的分析，读者也能感受到Spring的很多实现是通过反射来完成的，了解了这点，对于理解它的源码实现会大有帮助。最后，文章提出了一个思考题，引发读者对于案例2中的问题进行思考。总的来说，本文通过具体案例分析了Spring Bean定义中的常见错误，并深入解释了错误背后的原理，对于读者快速了解Spring框架中Bean定义的常见错误及修正方法具有很好的指导意义。

仅可试看部分内容，如需阅读全部内容，请付费购买文章所属专栏
《Spring 编程常见错误 50 例》，新⼈⾸单¥59

立即购买

登录后留言

全部留言(33)

最新
精选

小不点
先马后看，从Netty过来的，Netty篇章反复看了好久才算整明白，希望这次也一样
作者回复: 你这个昵称我还记得，多谢支持！这个肯定也类似，源码分析类的课程都差不多，要多看二篇！不行就对着github上的案例自己调试下。
2021-04-21
2

许金亮
案例 3：原型 Bean 被固定 service可以使用scope注解的proxyMode，设置成target_class，这样注入到controller的bean就是代理对象了，每次都会从beanfactory里面重新拿过 @Scope(value = "prototype", proxyMode = ScopedProxyMode.TARGET_CLASS)
2021-04-21
5
49
点点
@Scope(value=ConfigurableBeanFactory.SCOPE_PROTOTYPE)这个是说在每次注入的时候回自动创建一个新的bean实例 @Scope(value=ConfigurableBeanFactory.SCOPE_SINGLETON)单例模式，在整个应用中只能创建一个实例 @Scope(value=WebApplicationContext.SCOPE_GLOBAL_SESSION)全局session中的一般不常用 @Scope(value=WebApplicationContext.SCOPE_APPLICATION)在一个web应用中只创建一个实例 @Scope(value=WebApplicationContext.SCOPE_REQUEST)在一个请求中创建一个实例 @Scope(value=WebApplicationContext.SCOPE_SESSION)每次创建一个会话中创建一个实例里面还有个属性 proxyMode=ScopedProxyMode.INTERFACES创建一个JDK代理模式 proxyMode=ScopedProxyMode.TARGET_CLASS基于类的代理模式 proxyMode=ScopedProxyMode.NO（默认）不进行代理
2021-05-06
1
26
Monday
亲测： 1、@ComponentScan可以多个同时使用，且都生效。效果等同于@ComponentScans 2、@ComponentScans不能与@ComponentScan一起使用
2021-06-15
1
12
Bumblebee
今日收获 ① Spring默认扫描包是application类（@SpringBootApplication）所在的包，通过@ComponentScans或@ComponentScan直接可以指定需要扫码的包； ② Bean的定义缺少隐式依赖； @Service public class ServiceImpl { private String serviceName； public ServiceImpl(String serviceName){ this.serviceName = serviceName; } } 1）上述代码中的serviceName如果不是Spring容器的Bean创建ServiceIml Bean时会报错，因为Spring创建Bean时会调用AbstractAutowireCapableBeanFactory#createBeanInstance，他主要是通过反射获取构造器，通过构造器创建Bean，此时获取到的构造器是一个携带参数的构造，为了获取此构造器的参数serviceName，会从Spring容器中去获取，获取不到则报错； 2）需要Spring管理的类不能有多个构造函数，因为Spring在创建Bean时无法确定该调用那个构造函数，会报错； ③ 原型Bean被固定； 1）被@Autowired修饰的成员变量会在所属Bean被创建后，执行BeanPostProcessor给属性注入值，只注入一次，因为对于被@Autowired修饰的原型Bean，每次想获取到一个全新的Bean，是不能达到目的的； 2）对于原型Bean每次想获取到一个全新的Bean可以从AppliactionContext获取，或者通过@LookUp注解获取，示例代码如下； @Lookup public ServiceImpl getServiceImpl(){ return null; } 被@LookUp注解修饰的方法本身实现不重要
2022-05-25

9
Geek_ca230e
案例1 也可以用这样的方式显示指定扫描包：@SpringBootApplication(scanBasePackages = {"com.xxx.xxxxx","com.xxx.xxx"})
2021-05-08
1
9
Sway
想咨询一下，是怎么通过 ComponentScan 注解，找到 ComponentScanAnnotationParser 这个类的？在看其他的项目时，看到很多注解，但是想了解它具体做了什么工作，却无从下手。（很可能项目并不能跑起来去 DEBUG ）
2021-04-21
4
5
jzhongchen
案例 3：原型 Bean 被固定设置scope为prototype的bean是每次调用的时候会产生一个新的bean，案例中由于controller没有设置scope，默认为singleton。每次请求的时候controller是同一个对象，当然service不会变。如果把controller的scope设置为prototype的话，就能够实现每次请求的时候service是一个新对象。 lookup注解以前没有听说过，还是第一次看到。
2021-04-27
3
4
学无涯
问题： 1、关于用@ComponentScan修正那段代码，是不是少写了ComponentScan 2、JDK 1.8已经支持Repeatable注解，那是不是就不需要用@ComponentScans注解了，直接添加多个@ComponentScan注解就行思考题：可以给构造器的参数添加@Autowired(required = false)就不会报错了
2021-04-21
1
4
慎独明强
对于案例3: 最近项目中，我使用构造器模式，构造器scop指定的为prototype；通过autowired去注入构造器；我感觉我自己就踩坑了...在测试过程中由于没有多线程去使用构造器，数据看不出来，待会去增加一个日志看下，是否返回都是同一个对象。
2021-04-23
1
3

收起评论