3. Spring - IOC - 组件扫描规则

系列篇幅

注解说明

注解说明
@Service用于标注业务层组件
@Controller用于标注控制层组件
@Repository标注数据访问组件,即DAO组件
@Component泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注

引入依赖

lombok 推荐: Lombok 的使用

<dependency>
  <groupId>org.springframework</groupId>
  <artifactId>spring-context</artifactId>
  <version>4.3.12.RELEASE</version>
</dependency>
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.18.10</version>
</dependency>

测试使用的几个类

@Controller
public class BookController {}
@Repository
public class BookRepository {}
@Service
public class BookService {}

注解说明

扫描

public @interface ComponentScan {
  // 指定要扫描的包
	@AliasFor("basePackages")
	String[] value() default {};
  
  // 指定扫描的时候只需要包含哪些组件
  Filter[] includeFilters() default {};
  
  // 指定扫描的时候按规则排除那些组件
  Filter[] excludeFilters() default {};
  
}

过滤规则

注解说明
FilterType.ANNOTATION注解
FilterType.ASSIGNABLE_TYPE给定的类型
FilterType.ASPECTJ使用ASPECTJ表达式
FilterType.REGEX使用正则指定
FilterType.CUSTOM使用自定义规则

xml方式

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">
		
    <!-- 定义包扫描规则 -->
    <context:component-scan base-package="org.example.demo"/>

</beans>

查找

ApplicationContext applicationContext = new ClassPathXmlApplicationContext("beans.xml");
String[] names = applicationContext.getBeanDefinitionNames();
Stream.of(names).forEach(System.out::println);

代码配置

查找

AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MainConfig.class);
// 输出容器内的Bean
String[] names = applicationContext.getBeanDefinitionNames();
Stream.of(names).forEach(System.out::println);

扫描指定的 注解@Controller

@Configuration
@ComponentScan(value = "org.example", includeFilters = {
   @Filter(type = FilterType.ANNOTATION, classes = {Controller.class})
}, useDefaultFilters = false)
public class MainConfig {

}

扫描指定的 BookService.class

@Configuration
@ComponentScan(value = "org.example", includeFilters = {
        @Filter(type=FilterType.ASSIGNABLE_TYPE,classes={BookService.class})
}, useDefaultFilters = false)
public class MainConfig {

}

扫描指定的 自定义注解

@Configuration
@ComponentScan(value = "org.example", includeFilters = {
   @Filter(type=FilterType.CUSTOM,classes={MyTypeFilter.class})
}, useDefaultFilters = false)
public class MainConfig {

}
public class MyTypeFilter implements TypeFilter {

    /**
     * 匹配规则
     * metadataReader:读取到的当前正在扫描的类的信息
     * metadataReaderFactory:可以获取到其他任何类信息的
     */
    @Override
    public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) {
        //获取当前类注解的信息
        AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
        //获取当前正在扫描的类的类信息
        ClassMetadata classMetadata = metadataReader.getClassMetadata();
        //获取当前类资源(类的路径)
        Resource resource = metadataReader.getResource();

        String className = classMetadata.getClassName();
        System.out.printf("当前正在扫描的类 -> %s \r\n", className);
        // 只保留 包含 er字符串的
        return className.contains("er");
    }

}
©️2020 CSDN 皮肤主题: Age of Ai 设计师:meimeiellie 返回首页