1.10 扫描classPath 和 组件管理【spring 核心技术 翻译】

于 2020-07-12 15:34:52 发布
阅读量139 收藏
点赞数
分类专栏： spring 核心技术 文章标签： java

1.10 扫描classPath 和 组件管理

本章中的大多数示例使用XML指定在Spring容器中生成每个BeanDefinition的配置元数据。上一节(基于注释的容器配置)演示了如何通过源代码级注释提供大量配置元数据。然而，即使在这些示例中，“基本”bean定义也显式地定义在XML文件中，而注释仅驱动依赖项注入。本节描述通过扫描类路径隐式检测候选组件的选项。候选组件是与筛选标准匹配的类，并有相应的bean定义注册到容器中。这样就不需要使用XML来执行bean注册。相反，您可以使用注释(例如@Component)、AspectJ类型表达式或您自己的自定义筛选标准来选择哪些类已经向容器注册了bean定义。

从Spring 3.0开始，Spring JavaConfig项目提供的许多特性都是核心Spring框架的一部分。这允许您使用Java而不是传统的XML文件定义bean。查看@Configuration、@Bean、@Import和@DependsOn注释，了解如何使用这些新特性。

1.10.1 @Component和进一步的构造型注释

@Repository注释是满足存储库角色或构造型的任何类的标记(也称为数据访问对象或DAO)。该标记的使用包括异常的自动翻译，如异常翻译中所述。

Spring提供了进一步的构造型注解:@Component， @Service和@Controller。
@Component是任何spring管理组件的通用原型。
@Repository、@Service和@Controller是针对更具体用例(分别在持久性、服务和表示层中)的@Component的专门化。
因此，您可以使用@Component注释组件类，但是，通过使用@Repository、@Service或@Controller注释它们，您的类更适合通过工具处理或与方面关联。
例如，这些构造型注释是切入点的理想目标。
@Repository、@Service和@Controller还可以在Spring框架的未来版本中附带额外的语义。
因此，如果您要在您的服务层使用@Component或@Service之间进行选择，那么@Service显然是更好的选择。
类似地，如前所述，@Repository已经被支持作为持久化层中自动异常转换的标记。

1.10.2。使用元注释和组合注释

Spring提供的许多注释都可以在您自己的代码中用作元注释。元注释是可以应用于另一个注释的注释。例如，前面提到的@Service注释是用@Component进行元注释的，如下面的示例所示:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component 
public @interface Service {

    // ...
}

该组件导致以与@Component相同的方式处理@Service。

您还可以组合元注释来创建“组合注释”。例如，Spring MVC的@RestController注释由@Controller和@ResponseBody组成。

此外，组合注释可以选择性地从元注释中重新声明属性，从而允许定制。当您只想公开元注释属性的一个子集时，这可能特别有用。例如，Spring的@SessionScope注释将作用域名称硬编码为session，但仍然允许定制proxyMode。下面的清单显示了SessionScope注释的定义:

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Scope(WebApplicationContext.SCOPE_SESSION)
public @interface SessionScope {

    /**
     * Alias for {@link Scope#proxyMode}.
     * <p>Defaults to {@link ScopedProxyMode#TARGET_CLASS}.
     */
    @AliasFor(annotation = Scope.class)
    ScopedProxyMode proxyMode() default ScopedProxyMode.TARGET_CLASS;

}

然后你可以使用@SessionScope而不用像下面这样声明proxyMode:

@Service
@SessionScope
public class SessionScopedService {
    // ...
}

你也可以重写proxyMode的值，如下面的例子所示:

@Service
@SessionScope(proxyMode = ScopedProxyMode.INTERFACES)
public class SessionScopedUserService implements UserService {
    // ...
}

有关更多细节，请参见Spring注释编程模型wiki页面。

1.10.3。自动检测类并注册Bean定义

Spring可以自动检测原型类，并向ApplicationContext注册相应的BeanDefinition实例。例如，以下两个类符合这种自动检测:

@Service
public class SimpleMovieLister {

    private MovieFinder movieFinder;

    public SimpleMovieLister(MovieFinder movieFinder) {
        this.movieFinder = movieFinder;
    }
}

@Repository
public class JpaMovieFinder implements MovieFinder {
    // implementation elided for clarity
}

要自动检测这些类并注册相应的bean，您需要将@ComponentScan添加到您的@Configuration类中，其中basePackages属性是这两个类的公共父包。(或者，您可以指定一个逗号、分号或空格分隔的列表，其中包含每个类的父包。)

@Configuration
@ComponentScan(basePackages = "org.example")
public class AppConfig  {
    // ...
}

为简便起见，前面的示例可以使用注释的value属性(即@ComponentScan(“org.example”))。
下面是使用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
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd">

    <context:component-scan base-package="org.example"/>

