方法注入

在大多数应用场景中，容器中的大多数 Bean 都是单例的。当一个单例 Bean 需要与另一个单例 Bean 或一个非单例 Bean 需要与另一个非单例 Bean 协作时，通常的处理依赖关系的方式是将一个 Bean 定义为另一个 Bean 的属性。当 Bean 的生命周期不同时，就会出现问题。假设单例 Bean A 需要使用非单例（原型）Bean B，也许在 A 的每次方法调用中都需要。容器只创建一次单例 Bean A，因此只有一次机会设置属性。容器无法在 Bean A 每次需要时都为其提供 Bean B 的新实例。

一种解决方案是放弃部分控制反转。可以通过实现 ApplicationContextAware 接口使 Bean A 意识到容器，并通过调用容器的 getBean("B") 来在 Bean A 每次需要时获取（通常是新的）Bean B 实例。以下示例展示了这种方法

  • Java

  • Kotlin

package fiona.apple;

// Spring-API imports
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;

/**
 * A class that uses a stateful Command-style class to perform
 * some processing.
 */
public class CommandManager implements ApplicationContextAware {

	private ApplicationContext applicationContext;

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

	protected Command createCommand() {
		// notice the Spring API dependency!
		return this.applicationContext.getBean("command", Command.class);
	}

	public void setApplicationContext(
			ApplicationContext applicationContext) throws BeansException {
		this.applicationContext = applicationContext;
	}
}
package fiona.apple

// Spring-API imports
import org.springframework.context.ApplicationContext
import org.springframework.context.ApplicationContextAware

// A class that uses a stateful Command-style class to perform
// some processing.
class CommandManager : ApplicationContextAware {

	private lateinit var applicationContext: ApplicationContext

	fun process(commandState: Map<*, *>): Any {
		// grab a new instance of the appropriate Command
		val command = createCommand()
		// set the state on the (hopefully brand new) Command instance
		command.state = commandState
		return command.execute()
	}

	// notice the Spring API dependency!
	protected fun createCommand() =
			applicationContext.getBean("command", Command::class.java)

	override fun setApplicationContext(applicationContext: ApplicationContext) {
		this.applicationContext = applicationContext
	}
}

上述做法并不理想，因为业务代码了解 Spring Framework 并与之耦合。方法注入是 Spring IoC 容器的一个稍微高级的特性，它允许你干净利落地处理此用例。

你可以在这篇博客文章中阅读更多关于方法注入的动机。

Lookup 方法注入

Lookup 方法注入是容器覆盖容器管理的 Bean 的方法并返回容器中另一个指定名称的 Bean 的查找结果的能力。查找通常涉及原型 Bean，就像前面部分描述的场景那样。Spring Framework 通过使用 CGLIB 库的字节码生成来动态生成一个覆盖该方法的子类来实现这种方法注入。

  • 为了使这种动态子类化工作，Spring Bean 容器子类化的类不能是 final 的，并且要被覆盖的方法也不能是 final 的。

  • 单元测试一个包含 abstract 方法的类需要你自己子类化该类并提供抽象方法的 stub 实现。

  • 另一个关键限制是 lookup 方法不适用于工厂方法，特别是配置类中的 @Bean 方法，因为在这种情况下，容器不负责创建实例，因此无法在运行时动态创建子类。

在前面代码片段中的 CommandManager 类的情况下，Spring 容器动态覆盖 createCommand() 方法的实现。重新设计后的示例显示，CommandManager 类没有任何 Spring 依赖。

  • Java

  • Kotlin

package fiona.apple;

// no more Spring imports!

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();
}
package fiona.apple

// no more Spring imports!

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.state = commandState
		return command.execute()
	}

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

在包含要注入方法的客户端类（在本例中是 CommandManager）中，要注入的方法需要具有以下形式的签名

<public|protected> [abstract] <return-type> theMethodName(no-arguments);

如果方法是 abstract 的，则动态生成的子类会实现该方法。否则，动态生成的子类会覆盖原始类中定义的具体方法。考虑以下示例

<!-- a stateful bean deployed as a prototype (non-singleton) -->
<bean id="myCommand" class="fiona.apple.AsyncCommand" scope="prototype">
	<!-- inject dependencies here as required -->
</bean>

