前言
在 Spring 框架中,@Lookup
注解是一个比较少见但极为实用的注解。它的主要作用是用来解决原型(prototype)Bean 在单例(singleton)Bean 中注入的问题。@Lookup
注解的本质是告诉 Spring 容器在运行时为被注解的方法动态生成方法实现,以便每次调用方法时都返回一个新的(或指定作用域的)Bean 实例。
本篇文章将详细解析 @Lookup
注解的使用方法、底层实现原理以及实际应用案例,帮助你更深入理解 Spring 框架的动态代理机制和依赖注入原理。
一、@Lookup 的应用场景
1.1 多实例 Bean 的注入
在 Spring 中,默认情况下,Bean 是单例模式的。如果我们将一个原型 Bean 注入到一个单例 Bean 中,那么这个原型 Bean 实际上只会被实例化一次,后续使用的都是同一个对象,这与原型 Bean 的设计初衷相悖。
这时就可以使用 @Lookup
注解,在每次方法调用时动态获取新的原型 Bean。
1.2 场景示例
比如有一个发送通知的服务类 NotificationService
是单例的,但其内部依赖一个状态对象 NotificationTask
是原型的,每次发送通知都需要新的任务对象。
@Component
public class NotificationService {
@Lookup
public NotificationTask createTask() {
// Spring 会在运行时覆盖这个方法实现,返回新的原型 Bean
return null;
}
public void sendNotification(String message) {
NotificationTask task = createTask();
task.setMessage(message);
task.execute();
}
}
@Component
@Scope("prototype")
public class NotificationTask {
private String message;
public void setMessage(String message) {
this.message = message;
}
public void execute() {
System.out.println("Sending: " + message);
}
}
二、@Lookup 的使用方式
2.1 注解方法
可以将 @Lookup
注解放在一个无参的抽象方法或者普通方法上,Spring 会通过 CGLIB 动态代理重写这个方法,返回指定类型的 Bean。
@Lookup
public SomePrototypeBean getBean() {
return null;
}
2.2 指定 Bean 名称
@Lookup("myPrototypeBean")
public SomePrototypeBean getBean() {
return null;
}
如果有多个相同类型的 Bean,可以通过参数指定 Bean 的名称。
三、@Lookup 注解的实现原理
3.1 背景知识:动态代理和 CGLIB
Spring 在处理 @Lookup
注解时,会在 Bean 实例化时对类生成 CGLIB 代理子类,并动态地覆写被 @Lookup
注解的方法。
3.2 LookupOverride 机制
Spring 的 @Lookup
注解其实是 AbstractBeanDefinition
中 MethodOverrides
的一种实现,底层对应的是 LookupOverride
对象。Spring 会在解析 Bean 定义时记录 @Lookup
的方法,并在创建 Bean 的时候将其注入到 BeanDefinition
中。
3.3 实例流程解析
-
Spring 容器启动时,扫描
@Lookup
注解。 -
通过反射分析类的方法,记录需要被覆盖的方法。
-
创建代理类时,使用 CGLIB 覆盖这些方法,实现调用
BeanFactory.getBean()
。 -
方法被调用时,返回新的原型 Bean 实例。
伪代码说明:
@Override
public SomePrototypeBean getBean() {
return applicationContext.getBean("somePrototypeBean");
}
这就是 Spring 自动生成的方法逻辑。
五、源码剖析
5.1 关键类
-
org.springframework.beans.factory.annotation.Lookup
-
org.springframework.beans.factory.support.LookupOverride
-
org.springframework.beans.factory.support.MethodOverrides
-
org.springframework.beans.factory.support.AbstractBeanDefinition
5.2 解析流程
Spring 在解析 Bean 时调用 LookupAnnotationBeanPostProcessor
,通过 MethodIntrospector
找到标记了 @Lookup
的方法,并构建 LookupOverride
对象添加到 BeanDefinition
中。
5.3 CGLIB 代理生成
最终由 CglibSubclassingInstantiationStrategy
创建代理对象,并生成覆写方法的代理类,实现运行时动态注入逻辑。
六、与其他方式的对比
6.1 使用 ApplicationContext.getBean()
手动从容器中获取原型 Bean:
@Component
public class MyService {
@Autowired
private ApplicationContext context;
public void doWork() {
TaskBean task = context.getBean(TaskBean.class);
task.run();
}
}
缺点是侵入性强,可测试性差。
6.2 使用 ObjectFactory
@Component
public class MyService {
@Autowired
private ObjectFactory<TaskBean> taskFactory;
public void doWork() {
TaskBean task = taskFactory.getObject();
task.run();
}
}
灵活性高,但代码可读性略差。
6.3 使用 @Lookup
@Lookup
public TaskBean getTask() {
return null;
}
代码简洁,低侵入性,推荐使用。
七、实战建议
7.1 不要滥用
虽然 @Lookup
功能强大,但如果过多使用,会增加系统复杂度,建议仅在确实需要动态获取原型 Bean 的场景下使用。
7.2 方法不能是 private
Spring 需要代理方法,不能代理 private 方法。
7.3 与 AOP 的兼容性
由于基于 CGLIB 实现,可能会和 AOP 产生冲突,需注意使用顺序和代理模式设置。
八、总结
@Lookup
注解提供了一种非常优雅的方式在运行时注入多实例 Bean,极大地提升了 Spring Bean 管理的灵活性。其底层依赖 CGLIB 动态代理和 BeanDefinition
的 MethodOverrides
机制,充分展现了 Spring 框架在依赖注入方面的强大能力。
通过掌握 @Lookup
,你可以在需要动态获取 Bean 实例的场景中更好地控制对象生命周期和使用方式,也能更深入理解 Spring 的设计理念与实现细节。