写点什么

Spring 进阶:定义 bean 时容易踩的两个坑,连老手也容易犯错

作者:程序员拾山
  • 2023-03-05
    河南
  • 本文字数:1776 字

    阅读完需:约 6 分钟

Spring 的核心是 IOC,而 IOC 的核心就是去维护一个个的 bean,当我们使用 Spring 时,定义一个 bean 是很普通也很重要的操作。


得益于 Spring 的“约定大于配置”,让我们定义一个 bean 变得非常简单,但是在有些场景下,我们可能还是会犯一些经典的错误。


今天,我们来梳理一下,这两个看起来很基础,但是又很容易翻车的经典错误。

1,包扫描路径配置不当导致请求 404


我们使用 Spring boot 快速构建一个 web 应用,启动类 application 类定义如下:


@SpringBootApplicationpublic class Demo2023Application {
public static void main(String[] args) { SpringApplication.run(Demo2023Application.class, args); }
}
复制代码


我们再定一个 Controller,


@RestController@RequestMapping(value = "/demo")public class DemoController {
@RequestMapping(value = "/hello") public String hello(){ return "hello world!"; }}
复制代码


项目目录如下图:



通过简单的两步,我们就能对外提供一个 http 服务。


正常来说,通过访问 http://localhost:8080/demo/hello 就能返回 hello world!。


但你可能会惊愕地发现,访问这个接口却返回了 404。


{  "timestamp": "2022-11-27T07:28:40.148+00:00",  "status": 404,  "error": "Not Found",  "message": "No message available",  "path": "/demo/hello"}
复制代码


有经验的同学可能立马就能反应过来,DemoController 这个类没有被 Spring 扫描到,所以才出现了 404。


大家可能注意到了,我在图 1 特意将 Demo2023Application 所在目录框了出来,我们将其挪个位置,放到包的最外层。



我们再访问 http://localhost:8080/demo/hello,这时结果可以正常返回了:


http://localhost:8080/demo/hello
HTTP/1.1 200 Content-Type: text/plain;charset=UTF-8Content-Length: 12Date: Sun, 27 Nov 2022 07:46:52 GMTKeep-Alive: timeout=60Connection: keep-alive
hello world!
Response code: 200; Time: 92ms (92 ms); Content length: 12 bytes (12 B)
复制代码


这就是新手同学最容易犯的一个错:包扫描路径配置不当。


为什么我们将启动类放在包的最外层就可以了呢?


其实原理很简单,当我们未配置 @SpringBootApplication 注解中的 scanBasePackages 扫描的范围时,Spring 默认会以当前类所在的包往下扫描。


所以,在我们实际项目开发中,将启动类放在目录最外层,并且手动配置包扫描路径是一个非常值得提倡的做法。


@SpringBootApplication(scanBasePackages = "com.shishan.demo2023.*")
复制代码

2,定义的原型 bean 没有生效


默认情况下,Spring 维护的 bean 都是单例,但是有时候我们也需要一些非单例 bean,比如 prototype。


定义一个 bean 为 prototype 类型很简单,使用 @Scope 注解即可。


@Service@Scope(value = ConfigurableBeanFactory.SCOPE_PROTOTYPE)public class DemoBean {  //....}
复制代码


定义很简单,但是使用的时候可能并不会产生如我们预期的结果。


请看下面这个例子:


@RestController@RequestMapping(value = "/demo")public class DemoController {
@Autowired private DemoBean demoBean;
@RequestMapping(value = "/hello") public String hello(){ return "hello world! I am " + demoBean; }}
复制代码


按照预期,每次访问/demo/hello,返回的应该都是一个新的 DemoBean 实例。


但是结果可能让大家失望了,不论访问多少次,结果返回的都是:


hello world! I am com.shishan.demo2023.bean.DemoBean@3b9c9596
复制代码


为什么会这样呢?@Scope 注解有 bug?


其实问题出现在 @Autowired private DemoBean demoBean;


当一个单例的 bean,使用 @Autowired 声明引入属性时,这个属性值会固定下来,造成的结果就是我们定义的原型 bean 失效了。


大家如果在项目中使用过 prototype,不妨检查一下,自己有没有踩过这种坑。


解决方案:


1,指定 @Scope 的代理模式


我们在使用 @Scope 注解时,不仅可以指定 value,还可以指定 proxyMode,如果 proxyMode 指定为 ScopedProxyMode.TARGET_CLASS,这样每次都会通过 cglib 代理产生一个新的代理类。



2,通过 @Lookup 注解



3,通过 ApplicationContext 获取类实例



最后


Spring 默认帮我们做了很多工作,使我们开发功能变得非常便捷,但是如果不了解背后的运行原理,大多数情况下可能项目也能跑起来,然而一旦出错就可能抓瞎了。


多了解其后的原理,解决问题的能力也会越来越高。


毕竟,有些坑,踩一次就够了。


发布于: 刚刚阅读数: 3
用户头像

JAVA技术分享,全网同名 2019-06-19 加入

学习如逆水行舟,不进则退

评论

发布
暂无评论
Spring进阶:定义bean时容易踩的两个坑,连老手也容易犯错_spring_程序员拾山_InfoQ写作社区