Spring Boot如何用@EntityScan加载实体类并按规则排除部分类？

@EntityScan确实提供了类似@ComponentScan的过滤机制，支持通过includeFilters和excludeFilters属性按规则筛选需要加载的实体类，这一特性在Spring Data JPA 2.0及以上版本中可用。

以下是几种常见的排除方式：

1. 按正则表达式排除类名 #

如果需要按类的全限定名匹配排除，可以使用FilterType.REGEX类型的过滤器：

@SpringBootApplication
@EntityScan(
    basePackages = "com.path.to.entities",
    excludeFilters = @Filter(
        type = FilterType.REGEX,
        pattern = "com\\.path\\.to\\.entities\\.(ExcludedEntity|Temp.*)"
    )
)
public class YourApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourApplication.class, args);
    }
}

上面的示例会排除com.path.to.entities.ExcludedEntity以及所有以Temp开头的实体类。

2. 按自定义注解排除 #

如果需要批量排除带有特定注解的实体类，可以先定义一个自定义注解：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface SkipEntityScan {}

然后在需要排除的实体类上标记该注解：

@Entity
@SkipEntityScan
public class ExcludedEntity {
    // ...
}

最后在@EntityScan中配置过滤规则：

@EntityScan(
    basePackages = "com.path.to.entities",
    excludeFilters = @Filter(
        type = FilterType.ANNOTATION,
        classes = SkipEntityScan.class
    )
)

3. 按类类型排除 #

如果需要直接指定某个具体类排除，可以使用FilterType.ASSIGNABLE_TYPE：

@EntityScan(
    basePackages = "com.path.to.entities",
    excludeFilters = @Filter(
        type = FilterType.ASSIGNABLE_TYPE,
        classes = ExcludedEntity.class
    )
)

注意事项 #

• 确保使用的Spring Data JPA版本在2.0及以上，旧版本不支持excludeFilters和includeFilters属性；
• 被排除的实体类不会被JPA容器管理，不会生成对应的数据库表，也无法通过Spring Data JPA的Repository进行持久化操作。

内容的提问来源于stack exchange，提问作者Mohammed Gamal