SpringBoot从0到实战4：容器功能

程序员洲洲

发布于 2024-06-06 13:44:23

12800

代码可运行

文章被收录于专栏：项目文章项目文章

运行总次数：0

代码可运行

在Spring中，如果要引入组件，需要写以下bean.xml配置文件。

SpringBoot容器功能：组件添加之@Configuration

@Configuration 创建一个类，对这个类标注@Configuration，告诉springboot这是一个配置类，等同于之前的配置文件，配置文件能做到什么，配置类也可以做到什么东西。
@Bean是给容器中添加组件，以方法名作为组件的id。返回类型就是组件类型。返回的值就是组件在容器汇总的实例对象。如果不想组件名就是方法名可以这样使用：这个时候组件名就不是petpp而Zujian。
默认组件是单实例的。
配置类本身也是一个组件。
proxyBeanMethods：代理bean的方法。

外部无论对配置类中的这个组件注册方法调用多少次获取多少次都是之前注册容器中的单实例对象。

Full(proxyBeanMethods = true) 【保证每个@Bean方法被调用多少次返回的组件都是单实例的】

Lite轻量级模式(proxyBeanMethods = false) 【每个@Bean方法被调用多少次返回的组件都是新创建的】

组件依赖必须使用Full模式默认。其他默认是否Lite模式如果使用false的那话，那么springboot启动起来就会非常快，springboot不会去检查是否有组件之间的关系会直接跳过，但是如果用户需要保证组件依赖的话就需要使用true。

@Bean（“Zujian”）
public pet petpp(){
}

@Configuration(proxyBeanMethods = false) //告诉SpringBoot这是一个配置类 == 配置文件
public class MyConfig {

    /**
     * Full:外部无论对配置类中的这个组件注册方法调用多少次获取的都是之前注册容器中的单实例对象
     * @return
     */
    @Bean //给容器中添加组件。以方法名作为组件的id。返回类型就是组件类型。返回的值，就是组件在容器中的实例
    public User user01(){
        User zhangsan = new User("zhangsan", 18);
        //user组件依赖了Pet组件
        zhangsan.setPet(tomcatPet());
        return zhangsan;
    }

    @Bean("tom")
    public Pet tomcatPet(){
        return new Pet("tomcat");
    }
}

################################@Configuration测试代码如下########################################
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan("com.atguigu.boot")
public class MainApplication {

    public static void main(String[] args) {
        //1、返回我们IOC容器
        ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);

        //2、查看容器里面的组件
        String[] names = run.getBeanDefinitionNames();
        for (String name : names) {
            System.out.println(name);
        }
        //3、从容器中获取组件

        Pet tom01 = run.getBean("tom", Pet.class);
        Pet tom02 = run.getBean("tom", Pet.class);
        System.out.println("组件："+(tom01 == tom02));

        //4、com.atguigu.boot.config.MyConfig$$EnhancerBySpringCGLIB$$51f1e1ca@1654a892
        MyConfig bean = run.getBean(MyConfig.class);
        System.out.println(bean);

        //如果@Configuration(proxyBeanMethods = true)代理对象调用方法。SpringBoot总会检查这个组件是否在容器中有。
        //保持组件单实例
        User user = bean.user01();
        User user1 = bean.user01();
        System.out.println(user == user1);


        User user01 = run.getBean("user01", User.class);
        Pet tom = run.getBean("tom", Pet.class);
        System.out.println("用户的宠物："+(user01.getPet() == tom));
    }
}

@Configuration总结：

配置类组件之间无依赖关系用Lite模式加速容器启动过程，减少判断
配置类组件之间有依赖关系，方法会被调用得到之前单实例组件，用Full模式

@Bean @Component

标志是一个组件。

@Service

标志是一个业务逻辑组件。

@Controller

是一个控制器组件。

@Repository

代表是一个数据库存组件。

组件所在位置

只要这些组件在扫描的包的下面，那么就可以都识别到。
通过@ComponentScan（“com.zhouzhou.springboot”）来进行识别扫描，即实战3的文章内容。

@Import

导入用法：给容器中导入组件。自动给容器中自动创建出导入的两个类型的组件，同时导入的的组件的名字默认是全类名。

