组合基于 Java 的配置

Spring 的基于 Java 的配置功能允许您组合注解，这可以降低配置的复杂性。

使用 `@Import` 注解

就像 <import/> 元素在 Spring XML 文件中用于帮助模块化配置一样，@Import 注解允许从另一个配置类加载 @Bean 定义，如下例所示

Java
Kotlin

@Configuration
public class ConfigA {

	@Bean
	public A a() {
		return new A();
	}
}

@Configuration
@Import(ConfigA.class)
public class ConfigB {

	@Bean
	public B b() {
		return new B();
	}
}

@Configuration
class ConfigA {

	@Bean
	fun a() = A()
}

@Configuration
@Import(ConfigA::class)
class ConfigB {

	@Bean
	fun b() = B()
}

现在，您不需要在实例化上下文时同时指定 ConfigA.class 和 ConfigB.class，只需要显式提供 ConfigB，如下例所示

Java
Kotlin

public static void main(String[] args) {
	ApplicationContext ctx = new AnnotationConfigApplicationContext(ConfigB.class);

	// now both beans A and B will be available...
	A a = ctx.getBean(A.class);
	B b = ctx.getBean(B.class);
}

import org.springframework.beans.factory.getBean

fun main() {
	val ctx = AnnotationConfigApplicationContext(ConfigB::class.java)

	// now both beans A and B will be available...
	val a = ctx.getBean<A>()
	val b = ctx.getBean<B>()
}

这种方法简化了容器实例化，因为只需要处理一个类，而不需要您在构造过程中记住可能大量的 @Configuration 类。

从 Spring Framework 4.2 开始，@Import 也支持引用常规组件类，类似于 AnnotationConfigApplicationContext.register 方法。如果您想避免组件扫描，通过使用几个配置类作为入口点来显式定义所有组件，这将特别有用。

注入导入的 `@Bean` 定义的依赖项

前面的示例有效，但过于简单。在大多数实际场景中，bean 在不同的配置类之间相互依赖。使用 XML 时，这不是问题，因为没有涉及编译器，您可以声明 ref="someBean" 并相信 Spring 会在容器初始化期间解决它。使用 @Configuration 类时，Java 编译器对配置模型施加了约束，即对其他 bean 的引用必须是有效的 Java 语法。

幸运的是，解决这个问题很简单。正如我们之前讨论过的那样，@Bean 方法可以具有任意数量的参数来描述 bean 依赖项。考虑以下更现实的场景，其中包含多个 @Configuration 类，每个类都依赖于在其他类中声明的 bean

Java
Kotlin

@Configuration
public class ServiceConfig {

	@Bean
	public TransferService transferService(AccountRepository accountRepository) {
		return new TransferServiceImpl(accountRepository);
	}
}

@Configuration
public class RepositoryConfig {

	@Bean
	public AccountRepository accountRepository(DataSource dataSource) {
		return new JdbcAccountRepository(dataSource);
	}
}

@Configuration
@Import({ServiceConfig.class, RepositoryConfig.class})
public class SystemTestConfig {

	@Bean
	public DataSource dataSource() {
		// return new DataSource
	}
}

public static void main(String[] args) {
	ApplicationContext ctx = new AnnotationConfigApplicationContext(SystemTestConfig.class);
	// everything wires up across configuration classes...
	TransferService transferService = ctx.getBean(TransferService.class);
	transferService.transfer(100.00, "A123", "C456");
}

import org.springframework.beans.factory.getBean

@Configuration
class ServiceConfig {

	@Bean
	fun transferService(accountRepository: AccountRepository): TransferService {
		return TransferServiceImpl(accountRepository)
	}
}

@Configuration
class RepositoryConfig {

	@Bean
	fun accountRepository(dataSource: DataSource): AccountRepository {
		return JdbcAccountRepository(dataSource)
	}
}

@Configuration
@Import(ServiceConfig::class, RepositoryConfig::class)
class SystemTestConfig {

	@Bean
	fun dataSource(): DataSource {
		// return new DataSource
	}
}


fun main() {
	val ctx = AnnotationConfigApplicationContext(SystemTestConfig::class.java)
	// everything wires up across configuration classes...
	val transferService = ctx.getBean<TransferService>()
	transferService.transfer(100.00, "A123", "C456")
}