<!-- commandManager uses myCommand prototype bean -->
<bean id="commandManager" class="fiona.apple.CommandManager">
	<lookup-method name="createCommand" bean="myCommand"/>
</bean>

被标识为 commandManager 的 Bean 在每次需要 myCommand Bean 的新实例时，都会调用它自己的 createCommand() 方法。如果确实需要，必须小心将 myCommand Bean 部署为原型（prototype）。如果它是单例（singleton），则每次返回的都是 myCommand Bean 的同一个实例。

或者，在基于注解的组件模型中，可以通过 @Lookup 注解声明一个 lookup 方法，如下例所示

  • Java

  • Kotlin

public abstract class CommandManager {

	public Object process(Object commandState) {
		Command command = createCommand();
		command.setState(commandState);
		return command.execute();
	}

	@Lookup("myCommand")
	protected abstract Command createCommand();
}
abstract class CommandManager {

	fun process(commandState: Any): Any {
		val command = createCommand()
		command.state = commandState
		return command.execute()
	}

	@Lookup("myCommand")
	protected abstract fun createCommand(): Command
}

或者，更惯用的做法是，你可以依赖于根据 lookup 方法声明的返回类型解析目标 Bean。

  • Java

  • Kotlin

public abstract class CommandManager {

	public Object process(Object commandState) {
		Command command = createCommand();
		command.setState(commandState);
		return command.execute();
	}

	@Lookup
	protected abstract Command createCommand();
}
abstract class CommandManager {

	fun process(commandState: Any): Any {
		val command = createCommand()
		command.state = commandState
		return command.execute()
	}

	@Lookup
	protected abstract fun createCommand(): Command
}

访问不同作用域目标 Bean 的另一种方法是 ObjectFactory/Provider 注入点。请参阅作用域 Bean 作为依赖项。

你可能还会发现 ServiceLocatorFactoryBean（位于 org.springframework.beans.factory.config 包中）也很有用。

任意方法替换

方法注入中一种不如 lookup 方法注入有用的形式是，用另一个方法实现替换托管 Bean 中的任意方法的能力。你可以安全地跳过本节的其余部分，直到你实际需要此功能。

使用基于 XML 的配置元数据，你可以使用 replaced-method 元素来替换已部署 Bean 的现有方法实现。考虑以下类，它有一个名为 computeValue 的方法，我们想要覆盖它

  • Java

  • Kotlin

public class MyValueCalculator {

	public String computeValue(String input) {
		// some real code...
	}

	// some other methods...
}
class MyValueCalculator {

	fun computeValue(input: String): String {
		// some real code...
	}

	// some other methods...
}

实现 org.springframework.beans.factory.support.MethodReplacer 接口的类提供了新的方法定义，如下例所示

  • Java

  • Kotlin

/**
 * meant to be used to override the existing computeValue(String)
 * implementation in MyValueCalculator
 */
public class ReplacementComputeValue implements MethodReplacer {

	public Object reimplement(Object o, Method m, Object[] args) throws Throwable {
		// get the input value, work with it, and return a computed result
		String input = (String) args[0];
		...
		return ...;
	}
}
/**
 * meant to be used to override the existing computeValue(String)
 * implementation in MyValueCalculator
 */
class ReplacementComputeValue : MethodReplacer {

	override fun reimplement(obj: Any, method: Method, args: Array<out Any>): Any {
		// get the input value, work with it, and return a computed result
		val input = args[0] as String;
		...
		return ...;
	}
}

用于部署原始类并指定方法覆盖的 Bean 定义将类似于以下示例

<bean id="myValueCalculator" class="x.y.z.MyValueCalculator">
	<!-- arbitrary method replacement -->
	<replaced-method name="computeValue" replacer="replacementComputeValue">
		<arg-type>String</arg-type>
	</replaced-method>
</bean>

<bean id="replacementComputeValue" class="a.b.c.ReplacementComputeValue"/>

你可以在 <replaced-method/> 元素内使用一个或多个 <arg-type/> 元素来指示被覆盖方法的签名。参数的签名仅在方法重载且类中存在多个变体时才需要。为方便起见，参数的类型字符串可以是完全限定类型名的子字符串。例如，以下所有字符串都匹配 java.lang.String

java.lang.String
String
Str

由于参数数量通常足以区分各种可能的选择，此快捷方式可以节省大量输入，只需键入与参数类型匹配的最短字符串即可。