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

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

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

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

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

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

@SpringBootApplication
public 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!";
    }
}

项目目录如下图：

图1

通过简单的两步，我们就能对外提供一个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所在目录框了出来，我们将其挪个位置，放到包的最外层。

图2

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

http://localhost:8080/demo/hello

HTTP/1.1 200 
Content-Type: text/plain;charset=UTF-8
Content-Length: 12
Date: Sun, 27 Nov 2022 07:46:52 GMT
Keep-Alive: timeout=60
Connection: 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代理产生一个新的代理类。

图3

2，通过@Lookup注解

图4

3，通过ApplicationContext获取类实例

图5

最后

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

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

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

学习技术，分享技术，期待与大家共同进步，也感谢您的点赞与关注。