深入了解@Configuration、@Bean注解

2022/01/17 spring专题 共 42268 字,约 121 分钟
闷骚的程序员

1. spring底层对普通方式比如@Component,和特殊方式@Bean的处理区别

@Bean标注在一个方法上,会自动执行该方法,将该方法的返回值作为bean实例注册到spring容器中去。

1.1 beanDefinition描述的bean类型有区别

@Bean注册的beanDefinition中,描述的bean类型就是@Bean标注的方法返回值类型,不会添加目标bean的所有父类型。
这点需要特别注意,@Bean注册的bean类型就是方法返回值的类型,为什么非要强调这一点?
是因为通过@Bean的方式注册到容器中的bean的类型就是方法返回值的类型,这在通过context.getBean(TargetBean.class)这种方式获取bean实例时有很大的影响。

举个例子:

public interface MyInterface{}

上述接口有一个实现类:

public class MyInterfaceImpl implements MyInterface{}

如果通过普通方式注册MyInterfaceImpl的话,比如:

@Component
public class MyInterfaceImpl implements MyInterface{}

这种方式注册到spring容器中的bean,其根据该类的class转换成的BeanDefinition对象中,大概有如下信息:
beanName:是类名驼峰化后的字符串。
beanType:是该类的真实类型,比如MyInterfaceImpl、同时还会将该类的所有父类型依次绑定到该bean的BeanDefinition中,比如 MyInterface类型。如果MyInterface还有父类型,会递归检索,直到发现父类型是Object.class为止。
因此,通过applicationContext.getBean(MyInterface.class)是可以成功从容器中获取到MyInterfaceImpl实例的。
实际上通过@Component等方式注册的bean,转换后的BeanDefinition类型是org.springframework.context.annotation.ScannedGenericBeanDefinition,通过在自定义的beanFactoryPostProcessor中进行代码调试可以发现有如下结构:
metaData:这个对象中定义了目标bean的ClassName、SuperClassName表示目标Bean的直接父类、InterfaceNames表示了目标Bean的所有直接接口的权限定名。
beanClass:表示目标Bean的Class对象。
scope:表示目标Bean的scope,默认是singleton。
除此之外还有很多信息,都用来描述目标bean。

而如果通过@Bean的方式注册:

@Bean
public MyInterfaceImpl myTest(){
    return new MyInterfaceImpl();
}

则注册到容器中的beanDefinition对象类型是class org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader$ConfigurationClassBeanDefinition,大概包括如下信息:
beanName:默认是方法名称、如果@Bean注解显式指定了beanName,则优先使用指定的。比如该案例中,beanName就是myTest。
beanType:beanDefinition中绑定的目标bean类型就是@Bean方法返回的类型。在本案例中就是MyInterfaceImpl一个,而不会包含返回类型的所有父类型。
具体结构如下:
annotationMetadata:描述目标bean所在类的注解信息,里面有所在配置类的类名称、配置类上的注解等信息。
factoryMethodMetadata:这个字段比较重要了,只有通过@Bean方式注册的beanDefinition才有这个字段,它里面描述了真正用于实例化目标bean的工厂方法信息,其中有methodName、returnTypeName等。这个returnTypeName就是用来描述@Bean的工厂方法返回值类型的。
而@Bean方式注册的beanDefinition中没有beanClass以及metaData等信息。

从这可以看出,实际上对于@Component和@Bean注册的bean,转换后的BeanDefinition类型本来就不同,且其中维护bean信息的描述结构也有差异,这种差异导致了通过applicationContext.getBean(MyInterface.class)获取目标类型的bean实例时,底层采用了不同的策略。

导致的结果是:通过applicationContext.getBean(MyInterface.class)是无法获取到@Bean注册的bean实例的,除非将@Bean的返回值类型显式修改为MyInterface。

1.1.1 @Bean注册方式深入分析

如果有一个Bean的类是MyClass,它实现了一个接口MyB,MyB继承了MyA。

在Spring中,通过@Bean注册的Bean和通过@Component或其他注解(如@Service, @Repository等)注册的Bean在类型处理上确实存在一些差异,这与Spring容器管理Bean的方式以及context.getBean()方法的底层逻辑有关。 当你使用@Bean注解注册一个Bean时,Spring默认会将这个Bean的描述对象BeanDefinition中的目标bean类型绑定为@Bean方法的返回值类型。
也就是说,@Bean方法本质上是通过Java配置类(通常使用@Configuration注解标注)显式声明的,它仅将返回值的具体类型绑定到BeanDefinition对象然后注册到Spring容器中。

具体描述为:当你使用@Bean方法注册一个Bean时,Spring会根据方法的返回类型来创建一个BeanDefinition。在这种情况下,BeanDefinition只会持有方法返回值的类型信息,而不会包括这个类型的父类和接口,除非你显式地将方法返回类型声明为父类或接口类型。
(1)Spring解析@Bean方法,创建BeanDefinition。
(2)BeanDefinition持有的方法返回类型是唯一的类型信息,这个类型存储在factoryMethodMetadata中,上面已经分析过。

例如:

@Bean
public MyClass myBean() {
    return new MyClass();
}

在这个例子中,Spring将myBean方法返回的对象注册为MyClass类型的Bean。这句话的意思是指,spring首先解析出当前bean的BeanDefinition,然后为该bean定义绑定beanType时,只将@Bean方法的返回值类型绑定,作为目标bean的描述类型。
因此,Spring容器中管理的这个Bean的类型是MyClass,你可以通过context.getBean(MyClass.class)来获取这个Bean。
然而,如果你尝试通过context.getBean(MyB.class)context.getBean(MyA.class)来获取这个Bean,Spring会找不到它,因为在注册时它被视为MyClass类型,而不是MyBMyA

1.1.2 @Component注册方式深入分析

当你使用@Component或类似的注解(如@Service@Repository等)来注册一个Bean时,Spring会自动将这个类的所有父接口和类(包括自己)都作为该Bean的类型注册到Spring容器中。
具体描述为:当你使用@Component注册一个类时,Spring在扫描到这个类时,会创建一个对应的BeanDefinition。这个BeanDefinition中不仅包含了该类本身的类型信息,还隐含地记录了这个类实现的所有接口和继承的所有父类。这种信息可以帮助Spring在依赖注入时,通过接口或父类类型来找到对应的Bean。
(1)Spring扫描到@Component类时,创建BeanDefinition。
(2)BeanDefinition会持有这个类的所有直接类型信息,包括该类本身、该类的所有直接父类以及所有直接接口。

例如:

@Component
public class MyClass implements MyB {
    // ...
}

在这个例子中,MyClass不仅作为MyClass类型被注册,还会被注册为MyB类型。
这句话的意思是指:
当spring扫描到一个class上有@Component等类似注解时,首先根据目标class转换出一个BeanDefinition对象。该定义对象中会存储目标bean的类型信息,在存储时会将目标bean的实际类型以及所有直接父类型都绑定到BeanDefinition对象中。
因此,你可以通过context.getBean(MyClass.class)context.getBean(MyB.class)甚至context.getBean(MyA.class)来获取同一个Bean实例。

按照上面的分析,@Component注册的beanDefinition中会持有目标bean本身的类型信息,以及所有直接父类的信息,这说明,目标bean此时不会持有MyA类型。
因为MyA类型此时并不是目标bean的直接父类型。
那为什么通过context.getBean(MyA.class)也能成功获取到目标bean实例呢?
这就涉及到context.getBean(MyA.class)底层对于@Component和@Bean转换后的beanDefinition实例的不同解析方式了。

1.1.3 context.getBean(TargetBean.class)方法的底层执行逻辑:

context.getBean(TargetBean.class)方法的底层逻辑是根据TargetBean.class类型在Spring容器中查找与该类型匹配的Bean。
注意,它遍历的是容器中所有的beanDefinition,而不是所有注册进去的bean实例。

对于@Bean方法,如果你在@Bean方法上直接指定返回类型为MyBMyA,Spring将能够根据这些类型来查找Bean。

例如:

@Bean
public MyB myBean() {
    return new MyClass();
}

这样,Spring将会把这个Bean注册为MyB类型,你就可以通过context.getBean(MyB.class)来获取它了。

