从@ComponentScan中排除@Component

Question

我想从特定@Configuration中的@ComponentScan中排除一个组件：

@Component("foo") class Foo {
...
}

否则，它似乎会与我项目中的其他类发生冲突。我并不完全理解这种冲突，但是如果我注释掉< code>@Component注释，事情就会如我所愿地运行。但是其他依赖这个库的项目期望这个类由Spring管理，所以我只想在我的项目中跳过它。

我尝试使用< code>@ComponentScan。过滤器:

@Configuration 
@EnableSpringConfigured
@ComponentScan(basePackages = {"com.example"}, excludeFilters={
  @ComponentScan.Filter(type=FilterType.ASSIGNABLE_TYPE, value=Foo.class)})
public class MySpringConfiguration {}

但是它似乎不起作用。如果我尝试使用FilterType.ASSIGNABLE_TYPE，我会收到一个奇怪的错误，因为无法加载一些看似随机的类：

由以下原因引起：java.io.文件未发现异常：类路径资源 [junit/框架/测试用例.class] 无法打开，因为它不存在

我还尝试使用type=FilterType.CUSTOM如下：

class ExcludeFooFilter implements TypeFilter {
    @Override
    public boolean match(MetadataReader metadataReader,
            MetadataReaderFactory metadataReaderFactory) throws IOException {
        return metadataReader.getClass() == Foo.class;
    }
}

@Configuration @EnableSpringConfigured
@ComponentScan(basePackages = {"com.example"}, excludeFilters={
  @ComponentScan.Filter(type=FilterType.CUSTOM, value=ExcludeFooFilter.class)})
public class MySpringConfiguration {}

但这似乎并没有像我希望的那样将组件排除在扫描范围之外。

如何排除它？

Answer 1

另一种方法是使用新的条件注释。由于纯Spring 4，您可以使用@Conditional annotation：

@Component("foo")
@Conditional(FooCondition.class)
class Foo {
    ...
}

并定义用于注册Foo组件的条件逻辑：

public class FooCondition implements Condition{
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // return [your conditional logic]
    }     
}

条件逻辑可以基于上下文，因为您可以访问bean工厂。对于“Bar”组件未注册为bean时的示例：

    return !context.getBeanFactory().containsBean(Bar.class.getSimpleName());

使用Spring Boot（应该用于每个新的Spring项目），您可以使用这些条件注释：

• @ConditionalOnBean
• @ConditionalOnClass
• @ConditionalOnExpression
• @ConditionalOnJava
• @ConditionalOnMissingBean
• @ConditionalOnMissingClass
• @ConditionalOnNotWebApplication
• @ConditionalOnProperty
• @ConditionalOnResource
• @ConditionalOnWebApplication

这样可以避免创建Condition类。有关更多详细信息，请参阅Spring Boot文档。

Answer 2

在扫描过滤器中使用显式类型对我来说很难看。我认为更优雅的方法是创建自己的标记注释：

@Retention(RetentionPolicy.RUNTIME)
public @interface IgnoreDuringScan {
}

标记应与之一起排除的组件：

@Component("foo") 
@IgnoreDuringScan
class Foo {
    ...
}

并从组件扫描中排除此批注:

@ComponentScan(excludeFilters = @Filter(IgnoreDuringScan.class))
public class MySpringConfiguration {}

Answer 3

配置似乎没问题，只是您应该使用excludeFilters而不是exclude：

@Configuration @EnableSpringConfigured
@ComponentScan(basePackages = {"com.example"}, excludeFilters={
  @ComponentScan.Filter(type=FilterType.ASSIGNABLE_TYPE, value=Foo.class)})
public class MySpringConfiguration {}