还有另一种方法可以实现相同的结果。请记住，@Configuration 类最终只是容器中的另一个 bean：这意味着它们可以利用 @Autowired 和 @Value 注入以及其他功能，就像任何其他 bean 一样。

确保您以这种方式注入的依赖项仅是最简单的类型。@Configuration 类在上下文初始化期间非常早地被处理，强制以这种方式注入依赖项可能会导致意外的早期初始化。只要有可能，请使用基于参数的注入，如前面的示例所示。

避免在同一配置类上的 @PostConstruct 方法中访问本地定义的 bean。这实际上会导致循环引用，因为非静态 @Bean 方法在语义上需要一个完全初始化的配置类实例才能调用。由于不允许循环引用（例如，在 Spring Boot 2.6+ 中），这可能会触发 BeanCurrentlyInCreationException。

此外，要特别注意通过 @Bean 定义的 BeanPostProcessor 和 BeanFactoryPostProcessor。这些通常应声明为 static @Bean 方法，不会触发其包含的配置类的实例化。否则，@Autowired 和 @Value 可能无法在配置类本身使用，因为有可能在 AutowiredAnnotationBeanPostProcessor 之前创建它作为 bean 实例。

以下示例展示了如何将一个 bean 自动装配到另一个 bean

Java
Kotlin

@Configuration
public class ServiceConfig {

	@Autowired
	private AccountRepository accountRepository;

	@Bean
	public TransferService transferService() {
		return new TransferServiceImpl(accountRepository);
	}
}

@Configuration
public class RepositoryConfig {

	private final DataSource dataSource;

	public RepositoryConfig(DataSource dataSource) {
		this.dataSource = dataSource;
	}

	@Bean
	public AccountRepository accountRepository() {
		return new JdbcAccountRepository(dataSource);
	}
}

@Configuration
@Import({ServiceConfig.class, RepositoryConfig.class})
public class SystemTestConfig {

	@Bean
	public DataSource dataSource() {
		// return new DataSource
	}
}

public static void main(String[] args) {
	ApplicationContext ctx = new AnnotationConfigApplicationContext(SystemTestConfig.class);
	// everything wires up across configuration classes...
	TransferService transferService = ctx.getBean(TransferService.class);
	transferService.transfer(100.00, "A123", "C456");
}

import org.springframework.beans.factory.getBean

@Configuration
class ServiceConfig {

	@Autowired
	lateinit var accountRepository: AccountRepository

	@Bean
	fun transferService(): TransferService {
		return TransferServiceImpl(accountRepository)
	}
}

@Configuration
class RepositoryConfig(private val dataSource: DataSource) {

	@Bean
	fun accountRepository(): AccountRepository {
		return JdbcAccountRepository(dataSource)
	}
}

@Configuration
@Import(ServiceConfig::class, RepositoryConfig::class)
class SystemTestConfig {

	@Bean
	fun dataSource(): DataSource {
		// return new DataSource
	}
}

fun main() {
	val ctx = AnnotationConfigApplicationContext(SystemTestConfig::class.java)
	// everything wires up across configuration classes...
	val transferService = ctx.getBean<TransferService>()
	transferService.transfer(100.00, "A123", "C456")
}

从 Spring Framework 4.3 开始才支持 @Configuration 类中的构造函数注入。另外，如果目标 bean 只定义了一个构造函数，则无需指定 @Autowired。

完全限定导入的 bean 以便于导航

在前面的场景中，使用 @Autowired 运行良好并提供了所需的模块化，但确定自动装配的 bean 定义的具体位置仍然有些模糊。例如，作为查看 ServiceConfig 的开发人员，您如何确切地知道 @Autowired AccountRepository bean 在哪里声明？代码中没有明确说明，这可能很好。请记住，Spring Tools for Eclipse 提供了可以渲染显示所有连接方式的图形的工具，这可能是您所需要的。此外，您的 Java IDE 可以轻松找到 AccountRepository 类型的所有声明和使用，并快速显示返回该类型的 @Bean 方法的位置。

在这种情况不可接受且您希望从 IDE 中的某个 @Configuration 类直接导航到另一个类时，请考虑自动装配配置类本身。以下示例展示了如何做到这一点