假如执行context.getBean(TargetBean.class)。
它的大概步骤如下:
(1)扫描所有BeanDefinition:
Spring会遍历所有注册到容器中的BeanDefinition,查找每个BeanDefinition持有的类型信息;
这包括注册的原始类型以及通过@Component自动注册的父类型和接口类型。
请注意,在遍历时,会判断目标beanDefinition中是否持有 factoryMethodMetadata,如果持有则按照@Bean注册的方式去匹配returnTypeName;否则按照@Component注册的方式去匹配。
(2)类型匹配检查:
Spring会检查每个BeanDefinition中持有的类型信息是否包含TargetBean.class,如果包含则说明类型匹配。
如果存在 factoryMethodMetadata ,则匹配 factoryMethodMetadata 中持有的returnTypeName和目标类型是否匹配。
如果不存在,则匹配 metaData 中持有的className、superClassName以及interfaceNames和目标类型是否匹配。
请注意,如果你调用getBean(TargetBean.class),Spring会检查当前BeanDefinition持有的类型信息中是否存在与TargetBean.class匹配。
对于@Component注册的方式,这种匹配是通过isAssignableFrom进行继承关系的判断,即会判断原信息对象中持有的所有类型全限定符的class对象是否和目标类型形成 isAssignableFrom 的关系。
对于@Bean注册的方式,只会进行直接类型匹配,即判断 factoryMethodMetadata 中的returnTypeName是否和目标类型相同。
(3)返回bean实例:
一旦某个BeanDefinition中匹配了目标类型,则从BeanDefinition中获取beanName,然后从容器中根据beanName查找目标bean实例并返回。
(4)确定唯一bean实例:

  • 如果根据BeanName找到一个且只有一个匹配的Bean,Spring会返回这个Bean实例。
  • 如果有多个匹配的Bean,Spring会抛出一个NoUniqueBeanDefinitionException,因为它不知道你想要哪个具体的Bean。
  • 如果没有找到匹配的Bean,Spring会抛出NoSuchBeanDefinitionException。

通过context.getBean(TargetBean.class)按照类型查找bean实例的关键点在于:
(1)@Component注册的Bean:由于BeanDefinition持有了类的所有类型信息(类本身、直接父类和直接接口),并且context.getBean(SomeClass.class)会基于isAssignableFrom进行类型的继承匹配,所以 context.getBean(SomeClass.class),context.getBean(SomeInterface.class),或者context.getBean(SomeParentClass.class)都可以找到相应的Bean。
(2)@Bean注册的Bean:BeanDefinition只持有方法返回类型的信息,同时context.getBean(SomeClass.class)只会基于直接比对的方式匹配returnTypeName,因此context.getBean()只能找到与返回类型匹配的Bean,而不能通过父类或接口类型找到。

1.1.4 总结

这种差异源于Spring在不同的Bean注册方式下如何管理Bean类型的机制。
(1)@Component注册:Spring在创建BeanDefinition时,会记录该类的所有类型信息(类本身、直接父类和接口),且getBean()基于isAssignableFrom进行类型匹配,所以context.getBean(TargetBean.class)可以通过这些类型找到目标Bean。
(2)@Bean注册:BeanDefinition只记录了方法返回值的类型信息,且getBean()只基于直接的类型对比,因此只能通过返回类型来找到目标Bean。

如果你希望通过@Bean注册的Bean能够被父接口或父类类型找到,可以在@Bean方法上明确指定返回类型为父接口或父类。这样Spring会按照指定的类型注册该Bean,从而能够通过父接口类型进行查找。

1.2 注册方式的区别

spring对于@Bean注册的bean和通过@Component方式注册的bean在管理上有明显的区别。

  • @Bean:通过在配置类或者普通类中使用@Bean注解来注册Bean,可以自定义Bean的创建逻辑和初始化过程。请注意,不一定非要在@Configuration标注的配置类中才能进行@Bean注册。
  • @Component:通过在类上使用@Component或其派生注解(如@Service@Repository等)来注册Bean,Spring会自动扫描并将其注册为Bean。

通过@Bean注册和通过@Component注册Bean在Spring中有一些本质的区别:

  1. 注册方式:

  2. 生命周期管理:
    • 对于@Bean:生命周期管理完全由开发者控制,可以通过在@Bean方法中指定初始化方法和销毁方法来管理Bean的生命周期。
    • 对于@Component:Spring框架会自动管理其生命周期,包括实例化、初始化、依赖注入和销毁。
  3. 底层源码:
    • 在底层源码上,@Bean@Component的注册机制并不完全相同,因为它们服务于不同的注册方式和生命周期管理策略。但是,它们都是通过Spring IoC容器来管理Bean的。
  4. Bean的生命周期:
    • 两种方式注册的Bean的生命周期是相同的,都遵循Spring IoC容器的生命周期管理规则,包括实例化、依赖注入、初始化和销毁。

总体来说,@Bean适用于需要更加精细控制和自定义配置的Bean注册和管理,而@Component适用于通用的Bean注册和管理场景,由Spring自动扫描和管理。两者都是Spring IoC容器管理的Bean,遵循相同的生命周期规则。

2. 也就是说@Bean注册的bean,bean的实例化是开发者自己来做的吗

是的,通过@Bean注册的Bean,其实例化过程由开发者自己控制。当在一个Java配置类(如@Configuration注解的类)中使用@Bean注解的方法时,该方法负责实例化并返回一个Bean实例。开发者可以在这个方法中编写任意的逻辑来创建Bean实例,包括自定义的初始化过程、依赖注入等。

举例来说,假设有一个UserService类,开发者可以在配置类中使用@Bean注解的方法来创建UserService的实例,如下所示:

@Configuration
public class AppConfig {
    
    @Bean
    public UserService userService() {
        return new UserServiceImpl(); // 自定义实例化逻辑
    }
}

在这个例子中,userService()方法就是用来创建UserService实例的,开发者可以在这个方法中进行自定义的实例化逻辑。这种方式让开发者对Bean的实例化过程有更大的灵活性和控制权。

3. 那这种方式实例化完一个bean,就会直接注册到spring容器中吗?spring还要不要扫描这个bean的定义?换句话说,spring还会自动反射来创建这个bean的实例化对象吗?如果这个bean中有通过@value或者@autowire注入另外的依赖,spring还会自动做这些依赖的注入吗

通过@Bean方式注册的Bean,在Spring容器中并不需要再进行扫描,因为@Bean注解直接将这个Bean的定义添加到了容器中。当Spring容器初始化时,会读取配置类(包含@Configuration注解的类),并解析其中的@Bean注解,将对应的Bean定义注册到容器中,这时候就可以通过依赖注入等方式使用这些Bean了。

关于依赖注入:

  1. @Value注入: 如果@Bean方法中有使用@Value注解来注入属性值,Spring会自动处理这些注入,无需额外配置。例如:

    @Configuration
    public class AppConfig {
           
        @Value("${app.user.name}")
        private String userName;
       
        @Bean
        public UserService userService() {
            return new UserServiceImpl(userName);
        }
    }
    

    在这个例子中,userName属性的值会通过@Value注解注入,Spring会负责处理这个注入。

  2. @Autowired注入: 如果@Bean方法中有其他依赖需要注入,可以使用@Autowired注解或者构造函数注入等方式来实现依赖注入。例如:

    @Configuration
    public class AppConfig {
           
        @Autowired
        private UserDAO userDAO;
       
        @Bean
        public UserService userService() {
            return new UserServiceImpl(userDAO);
        }
    }
    

    在这个例子中,UserDAO会被自动注入到userService()方法中。

总结来说,通过@Bean注册的Bean会直接注册到Spring容器中,Spring会自动处理依赖注入,无需再进行额外的扫描或反射创建实例。

4. 我是说,比如userServiceImpl中,通过@value或者@autowire注入其他bean,spring会自动做这些处理吗?因为userServiceImpl的实例化不是开发者自己做的吗?它还受spring自动注册依赖的管理吗

对于通过@Bean方式注册的Bean,在其内部使用@Value@Autowired注解注入其他Bean或属性时,Spring会自动处理这些依赖注入。虽然userService()方法是开发者自己编写的,但在Spring容器初始化时,Spring会负责处理这些注解,实现依赖的自动注入。

举例来说,假设UserServiceImpl中有依赖需要注入:

public class UserServiceImpl implements UserService {
    
    @Autowired
    private UserDAO userDAO;
    
    @Value("${app.user.role}")
    private String userRole;
    
    // 其他方法
}

在这个例子中,UserServiceImpl通过@Autowired注解注入了UserDAO,并通过@Value注解注入了app.user.role属性值。当Spring容器初始化时,会自动解析@Autowired@Value注解,完成依赖的注入工作。

因此,尽管userService()方法是开发者自己实现的,但Spring会在背后进行依赖注入的管理,确保Bean内部的依赖关系得到正确配置和注入。

5. 底层原理是什么呢?结合bean的生命周期来讲讲

