使用 @Configuration 注解

@Configuration 是一个类级注解,表示对象是 Bean 定义的源。@Configuration 类通过 @Bean 注解的方法声明 Bean。对 @Configuration 类上的 @Bean 方法的调用也可用于定义 Bean 之间的依赖关系。有关一般介绍,请参阅 基本概念:@Bean@Configuration

注入 Bean 之间的依赖关系

当 Bean 之间存在依赖关系时,表达这种依赖关系就像让一个 Bean 方法调用另一个方法一样简单,如下例所示

  • Java

  • Kotlin

@Configuration
public class AppConfig {

	@Bean
	public BeanOne beanOne() {
		return new BeanOne(beanTwo());
	}

	@Bean
	public BeanTwo beanTwo() {
		return new BeanTwo();
	}
}
@Configuration
class AppConfig {

	@Bean
	fun beanOne() = BeanOne(beanTwo())

	@Bean
	fun beanTwo() = BeanTwo()
}

在前面的示例中,beanOne 通过构造函数注入接收对 beanTwo 的引用。

这种声明 Bean 之间依赖关系的方法仅在 @Bean 方法在 @Configuration 类中声明时才有效。您不能通过使用普通 @Component 类来声明 Bean 之间的依赖关系。

查找方法注入

如前所述,查找方法注入 是一项高级功能,您应该很少使用。它在单例范围的 Bean 依赖于原型范围的 Bean 的情况下很有用。在这种类型的配置中使用 Java 为实现此模式提供了自然的方法。以下示例显示了如何使用查找方法注入

  • Java

  • Kotlin

public abstract class CommandManager {
	public Object process(Object commandState) {
		// grab a new instance of the appropriate Command interface
		Command command = createCommand();
		// set the state on the (hopefully brand new) Command instance
		command.setState(commandState);
		return command.execute();
	}

	// okay... but where is the implementation of this method?
	protected abstract Command createCommand();
}
abstract class CommandManager {
	fun process(commandState: Any): Any {
		// grab a new instance of the appropriate Command interface
		val command = createCommand()
		// set the state on the (hopefully brand new) Command instance
		command.setState(commandState)
		return command.execute()
	}

	// okay... but where is the implementation of this method?
	protected abstract fun createCommand(): Command
}

通过使用 Java 配置,您可以创建 CommandManager 的子类,其中抽象的 createCommand() 方法被覆盖,以便它查找新的(原型)命令对象。以下示例显示了如何执行此操作

  • Java

  • Kotlin

@Bean
@Scope("prototype")
public AsyncCommand asyncCommand() {
	AsyncCommand command = new AsyncCommand();
	// inject dependencies here as required
	return command;
}

@Bean
public CommandManager commandManager() {
	// return new anonymous implementation of CommandManager with createCommand()
	// overridden to return a new prototype Command object
	return new CommandManager() {
		protected Command createCommand() {
			return asyncCommand();
		}
	}
}
@Bean
@Scope("prototype")
fun asyncCommand(): AsyncCommand {
	val command = AsyncCommand()
	// inject dependencies here as required
	return command
}

@Bean
fun commandManager(): CommandManager {
	// return new anonymous implementation of CommandManager with createCommand()
	// overridden to return a new prototype Command object
	return object : CommandManager() {
		override fun createCommand(): Command {
			return asyncCommand()
		}
	}
}

有关 Java 配置内部工作原理的更多信息

考虑以下示例,它显示了 @Bean 注解的方法被调用了两次

  • Java

  • Kotlin

@Configuration
public class AppConfig {

	@Bean
	public ClientService clientService1() {
		ClientServiceImpl clientService = new ClientServiceImpl();
		clientService.setClientDao(clientDao());
		return clientService;
	}

	@Bean
	public ClientService clientService2() {
		ClientServiceImpl clientService = new ClientServiceImpl();
		clientService.setClientDao(clientDao());
		return clientService;
	}

	@Bean
	public ClientDao clientDao() {
		return new ClientDaoImpl();
	}
}
@Configuration
class AppConfig {

	@Bean
	fun clientService1(): ClientService {
		return ClientServiceImpl().apply {
			clientDao = clientDao()
		}
	}

	@Bean
	fun clientService2(): ClientService {
		return ClientServiceImpl().apply {
			clientDao = clientDao()
		}
	}

	@Bean
	fun clientDao(): ClientDao {
		return ClientDaoImpl()
	}
}

clientDao() 已在 clientService1()clientService2() 中分别调用了一次。由于此方法创建了 ClientDaoImpl 的新实例并返回它,因此您通常会期望有两个实例(每个服务一个)。这绝对会有问题:在 Spring 中,实例化的 Bean 默认具有 singleton 范围。这就是魔力所在:所有 @Configuration 类在启动时都使用 CGLIB 进行子类化。在子类中,子方法首先检查容器中是否存在任何缓存的(范围的)Bean,然后才调用父方法并创建一个新实例。

根据 Bean 的范围,行为可能会有所不同。我们在这里讨论的是单例。

无需将 CGLIB 添加到您的类路径中,因为 CGLIB 类被打包在 org.springframework.cglib 包下,并直接包含在 spring-core JAR 中。

由于 CGLIB 在启动时动态添加功能,因此存在一些限制。特别是,配置类不能是最终类。但是,配置类允许任何构造函数,包括使用 @Autowired 或单个非默认构造函数声明进行默认注入。

如果您希望避免任何 CGLIB 施加的限制,请考虑在非 @Configuration 类上声明您的 @Bean 方法(例如,在普通 @Component 类上),或通过使用 @Configuration(proxyBeanMethods = false) 注解您的配置类。然后不会拦截 @Bean 方法之间的跨方法调用,因此您必须在那里专门依赖于构造函数或方法级别的依赖注入。