@Import({User.class, DBHelper.class})
@Configuration(proxyBeanMethods = false) //告诉SpringBoot这是一个配置类 == 配置文件
public class MyConfig {
}

@Conditional

条件装配：满足Conditional指定的条件则进行组件的注入。
如下图所示，ConditionalOnJava就是指定的java的版本号才干什么等。

可以通过以下代码来判断容器中是否有以下组件。

使用@ConditionalOnBean进行一个注解，如果容器中有某个组件，我就给容器中加入一个别的组件。如下代码所示，如果容器中没有名为tom的组件那么久不会注入user01组件。如果将@conditionalOnBean加到类上面的话那么意思就是容器中有tom组件的时候，下面的类才会生效，如果没则不生效。
至于容器中是否有该组件，那么就可以使用上述图片中的判断方法进行判断。

public class MyConfig {
    @Bean //给容器中添加组件。以方法名作为组件的id。返回类型就是组件类型。返回的值，就是组件在容器中的实例
    @ConditionalOnBean(name = "tom")
    public User user01(){
        User zhangsan = new User("zhangsan", 18);
        //user组件依赖了Pet组件
        zhangsan.setPet(tomcatPet());
        return zhangsan;
    }
    @Bean("tom")
    public Pet tomcatPet(){
        return new Pet("tomcat");
    }
}

对于@ConditionalOnMissingBean：就是当容器中没有什么的时候，就进行组件的注入，进行条件装配。

原生配置文件的引入

@ImportResource
@ImportResource（“classpath：beans.xml”） -就是允许我们使用以前beans.xml文件进行导入组件，不用手动一个个进行重新添加。因为springboot不会对beans.xml文件中的bean组件进行识别了。

======================beans.xml=========================
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">

    <bean id="haha" class="com.atguigu.boot.bean.User">
        <property name="name" value="zhangsan"></property>
        <property name="age" value="18"></property>
    </bean>

    <bean id="hehe" class="com.atguigu.boot.bean.Pet">
        <property name="name" value="tomcat"></property>
    </bean>
</beans>

@ImportResource("classpath:beans.xml")
public class MyConfig {}

======测试容器中是否有该组件，测试结果成功======
        boolean haha = run.containsBean("haha");
        boolean hehe = run.containsBean("hehe");
        System.out.println("haha："+haha);//true
        System.out.println("hehe："+hehe);//true

配置绑定

使用Java读取到properties文件中的内容，并且把它封装到JavaBean中，以供随时使用；例如数据库账号密码链接地址之类的，通过配置绑定可以实现的非常简单。

public class getProperties {
     public static void main(String[] args) throws FileNotFoundException, IOException {
         Properties pps = new Properties();
         pps.load(new FileInputStream("a.properties"));
         Enumeration enum1 = pps.propertyNames();//得到配置文件的名字
         while(enum1.hasMoreElements()) {
             String strKey = (String) enum1.nextElement();
             String strValue = pps.getProperty(strKey);
             System.out.println(strKey + "=" + strValue);
             //封装到JavaBean。
         }
     }
 }

/**
 * 只有在容器中的组件，才会拥有SpringBoot提供的强大功能
 * 比如说配置绑定
 */
@Component//将组件添加到容器中
@ConfigurationProperties(prefix = "mycar")
//配置文件中会有如下定义：
//mycar.brand=BYD
//mycar.price=100
//所以这个的意思就是自动绑定配置文件中的mycar前缀中的brand和price进行绑定，也是因为mycar中的brand和price刚好就是car中对应的类成员
public class Car {

    private String brand;
    private Integer price;

    public String getBrand() {
        return brand;
    }
    public void setBrand(String brand) {
        this.brand = brand;
    }
    public Integer getPrice() {
        return price;
    }
    public void setPrice(Integer price) {
        this.price = price;
    }
   @Override
    public String toString() {
        return "Car{" +
                "brand='" + brand + '\'' +
                ", price=" + price +
                '}';
    }
}

然后在主程序中进行自动装配填充car，然后测试一个car类请求。

