Spring Boot: TypeExcludeFilter过滤器

在Spring Boot中，TypeExcludeFilter是@CommonentScan注解设定的两个默认过滤器中的一个。

TypeExcludeFilter是Spring boot提供的一种机制，用于在测试中排除某些类型的Bean。这在大型应用程序中非常有用，可以防止某些bean在测试中被加载，从而加快测试速度或比年冲突。

使用方法：

1 创建一个自定义的`TypeExcludeFilter`

MyTypeExcludeFilter.java这个过滤器将制定哪些类型的bean应该被排除。

import org.springframework.boot.context.TypeExcludeFilter;
import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.stereotype.Component;

@Component
public class MyTypeExcludeFilter extends TypeExcludeFilter {

    @Override
    public boolean match(AnnotatedTypeMetadata metadata) {
        // 在这里定义需要排除的bean的逻辑
        String className = metadata.getClassName();
        // 例如，排除所有 MyExcludedService 类型的 bean
        return className.equals("com.example.demo.MyExcludedService");
    }
}

2 创建要排除的服务类

创建一个简单的服务类，该服务类将在测试中被排除。

MyExcludedService.java

package com.example.demo;

import org.springframework.stereotype.Service;

@Service
public class MyExcludedService {
    public void doSomething() {
        System.out.println("This service should be excluded in tests.");
    }
}

3 在测试中使用自定义的`TypeExcludeFilter`

在测试类中，我们需要将自定义的TypeExcludeFilter注册到Spring Boot测试上下文中。

MyApplicationTests.java

package com.example.demo;

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.FilterType;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.boot.test.autoconfigure.filter.TypeExcludeFilters;

@SpringBootTest
@ContextConfiguration(classes = MyApplication.class)
@TypeExcludeFilters(MyTypeExcludeFilter.class)
public class MyApplicationTests {

    @Test
    public void contextLoads() {
        // 测试内容
    }
}

4 代码结构

src
├── main
│   └── java
│       └── com
│           └── example
│               └── demo
│                   ├── MyApplication.java
│                   ├── MyExcludedService.java
│                   └── MyTypeExcludeFilter.java
└── test
    └── java
        └── com
            └── example
                └── demo
                    └── MyApplicationTests.java

MyApplication.java

package com.example.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }
}

5 测试

当运行 MyApplicationTests 时，MyExcludedService 将不会被加载到 Spring 上下文中。这可以通过在 MyExcludedService 中添加一些输出语句并观察控制台输出来验证。

使用 TypeExcludeFilter 可以在测试中排除特定类型的 bean，从而简化测试环境，减少不必要的依赖，提高测试的速度和稳定性。通过自定义 TypeExcludeFilter，可以灵活地控制哪些 bean 需要被排除，非常适合复杂的应用场景。

有意与无意之间