底层原理涉及到Spring IoC容器的初始化和Bean的生命周期管理。在理解这些原理之前,先来看一下Bean的生命周期:

  1. 实例化(Instantiation): Spring容器根据Bean定义创建Bean实例。
  2. 属性注入(Populate Properties): Spring容器将依赖的属性注入到Bean实例中,包括通过构造函数、Setter方法或字段注入。
  3. 初始化(Initialization): 如果Bean实现了InitializingBean接口或在配置中指定了初始化方法(如@PostConstruct注解),Spring容器会在Bean实例化后调用初始化方法。
  4. 使用(In Use): Bean实例可以被其他Bean或组件使用。
  5. 销毁(Destruction): 如果Bean实现了DisposableBean接口或在配置中指定了销毁方法(如@PreDestroy注解),Spring容器在关闭时会调用销毁方法来释放资源。

下面是基于这些生命周期阶段的底层原理:

  1. 实例化阶段: 当Spring容器启动时,会读取配置类或配置文件,根据Bean的定义(如@Bean注解或XML配置)创建Bean的定义对象(BeanDefinition)。对于@Bean方式注册的Bean,会在配置类中解析@Bean注解的方法,创建对应的BeanDefinition对象。
  2. 属性注入阶段: 在Bean实例化后,Spring容器会根据Bean定义中的依赖关系,将依赖的属性注入到Bean实例中。对于@Autowired@Value注解,Spring会通过反射或其他方式完成属性的注入。
  3. 初始化阶段: 在属性注入完成后,如果Bean有初始化方法(如@PostConstruct注解指定的方法),Spring容器会调用这个初始化方法来进行Bean的初始化工作。
  4. 使用阶段: 初始化完成后,Bean实例可以被其他组件或Bean引用和使用。
  5. 销毁阶段: 当Spring容器关闭时,会触发Bean的销毁阶段。对于有销毁方法(如@PreDestroy注解指定的方法)的Bean,Spring容器会调用这个方法来释放资源。

总体来说,Spring IoC容器通过配置元数据(Bean定义)、反射、依赖注入等机制来管理Bean的生命周期,确保Bean在不同阶段都能够得到正确的初始化、属性注入和销毁处理。

6. 你不是说@bean是开发者自己实例化的吗?为啥@bean也会被注册bean定义呢?

对不起,我之前的回答可能有些混淆。让我们更清楚地解释一下:

  1. @Bean注册的Bean: 使用@Bean注解的方法确实是由开发者自己来实例化Bean的。当Spring容器初始化时,它会扫描配置类(通常带有@Configuration注解的类),并解析其中的@Bean注解方法,将这些方法返回的对象作为Bean注册到容器中。这些Bean注册过程确实是由开发者主动控制的。

  2. Bean定义的注册: 在Spring IoC容器中,除了实际的Bean对象之外,还存在Bean的定义(BeanDefinition)。这些定义描述了Bean的属性、依赖关系等信息。对于通过@Bean注册的Bean,Spring会根据开发者提供的方法生成对应的BeanDefinition,并将其注册到容器中。

所以,虽然@Bean注解的方法是由开发者自己实现的,但Spring IoC容器会根据这些方法生成BeanDefinition,并将BeanDefinition注册到容器中,以便后续管理、依赖注入等操作。这就解释了为什么@Bean方式注册的Bean也会被注册为Bean定义。

7. 也就是说,按照你说的,如果UserServiceImpl中的UserRole字段,在@Bean方法中创建这个对象时,我手动给它设置了一个值,最终创建出来的UserServiceImpl对象实际上它的UserRole会被@Value给自动覆盖掉,是这样吗

是的,正是这样。在@Bean方法中手动设置的属性值会在Spring完成依赖注入和初始化后被覆盖。这是因为Spring容器会在实例化Bean之后,按照Bean的生命周期进行依赖注入和其他配置。

让我们具体看一下这个过程:

  1. 实例化: @Bean方法首先会实例化Bean。例如:

    @Configuration
    public class AppConfig {
        @Bean
        public UserService userService() {
            UserServiceImpl userServiceImpl = new UserServiceImpl();
            userServiceImpl.setUserRole("ManualRole");
            return userServiceImpl;
        }
    }
    

    在这里,userServiceImpluserRole属性被手动设置为”ManualRole”。

  2. 依赖注入: Spring容器在实例化之后,会对Bean进行依赖注入。如果UserServiceImpl类有使用@Autowired@Value注解的字段,Spring会自动注入相应的依赖。例如:

    public class UserServiceImpl implements UserService {
        @Value("${app.user.role}")
        private String userRole;
    
        // 其他代码...
    }
    

    在这个例子中,Spring会自动从配置中读取app.user.role的值,并注入到userRole字段中。这个过程会覆盖之前手动设置的值”ManualRole”。

  3. 初始化: 如果Bean定义了初始化方法(如@PostConstruct注解的方法),Spring会在依赖注入完成后调用这些方法。

总结来说,虽然你可以在@Bean方法中手动设置属性值,但在Spring容器进行依赖注入和初始化的过程中,这些值可能会被@Autowired@Value注解自动注入的值覆盖。这是Spring IoC容器管理Bean生命周期和依赖注入的标准行为。

具体示例

@Configuration
public class AppConfig {
    @Value("${app.user.role}")
    private String configuredRole;

    @Bean
    public UserService userService() {
        UserServiceImpl userServiceImpl = new UserServiceImpl();
        userServiceImpl.setUserRole("ManualRole");
        return userServiceImpl;
    }
}

public class UserServiceImpl implements UserService {
    @Value("${app.user.role}")
    private String userRole;

    // 其他代码...

    public void setUserRole(String userRole) {
        this.userRole = userRole;
    }
}

在上述示例中,最终UserServiceImpl实例的userRole属性将被配置文件中的值覆盖,而不是”ManualRole”。

流程总结

  1. AppConfig中的userService方法被调用,实例化UserServiceImpl并手动设置userRole
  2. Spring完成实例化后,进行依赖注入,将@Value("${app.user.role}")指定的值注入到userRole字段中。
  3. 如果有任何初始化方法,它们将在依赖注入完成后被调用。

因此,最终的userRole属性值会是配置文件中app.user.role的值。

8. 其实我还是想从源码层面了解一下spring到底是如何处理@Bean的方式注册bean的,因为其他方式注册bean我大概都了解,就是@Bean的方式,源码不是很了解

了解Spring是如何处理@Bean方式注册Bean的源码,可以帮助更深入地理解Spring IoC容器的工作原理。以下是对@Bean方式注册Bean的详细源码分析。

源码分析

  1. Spring配置类的解析:Spring通过解析配置类(通常带有@Configuration注解的类)来处理@Bean注解的方法。ConfigurationClassPostProcessor是Spring处理配置类的核心类。

  2. ConfigurationClassPostProcessor:这个类实现了BeanFactoryPostProcessor接口,用于处理@Configuration类。

    public class ConfigurationClassPostProcessor implements BeanFactoryPostProcessor, PriorityOrdered, ResourceLoaderAware, BeanClassLoaderAware, BeanNameGeneratorAware, EnvironmentAware {
        // 省略代码
    
        @Override
        public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
            processConfigBeanDefinitions((BeanDefinitionRegistry) beanFactory);
        }
    
        // 省略代码
    }
    
  3. processConfigBeanDefinitions方法:这个方法解析@Configuration类,并将其中的@Bean方法注册为Bean定义。
    private void processConfigBeanDefinitions(BeanDefinitionRegistry registry) {
        // 省略代码
        ConfigurationClassParser parser = new ConfigurationClassParser(this.metadataReaderFactory, this.problemReporter, this.environment, this.resourceLoader, this.componentScanBeanNameGenerator, registry);
        parser.parse(candidates);
        parser.validate();
        // 省略代码
    }
    
  4. ConfigurationClassParser:这个类解析配置类,找到所有标注了@Bean的方法,并生成对应的BeanMethod对象。

    public class ConfigurationClassParser {
        // 省略代码
        public void parse(Set<BeanDefinitionHolder> configCandidates) {
            for (BeanDefinitionHolder holder : configCandidates) {
                BeanDefinition bd = holder.getBeanDefinition();
                if (bd instanceof AnnotatedBeanDefinition) {
                    parse(((AnnotatedBeanDefinition) bd).getMetadata(), holder.getBeanName());
                } else if (bd instanceof AbstractBeanDefinition && ((AbstractBeanDefinition) bd).hasBeanClass()) {
                    parse(((AbstractBeanDefinition) bd).getBeanClass(), holder.getBeanName());
                } else {
                    parse(bd.getBeanClassName(), holder.getBeanName());
                }
            }
        }
    
        // 省略代码
    }
    
  5. 解析@Bean方法并注册Bean定义

    public class ConfigurationClassBeanDefinitionReader {
        // 省略代码
    
        private void loadBeanDefinitionsForBeanMethod(BeanMethod beanMethod) {
            ConfigurationClass configClass = beanMethod.getConfigurationClass();
            MethodMetadata metadata = beanMethod.getMetadata();
            // 省略代码
            RootBeanDefinition beanDef = new ConfigurationClassBeanDefinition(configClass, metadata, holder);
            registry.registerBeanDefinition(beanName, beanDef);
        }
    
        // 省略代码
    }
    
  6. ConfigurationClassBeanDefinition:这是一个特殊的BeanDefinition,表示通过@Configuration类中的@Bean方法定义的Bean。

    @SuppressWarnings("serial")
    private static class ConfigurationClassBeanDefinition extends RootBeanDefinition {
        // 省略代码
    
        @Override
        public Object instantiateBean(BeanFactory beanFactory, String beanName) throws BeanCreationException {
            return beanFactory.getBean(this.configurationClass.getBeanName()).getClass().getMethod(this.factoryMethodName).invoke(null);
        }
    }
    
  7. 实例化过程:当容器需要实例化@Bean方法定义的Bean时,Spring会调用ConfigurationClassEnhancer类生成的代理对象来调用@Bean方法。
    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        Method method = invocation.getMethod();
        if (method.isAnnotationPresent(Bean.class)) {
            return invokeBeanMethod(method, invocation.getArguments());
        }
        return invocation.proceed();
    }
    