</beans>

使用context:component-scan 隐式地启用了的功能。在使用时，通常不需要包含context:annotation-config元素。

类路径包的扫描要求类路径中存在相应的目录项。当您使用Ant构建JAR时，请确保没有激活JAR任务的文件切换。另外，在某些环境中，基于安全策略可能不会公开类路径目录，例如JDK 1.7.0_45或更高版本上的独立应用程序(需要在清单中设置’Trusted-Library’，请参见https://stackoverflow.com/questions/19394570/java-jre-7u45-breaks-classloader-getresources)。

在JDK 9的模块路径(Jigsaw)上，Spring的类路径扫描通常按预期工作。但是，请确保在模块信息描述符中导出组件类。如果希望Spring调用类的非公共成员，请确保它们是“打开的”(也就是说，它们在模块信息描述符中使用open声明而不是export声明)。

此外，当您使用组件扫描元素时，AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor都是隐式包含的。这意味着这两个组件是自动检测并连接在一起的——所有这些都不需要XML提供任何bean配置元数据。

你可以禁用AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor的注册，方法是将注解-配置属性的值设为false。

1.10.4。使用过滤器自定义扫描

默认情况下，仅检测到用@Component、@Repository、@Service、@Controller、@Configuration注释的类或本身用@Component注释的自定义注释。但是，您可以通过应用自定义筛选器来修改和扩展此行为。添加它们作为@ComponentScan注释的includeFilters或excludeFilters属性(或作为XML配置中或子元素元素)。每个筛选器元素都需要类型和表达式属性。

下表描述了筛选选项:
在这里插入图片描述
下面的示例显示了忽略所有@Repository注释并使用“stub”存储库的配置:

@Configuration
@ComponentScan(basePackages = "org.example",
        includeFilters = @Filter(type = FilterType.REGEX, pattern = ".*Stub.*Repository"),
        excludeFilters = @Filter(Repository.class))
public class AppConfig {
    ...
}

下面的清单显示了等效的XML:

<beans>
    <context:component-scan base-package="org.example">
        <context:include-filter type="regex"
                expression=".*Stub.*Repository"/>
        <context:exclude-filter type="annotation"
                expression="org.springframework.stereotype.Repository"/>
    </context:component-scan>
</beans>

您还可以通过在注释上设置useDefaultFilters=false来禁用默认过滤器，或者通过提供use-default-filters="false"作为元素的属性来禁用默认过滤器。这有效地禁止了对用@Component、@Repository、@Service、@Controller、@RestController或@Configuration注释或元注释的类的自动检测。

1.10.5。在组件中定义Bean元数据

Spring组件还可以向容器提供bean定义元数据。您可以使用与在@Configuration注释类中定义bean元数据相同的@Bean注释来做到这一点。下面的例子展示了如何做到这一点:

@Component
public class FactoryMethodComponent {

    @Bean
    @Qualifier("public")
    public TestBean publicInstance() {
        return new TestBean("publicInstance");
    }

    public void doWork() {
        // Component method implementation omitted
    }
}

前面的类是一个Spring组件，在它的doWork()方法中有特定于应用程序的代码。但是，它也提供了一个bean定义，其中有一个引用方法publicInstance()的工厂方法。@Bean注释标识工厂方法和其他bean定义属性，例如通过@Qualifier注释标识的限定符值。其他可以指定的方法级注释是@Scope、@Lazy和自定义限定符注释。

除了用于组件初始化的角色之外，还可以将**@Lazy**注释放在用@Autowired或@Inject标记的注入点上。在这个上下文中，它导致注入一个延迟解析代理。

如前所述，支持自动生成的字段和方法，另外还支持@Bean方法的自动生成。下面的例子展示了如何做到这一点:

@Component
public class FactoryMethodComponent {

    private static int i;

    @Bean
    @Qualifier("public")
    public TestBean publicInstance() {
        return new TestBean("publicInstance");
    }

    // use of a custom qualifier and autowiring of method parameters
    @Bean
    protected TestBean protectedInstance(
            @Qualifier("public") TestBean spouse,
            @Value("#{privateInstance.age}") String country) {
        TestBean tb = new TestBean("protectedInstance", 1);
        tb.setSpouse(spouse);
        tb.setCountry(country);
        return tb;
    }

    @Bean
    private TestBean privateInstance() {
        return new TestBean("privateInstance", i++);
    }

    @Bean
    @RequestScope
    public TestBean requestScopedInstance() {
        return new TestBean("requestScopedInstance", 3);
    }
}

该示例将字符串方法参数country自动转换为另一个名为privateInstance的bean上的age属性的值。Spring Expression语言元素通过符号#{< Expression >}定义属性的值。对于@Value注释，表达式解析器被预先配置为在解析表达式文本时查找bean名称。

在Spring Framework 4.3中，您还可以声明一个类型为InjectionPoint的工厂方法参数(或者它更具体的子类:DependencyDescriptor)来访问触发当前bean创建的请求注入点。注意，这只适用于bean实例的实际创建，不适用于现有实例的注入。因此，这个特性对原型范围的bean最有意义。对于其他范围，工厂方法只能看到在给定范围内触发新bean实例创建的注入点(例如，触发惰性单例bean创建的依赖项)。您可以在这样的场景中谨慎使用提供的注入点元数据。下面的例子展示了如何使用InjectionPoint:

@Component
public class FactoryMethodComponent {

    @Bean @Scope("prototype")
    public TestBean prototypeInstance(InjectionPoint injectionPoint) {
        return new TestBean("prototypeInstance for " + injectionPoint.getMember());
    }
}

常规Spring组件中的@Bean方法与Spring @Configuration类中的对应方法处理方式不同。区别在于@Component类没有通过CGLIB增强来拦截方法和字段的调用。CGLIB代理是通过调用@Configuration类中@Bean方法中的方法或字段来创建对协作对象的bean元数据引用的方法。这些方法不是用普通的Java语义调用的，而是通过容器来提供通常的生命周期管理和Spring bean的代理，甚至在通过编程调用@Bean方法引用其他bean时也是如此。相反，在普通的@Component类中调用@Bean方法或字段具有标准的Java语义，不应用特殊的CGLIB处理或其他约束。

您可以将@Bean方法声明为静态的，允许在不将其包含的配置类创建为实例的情况下调用它们。这在定义后处理器bean(例如BeanFactoryPostProcessor或BeanPostProcessor类型)时特别有意义，因为这样的bean在容器生命周期的早期被初始化，应该避免在此时触发配置的其他部分。

容器永远不会拦截对静态@Bean方法的调用，甚至在@Configuration类中也不会(如本节前面所述)，由于技术限制:CGLIB子类化只能覆盖非静态方法。因此，对另一个@Bean方法的直接调用具有标准的Java语义，从而直接从工厂方法本身返回一个独立的实例。

Java语言中@Bean方法的可见性对Spring容器中生成的bean定义没有直接影响。您可以自由地在non-@Configuration类中声明您的工厂方法，也可以在任何地方声明静态方法。但是，@Configuration类中的常规@Bean方法需要被重写——也就是说，它们不能被声明为private或final。

@Bean方法也可以在给定组件或配置类的基类中发现，也可以在Java 8中在组件或配置类实现的接口中声明的默认方法中发现。这为组合复杂配置安排提供了很大的灵活性，甚至可以通过Spring 4.2中的Java 8默认方法实现多重继承。

最后，一个类可能为同一个bean保留多个@Bean方法，作为多个工厂方法的安排，在运行时根据可用的依赖项使用。这与在其他配置场景中选择“贪婪的”构造函数或工厂方法是相同的算法:在构建时选择可满足依赖关系最多的变量，类似于容器在多个@Autowired构造函数之间进行选择。

1.10.6。命名检测组件

当一个组件作为扫描过程的一部分被自动检测时，它的bean名称由扫描器知道的BeanNameGenerator策略生成。默认情况下，任何包含名称值的Spring原型注释(@Component， @Repository， @Service，和@Controller)将该名称提供给相应的bean定义。

如果这样的注释不包含任何名称值，或者不包含任何其他检测到的组件(比如那些由自定义过滤器发现的组件)，那么默认的bean名称生成器将返回未大写且不合格的类名。例如，如果检测到以下组件类，名称将是myMovieLister和movieFinderImpl:

@Service("myMovieLister")
public class SimpleMovieLister {
    // ...
}

@Repository
public class MovieFinderImpl implements MovieFinder {
    // ...
}

如果不希望依赖默认的bean命名策略，可以提供自定义bean命名策略。首先，实现BeanNameGenerator接口，并确保包含默认的无参数构造函数。然后，在配置扫描器时提供完全限定的类名，如下面的示例注释和bean定义所示。

如果您遇到命名冲突，因为多个自动检测组件具有相同的非限定类名(例如，您可能需要配置BeanNameGenerator，它默认为生成的bean名的完全限定类名。在Spring Framework 5.2.3中，位于package org.springframework.context中的完全限定的注释beannamegenerator。注释可用于此类目的。

@Configuration
@ComponentScan(basePackages = "org.example", nameGenerator = MyNameGenerator.class)
public class AppConfig {
    // ...
}

<beans>
    <context:component-scan base-package="org.example"
        name-generator="org.example.MyNameGenerator" />
</beans>

作为一般规则，当其他组件可能显式引用注释时，请考虑使用注释指定名称。另一方面，只要容器负责连接，自动生成的名称就足够了。

1.10.7。为自动检测的组件提供范围

与一般的spring管理组件一样，自动检测组件的默认和最常见的作用域是singleton。但是，有时需要由@Scope注释指定不同的作用域。您可以在注释中提供作用域的名称，如下面的示例所示:

@Scope("prototype")
@Repository
public class MovieFinderImpl implements MovieFinder {
    // ...
}

@Scope注释仅在具体bean类(对于带注释的组件)或工厂方法(对于@Bean方法)上自省。与XML bean定义相反，不存在bean定义继承的概念，而且类级别的继承层次结构与元数据目的无关。

有关web特定作用域的详细信息，如在Spring上下文中的“请求”或“会话”，请参阅请求、会话、应用程序和WebSocket作用域。与为这些作用域预构建的注释一样，您也可以通过使用Spring的元注释方法来编写自己的作用域注释:例如，使用@Scope(“prototype”)注释的自定义注释元注释，也可能声明自定义作用域代理模式。

@Configuration
@ComponentScan(basePackages = "org.example", scopeResolver = MyScopeResolver.class)
public class AppConfig {
    // ...
}

<beans>
    <context:component-scan base-package="org.example" scope-resolver="org.example.MyScopeResolver"/>
</beans>

在使用某些非单例作用域时，可能需要为作用域对象生成代理。其原因在作用域bean中描述为依赖关系。为此，component-scan元素上有一个作用域代理属性。三个可能的值是:no、interface和targetClass。例如，以下配置导致了标准JDK动态代理:

@Configuration
@ComponentScan(basePackages = "org.example", scopedProxy = ScopedProxyMode.INTERFACES)
public class AppConfig {
    // ...
}

<beans>
    <context:component-scan base-package="org.example" scoped-proxy="interfaces"/>
</beans>

@Qualifier注解将在基于注释的微调自动装配限定符中讨论。该部分中的示例演示了@Qualifier注释和custom qualifier注释的使用，以在解析自动装配候选时提供细粒度的控制。因为这些示例基于XML bean定义，所以限定符元数据是通过使用XML中bean元素的限定符或元子元素在候选bean定义上提供的。当依赖类路径扫描来自动检测组件时，您可以在候选类上提供带有类型级别注释的限定符元数据。下面的三个示例演示了这种技术

@Component
@Qualifier("Action")
public class ActionMovieCatalog implements MovieCatalog {
    // ...
}

@Component
@Genre("Action")
public class ActionMovieCatalog implements MovieCatalog {
    // ...
}

@Component
@Offline
public class CachingMovieCatalog implements MovieCatalog {
    // ...
}

与大多数基于注释的替代方法一样，请记住，注释元数据绑定到类定义本身，而XML的使用允许相同类型的多个bean在其限定符元数据中提供变体，因为元数据是按实例而不是按类提供的。

1.10.9。生成候选组件的索引

虽然类路径扫描非常快，但是可以通过在编译时创建一个静态候选列表来提高大型应用程序的启动性能。在这种模式下，所有作为组件扫描目标的模块都必须使用这种机制。

您现有的@ComponentScan或<context:component-scan指令必须保持原样，以请求上下文扫描某些包中的候选内容。
当ApplicationContext检测到这样一个索引时，它会自动使用它，而不是扫描类路径。

为了生成索引，向包含组件扫描指令目标组件的每个模块添加额外的依赖项。下面的例子展示了如何使用Maven来实现这一点:

<dependencies>
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context-indexer</artifactId>
        <version>5.2.7.RELEASE</version>
        <optional>true</optional>
    </dependency>
</dependencies>

在Gradle 4.5和更早的版本中，依赖关系应该在compileOnly配置中声明，如下面的例子所示:

dependencies {
    compileOnly "org.springframework:spring-context-indexer:5.2.7.RELEASE"
}

在Gradle 4.6及以后版本中，依赖关系应该在annotationProcessor配置中声明，如下面的例子所示:

dependencies {
    annotationProcessor "org.springframework:spring-context-indexer:{spring-version}"
}

该过程生成包含在jar文件中的META-INF/spring.components文件。

在IDE中使用此模式时，必须将spring上下文索引器注册为注释处理器，以确保在更新候选组件时索引是最新的。

当在类路径中找到META-INF/spring.components时，索引会自动启用。如果索引对于某些库(或用例)是部分可用的，但不能为整个应用程序构建，那么您可以通过设置spring.index.ignore 为true 来回到常规的类路径安排(就像根本没有索引一样)。无论是作为系统属性还是在spring.properties文件位于类路径的根。

yxpcc
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值