Java
Kotlin

@Configuration
public class ServiceConfig {

	@Autowired
	private RepositoryConfig repositoryConfig;

	@Bean
	public TransferService transferService() {
		// navigate 'through' the config class to the @Bean method!
		return new TransferServiceImpl(repositoryConfig.accountRepository());
	}
}

@Configuration
class ServiceConfig {

	@Autowired
	private lateinit var repositoryConfig: RepositoryConfig

	@Bean
	fun transferService(): TransferService {
		// navigate 'through' the config class to the @Bean method!
		return TransferServiceImpl(repositoryConfig.accountRepository())
	}
}

在前面的情况下，AccountRepository 的定义是完全明确的。但是，ServiceConfig 现在与 RepositoryConfig 紧密耦合。这就是权衡。这种紧密耦合可以通过使用基于接口或基于抽象类的 @Configuration 类来缓解。请考虑以下示例

Java
Kotlin

@Configuration
public class ServiceConfig {

	@Autowired
	private RepositoryConfig repositoryConfig;

	@Bean
	public TransferService transferService() {
		return new TransferServiceImpl(repositoryConfig.accountRepository());
	}
}

@Configuration
public interface RepositoryConfig {

	@Bean
	AccountRepository accountRepository();
}

@Configuration
public class DefaultRepositoryConfig implements RepositoryConfig {

	@Bean
	public AccountRepository accountRepository() {
		return new JdbcAccountRepository(...);
	}
}

@Configuration
@Import({ServiceConfig.class, DefaultRepositoryConfig.class})  // import the concrete config!
public class SystemTestConfig {

	@Bean
	public DataSource dataSource() {
		// return DataSource
	}

}

public static void main(String[] args) {
	ApplicationContext ctx = new AnnotationConfigApplicationContext(SystemTestConfig.class);
	TransferService transferService = ctx.getBean(TransferService.class);
	transferService.transfer(100.00, "A123", "C456");
}

import org.springframework.beans.factory.getBean

@Configuration
class ServiceConfig {

	@Autowired
	private lateinit var repositoryConfig: RepositoryConfig

	@Bean
	fun transferService(): TransferService {
		return TransferServiceImpl(repositoryConfig.accountRepository())
	}
}

@Configuration
interface RepositoryConfig {

	@Bean
	fun accountRepository(): AccountRepository
}

@Configuration
class DefaultRepositoryConfig : RepositoryConfig {

	@Bean
	fun accountRepository(): AccountRepository {
		return JdbcAccountRepository(...)
	}
}

@Configuration
@Import(ServiceConfig::class, DefaultRepositoryConfig::class)  // import the concrete config!
class SystemTestConfig {

	@Bean
	fun dataSource(): DataSource {
		// return DataSource
	}

}

fun main() {
	val ctx = AnnotationConfigApplicationContext(SystemTestConfig::class.java)
	val transferService = ctx.getBean<TransferService>()
	transferService.transfer(100.00, "A123", "C456")
}

现在 ServiceConfig 与具体的 DefaultRepositoryConfig 松散耦合，内置的 IDE 工具仍然有用：您可以轻松获得 RepositoryConfig 实现的类型层次结构。这样，导航 @Configuration 类及其依赖项与通常的基于接口的代码导航过程没有什么不同。

如果您想影响某些 Bean 的启动创建顺序，请考虑将其中一些声明为 @Lazy（以便在首次访问时创建，而不是在启动时创建）或声明为 @DependsOn 某些其他 Bean（确保在当前 Bean 之前创建特定其他 Bean，超出后者直接依赖项的含义）。

有条件地包含 `@Configuration` 类或 `@Bean` 方法

根据某些任意系统状态，有条件地启用或禁用完整的 @Configuration 类甚至单个 @Bean 方法通常很有用。一个常见的例子是使用 @Profile 注解，仅在 Spring Environment 中启用了特定配置文件时才激活 Bean（有关详细信息，请参阅 Bean 定义配置文件）。

@Profile 注解实际上是通过使用更灵活的注解 @Conditional 来实现的。@Conditional 注解指示在注册 @Bean 之前应咨询的特定 org.springframework.context.annotation.Condition 实现。