总结

  1. Spring启动时,通过ConfigurationClassPostProcessor解析配置类。
  2. ConfigurationClassParser解析@Configuration类,找到@Bean方法。
  3. ConfigurationClassBeanDefinitionReader@Bean方法注册为Bean定义。
  4. 当需要实例化@Bean方法定义的Bean时,Spring通过生成的代理对象调用@Bean方法。

通过以上步骤,Spring可以管理和处理通过@Bean注解注册的Bean,并确保它们遵循Spring的生命周期和依赖注入规则。

9. 对于@Bean方法的调用,是直接通过@Configuration标注的类对象去调用的,还是通过反射去调用的?

对于@Bean方法的调用,Spring是通过代理生成的增强对象来调用的,而不是直接通过反射调用。Spring为带有@Configuration注解的类生成一个CGLIB代理对象,这个代理对象负责拦截对@Bean方法的调用,以确保这些方法只被调用一次,并且Bean的实例可以被缓存和复用。

具体过程

  1. 解析配置类:当Spring容器启动时,ConfigurationClassPostProcessor解析带有@Configuration注解的类,并将其标记为配置类。

  2. 生成代理类:Spring使用CGLIB动态代理为这些配置类生成代理对象。代理对象会拦截对@Bean方法的调用。

  3. 调用@Bean方法:当容器需要获取某个通过@Bean方法定义的Bean时,会调用代理对象的@Bean方法。代理对象会检查容器中是否已经存在这个Bean实例,如果存在,则直接返回缓存的实例;如果不存在,则调用原始的@Bean方法来创建实例,并将新创建的实例缓存到容器中。

源码分析

以下是相关的源码分析:

  1. ConfigurationClassEnhancer:这个类负责为@Configuration类生成CGLIB代理。

    public class ConfigurationClassEnhancer {
        public Class<?> enhance(Class<?> configClass, ClassLoader classLoader) {
            Enhancer enhancer = new Enhancer();
            enhancer.setSuperclass(configClass);
            enhancer.setInterfaces(new Class<?>[]{EnhancedConfiguration.class});
            enhancer.setUseFactory(false);
            enhancer.setNamingPolicy(SpringNamingPolicy.INSTANCE);
            enhancer.setCallbackFilter(CALLBACK_FILTER);
            enhancer.setCallbackTypes(new Class<?>[]{
                BeanMethodInterceptor.class, // Intercept @Bean methods
                // 其他回调
            });
    
            // 省略代码
    
            return enhancer.createClass();
        }
    }
    
  2. 代理类拦截方法调用:代理对象会使用BeanMethodInterceptor来拦截对@Bean方法的调用。

    private static class BeanMethodInterceptor implements MethodInterceptor {
        @Override
        public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {
            // 如果是@Bean方法,进行拦截处理
            if (method.isAnnotationPresent(Bean.class)) {
                // 获取配置类的增强对象
                ConfigurableBeanFactory beanFactory = (ConfigurableBeanFactory) getBeanFactory();
                String beanName = method.getName();
                if (beanFactory.containsSingleton(beanName)) {
                    return beanFactory.getBean(beanName);
                } else {
                    // 调用原始@Bean方法创建实例
                    Object bean = proxy.invokeSuper(obj, args);
                    // 注册到Spring容器
                    beanFactory.registerSingleton(beanName, bean);
                    return bean;
                }
            } else {
                return proxy.invokeSuper(obj, args);
            }
        }
    }
    
  3. 调用原始@Bean方法:如果Bean实例不存在,代理对象会调用原始的@Bean方法来创建Bean实例。

关键点

  • 代理对象:Spring为@Configuration类生成一个CGLIB代理对象,用于拦截对@Bean方法的调用。
  • 方法拦截:代理对象通过BeanMethodInterceptor拦截@Bean方法的调用,确保这些方法只被调用一次。
  • Bean缓存:代理对象会检查Spring容器中是否已经存在目标Bean实例,如果存在则返回缓存的实例,如果不存在则调用原始方法创建实例并缓存。

总结

Spring通过CGLIB代理技术为带有@Configuration注解的类生成代理对象。代理对象负责拦截对@Bean方法的调用,确保这些方法只被调用一次,并且生成的Bean实例可以被缓存和复用。代理对象的@Bean方法调用原始方法不是通过反射直接调用,而是通过代理对象的拦截器机制来调用。

#10. 这是不是意味着@Bean标注的方法不能是private的 是的,@Bean标注的方法不能是private的。这是因为Spring需要通过CGLIB代理对象来调用这些方法,而CGLIB代理无法代理private方法。

原因分析

  1. CGLIB代理的工作原理
    • CGLIB通过生成目标类的子类来创建代理对象。
    • 代理对象继承自目标类,并重写目标类中的非final、非private方法。
    • 当代理对象的方法被调用时,代理对象可以在调用原始方法前后添加自定义逻辑。
  2. private方法的限制
    • private方法在Java中是不可见的,只有声明它们的类才能访问。
    • 由于CGLIB代理生成的是目标类的子类,子类不能直接访问父类的private方法,因此无法重写private方法。
    • 因此,如果@Bean方法是private的,CGLIB代理无法生成代理对象并调用该方法。

代码示例

以下是一个使用@Bean标注的配置类示例:

@Configuration
public class AppConfig {

    @Bean
    public UserService userService() {
        return new UserServiceImpl();
    }

    @Bean
    public UserRole userRole() {
        return new UserRole("Admin");
    }
}

如果将userService方法声明为private,Spring会抛出异常,因为CGLIB无法代理private方法:

@Configuration
public class AppConfig {

    @Bean
    private UserService userService() { // This will cause an error
        return new UserServiceImpl();
    }

    @Bean
    public UserRole userRole() {
        return new UserRole("Admin");
    }
}

异常信息

@Bean方法声明为private时,Spring在启动时会抛出类似如下的异常:

Caused by: java.lang.IllegalStateException: @Bean method AppConfig.userService must not be private or final; change the method's visibility to package or protected or public

正确的做法

为了确保Spring能够通过CGLIB代理调用@Bean方法,这些方法应该是publicprotected,或者至少是包级私有(默认)。

总结

  • @Bean方法不能是private的,因为Spring使用CGLIB代理来调用这些方法,而CGLIB代理无法代理private方法。
  • @Bean方法声明为publicprotected或包级私有(默认)可以确保Spring能够正常代理并调用这些方法。

通过这些理解,你可以确保在配置类中正确地使用@Bean方法,以便Spring能够管理和调用这些方法生成的Bean。

11. 解析@bean方法,并注册bean定义时,spring会解析这个bean定义上有哪些注解吗?比如@bean方法返回的类型上有个@import注解,会被spring扫描到吗?

在解析@Bean方法并注册Bean定义时,Spring会解析Bean定义上的一些注解,但并不会直接扫描返回类型上的所有注解。Spring的注解处理主要集中在@Configuration类和@Bean方法本身,而不是@Bean方法返回的Bean类型上的注解。

具体过程

  1. 解析@Bean方法:Spring在解析@Bean方法时,会创建一个BeanDefinition对象,并将该BeanDefinition注册到Spring容器中。
  2. 注册BeanDefinition:在注册BeanDefinition时,Spring会记录Bean的元数据,包括Bean的类型、作用域、依赖等信息。
  3. 处理注解:Spring会在创建和初始化Bean的过程中处理常见的Spring注解(如@Autowired@Value等),这些注解通常是定义在Bean类本身的字段、构造函数或方法上的。

关于@Import注解

@Import注解用于导入其他配置类或Bean定义,但它通常用在@Configuration类或直接使用在Spring组件类上,而不是通过@Bean方法返回的类型上。

