马上注册,结交更多好友,享用更多功能,让你轻松玩转社区。
您需要 登录 才可以下载或查看,没有账号?立即注册
x
使用案例
前置条件: 现在有一个 Vehicle 接口,它有两个实现类 Bus 和 Car ,现在还有一个类 VehicleService 需要注入一个 Vehicle 类型的 Bean:- public interface Vehicle {}
- @Component
- public class Car implements Vehicle {}
- @Component
- public class Bus implements Vehicle {}
复制代码 使用 @Autowired 注解注入 Bean:
@Autowired 注解可以和 @Qualifier 注解一起使用,在有多个符合条件的 Bean 的情况下限制注入特定名称的 Bean:- @Component
- public class VehicleService {
- @Autowired
- @Qualifier("car") //假设这里是想要注入Bean名称为car的这个Bean
- private Vehicle vehicle;
- }
复制代码 使用 @Inject 注解注入 Bean:
@Inject 注解可以和 @Qualifier或者 @Named 注解一起使用,在有多个符合条件的 Bean 的情况下限制注入特定名称的 Bean:- @Component
- public class VehicleService {
- @Inject
- @Qualifier("car") //假设这里是想要注入Bean名称为car的这个Bean
- private Vehicle vehicle;
- @Inject
- @Named("bus") //假设这里是想要注入Bean名称为bus的这个Bean
- private Vehicle anotherVehicle;
- }
复制代码 使用 @Resource 注解注入 Bean:- @Component
- public class VehicleService {
- @Resource(name = "car")
- private Vehicle vehicle;
- }
复制代码 虽然以上三种使用方法都能够实现注入 Bean 的需求,但是它们在底层实现上有什么区别呢?
注崩溃系
在 Java EE 和 Spring 体系中定义了几套注解:
JSR 250:定义了 @PostConstruct,@PreDestroy,@Resource 注解,其中 @Resource 注解默认是按照名称进行注入。
JSR 330:定义了 @Inject,@Qualifier, @Named 注解,其中 @Inject 注解默认是按照类型进行注入,可以搭配 @Qualifier 或者@Named 注解实现按照名称注入。
Spring:定义了 @Autowired,@Qualifier注解,其中 @Autowired 注解默认是按照类型进行注入,可以搭配 @Qualifier 注解实现按照名称注入。
当前 JSR 250 定义的注解属于 jakarta.annotation-api,而 JSR 330 定义的注解属于 jakarta.inject-api。
实现原理
InstantiationAwareBeanPostProcessor 方法调用触发的位置:
Spring 中提供了 InstantiationAwareBeanPostProcessor 接口,它有一个 postProcessProperties() 负责实现对 Bean 的属性进行处理。
Spring 中提供了实现类 CommonAnnotationBeanPostProcessor 负责处理 @Resource 注解;提供了实现类 AutowiredAnnotationBeanPostProcessor 负责处理 @Autowired 注解和 @Inject 注解。
InstantiationAwareBeanPostProcessor的 postProcessProperties() 方法是在 AbstractAutowireCapableBeanFactory 中的 doCreateBean() 创建 Bean 的方法中触发调用的,在这个方法中的主要实现逻辑是实例化 Bean -> 添补 Bean 属性 -> 初始化 Bean。 代码如下:- protected Object doCreateBean(String beanName, RootBeanDefinition mbd,
- @Nullable Object[] args) throws BeanCreationException {
- BeanWrapper instanceWrapper = null;
- if (mbd.isSingleton()) {
- instanceWrapper = this.factoryBeanInstanceCache.remove(beanName);
- }
- if (instanceWrapper == null) {
- //实例化Bean对象
- instanceWrapper = createBeanInstance(beanName, mbd, args);
- }
- Object bean = instanceWrapper.getWrappedInstance();
- boolean earlySingletonExposure = (mbd.isSingleton()
- && this.allowCircularReferences
- && isSingletonCurrentlyInCreation(beanName));
- if (earlySingletonExposure) {
- addSingletonFactory(beanName,
- () -> getEarlyBeanReference(beanName, mbd, bean));
- }
- Object exposedObject = bean;
- try {
- //填充Bean属性
- populateBean(beanName, mbd, instanceWrapper);
- //初始化Bean
- exposedObject = initializeBean(beanName, exposedObject, mbd);
- }
- }
复制代码 在添补 Bean 属性的方法 populateBean() 中实现了对 postProcessProperties() 方法的调用,在该方法实现对注解修饰的需要注入的字段进行赋值,即自动注入。 代码如下:- protected void populateBean(String beanName, RootBeanDefinition mbd, @Nullable BeanWrapper bw) {
- //省略部分代码
- PropertyValues pvs = (mbd.hasPropertyValues() ? mbd.getPropertyValues() : null);
- if (hasInstantiationAwareBeanPostProcessors()) {
- if (pvs == null) {
- pvs = mbd.getPropertyValues();
- }
- //这里获取所有InstantiationAwareBeanPostProcessor接口的实现类
- for (InstantiationAwareBeanPostProcessor bp : getBeanPostProcessorCache().instantiationAware) {
- //调用postProcessProperties()方法
- PropertyValues pvsToUse = bp.postProcessProperties(pvs,
- bw.getWrappedInstance(), beanName);
- if (pvsToUse == null) {
- return;
- }
- pvs = pvsToUse;
- }
- }
- }
复制代码 InstantiationAwareBeanPostProcessor 注册的时机:
既然 InstantiationAwareBeanPostProcessor 是负责处理 Bean 的属性的自动注入的,那么它一定是在业务 Bean 创建之前就已经完成初始化了,这样在业务 Bean 创建的时间才气调用它的实例方法。它的初始化是在 Spring 上下文的基类 AbstractApplicationContext 的 refresh() 方法中完成的。代码如下:- public void refresh() throws BeansException, IllegalStateException {
- //省略其它代码
- //这里注册了InstantiationAwareBeanPostProcessor
- registerBeanPostProcessors(beanFactory);
-
- //省略其它代码
-
- //这里创建所有的单例Bean
- finishBeanFactoryInitialization(beanFactory);
-
- finishRefresh();
- }
复制代码 而在 registerBeanPostProcessors() 方法中又调用了 PostProcessorRegistrationDelegate 的 registerBeanPostProcessors() 方法来完成注册的。代码如下:- protected void registerBeanPostProcessors(ConfigurableListableBeanFactory beanFactory) {
- PostProcessorRegistrationDelegate.registerBeanPostProcessors(beanFactory, this);
- }
复制代码 在PostProcessorRegistrationDelegate 的 registerBeanPostProcessors() 方法真正实现注册逻辑。代码如下:- public static void registerBeanPostProcessors(ConfigurableListableBeanFactory beanFactory,
- AbstractApplicationContext applicationContext) {
- //这里获取到所有实现了BeanPostProcessor接口的Bean名称
- //InstantiationAwareBeanPostProcessor接口继承了BeanPostProcessor接口
- String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanPostProcessor.class, true, false);
- //遍历Bean名称调用BeanFactory.getBean()方法触发BeanPostProcessor Bean的创建
- //然后根据是否实现了PriorityOrdered接口、Ordered接口和其它分为三大类
- //分别将这三大类的BeanPostProcessor实例进行注册
- List<BeanPostProcessor> priorityOrderedPostProcessors = new ArrayList<>();
- List<BeanPostProcessor> internalPostProcessors = new ArrayList<>();
- List<String> orderedPostProcessorNames = new ArrayList<>();
- List<String> nonOrderedPostProcessorNames = new ArrayList<>();
- for (String ppName : postProcessorNames) {
- if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {
- //这里调用BeanFactory.getBean()方法触发BeanPostProcessor Bean的创建
- BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
- priorityOrderedPostProcessors.add(pp);
- if (pp instanceof MergedBeanDefinitionPostProcessor) {
- internalPostProcessors.add(pp);
- }
- }
- else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
- orderedPostProcessorNames.add(ppName);
- }
- else {
- nonOrderedPostProcessorNames.add(ppName);
- }
- }
- //首先注册实现了PriorityOrdered接口的BeanPostProcessor
- sortPostProcessors(priorityOrderedPostProcessors, beanFactory);
- registerBeanPostProcessors(beanFactory, priorityOrderedPostProcessors);
- //然后触发实现了Ordered接口的BeanPostProcessor Bean的创建并注册
- List<BeanPostProcessor> orderedPostProcessors = new ArrayList<>(orderedPostProcessorNames.size());
- for (String ppName : orderedPostProcessorNames) {
- BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
- orderedPostProcessors.add(pp);
- if (pp instanceof MergedBeanDefinitionPostProcessor) {
- internalPostProcessors.add(pp);
- }
- }
- sortPostProcessors(orderedPostProcessors, beanFactory);
- registerBeanPostProcessors(beanFactory, orderedPostProcessors);
- //最后触发其它BeanPostProcessor Bean的创建并注册
- List<BeanPostProcessor> nonOrderedPostProcessors = new ArrayList<>(nonOrderedPostProcessorNames.size());
- for (String ppName : nonOrderedPostProcessorNames) {
- BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
- nonOrderedPostProcessors.add(pp);
- if (pp instanceof MergedBeanDefinitionPostProcessor) {
- internalPostProcessors.add(pp);
- }
- }
- registerBeanPostProcessors(beanFactory, nonOrderedPostProcessors);
- sortPostProcessors(internalPostProcessors, beanFactory);
- registerBeanPostProcessors(beanFactory, internalPostProcessors);
- }
复制代码 CommonAnnotationBeanPostProcessor 实现逻辑(以修饰字段为例)
首先在 CommonAnnotationBeanPostProcessor 的静态初始化块中初始化了它要处理的注解。代码如下:- static {
- //这里是为了适配不同版本@Resource注解在不同的包路径下
- jakartaResourceType = loadAnnotationType("jakarta.annotation.Resource");
- if (jakartaResourceType != null) {
- resourceAnnotationTypes.add(jakartaResourceType);
- }
- //这里是为了适配不同版本@Resource注解在不同的包路径下
- javaxResourceType = loadAnnotationType("javax.annotation.Resource");
- if (javaxResourceType != null) {
- resourceAnnotationTypes.add(javaxResourceType);
- }
- }
复制代码 在它的 postProcessProperties() 方法中主要实现逻辑为找到 @Resource 注解修饰的字段 -> 通过反射给字段赋值。代码如下:- public PropertyValues postProcessProperties(PropertyValues pvs, Object bean, String beanName) {
- //找@Resource注解修饰的字段
- InjectionMetadata metadata = findResourceMetadata(beanName, bean.getClass(), pvs);
- try {
- //给字段赋值
- metadata.inject(bean, beanName, pvs);
- }
- catch (Throwable ex) {
- throw new BeanCreationException(beanName, "Injection of resource dependencies failed", ex);
- }
- return pvs;
- }
复制代码 找 @Resource 注解修饰的字段是在 findResourceMetadata() 方法中实现的,在该方法中又调用了 buildResourceMetadata() 来进行实际的查找,在这个方法中通过反射的方式遍历字段看它是否有 @Resource 注解修饰,如果是的话把它包装为一个 ResourceElement 对象放到列表中。末了基于列表构造一个 InjectionMetadata 对象返回。代码如下:- private InjectionMetadata findResourceMetadata(String beanName, Class<?> clazz, @Nullable PropertyValues pvs) {
- String cacheKey = (StringUtils.hasLength(beanName) ? beanName : clazz.getName());
- InjectionMetadata metadata = this.injectionMetadataCache.get(cacheKey);
- if (InjectionMetadata.needsRefresh(metadata, clazz)) {
- synchronized (this.injectionMetadataCache) {
- metadata = this.injectionMetadataCache.get(cacheKey);
- if (InjectionMetadata.needsRefresh(metadata, clazz)) {
- if (metadata != null) {
- metadata.clear(pvs);
- }
- //这里调用buildResourceMetadata()方法
- metadata = buildResourceMetadata(clazz);
- this.injectionMetadataCache.put(cacheKey, metadata);
- }
- }
- }
- return metadata;
- }
- private InjectionMetadata buildResourceMetadata(Class<?> clazz) {
- List<InjectionMetadata.InjectedElement> elements = new ArrayList<>();
- Class<?> targetClass = clazz;
- //省略部分代码
-
- do {
- final List<InjectionMetadata.InjectedElement> currElements = new ArrayList<>();
- //这里就会遍历每个字段看字段是否有@Resource注解修饰有的话就加入到列表中
- ReflectionUtils.doWithLocalFields(targetClass, field -> {
- //省略部分代码
-
- if (jakartaResourceType != null && field.isAnnotationPresent(jakartaResourceType)) {
- if (Modifier.isStatic(field.getModifiers())) {
- throw new IllegalStateException("@Resource annotation is not supported on static fields");
- }
- if (!this.ignoredResourceTypes.contains(field.getType().getName())) {
- currElements.add(new ResourceElement(field, field, null));
- }
- }
- else if (javaxResourceType != null && field.isAnnotationPresent(javaxResourceType)) {
- if (Modifier.isStatic(field.getModifiers())) {
- throw new IllegalStateException("@Resource annotation is not supported on static fields");
- }
- if (!this.ignoredResourceTypes.contains(field.getType().getName())) {
- currElements.add(new LegacyResourceElement(field, field, null));
- }
- }
- });
- elements.addAll(0, currElements);
- targetClass = targetClass.getSuperclass();
- }
- while (targetClass != null && targetClass != Object.class);
- return InjectionMetadata.forElements(elements, clazz);
- }
复制代码 实际触发赋值的操作是在 InjectionMetadata 的 inject() 方法中实现的,在它的方法中又会循环调用 InjectedElement 的 inject() 方法。代码如下:- public void inject(Object target, @Nullable String beanName, @Nullable PropertyValues pvs) throws Throwable {
- Collection<InjectedElement> checkedElements = this.checkedElements;
- Collection<InjectedElement> elementsToIterate =
- (checkedElements != null ? checkedElements : this.injectedElements);
- if (!elementsToIterate.isEmpty()) {
- for (InjectedElement element : elementsToIterate) {
- element.inject(target, beanName, pvs);
- }
- }
- }
复制代码 在 InjectedElement 的 inject() 方法中通过反射的方式将找到的 Bean 赋值给字段。代码如下:- protected void inject(Object target, @Nullable String requestingBeanName, @Nullable PropertyValues pvs)
- throws Throwable {
- if (!shouldInject(pvs)) {
- return;
- }
- if (this.isField) {
- Field field = (Field) this.member;
- ReflectionUtils.makeAccessible(field);
- //这里通过反射的方式设置值,设置的值就是根据Bean名称获取到的Bean
- field.set(target, getResourceToInject(target, requestingBeanName));
- } else {
- //省略其它代码
- }
- }
复制代码 在 ResourceElement 的 getResourceToInject() 方法中实现了查找逻辑:如果 BeanFactory 中包含这个 Bean 名称对应的 Bean 则直接根据名称查找,否则会根据类型进行匹配,这个就是常说的 @Resource 注解默认是按照名称进行匹配的,名称匹配不到的情况下再按照类型进行匹配。代码如下:- protected Object getResource(LookupElement element, @Nullable String requestingBeanName)
- throws NoSuchBeanDefinitionException {
- //省略代码
- // Regular resource autowiring
- if (this.resourceFactory == null) {
- throw new NoSuchBeanDefinitionException(element.lookupType,
- "No resource factory configured - specify the 'resourceFactory' property");
- }
- return autowireResource(this.resourceFactory, element, requestingBeanName);
- }
- protected Object autowireResource(BeanFactory factory, LookupElement element, @Nullable String requestingBeanName)
- throws NoSuchBeanDefinitionException {
- Object resource;
- Set<String> autowiredBeanNames;
- String name = element.name;
- if (factory instanceof AutowireCapableBeanFactory autowireCapableBeanFactory) {
- //如果根据Bean名称找不到Bean且允许按照类型匹配的情况下走第一个分支
- if (this.fallbackToDefaultTypeMatch && element.isDefaultName && !factory.containsBean(name)) {
- autowiredBeanNames = new LinkedHashSet<>();
- resource = autowireCapableBeanFactory.resolveDependency(
- element.getDependencyDescriptor(), requestingBeanName, autowiredBeanNames, null);
- if (resource == null) {
- throw new NoSuchBeanDefinitionException(element.getLookupType(), "No resolvable resource object");
- }
- } else { //如果根据名称找得到Bean则直接根据名称获取Bean
- resource = autowireCapableBeanFactory.resolveBeanByName(name, element.getDependencyDescriptor());
- autowiredBeanNames = Collections.singleton(name);
- }
- } else {
- //省略代码
- }
- //省略代码
- return resource;
- }
复制代码 按照类型匹配的逻辑是在 DefaultListableBeanFactory 的 doResolveDependency() 方法中实现的,在该方法中会根据类型找到所有是当前类型的 Bean,然后构造一个 Map,key 是 Bean 的名称,value 是对应的 Bean 对象,如果找到的 Bean 个数大于 1 则会选择一个最符合条件的返回(选择的依据背面会讲到),如果等于 1 则直接返回这个 Bean。代码如下:- public Object doResolveDependency(DependencyDescriptor descriptor, @Nullable String beanName,
- @Nullable Set<String> autowiredBeanNames, @Nullable TypeConverter typeConverter) throws BeansException {
- InjectionPoint previousInjectionPoint = ConstructorResolver.setCurrentInjectionPoint(descriptor);
- try {
- //省略代码
-
- //这里根据类型找到所有的Bean,然后Bean的名称作为key,Bean作为Value
- Map<String, Object> matchingBeans = findAutowireCandidates(beanName, type, descriptor);
- if (matchingBeans.isEmpty()) {
- // Step 4c (fallback): custom Collection / Map declarations for collecting multiple beans
- multipleBeans = resolveMultipleBeansFallback(descriptor, beanName, autowiredBeanNames, typeConverter);
- if (multipleBeans != null) {
- return multipleBeans;
- }
- // Raise exception if nothing found for required injection point
- if (isRequired(descriptor)) {
- raiseNoMatchingBeanFound(type, descriptor.getResolvableType(), descriptor);
- }
- return null;
- }
- String autowiredBeanName;
- Object instanceCandidate;
- //如果根据类型找到多个Bean则需要选择一个合适的Bean返回
- if (matchingBeans.size() > 1) {
- autowiredBeanName = determineAutowireCandidate(matchingBeans, descriptor);
- if (autowiredBeanName == null) {
- if (isRequired(descriptor) || !indicatesArrayCollectionOrMap(type)) {
- // Raise exception if no clear match found for required injection point
- return descriptor.resolveNotUnique(descriptor.getResolvableType(), matchingBeans);
- }
- else {
- // In case of an optional Collection/Map, silently ignore a non-unique case:
- // possibly it was meant to be an empty collection of multiple regular beans
- // (before 4.3 in particular when we didn't even look for collection beans).
- return null;
- }
- }
- instanceCandidate = matchingBeans.get(autowiredBeanName);
- } else {
- //如果只有一个Bean则直接返回这个Bean
- Map.Entry<String, Object> entry = matchingBeans.entrySet().iterator().next();
- autowiredBeanName = entry.getKey();
- instanceCandidate = entry.getValue();
- }
- // Step 6: validate single result
- if (autowiredBeanNames != null) {
- autowiredBeanNames.add(autowiredBeanName);
- }
- if (instanceCandidate instanceof Class) {
- instanceCandidate = descriptor.resolveCandidate(autowiredBeanName, type, this);
- }
- return resolveInstance(instanceCandidate, descriptor, type, autowiredBeanName);
- }
- finally {
- ConstructorResolver.setCurrentInjectionPoint(previousInjectionPoint);
- }
- }
复制代码 AutowiredAnnotationBeanPostProcessor 实现逻辑(以修饰字段为例)
首先在构造函数中初始化了需要处理的注解包罗 @Autowired 和 @Inject 注解。代码如下:
[code]public AutowiredAnnotationBeanPostProcessor() { //添加要处理@Autowired注解 this.autowiredAnnotationTypes.add(Autowired.class); this.autowiredAnnotationTypes.add(Value.class); ClassLoader classLoader = AutowiredAnnotationBeanPostProcessor.class.getClassLoader(); try { //这里是为了适配不同版本@Inject注解在不同的包路径下 this.autowiredAnnotationTypes.add((Class |