Condition 接口的实现提供了一个 matches(…) 方法，该方法返回 true 或 false。例如，以下清单显示了用于 @Profile 的实际 Condition 实现

Java
Kotlin

@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
	// Read the @Profile annotation attributes
	MultiValueMap<String, Object> attrs = metadata.getAllAnnotationAttributes(Profile.class.getName());
	if (attrs != null) {
		for (Object value : attrs.get("value")) {
			if (context.getEnvironment().acceptsProfiles(((String[]) value))) {
				return true;
			}
		}
		return false;
	}
	return true;
}

override fun matches(context: ConditionContext, metadata: AnnotatedTypeMetadata): Boolean {
	// Read the @Profile annotation attributes
	val attrs = metadata.getAllAnnotationAttributes(Profile::class.java.name)
	if (attrs != null) {
		for (value in attrs["value"]!!) {
			if (context.environment.acceptsProfiles(Profiles.of(*value as Array<String>))) {
				return true
			}
		}
		return false
	}
	return true
}

有关更多详细信息，请参阅 @Conditional javadoc。

组合 Java 和 XML 配置

Spring 的 @Configuration 类支持并非旨在完全替代 Spring XML。某些功能（例如 Spring XML 命名空间）仍然是配置容器的理想方式。在 XML 方便或必要的情况下，您可以选择：要么通过使用例如 ClassPathXmlApplicationContext 以“以 XML 为中心”的方式实例化容器，要么通过使用 AnnotationConfigApplicationContext 和 @ImportResource 注解以“以 Java 为中心”的方式实例化容器，以根据需要导入 XML。

以 XML 为中心的 `@Configuration` 类使用

从 XML 启动 Spring 容器并以即时方式包含 @Configuration 类可能更可取。例如，在使用 Spring XML 的大型现有代码库中，根据需要创建 @Configuration 类并将它们包含在现有 XML 文件中更容易。在本节的后面，我们将介绍在这种“以 XML 为中心”的情况下使用 @Configuration 类的选项。

将 @Configuration 类声明为普通的 Spring <bean/> 元素

请记住，@Configuration 类最终是容器中的 bean 定义。在本系列示例中，我们创建了一个名为 AppConfig 的 @Configuration 类，并将其作为 <bean/> 定义包含在 system-test-config.xml 中。由于 <context:annotation-config/> 已启用，容器会识别 @Configuration 注解并正确处理 AppConfig 中声明的 @Bean 方法。

以下示例显示了一个普通的 Java 配置类

Java
Kotlin

@Configuration
public class AppConfig {

	@Autowired
	private DataSource dataSource;

	@Bean
	public AccountRepository accountRepository() {
		return new JdbcAccountRepository(dataSource);
	}

	@Bean
	public TransferService transferService() {
		return new TransferService(accountRepository());
	}
}

@Configuration
class AppConfig {

	@Autowired
	private lateinit var dataSource: DataSource

	@Bean
	fun accountRepository(): AccountRepository {
		return JdbcAccountRepository(dataSource)
	}

	@Bean
	fun transferService() = TransferService(accountRepository())
}

以下示例显示了示例 system-test-config.xml 文件的一部分

<beans>
	<!-- enable processing of annotations such as @Autowired and @Configuration -->
	<context:annotation-config/>
	<context:property-placeholder location="classpath:/com/acme/jdbc.properties"/>

	<bean class="com.acme.AppConfig"/>

	<bean class="org.springframework.jdbc.datasource.DriverManagerDataSource">
		<property name="url" value="${jdbc.url}"/>
		<property name="username" value="${jdbc.username}"/>
		<property name="password" value="${jdbc.password}"/>
	</bean>
</beans>

以下示例显示了一个可能的 jdbc.properties 文件

jdbc.url=jdbc:hsqldb:hsql://127.0.0.1/xdb
jdbc.username=sa
jdbc.password=

Java
Kotlin

public static void main(String[] args) {
	ApplicationContext ctx = new ClassPathXmlApplicationContext("classpath:/com/acme/system-test-config.xml");
	TransferService transferService = ctx.getBean(TransferService.class);
	// ...
}