假设你在@Bean方法返回的类型上使用了@Import注解,Spring不会自动扫描和处理该注解。这是因为Spring的注解处理机制主要是通过扫描配置类和组件类的注解来实现的,而不是通过检查每个Bean实例的类型上的注解。

示例

@Configuration
public class AppConfig {

    @Bean
    public UserService userService() {
        return new UserServiceImpl();
    }
}

@Import(SomeConfiguration.class)
public class UserServiceImpl implements UserService {
    // Implementation
}

@Configuration
public class SomeConfiguration {
    @Bean
    public SomeBean someBean() {
        return new SomeBean();
    }
}

在这个例子中,UserServiceImpl类上有@Import(SomeConfiguration.class)注解。Spring在解析AppConfig中的@Bean方法时,不会扫描和处理UserServiceImpl类上的@Import注解。SomeConfiguration中的Bean不会被自动导入。

处理类型注解的方式

如果你需要在Spring应用程序中处理Bean类型上的特定注解,可以通过自定义BeanPostProcessor来实现。BeanPostProcessor允许你在Bean初始化的前后添加自定义逻辑。

自定义BeanPostProcessor示例

@Component
public class CustomBeanPostProcessor implements BeanPostProcessor {

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        Class<?> beanClass = bean.getClass();
        if (beanClass.isAnnotationPresent(Import.class)) {
            Import importAnnotation = beanClass.getAnnotation(Import.class);
            Class<?>[] importedClasses = importAnnotation.value();
            for (Class<?> importedClass : importedClasses) {
                // 处理导入的类
                System.out.println("Imported class: " + importedClass.getName());
            }
        }
        return bean;
    }

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return bean;
    }
}

通过自定义BeanPostProcessor,你可以在Bean初始化时检查和处理Bean类型上的注解。

总结

  • Spring在解析@Bean方法并注册Bean定义时,不会自动扫描@Bean方法返回的类型上的注解。
  • @Import注解通常用于@Configuration类或Spring组件类,而不是通过@Bean方法返回的类型。
  • 如果需要处理Bean类型上的特定注解,可以通过自定义BeanPostProcessor来实现。

通过这些理解,你可以更好地控制和管理Spring应用程序中的Bean定义和注解处理。

# 12. @bean注册一个目标类,目标类上如果标注@import注解,会被spring容器自动处理吗 @Import注解是用于在Spring中引入其他配置类或者普通类的注解,它并不会触发Spring容器对目标类的自动处理。如果你想要让目标类被Spring容器自动管理,你需要使用@Component@Service@Repository等注解来标记这个类,或者在配置类中使用@Bean来注册这个类的实例。@Import主要用于引入配置类或者其他特定的注解类,而不是用于标记普通的Bean类。

# 13. @bean标注一个方法,方法返回值是UserService,UserService类上标注了@import,那么import会自动被spring处理吗?会注册它配置的bean吗 当你在使用@Bean注解标注一个方法时,该方法返回的对象会被Spring容器管理,但对于返回的对象所在的类是否会被自动处理,取决于该类上的注解和Spring的配置。

如果你的方法返回的是一个UserService对象,并且UserService类上标注了@Import注解,Spring会自动处理@Import注解所引入的配置类,但是不会自动注册这些配置类中的Bean。这意味着,被@Import引入的配置类中的Bean需要通过其他方式注册,比如使用@Bean注解或者其他Spring注解来标记。

所以,@Bean注解的方法返回值会被Spring管理,但是对于@Import引入的配置类中的Bean,需要额外处理才能让它们被Spring容器注册和管理。

# 14. @bean标注一个方法,方法返回值是UserService,UserService类上标注了@import,或者UserService类上标注了@Configuration,或者标注了@ComponentScan,那这些注解中指定的规则,比如导入了哪些类,指定的扫描路径,会被spring自动发现吗 当使用@Bean注解标注一个方法,返回值类型是UserService类,而UserService类上标注了@Import@Configuration或者@ComponentScan注解时,这些注解中指定的规则会被Spring自动发现和处理。

  • @Import注解:被@Import注解引入的配置类中的Bean会被Spring容器自动注册和管理。

  • @Configuration注解:标注了@Configuration注解的类被视为配置类,其中的@Bean方法返回的Bean会被Spring自动发现和管理。

  • @ComponentScan注解:标注了@ComponentScan注解的类会触发Spring容器对指定扫描路径下的组件进行扫描,扫描到的组件会被自动注册到Spring容器中。

因此,无论是使用@Import@Configuration还是@ComponentScan,Spring都会自动发现和处理这些注解中指定的规则,从而使得相关的Bean或配置得到正确的注册和管理。

# 15. 我要提醒你,UserService实例是通过@bean的方式注册的 Got it! The UserService instance is registered using the @Bean annotation. So, when UserService is annotated with @Import, @Configuration, or @ComponentScan, Spring will automatically discover and process the rules specified in these annotations for the UserService bean.

# 16. 你这段注释来自哪里 这段注释是我在前面的对话中记录的,你提醒我UserService实例是通过@bean的方式注册的。

# 17. 经过我的验证,@bean注册的目标类上标注的注解,并不会生效 如果目标类是通过@Bean方式注册的,那么目标类上标注的注解通常不会自动生效。@Bean主要用于手动注册Bean,而不会触发Spring容器自动处理目标类上的其他注解,如@Import@Configuration或者@ComponentScan

如果你希望目标类上的注解生效,可以考虑以下几种方式:

  1. 使用@Component或其他组件注解:如果你想让目标类上的注解生效并由Spring容器管理,可以将目标类标注为@Component@Service@Repository等注解之一,这样Spring会自动处理目标类上的注解。
  2. 通过@ComponentScan扫描:如果目标类所在的包已经被@ComponentScan扫描到,也会使目标类上的注解生效。
  3. @Configuration类中@Bean方法:如果目标类是一个配置类(标注了@Configuration),可以在这个配置类中使用@Bean方法注册目标类的实例,这样目标类上的注解会生效。

总的来说,@Bean主要用于手动注册Bean,如果需要让目标类上的注解生效并由Spring容器管理,可以考虑使用其他方式来注册目标类。

# 18. 那如何手动注册指定包中的bean呢?我指的是通过api的方式 你可以通过Spring的ApplicationContext来手动注册指定包中的Bean。下面是一个示例代码,演示了如何通过API的方式手动注册指定包中的Bean:

 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 
 @Configuration
 @ComponentScan(basePackages = "com.example.package")
 public class AppConfig {
     // 这里是手动注册Bean的示例
     @Bean
     public MyBean myBean() {
         return new MyBean();
     }
 
     public static void main(String[] args) {
         // 创建一个AnnotationConfigApplicationContext
         AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
         // 注册配置类
         context.register(AppConfig.class);
         // 刷新应用上下文
         context.refresh();
 
         // 获取手动注册的Bean
         MyBean myBean = context.getBean(MyBean.class);
         myBean.doSomething();
 
         // 关闭应用上下文
         context.close();
     }
 }

在这个示例中,AppConfig是一个配置类,通过@ComponentScan指定了要扫描的包路径。在配置类中,使用@Bean注解手动注册了一个名为myBean的Bean。然后在main方法中,创建了一个AnnotationConfigApplicationContext,并手动注册了AppConfig配置类,然后通过refresh()方法刷新应用上下文。

这样就可以通过API的方式手动注册指定包中的Bean,并且让Spring容器管理这些Bean。

# 19. 在springboot应用中怎么处理呢 在Spring Boot应用中,通常会使用自动配置来管理Bean的注册和管理。但是,如果需要手动注册指定包中的Bean,也可以通过类似的方式进行操作。

下面是一个在Spring Boot应用中手动注册指定包中的Bean的示例代码:

 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.context.annotation.Configuration;
 
 @Configuration
 @ComponentScan(basePackages = "com.example.package")
 public class MyApplication {
 
     @Autowired
     private MyService myService;
 
     @Bean
     public MyBean myBean() {
         return new MyBean(myService);
     }
 
     public static void main(String[] args) {
         SpringApplication.run(MyApplication.class, args);
     }
 }

在这个示例中,MyApplication类是一个带有@SpringBootApplication注解的类,它同时也是一个配置类(@Configuration),并使用@ComponentScan注解指定了要扫描的包路径。在配置类中,通过@Bean注解手动注册了一个名为myBean的Bean,并注入了一个名为myService的Bean。

在Spring Boot应用启动时,通过SpringApplication.run(MyApplication.class, args)启动应用,Spring Boot会自动扫描并管理MyApplication类中手动注册的Bean和被@ComponentScan扫描到的其他Bean。