也就是如果想一个JavaBean跟配置文件中的东西一一绑定的话，那么就使用如上语句即可
除此之外，还有@EnableConfigurationProperties + @ConfigurationProperties的搭配方法也可以进行如上相同操作。但是需要注意的是需要在配置类中进行如下操作。

@EnableConfigurationProperties(Car.class)
//1、开启Car配置绑定功能
//2、把这个Car这个组件自动注册到容器中
public class MyConfig {
}

自动配置原理

引导加载自动配置类

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication{}
=========核心代码如上=====

@SpringBootConfiguration 代表当前是一个配置类@Configuration。
@ComponentScan 指定扫描哪些，可以参考Spring注解。
@EnableAutoConfiguration @EnableAutoConfiguration中的子注解如下：

@AutoConfigurationPackage
//自动配置包：
//@Import(AutoConfigurationPackages.Registrar.class) 
//给容器中导入一个组件
//public @interface AutoConfigurationPackage {}
//利用Registrar给容器中导入一系列组件
//将指定的一个包下的所有组件导入进来即MainApplication 所在包下。也就是解释了一个事情，为什么默认的包路径是Main程序是在这个main路径下。

@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {}
//1、利用getAutoConfigurationEntry(annotationMetadata);给容器中批量导入一些组件，一启动就导入127个配置
//2、调用List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes)获取到所有需要导入到容器中的配置类
//3、利用工厂加载 Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader)；得到所有的组件
//4、从META-INF/spring.factories位置来加载一个文件。
	默认扫描我们当前系统里面所有META-INF/spring.factories位置的文件
//spring-boot-autoconfigure-2.3.4.RELEASE.jar包里面也有META-INF/spring.factories文件里面写死了spring-boot一启动就要给容器中加载的所有配置类一共是127个

按需开启自动配置项虽然我们127个场景的所有自动配置启动的时候默认全部加载。xxxxAutoConfiguration 按照条件装配规则（@Conditional），最终会按需配置。发红的就是没有生效实现，这就是springboot的加载核心，启动的时候默认加载全部的，但是根据装配规则，按需配置！

修改默认配置

        @Bean
		@ConditionalOnBean(MultipartResolver.class)  //容器中有这个类型组件
		@ConditionalOnMissingBean(name = DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME) //容器中没有这个名字 multipartResolver 的组件
		public MultipartResolver multipartResolver(MultipartResolver resolver) {
            //给@Bean标注的方法传入了对象参数，这个参数的值就会从容器中找。
            //SpringMVC multipartResolver。防止有些用户配置的文件上传解析器不符合规范
			// Detect if the user has created a MultipartResolver but named it incorrectly
			return resolver;
		}
给容器中加入了文件上传解析器；

SpringBoot默认会在底层配好所有的组件。但是如果用户自己配置了以用户的优先

@Bean
	@ConditionalOnMissingBean
	public CharacterEncodingFilter characterEncodingFilter() {
    }

最佳实践

引入场景依赖 https://docs.spring.io/spring-boot/docs/current/reference/html/using-spring-boot.html#using-boot-starter
查看自动配置了哪些（选做）自己分析，引入场景对应的自动配置一般都生效了
配置文件中debug=true开启自动配置报告。Negative（不生效）\Positive（生效）
是否需要修改参照文档修改配置项 https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html#common-application-properties
- 自己分析。xxxxProperties绑定了配置文件的哪些。
自定义加入或者替换组件 @Bean、@Component。。。
自定义器XXXXXCustomizer；

实战4总结：

SpringBoot先加载所有的自动配置类 xxxxxAutoConfiguration
每个自动配置类按照条件进行生效，默认都会绑定配置文件指定的值。xxxxProperties里面拿。xxxProperties和配置文件进行了绑定。
生效的配置类就会给容器中装配很多组件。
只要容器中有这些组件，相当于这些功能就有了。
定制化配置。用户直接自己@Bean替换底层的组件。用户去看这个组件是获取的配置文件什么值就去修改。 xxxxxAutoConfiguration —> 组件 —> xxxxProperties里面拿值 ----> application.properties。

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2024-06-06，如有侵权请联系 cloudcommunity@tencent.com 删除

public