springboot中TypeExcludeFilter的使用

TypeExcludeFilter 是 Spring Boot 中用于过滤某些类型的工具类，常用于控制自动配置和组件扫描的范围。它通常与 @Configuration 或 @ComponentScan 结合使用，以便排除某些特定的类型（如类、接口、注解等）在自动扫描或自动配置过程中被加载。

TypeExcludeFilter 的常见用法场景

1. 过滤不需要的 Bean：你可以通过自定义 TypeExcludeFilter 来排除某些特定的类或
   Bean，不让它们在自动配置或者扫描时被加载。
2. 控制自动配置：在某些情况下，某些自动配置类可能不需要，你可以通过 TypeExcludeFilter 来避免它们被加载到应用上下文中。

使用步骤

1.创建自定义的TypeExcludeFilter

首先你需要继承 TypeExcludeFilter，并重写 match 方法。match 方法的返回值决定了某个类是否会被排除。

public class MyTypeExcludeFilter extends TypeExcludeFilter {
    
    private static final Logger log = LoggerFactory.getLogger(MyTypeExcludeFilter.class);

    @Override
    public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {
        String className = metadataReader.getClassMetadata().getClassName();
        log.info("Checking class: {}", className);
        
        // 排除特定类，假设我们不想加载 xxxController 类
        if (className.equals("com.example.xxxController")) {
            return true; // 返回 true 表示排除该类
        }
        return false; // 否则不排除
    }
}

match 方法会检查传入的类是否是 xxxController，如果是，则返回 true，表示排除这个类。

2.在springboot应用中使用自定义的TypeExcludeFilter

在你的自定义TypeExcludeFilter上加上注解@Configuration和@ComponentScan

@Configuration
@ComponentScan(basePackages = "com.example",
    excludeFilters = @ComponentScan.Filter(type = FilterType.CUSTOM, classes = MyTypeExcludeFilter.class))

3.启动项目并验证

启动 Spring Boot 项目时，MyTypeExcludeFilter 将会在组件扫描时被触发，可以通过日志 log.info() 验证过滤器的行为，查看是否有类被正确排除。

实际应用场景

1. 排除某些控制器：比如在测试环境中，不想加载特定的控制器，你可以使用 TypeExcludeFilter 来动态地排除这些控制器。
2. 定制自动配置：在某些自动配置类中使用 TypeExcludeFilter 过滤掉特定的类，可以减少不必要的 Bean 加载。

小结

• TypeExcludeFilter 是 Spring Boot 中用于控制类扫描和自动配置行为的工具类。
• 通过继承TypeExcludeFilter 并重写 match 方法，可以定制化控制哪些类需要被排除。
• 将自定义的TypeExcludeFilter 注册到 Spring Boot 应用中，常用的方式是通过 @ComponentScan 的
  excludeFilters 属性。