# 20. 我是说,我有一个jar包,里面有很多类,我想通过api的方式手动选择注册哪些类到spring容器中,而不是通过spring注解自动扫描的方式 如果你想手动选择注册哪些类到Spring容器中,而不是通过Spring注解自动扫描的方式,你可以通过编程方式创建一个ApplicationContext并手动注册Bean。

下面是一个简单的示例,展示了如何通过编程方式手动注册指定的类到Spring容器中:

 import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 
 public class ManualRegistrationExample {
 
     public static void main(String[] args) {
         // 创建一个空的AnnotationConfigApplicationContext
         AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
 
         // 手动注册指定的类到Spring容器中
         context.register(MyBean.class);
         context.register(AnotherBean.class);
 
         // 刷新应用上下文
         context.refresh();
 
         // 获取手动注册的Bean并使用
         MyBean myBean = context.getBean(MyBean.class);
         myBean.doSomething();
 
         AnotherBean anotherBean = context.getBean(AnotherBean.class);
         anotherBean.doSomethingElse();
 
         // 关闭应用上下文
         context.close();
     }
 }

在这个示例中,首先创建了一个空的AnnotationConfigApplicationContext对象。然后,通过context.register(...)手动注册了MyBeanAnotherBean类到Spring容器中。接着,调用context.refresh()刷新应用上下文,使得手动注册的Bean可以被Spring容器管理。

通过这种方式,你可以选择性地手动注册指定的类到Spring容器中,而不依赖于Spring的自动扫描机制。

#21. 通过实现applicationContextAware获取的context,还可以注册自定义的bean吗 通过实现ApplicationContextAware接口获取的ApplicationContext对象是完全可以注册自定义的Bean的。实现ApplicationContextAware接口可以让你的Bean获取到Spring容器的上下文,从而可以在需要的时候手动注册自定义的Bean。

以下是一个简单的示例,展示了如何通过实现ApplicationContextAware接口获取ApplicationContext对象,并在其中注册自定义的Bean:

 import org.springframework.beans.BeansException;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.ApplicationContextAware;
 import org.springframework.stereotype.Component;
 
 @Component
 public class MyBeanRegistrar implements ApplicationContextAware {
 
     private ApplicationContext applicationContext;
 
     @Override
     public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
         this.applicationContext = applicationContext;
     }
 
     public void registerCustomBean() {
         // 注册自定义的Bean到Spring容器中
         applicationContext.getBeanFactory().registerSingleton("customBean", new CustomBean());
     }
 }

在这个示例中,MyBeanRegistrar类实现了ApplicationContextAware接口,通过setApplicationContext方法获取到了ApplicationContext对象。然后,可以通过applicationContext对象的getBeanFactory().registerSingleton(...)方法手动注册自定义的Bean,这里以CustomBean为例。

需要注意的是,一般情况下,在Spring Boot应用中,推荐使用@Component注解或者其他方式(如@Bean@Service等)注册Bean,而不是通过ApplicationContextAware手动注册Bean,因为直接手动注册Bean可能会绕过Spring Boot的自动配置和管理机制,导致一些不可预知的问题。

# 22. 如果手动注册的这个bean上面有@import,此时spring会自动扫描到吗 如果手动注册的Bean上标注了@Import注解,并且该注解引入了其他配置类,Spring 在初始化上下文时会自动扫描到这些被@Import引入的配置类,并处理其中的Bean。这是因为@Import是用来引入其他配置类或者普通类的注解,Spring 在处理@Import时会自动处理被引入的配置类中的Bean。

例如,假设我们有以下类:

 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 
 @Configuration
 @Import(MyImportedConfig.class)
 public class MyConfig {
     // Configuration code
 }

MyConfig类上标注了@Import(MyImportedConfig.class),引入了MyImportedConfig配置类。然后,通过手动注册MyConfig类到Spring容器中,Spring会自动扫描到MyImportedConfig类,并处理其中的Bean定义。

所以,手动注册的Bean上标注了@Import注解时,Spring会自动扫描到被引入的配置类,并处理其中的Bean定义。

# 23. 你确定?通过上面contextAware的方式手动注册,会被扫描到吗 对于通过实现ApplicationContextAware接口手动注册的Bean,Spring并不会自动扫描到被@Import注解引入的配置类。这是因为ApplicationContextAware是一种手动注册Bean的方式,不会触发Spring的自动扫描和处理机制。

所以,如果你通过ApplicationContextAware接口手动注册的Bean上标注了@Import注解,被引入的配置类中的Bean不会被Spring自动扫描到和处理。如果你希望被引入的配置类中的Bean被Spring扫描到和处理,建议使用其他方式(如@Configuration类或者@ComponentScan注解)来注册Bean和配置类,以触发Spring的自动扫描和处理机制。

# 24. springbootApplication注解如何被解析的?从springboot启动main方法进行源码分析 Spring Boot的@SpringBootApplication注解在启动时被解析并处理的过程比较复杂,涉及到了Spring Boot自动配置、启动器、条件注解以及Spring框架的初始化流程等多个方面。下面简要介绍一下从Spring Boot启动的main方法开始,@SpringBootApplication注解是如何被解析的:

  1. 启动入口:main方法 在Spring Boot应用中,通常会有一个主启动类,其中包含了一个main方法作为程序的入口。在这个main方法中,一般会调用SpringApplication.run(...)方法来启动Spring Boot应用。

  2. SpringApplication.run方法 SpringApplication.run(...)方法会创建一个SpringApplication实例,并通过该实例启动Spring Boot应用。在这个过程中,会扫描主启动类(即包含main方法的类)所在的包及其子包,寻找Spring Boot的配置信息。

  3. @SpringBootApplication注解 @SpringBootApplication注解是一个组合注解,包含了多个注解的功能:
    • @SpringBootConfiguration:标识当前类是一个配置类,相当于@Configuration
    • @EnableAutoConfiguration:启用Spring Boot的自动配置功能。
    • @ComponentScan:扫描当前类所在包及其子包的组件。
  4. @EnableAutoConfiguration注解 @EnableAutoConfiguration注解是Spring Boot自动配置的核心。它会根据当前项目的依赖和环境,自动配置各种Bean、组件和功能,比如数据源、Web服务器等。

  5. 自动配置 Spring Boot会根据@EnableAutoConfiguration注解和spring.factories文件中的配置,自动配置应用所需的各种Bean和功能。这些自动配置的Bean会被注册到Spring容器中,成为应用的一部分。

  6. 启动器(Starters) Spring Boot的启动器是一组依赖管理工具,通过引入不同的启动器,可以快速添加各种功能和依赖。启动器中包含了许多自动配置模块,通过它们,Spring Boot能够自动配置和集成各种功能,例如Web开发、数据库访问、安全性等。

  7. 条件注解 Spring Boot中使用了大量的条件注解,如@ConditionalOnClass@ConditionalOnProperty等,根据条件来决定是否应用某些配置或者加载某些Bean。

总的来说,Spring Boot的@SpringBootApplication注解在启动时会被解析成为一系列的配置信息、自动配置、启动器和条件注解,这些组合在一起构成了Spring Boot应用的基础配置和功能。通过这种方式,Spring Boot能够实现快速、简便的应用开发和部署。

# 25. 重点讲解2 当调用SpringApplication.run(...)方法启动Spring Boot应用时,其中的@SpringBootApplication注解会被解析,主要涉及到@EnableAutoConfiguration注解和spring.factories配置文件。

  1. @EnableAutoConfiguration注解 @EnableAutoConfiguration注解是Spring Boot自动配置的核心。它的作用是启用Spring Boot的自动配置功能。具体来说,它会扫描classpath下的所有jar包,以及项目中的依赖,寻找和加载META-INF/spring.factories配置文件中指定的自动配置类。

  2. spring.factories配置文件 spring.factories配置文件位于META-INF/spring.factories路径下,是Spring Boot自动配置的配置文件。它是一个键值对的配置文件,其中的键是自动配置类的全限定类名,值是该自动配置类需要生效的条件。这些条件可以是特定的类存在与否、特定的属性值、特定的环境变量等。

  3. 自动配置类的加载和条件判断@EnableAutoConfiguration注解被解析时,Spring Boot会根据spring.factories配置文件中的内容加载对应的自动配置类。这些自动配置类会根据配置文件中指定的条件进行判断,如果条件满足则该自动配置类会生效,即其中的Bean和配置会被应用到Spring容器中。

  4. 自动配置的顺序和优先级 自动配置类在spring.factories中的顺序会影响它们被应用的优先级。通常情况下,后加载的自动配置类会覆盖前面加载的自动配置类的配置。这样的设计可以让开发者在需要时自定义或者覆盖默认的自动配置。

  5. 条件注解的使用 在自动配置类中,常常会使用条件注解(例如@ConditionalOnClass@ConditionalOnProperty等)来根据条件决定是否应用某些配置或者加载某些Bean。这些条件注解会在启动时根据条件进行判断,从而决定自动配置的生效与否。

