正确使用@Resource

目录

  • [1 怎么使用`@Resource`?](#1 怎么使用@Resource?)
    • [1.0 实验环境](#1.0 实验环境)
    • [1.1 通过字段注入依赖](#1.1 通过字段注入依赖)
    • [1.2 bean property setter methods (setter方法)](#1.2 bean property setter methods (setter方法))
  • [2 打破岁月静好(`@Resource takes a name attribute`)](#2 打破岁月静好(@Resource takes a name attribute))
    • [2.1 结论](#2.1 结论)
    • [2.2 那我不指定呢?【结论:又能正常执行了】](#2.2 那我不指定呢?【结论:又能正常执行了】)
      • [2.2.1 default name](#2.2.1 default name)
  • [3 总结【@Resource是by-name来注入依赖的】](#3 总结【@Resource是by-name来注入依赖的】)

1 怎么使用@Resource?

参考官方文档

1.0 实验环境

  • 项目结构:
  • 代码
java 复制代码
@Configuration
public class LearnResourceConfig {
    @Bean
    public MovieFinder movieFinder() {
        return new MovieFinder();
    }
}

public class MovieFinder {
    public void sayHello() {
        System.out.println(this.getClass().getSimpleName() + ", hello");
    }
}

1.1 通过字段注入依赖

  • SimpleMovieLister
java 复制代码
@Component
public class SimpleMovieLister {
    @Resource(name = "movieFinder")
    private MovieFinder movieFinder;

    public void sayHello() {
        movieFinder.sayHello();
        System.out.println(this.getClass().getSimpleName() + ", hello");
    }
}
  • Application
java 复制代码
@ComponentScan
public class Application {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(Application.class);
        Arrays.stream(applicationContext.getBeanDefinitionNames()).forEach(System.out::println);
        System.out.println("---------------------------------------------------------------");
        SimpleMovieLister simpleMovieLister = applicationContext.getBean(SimpleMovieLister.class);
        simpleMovieLister.sayHello();
    }
}

/*
org.springframework.context.event.internalEventListenerFactory
application
simpleMovieLister
learnResourceConfig
movieFinder
---------------------------------------------------------------
MovieFinder, hello
SimpleMovieLister, hello
*/

1.2 bean property setter methods (setter方法)

  • SimpleMovieLister
java 复制代码
@Component
public class SimpleMovieLister {
    private MovieFinder movieFinder;

    @Resource(name = "movieFinder")
    public void setMovieFinder(MovieFinder movieFinder) {
        this.movieFinder = movieFinder;
    }

    public void sayHello() {
        movieFinder.sayHello();
        System.out.println(this.getClass().getSimpleName() + ", hello");
    }
}
  • SimpleMovieLister打上了@Component注解,因此,在Spring的眼中,这是一个bean。
    • movieFinder是这个bean的property
    • 这个property提供了setter方法
  • 所以,这称为在"bean property setter methods"上用@Resource注解注入依赖。

2 打破岁月静好(@Resource takes a name attribute)

  • 修改LearnResourceConfig
java 复制代码
@Configuration
public class LearnResourceConfig {
	/*
	MovieFinder这个Bean的名称从movieFinder变成了myMovieFinder
	*/
    @Bean
    public MovieFinder myMovieFinder() {
        return new MovieFinder();
    }
}
  • 无论是字段注入还是setter方法注入,都没法运行了。报错:No bean named 'movieFinder' available。

2.1 结论

  • 如果@Resource注解中指定了name属性,那么Spring只会根据name属性的值去找bean,找不到则报错。

2.2 那我不指定呢?【结论:又能正常执行了】

  • 如果@Resource注解没有指定name属性,那么会根据字段名或setter方法推断一个默认名字。
    • 如果根据默认名字找到了bean,那就注入这个bean。
    • 如果根据默认名字找不到bean,那就降级为根据类型去找bean。
    • 如果还找不到,那就报错。

2.2.1 default name

  • org.springframework.context.annotation.CommonAnnotationBeanPostProcessor.ResourceElement#ResourceElement
java 复制代码
public ResourceElement(Member member, AnnotatedElement ae, @Nullable PropertyDescriptor pd) {
		super(member, pd);
		Resource resource = ae.getAnnotation(Resource.class);
		String resourceName = resource.name();
		Class<?> resourceType = resource.type();
		this.isDefaultName = !StringUtils.hasLength(resourceName);
		if (this.isDefaultName) {
			resourceName = this.member.getName();
			if (this.member instanceof Method && resourceName.startsWith("set") && resourceName.length() > 3) {
				resourceName = Introspector.decapitalize(resourceName.substring(3));
			}
		}
		...
  • 如果是字段注入,那么defaultName为字段名。
java 复制代码
@Component
public class SimpleMovieLister {
    @Resource
    private MovieFinder forrestMovieFinder;

	...
}
  • 如果是setter方法注入(setXXX),那么defaultName为XXX
java 复制代码
@Component
public class SimpleMovieLister {
    private MovieFinder movieFinder;

    @Resource
    public void setJerryMovieFinder(MovieFinder movieFinder) {
        this.movieFinder = movieFinder;
    }
    ...
}

3 总结【@Resource是by-name来注入依赖的】

  • 如果@Resource注解中指定了name属性,那么Spring只会根据name属性的值去找bean,找不到则报错。
  • 如果@Resource注解没有指定name属性,那么会根据字段名或setter方法推断一个默认名字。
    • 如果根据默认名字找到了bean,那就注入这个bean。
    • 如果根据默认名字找不到bean,那就降级为根据类型去找bean。
    • 如果还找不到,那就报错。
相关推荐
行百里er10 小时前
【Spring Insight 技术分享】跨服务调用链路是怎么串起来的?
后端·spring·开源
Forget the Dream12 小时前
Spring AI 2.0 系列(三):ChatClient 与 ChatModel:Spring AI 2.0 的两层职责
java·人工智能·spring·springai
皮皮林5511 天前
为什么越来越多人用 Spring AI ?
spring
Resean02231 天前
Spring 源码分析(七)AOP 原理(上):代理的创建
java·后端·spring
Tangq一定可以的1 天前
Spring AI Advisor 详解 - 给大模型调用加上“切面“,日志/过滤/记忆一键搞定
java·后端·spring
杨凯凡1 天前
Spring Framework 7 原生重试与并发限制实战:@Retryable、@ConcurrencyLimit 能替代 Resilience4j 吗?
数据库·spring·sqlserver
代码不停2 天前
Spring 原理
java·spring
杨凯凡2 天前
Spring AI MCP 多租户安全实战:共享 Session 会串数据吗?工具权限与隔离边界
人工智能·安全·spring
Resean02232 天前
Spring 源码分析(二)配置类的解析与扫描
java·后端·spring
斯维赤2 天前
SpringBoot接口调不通排查终极方案
java·后端·spring