方法注入

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

一个解决方案是放弃一些控制反转。你可以通过实现 ApplicationContextAware 接口让 bean A 知道容器,并通过每次 bean A 需要时调用 getBean("B") 向容器请求一个(通常是新的)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 框架。方法注入是 Spring IoC 容器的一个稍高级的特性,它能让你干净地处理这个用例。

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

查找方法注入

查找方法注入是容器覆盖容器管理 bean 上的方法并返回容器中另一个命名 bean 的查找结果的能力。查找通常涉及原型 bean,如上一节中描述的场景。Spring 框架通过使用 CGLIB 库的字节码生成来动态生成覆盖该方法的子类来实现此方法注入。

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

  • 对一个具有 abstract 方法的类进行单元测试,需要你自行创建该类的子类并提供 abstract 方法的桩实现。

  • 另一个关键限制是查找方法不适用于工厂方法,尤其不适用于配置类中的 @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 作为原型部署。如果它是单例,则每次都会返回 myCommand bean 的同一实例。

或者,在基于注解的组件模型中,你可以通过 @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
}

或者,更惯用的做法是,你可以依靠目标 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 包中)很有用。

任意方法替换

与查找方法注入相比,一种不太有用的方法注入形式是能够用另一种方法实现替换托管 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

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

© . This site is unofficial and not affiliated with VMware.