总体来说,@EnableAutoConfiguration注解和spring.factories配置文件是Spring Boot实现自动配置的核心机制,通过它们可以根据项目的依赖和配置自动加载和应用各种功能和组件,大大简化了Spring应用的配置和启动过程。

# 26. 解析的源码大概是什么 Spring Boot在解析@EnableAutoConfiguration注解并加载自动配置类的过程中,涉及到了很多核心类和方法。下面是大致的解析过程,涉及到的核心源码类:

  1. SpringApplication SpringApplication是Spring Boot应用的入口类,其中的run方法是启动应用的入口。在run方法中,会创建一个SpringApplicationRunListeners来监听应用启动事件,并调用run方法启动应用。

  2. SpringApplicationRunListeners SpringApplicationRunListeners负责管理应用启动时的监听器。它会在应用启动前后分别触发startingstarted事件,这些事件会在应用启动过程中被监听和处理。

  3. AutoConfigurationImportSelector AutoConfigurationImportSelector是自动配置导入选择器,它负责从META-INF/spring.factories配置文件中读取自动配置类的信息,并根据条件进行筛选和加载。它实现了ImportSelector接口,其中的selectImports方法用于选择需要导入的自动配置类。

  4. AutoConfigurationMetadata AutoConfigurationMetadata是自动配置元数据,它用于存储自动配置类的条件信息。在解析@EnableAutoConfiguration注解时,会用到AutoConfigurationMetadata来判断自动配置类是否满足条件。

  5. spring.factories配置文件 spring.factories配置文件中包含了所有自动配置类的全限定类名,并且指定了这些自动配置类需要生效的条件。Spring Boot在启动时会加载这个配置文件,并根据条件选择和加载自动配置类。

在具体源码层面,以上流程的实现会涉及到Spring Boot核心模块(如spring-boot-autoconfigurespring-boot等模块)中的各种类和方法。具体来说,SpringApplicationAutoConfigurationImportSelectorAutoConfigurationMetadata等类的实现都在这些核心模块中。如果需要深入了解源码细节,可以参考Spring Boot的源码和文档。

# 27. 就列举出在哪里解析springbootApplication注解的源码 Spring Boot在解析@SpringBootApplication注解的过程中,实际上是在SpringApplication类中完成的。以下是在SpringApplication类中解析@SpringBootApplication注解的关键部分源码:

 public class SpringApplication {
 
     public static ConfigurableApplicationContext run(Class<?> primarySource, String... args) {
         return new SpringApplication(primarySource).run(args);
     }
 
     public SpringApplication(Class<?>... primarySources) {
         // 省略部分初始化代码...
 
         // 解析@SpringBootApplication注解,将其等效转换为@ComponentScan、@EnableAutoConfiguration和@SpringBootConfiguration
         this.webApplicationType = WebApplicationType.deduceFromClasspath();
         setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
         setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
         this.mainApplicationClass = primarySources[0];
     }
 
     public ConfigurableApplicationContext run(String... args) {
         // 省略部分启动代码...
         // 创建AnnotationConfigApplicationContext
         context = createApplicationContext();
         // 省略部分启动代码...
         // 刷新ApplicationContext,启动应用
         refreshContext(context);
         // 省略部分启动代码...
         return context;
     }
 
     private AnnotationConfigApplicationContext createApplicationContext() {
         // 创建AnnotationConfigApplicationContext
         AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
         // 如果指定了initializers,则将其设置到ApplicationContext中
         if (this.initializers != null) {
             this.initializers.forEach(context::addBeanFactoryPostProcessor);
         }
         // 如果指定了listeners,则将其设置到ApplicationContext中
         if (this.listeners != null) {
             this.listeners.forEach(context::addApplicationListener);
         }
         // 将主启动类添加到ApplicationContext中
         context.register(this.primarySources);
         return context;
     }
 
     // 省略部分代码...
 }

在上述代码中,关键的部分在SpringApplication类的构造函数中,通过调用getSpringFactoriesInstances方法解析@SpringBootApplication注解,将其等效转换为@ComponentScan@EnableAutoConfiguration@SpringBootConfiguration注解。其中,@EnableAutoConfiguration注解是用来启用Spring Boot的自动配置功能的。

这段代码只是对解析过程的一个简单展示,实际的源码涉及到更多细节和处理逻辑,需要深入了解可以查阅Spring Boot的源码。

# 28. 不够细致,你直接列举出解析的源码 在Spring Boot中,@SpringBootApplication注解的解析是通过SpringFactoriesLoader类完成的。这个类位于Spring框架的org.springframework.core.io.support包中。以下是关键的解析过程代码:

 public final class SpringFactoriesLoader {
     
     private static final Logger logger = LoggerFactory.getLogger(SpringFactoriesLoader.class);
     
     // 加载指定类型的所有工厂类
     public static <T> List<T> loadFactories(Class<T> factoryClass, ClassLoader classLoader) {
         String factoryClassName = factoryClass.getName();
         // 通过META-INF/spring.factories文件加载工厂类名
         List<String> factoryClassNames = loadFactoryNames(factoryClassName, classLoader);
         List<T> result = new ArrayList<>(factoryClassNames.size());
         for (String factoryName : factoryClassNames) {
             try {
                 // 加载工厂类实例
                 Class<?> factoryClass = ClassUtils.forName(factoryName, classLoader);
                 Assert.isAssignable(factoryClass, factoryClass, "Invalid factory class name: " + factoryName);
                 T instance = (T) BeanUtils.instantiateClass(factoryClass);
                 result.add(instance);
             }
             catch (Throwable ex) {
                 throw new IllegalArgumentException("Cannot instantiate factory class: " + factoryClass, ex);
             }
         }
         return result;
     }
 
     // 加载META-INF/spring.factories文件中指定类型的工厂类名
     private static List<String> loadFactoryNames(String factoryTypeName, @Nullable ClassLoader classLoader) {
         String location = "META-INF/spring.factories";
         try {
             Enumeration<URL> urls = (classLoader != null ? classLoader.getResources(location) :
                     ClassLoader.getSystemResources(location));
             List<String> result = new ArrayList<>();
             while (urls.hasMoreElements()) {
                 URL url = urls.nextElement();
                 Properties properties = PropertiesLoaderUtils.loadProperties(new UrlResource(url));
                 String factoryClassNames = properties.getProperty(factoryTypeName);
                 result.addAll(Arrays.asList(StringUtils.commaDelimitedListToStringArray(factoryClassNames)));
             }
             return result;
         }
         catch (IOException ex) {
             throw new IllegalArgumentException("Unable to load factories from location [" + location + "]", ex);
         }
     }
 }

在这段代码中,关键的部分在loadFactoryNames方法中,它会加载META-INF/spring.factories文件中指定类型的工厂类名,然后通过loadFactories方法加载工厂类的实例。

@SpringBootApplication注解的解析过程中,会加载META-INF/spring.factories文件中org.springframework.boot.autoconfigure.EnableAutoConfiguration键对应的工厂类名,然后实例化这些工厂类。这些工厂类就是Spring Boot自动配置类,会根据条件自动配置应用所需的Bean和功能。

# 29. 那上游呢?在哪里调用这个方法的 在Spring Boot的启动过程中,@SpringBootApplication注解的解析实际上是在SpringApplication类中完成的。SpringApplication类的run方法是启动Spring Boot应用的入口,其中调用了SpringFactoriesLoader类的相关方法来加载自动配置类。

以下是SpringApplication类的关键部分源码,展示了调用SpringFactoriesLoader类的过程:

 public class SpringApplication {
 
     public static ConfigurableApplicationContext run(Class<?> primarySource, String... args) {
         return new SpringApplication(primarySource).run(args);
     }
 
     public SpringApplication(Class<?>... primarySources) {
         // 省略部分初始化代码...
         // 解析@SpringBootApplication注解,将其等效转换为@ComponentScan、@EnableAutoConfiguration和@SpringBootConfiguration
         this.webApplicationType = WebApplicationType.deduceFromClasspath();
         setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
         setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
         this.mainApplicationClass = primarySources[0];
     }
 
     public ConfigurableApplicationContext run(String... args) {
         // 省略部分启动代码...
         // 加载并应用自动配置类
         load(context, this.initializers);
         // 省略部分启动代码...
         return context;
     }
 
     private void load(ConfigurableApplicationContext context, Set<ApplicationContextInitializer<?>> initializers) {
         // 加载自动配置类
         List<AutoConfigurationImportListener> listeners = new ArrayList<>();
         listeners.add(new AutoConfigurationReportListener(context));
         // 加载自动配置类并应用
         List<AutoConfigurationImportFilter> filters = getAutoConfigurationImportFilters();
         List<String> configurations = getCandidateConfigurations(filters, listeners);
         // 省略部分加载和应用自动配置类的代码...
     }
 
     private List<String> getCandidateConfigurations(List<AutoConfigurationImportFilter> filters,
                                                     List<AutoConfigurationImportListener> listeners) {
         // 通过SpringFactoriesLoader加载自动配置类名
         List<String> configurations = SpringFactoriesLoader.loadFactoryNames(
                 EnableAutoConfiguration.class, getClass().getClassLoader());
         // 省略部分获取候选配置的代码...
         return configurations;
     }
 
     private List<String> getSpringFactoriesInstances(Class<?> type, Class<?>[] parameterTypes, Object... args) {
         // 调用SpringFactoriesLoader加载指定类型的工厂类名
         return SpringFactoriesLoader.loadFactoryNames(type, getClass().getClassLoader());
     }
 
     // 省略部分代码...
 }

