一、@ComponentScan
1.1、spring默认加载类的方式
当我们启动Spring项目的时候,Spring就会扫描启动引导类所在包及其子包中的类,并将这些加了注解的类创建对象,再放到Spring的容器中。
演示例子:
启动引导类UserWebApplication在user-web模块中的com.fuwei.user包中,并且在user-web模块中的pom.xml文件中依赖了user-api模块
user-api模块中的KycAddressApiServiceImpl的路径为com.fuwei.user.api.service.impl
此时在user-web模块中的UserWebApplicationTests 中注入KycAddressController,并调用里面的play方法
UserWebApplicationTests 中的代码
package com.fuwei.user;
import com.fuwei.user.controller.kyc.KycAddressController;
import jakarta.annotation.Resource;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest(classes = {UserWebApplication.class})
class UserWebApplicationTests {
@Resource
private KycAddressController kycAddressController;
@Test
void contextLoads() {
String play = kycAddressController.play();
System.out.println("play = " + play);
}
@Test
void contextLoads2() {
String eat = kycAddressController.eat();
System.out.println("eat=" + eat);
}
}
KycAddressController中的代码:
package com.fuwei.user.controller.kyc;
import com.fuwei.user.api.service.KycAddressApiService;
import jakarta.annotation.Resource;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api/kyc/address")
public class KycAddressController {
@Resource
private KycAddressApiService kycAddressApiService;
public String play() {
return "好好玩";
}
public String eat() {
String eat = kycAddressApiService.eat();
return eat;
}
}
KycAddressApiServiceImpl中的代码
package com.fuwei.user.api.service.impl;
import com.fuwei.user.api.resp.EditKycAddressVo;
import com.fuwei.user.api.resp.ResultBean;
import com.fuwei.user.api.service.KycAddressApiService;
import org.springframework.stereotype.Service;
@Service
public class KycAddressApiServiceImpl implements KycAddressApiService {
//@Resource
//private KycAddressService kycAddressService;
@Override
public ResultBean createKycAddress(String customerNo, EditKycAddressVo vo) {
return null;
}
@Override
public String eat() {
return "狗吃肉";
}
}
运行UserWebApplicationTests 中的contextLoads和contextLoads2
运行后的得到结果:
从结果中可以看到user-web模块中的KycAddressController,和user-api模块中的KycAddressApiServiceImpl都成功从spring的容器中获取了。
1.2、使用@ComponentScan注解加载的方式
在@ComponentScan注解中加上路径:com.fuwei.web
再次运行UserWebApplicationTests 中的contextLoads和contextLoads2得到结果
发现Spring容器中已经找不到UserWebApplicationTests ,这是因为在启动引导类上加上 @ComponentScan注解指定扫描包的位置。spring就不会再去扫描启动引导类所在包及其子包上的注解。
在@ComponentScan注解中加上路径:com.fuwei.web,,com.**
再次行UserWebApplicationTests 中的contextLoads和contextLoads2,同样能够得到好好玩和狗吃肉这两个正确的结果。
原因:在@ComponentScan注解中加上路径:com.fuwei.web,,com.**后,spring就会扫描com.fuwei.web包及其子包和com包及其子包
@ComponentScan注解后面的路径可以有1个也可以有多个(2个及2个以上),只要满足其中一个路径就会被扫描到。上面的com.fuwei.web,,com.**路径有些重复,因为com包及其子包就包含了com.fuwei.web包及其子包
1.3、@SpringBootApplication中的scanBasePackages和@ComponentScan效果一样
像上面的例子如果在同一配置类中同时使用这两个方式,@ComponentScan的配置会覆盖@SpringBootApplication的scanBasePackages配置。
1.4、总结
1、当我们启动Spring项目的时候,Spring就会扫描启动引导类所在包及其子包中的类,并将这些加了注解的类创建对象,再放到Spring的容器中
2、在启动引导类上加上 @ComponentScan注解指定扫描包的位置。spring就不会再去扫描启动引导类所在包及其子包上的注解。
3、@SpringBootApplication中的scanBasePackages和@ComponentScan效果一样,但是如果在同一配置类中同时使用这两个方式,@ComponentScan的配置会覆盖@SpringBootApplication的scanBasePackages配置。
4、上面1、2、3中的所有情况同样适用启动引导类所在模块依赖的模块,例如启动引导类在user-web模块中,user-web模块中的pom.xml文件引入了user-api模块的依赖,那么user-web模块中的启动引导类同样能扫描到user-api模块中的注解并创建对象。
二、@MapperScan
通过@MapperScan注解可以指定要扫描的Mapper接口的包路径。
这样,@MapperScan会自动为指定包中的所有接口创建MyBatis的代理实现,无需在每个Mapper接口上再添加@Mapper注解
com.fuwei.user.api.dao包中的所有mapper都不用在每个mapper上面加@Mapper注解