fun main() {
	val ctx = ClassPathXmlApplicationContext("classpath:/com/acme/system-test-config.xml")
	val transferService = ctx.getBean<TransferService>()
	// ...
}

在 system-test-config.xml 文件中，AppConfig <bean/> 没有声明 id 元素。虽然这样做是可以接受的，但考虑到没有其他 bean 会引用它，并且不太可能通过名称从容器中显式获取它，因此没有必要。同样，DataSource bean 仅通过类型自动装配，因此严格来说不需要显式 bean id。

使用 <context:component-scan/> 获取 @Configuration 类

由于 @Configuration 使用 @Component 进行元注解，因此使用 @Configuration 注解的类会自动成为组件扫描的候选对象。使用与上一示例中描述的相同场景，我们可以重新定义 system-test-config.xml 以利用组件扫描。请注意，在这种情况下，我们不需要显式声明 <context:annotation-config/>，因为 <context:component-scan/> 启用了相同的功能。

以下示例显示了修改后的 system-test-config.xml 文件

<beans>
	<!-- picks up and registers AppConfig as a bean definition -->
	<context:component-scan base-package="com.acme"/>
	<context:property-placeholder location="classpath:/com/acme/jdbc.properties"/>

	<bean class="org.springframework.jdbc.datasource.DriverManagerDataSource">
		<property name="url" value="${jdbc.url}"/>
		<property name="username" value="${jdbc.username}"/>
		<property name="password" value="${jdbc.password}"/>
	</bean>
</beans>

`@Configuration` 类为中心的 XML 使用方式，使用 `@ImportResource`

在 @Configuration 类是配置容器的主要机制的应用程序中，仍然可能需要使用至少一些 XML。在这些情况下，您可以使用 @ImportResource 并仅定义所需的 XML。这样做可以实现一种“以 Java 为中心”的方法来配置容器，并将 XML 减少到最低限度。以下示例（包括一个配置类、一个定义 bean 的 XML 文件、一个属性文件和 main 类）展示了如何使用 @ImportResource 注解来实现“以 Java 为中心”的配置，该配置根据需要使用 XML

Java
Kotlin

@Configuration
@ImportResource("classpath:/com/acme/properties-config.xml")
public class AppConfig {

	@Value("${jdbc.url}")
	private String url;

	@Value("${jdbc.username}")
	private String username;

	@Value("${jdbc.password}")
	private String password;

	@Bean
	public DataSource dataSource() {
		return new DriverManagerDataSource(url, username, password);
	}
}

@Configuration
@ImportResource("classpath:/com/acme/properties-config.xml")
class AppConfig {

	@Value("\${jdbc.url}")
	private lateinit var url: String

	@Value("\${jdbc.username}")
	private lateinit var username: String

	@Value("\${jdbc.password}")
	private lateinit var password: String

	@Bean
	fun dataSource(): DataSource {
		return DriverManagerDataSource(url, username, password)
	}
}

properties-config.xml
<beans>
	<context:property-placeholder location="classpath:/com/acme/jdbc.properties"/>
</beans>

jdbc.properties
jdbc.url=jdbc:hsqldb:hsql://127.0.0.1/xdb
jdbc.username=sa
jdbc.password=

Java
Kotlin

public static void main(String[] args) {
	ApplicationContext ctx = new AnnotationConfigApplicationContext(AppConfig.class);
	TransferService transferService = ctx.getBean(TransferService.class);
	// ...
}

import org.springframework.beans.factory.getBean

fun main() {
	val ctx = AnnotationConfigApplicationContext(AppConfig::class.java)
	val transferService = ctx.getBean<TransferService>()
	// ...
}

组合基于 Java 的配置

使用 @Import 注解

注入导入的 @Bean 定义的依赖项

有条件地包含 @Configuration 类或 @Bean 方法

组合 Java 和 XML 配置

以 XML 为中心的 @Configuration 类使用

@Configuration 类为中心的 XML 使用方式，使用 @ImportResource

使用 `@Import` 注解

注入导入的 `@Bean` 定义的依赖项

有条件地包含 `@Configuration` 类或 `@Bean` 方法

以 XML 为中心的 `@Configuration` 类使用

`@Configuration` 类为中心的 XML 使用方式，使用 `@ImportResource`