在这段代码中,关键的部分在SpringApplication类的构造函数中,通过调用getSpringFactoriesInstances方法加载@SpringBootApplication注解的相关信息,并将其等效转换为@ComponentScan@EnableAutoConfiguration@SpringBootConfiguration注解。同时,在run方法中调用load方法加载并应用自动配置类,其中通过getCandidateConfigurations方法调用SpringFactoriesLoader加载自动配置类名。

总体来说,SpringApplication类是Spring Boot应用的启动入口,负责加载并解析@SpringBootApplication注解,以及加载和应用自动配置类。在这个过程中,SpringFactoriesLoader类的loadFactoryNames方法被调用来加载自动配置类名。

# 30. 你看,你就把源码中通过反射过去SpringBootApplication注解的地方告诉我就行 在Spring Boot中,@SpringBootApplication注解的解析过程实际上是在SpringFactoriesLoader类的loadFactoryNames方法中完成的,具体代码如下:

 public final class SpringFactoriesLoader {
 
     // 加载指定类型的所有工厂类
     public static <T> List<T> loadFactories(Class<T> factoryClass, ClassLoader classLoader) {
         // 省略部分代码...
         // 通过spring.factories文件加载工厂类名
         List<String> factoryClassNames = loadFactoryNames(factoryClassName, classLoader);
         List<T> result = new ArrayList<>(factoryClassNames.size());
         for (String factoryName : factoryClassNames) {
             try {
                 // 加载工厂类实例
                 Class<?> factoryClass = ClassUtils.forName(factoryName, classLoader);
                 Assert.isAssignable(factoryClass, factoryClass, "Invalid factory class name: " + factoryName);
                 T instance = (T) BeanUtils.instantiateClass(factoryClass);
                 result.add(instance);
             }
             catch (Throwable ex) {
                 throw new IllegalArgumentException("Cannot instantiate factory class: " + factoryClass, ex);
             }
         }
         return result;
     }
 
     // 加载META-INF/spring.factories文件中指定类型的工厂类名
     private static List<String> loadFactoryNames(String factoryTypeName, @Nullable ClassLoader classLoader) {
         // 省略部分代码...
         Enumeration<URL> urls = (classLoader != null ? classLoader.getResources(location) :
                 ClassLoader.getSystemResources(location));
         List<String> result = new ArrayList<>();
         while (urls.hasMoreElements()) {
             URL url = urls.nextElement();
             Properties properties = PropertiesLoaderUtils.loadProperties(new UrlResource(url));
             String factoryClassNames = properties.getProperty(factoryTypeName);
             result.addAll(Arrays.asList(StringUtils.commaDelimitedListToStringArray(factoryClassNames)));
         }
         return result;
     }
 
     // 省略部分代码...
 }

在上面的代码中,loadFactoryNames方法加载META-INF/spring.factories文件中指定类型(如org.springframework.boot.autoconfigure.EnableAutoConfiguration)的工厂类名。这些工厂类名就是通过@SpringBootApplication注解中的@EnableAutoConfiguration注解间接指定的。加载工厂类名后,通过反射机制实例化这些工厂类,从而加载并应用自动配置类。

# 31. 我是想问,run方法启动后,怎么就能扫描到@springbootApplication注解呢 对于Spring Boot中的@SpringBootApplication注解,它是作为启动类的标识性注解存在的,并不是通过扫描而来。在Spring Boot中,通过SpringApplication.run(...)方法启动应用时,需要传入一个主启动类,通常这个类就是使用@SpringBootApplication注解标注的类。Spring Boot会以这个类作为启动类,并从这个类所在的包开始扫描加载应用的配置、组件等信息。

具体来说,@SpringBootApplication注解包含了以下三个注解的功能:

  1. @Configuration:标识这是一个配置类,其中可能包含了Bean的定义和其他配置信息。
  2. @ComponentScan:指定扫描组件的包路径,默认是启动类所在包及其子包。
  3. @EnableAutoConfiguration:启用Spring Boot的自动配置功能,会根据项目的依赖和环境自动配置各种Bean和功能。

因此,当使用SpringApplication.run(...)方法启动应用时,Spring Boot会从指定的主启动类所在的包开始扫描,并根据@SpringBootApplication注解的相关配置加载应用所需的配置和组件,同时也会根据@EnableAutoConfiguration注解加载自动配置的Bean。

总的来说,@SpringBootApplication注解并不是通过扫描获取的,而是作为启动类的标识,通过它所包含的三个注解来配置和加载应用的相关信息。

# 32. spring源码中在什么地方解析@configuration.@component.@import.@componentScan,@bean Spring Framework中解析@Configuration, @Component, @Import, @ComponentScan, @Bean等注解的地方主要集中在以下几个核心类和接口中:

  1. ConfigurationClassParser: 这个类负责解析@Configuration注解,它会扫描被@Configuration标记的类,并解析其中的@Bean注解,生成Bean定义并注册到Spring容器中。

  2. ClassPathBeanDefinitionScanner: 这个类负责解析@ComponentScan注解,它会扫描指定的包路径,找到带有@Component, @Service, @Repository, @Controller等注解的类,并将它们注册为Spring的Bean。

  3. ConfigurationClassPostProcessor: 这个接口的实现类负责处理@Import注解,它会将被@Import注解导入的配置类加入到当前的配置中,实现配置的组合和模块化。

  4. BeanFactoryPostProcessor: 这个接口的实现类负责处理@Bean注解,它在Spring容器加载Bean定义后,对这些定义进行后置处理,例如可以动态修改Bean定义或者添加新的Bean定义。

这些类和接口在Spring源码中的具体位置会有所变化,因为Spring框架的版本更新会涉及到代码结构的调整和优化。可以通过阅读Spring Framework的源码或者官方文档来深入了解这些注解在框架中的解析和处理过程。

# 33. 对应的生命周期阶段是什么样子的呢 对于Spring Framework中涉及的注解,它们的生命周期阶段大致如下:

  1. @Configuration:
    • 加载阶段:在Spring应用启动时,@Configuration注解标记的配置类会被加载。
    • 解析阶段:Spring会解析配置类中的Bean定义,包括@Bean方法,将它们转化为Bean定义并注册到应用上下文中。
    • 初始化阶段:在应用上下文初始化时,被@Configuration注解标记的类会被实例化,其中的@Bean方法也会被调用生成对应的Bean实例。
  2. @ComponentScan:
    • 扫描阶段:在应用启动时,Spring会扫描@ComponentScan注解指定的包路径下的类,找到标记了@Component@Service@Repository@Controller等注解的类。
    • 注册阶段:扫描到的类会被注册为Spring的Bean,并加入到应用上下文中,成为可被依赖注入的对象。
  3. @Import:
    • 导入阶段:@Import注解可以导入其他配置类,例如@Configuration注解的类或者带有@Import注解的类。这样可以实现配置类的模块化和组合,将不同功能模块的配置组合到一起。
  4. @Bean:
    • 注册阶段:@Bean注解用于声明一个Bean的定义,它会在Spring容器启动时被解析并注册到应用上下文中。
    • 实例化阶段:当需要使用这个Bean时,Spring会调用@Bean方法来实例化对应的Bean对象。

总体来说,这些注解的生命周期阶段涵盖了Spring应用的启动、Bean定义的解析注册、Bean的实例化等过程,确保了应用的配置和依赖注入能够顺利进行。

# 34. 个人总结 1.spring容器管理bean,开始于一个扫描范围,即要先告诉spring容器,classpath下的哪些class要被spring扫描到。 通常,通过@ComponentScan注解进行指定。在springboot中如果没有显式指定@ComponentScan注解,则默认以启动类所在的包以及所有子包作为spring容器的默认扫描范围。

2.在指定的classpath范围内,扫描得到一批class,然后找出符合条件的class。 即哪些class上标注了@Configuration、@Component、@Service、@Controller、@Import

文档信息

Search

    Table of Contents