了解SpringBoot自动配置原理

目录

1、SpringBoot特点

1.1、依赖管理

1.1.1 父项目做依赖管理

1.1.2 开发导入starter场景启动器

1.1.3 无需关注版本号，自动仲裁机制

1.1.4 可以修改默认版本号

1.2、自动配置

2、容器功能

2.1、组件添加

1、@Configuration

2、@Bean、@Component、@Controller、@Service、@Repository

3、@ComponentScan、@Import

4、@Conditional

2.2、原生配置文件引入

1、@ImportResource

2.3、配置绑定

1、@Component + @ConfigurationProperties

2、@EnableConfigurationProperties + @ConfigurationProperties

3、自动配置原理入门

3.1、引导加载自动配置类

1、@SpringBootConfiguration

2、@ComponentScan

3、@EnableAutoConfiguration

3.2、按需开启自动配置项

3.3、修改默认配置

3.4、最佳实践

4、开发小技巧

4.1、Lombok

4.2、dev-tools 

4.3、Spring Initailizr（项目初始化向导）

---

1、SpringBoot特点

1.1、依赖管理

1.1.1 父项目做依赖管理

依赖管理    

        org.springframework.boot
        spring-boot-starter-parent
        2.3.4.RELEASE

我们按住Ctrl点击spring-boot-starter-parent可以看到他也有一个父项目
 

    org.springframework.boot
    spring-boot-dependencies
    2.3.4.RELEASE
  

再按住Ctrl点击spring-boot-dependencies可以看到SpringBoot几乎声明了所有开发中常用的依赖的版本号，这是SpringBoot的自动版本仲裁机制

1.1.2 开发导入starter场景启动器

1、见到很多 spring-boot-starter-* ： *就表示某种场景，比如我们导入过的spring-boot-starter-web代表web开发的场景，可以看到这个starter导入了各种web开发所需要的依赖

2、只要引入starter，这个场景的所有常规需要的依赖我们都自动引入

3、SpringBoot所有支持的场景Developing with Spring Boot
4、见到的  *-spring-boot-starter： 第三方为我们提供的简化开发的场景启动器。
5、所有场景启动器最底层的依赖如下：

  org.springframework.boot
  spring-boot-starter
  2.3.4.RELEASE
  compile

1.1.3 无需关注版本号，自动仲裁机制

1、引入依赖默认都可以不写版本
2、引入非版本仲裁的jar，即SpringBoot内没有导入的jar，要写版本号。

1.1.4 可以修改默认版本号

1、查看spring-boot-dependencies里面规定当前依赖的版本 用的 key， 如下图的mysql.version即为key，根据该key在pom.xml文件重写配置。

2、在当前项目里面重写配置

    
        5.1.43
    

1.2、自动配置

• 自动配好Tomcat
  • 引入Tomcat依赖。
  • 配置Tomcat

    
      org.springframework.boot
      spring-boot-starter-tomcat
      2.3.4.RELEASE
      compile
    

• 自动配好SpringMVC
  • 引入SpringMVC全套组件
  • 自动配好SpringMVC常用组件（功能）
• 自动配好Web常见功能，如：字符编码问题
  • SpringBoot帮我们配置好了所有web开发的常见场景
• 默认的包结构
  • 主程序所在包及其下面的所有子包里面的组件都会被默认扫描进来
  • 无需以前的包扫描配置
  • 想要改变扫描路径，@SpringBootApplication(scanBasePackages="com.atguigu")
    • 或者@ComponentScan 指定扫描路径

@SpringBootApplication
等同于
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan("com.atguigu.boot")

• 各种配置拥有默认值
  • 默认配置最终都是映射到某个类上，如：MultipartProperties
  • 配置文件的值最终会绑定每个类上，这个类会在容器中创建对象
• 按需加载所有自动配置项
  • 非常多的starter
  • 引入了哪些场景这个场景的自动配置才会开启
  • SpringBoot所有的自动配置功能都在 spring-boot-autoconfigure 包里面
• ……

2、容器功能

2.1、组件添加

1、@Configuration

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

#############################Configuration使用示例######################################################
/**
 * 1、配置类里面使用@Bean标注在方法上给容器注册组件，默认也是单实例的
 * 2、配置类本身也是组件
 * 3、proxyBeanMethods：代理bean的方法
 *      Full(proxyBeanMethods = true)、【保证每个@Bean方法被调用多少次返回的组件都是单实例的】
 *      Lite(proxyBeanMethods = false)【每个@Bean方法被调用多少次返回的组件都是新创建的】
 *      组件依赖必须使用Full模式默认。其他默认是否Lite模式
 *
 *
 *
 */
@Configuration(proxyBeanMethods = true) //告诉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));



    }
}

2、@Bean、@Component、@Controller、@Service、@Repository

根据它们的源码可以看到，Controller、Service、Repository其本质就是Component。

它们存在的本质只是给开发者看的，对Spring而言它们就都是Component。

@Controller 控制层类，@Service 业务层类，@Repository 持久层类，@Component 无法归类到前3种时就称为组件。

3、@ComponentScan、@Import

@ComponentScan：扫描包

@Import：自动从类中的无参构造函数创建一个实例注册到 IOC 容器中

【注意】@Import所创建的实例在 IOC 容器中默认的id名为类的全限定名，如 User 类就是：com.atguigu.bean.User

可以看到Import内部是一个类数组，因此我们可以导入多个bean

 * @Import({User.class, DBHelper.class})
 *      给容器中自动创建出这两个类型的组件、默认组件的名字就是全类名
 *
 *
 *
 */

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

4、@Conditional

条件装配：满足Conditional指定的条件，则进行组件注入

 

=====================测试条件装配==========================
@Configuration(proxyBeanMethods = false) //告诉SpringBoot这是一个配置类 == 配置文件
//@ConditionalOnBean(name = "tom")
@ConditionalOnBean(name = "tom") //表示容器中有以tom为名的bean的话，类中的bean创建才会生效，如果是放在方法上，则表示如果条件成立被标注的方法才会创建bean
public class MyConfig {


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

    @Bean //给容器中添加组件。以方法名作为组件的id。返回类型就是组件类型。返回的值，就是组件在容器中的实例
    public User user01(){
        User zhangsan = new User("zhangsan", 18);
        //user组件依赖了Pet组件
        zhangsan.setPet(tomcatPet());
        return zhangsan;
    }
    //注意此时这里的tom的创建是取决于外部有没有创建名为tom的bean
    @Bean("tom")
    public Pet tomcatPet(){
        return new Pet("tomcat");
    }
}

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);
        }

        boolean tom = run.containsBean("tom");
        System.out.println("容器中Tom组件："+tom);

        boolean user01 = run.containsBean("user01");
        System.out.println("容器中user01组件："+user01);

        boolean tom22 = run.containsBean("tom22");
        System.out.println("容器中tom22组件："+tom22);


    }

2.2、原生配置文件引入

1、@ImportResource

将xml配置文件中的配置解析并放入到容器中。

======================beans.xml=========================



    
        
        
    

    
        
    

 测试

@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

2.3、配置绑定

如何使用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。
         }
     }
 }

 1、@Component + @ConfigurationProperties

为car这个类绑定上配置文件前缀为mycar的配置 ，前提是car这个类要注册在容器中

/**
 * 只有在容器中的组件，才会拥有SpringBoot提供的强大功能
 */
@Component
@ConfigurationProperties(prefix = "mycar")
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 +
                '}';
    }
}

测试 

//@Controller
//@ResponseBody
@RestController //相当于上面两个注解的组合
public class HelloController {

    @Autowired
    private Car car;
    @RequestMapping("/car")
    public Car car() {
        return car;
    }

    @RequestMapping("/hello")
    public String hello() {
        return "Hello SpringBoot2";
    }
}

2、@EnableConfigurationProperties + @ConfigurationProperties

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

3、自动配置原理入门

3.1、引导加载自动配置类

解析主启动类上的@SpringbootApplication注解

1、@SpringBootConfiguration

@Configuration。代表当前是一个配置类

2、@ComponentScan

指定扫描哪些，Spring注解；

3、@EnableAutoConfiguration

 

1、@AutoConfigurationPackage
自动配置包？指定了默认的包规则

@Import(AutoConfigurationPackages.Registrar.class)  //给容器中导入一个组件
public @interface AutoConfigurationPackage {}

//利用Registrar给容器中导入一系列组件
//将指定的一个包下的所有组件导入进来？MainApplication 所在包下。

打断点测试，提前将

new PackageImports(metadata).getPackageNames() 加入观察点

其值正是主启动类所在的包

 

 2、@Import(AutoConfigurationImportSelector.class)

@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {}

 ①进入AutoConfigurationImportSelector，第一个方法是通过getAutoConfigurationEntry这个方法获取了AutoConfigurationEntry，跟踪一下

 发现是通过getCandidateConfiguration方法获取到配置，后面对configuration进行了一些系列操作，通过打断点发现configuration有127个

 

我们继续跟踪getCandidateConfiguration

找到getCandidateConfigurations方法，点进loadFactoryNames方法

再点进loadSpringFactories方法

可以看到读取了META-INF/spring.factories这个文件，默认扫描我们当前系统里面所有META-INF/spring.factories位置的文件
 

  spring-boot-autoconfigure-2.3.4.RELEASE.jar包里面也有META-INF/spring.factories

 

 可以看到EnableAutoConfiguration在这个文件写死了，默认给容器中加载的所有配置类(127个)

总结

1、利用getAutoConfigurationEntry(annotationMetadata);给容器中批量导入一些组件
2、调用List configurations = getCandidateConfigurations(annotationMetadata, attributes)获取到所有需要导入到容器中的配置类
3、利用工厂加载 Map> 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
    

 3.2、按需开启自动配置项

虽然我们127个场景的所有自动配置启动的时候默认全部加载。xxxxAutoConfiguration

 

按照条件装配规则（@Conditional），最终会按需配置。 

 3.3、修改默认配置

例如：改变编码类型，可以查看官网或者直接看源码，找到对应的 Properties文件，例如上面的ServerProperties，或者更直接的找到绑定的prefix，直接在application.properties文件进行修改

 

  

总结：

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

xxxxxAutoConfiguration ---> 组件 ---> xxxxProperties里面拿值 ----> application.properties

3.4、最佳实践

• 引入场景依赖
  • Developing with Spring Boot
• 查看自动配置了哪些（选做）
  • 自己分析，引入场景对应的自动配置一般都生效了
  • 配置文件中debug=true开启自动配置报告。Negative（不生效）\Positive（生效）
• 是否需要修改
  • 参照文档修改配置项
    • Common Application Properties (spring.io)
    • 自己分析。xxxxProperties绑定了配置文件的哪些。
• 自定义加入或者替换组件
  • @Bean、@Component。。。
  • 自定义器 XXXXXCustomizer；
  • ......

4、开发小技巧

4.1、Lombok

简化JavaBean开发

        
            org.projectlombok
            lombok
        

idea中搜索安装lombok插件 

 测试

===============================简化JavaBean开发===================================
@NoArgsConstructor //午餐构造器
//@AllArgsConstructor //全参构造器
@Data //各种属性的get和set方法
@ToString //全部参数toString
@EqualsAndHashCode //equalandHash方法
public class User {

    private String name;
    private Integer age;

    private Pet pet;

    public User(String name,Integer age){ //若是部分参数的构造器那么就手动添加
        this.name = name;
        this.age = age;
    }


}



================================简化日志开发===================================
@Slf4j //也是Lombok的功能，给该类加上日志属性，可以进行日志添加输出
@RestController
public class HelloController {
    @RequestMapping("/hello")
    public String handle01(@RequestParam("name") String name){
        
        log.info("请求进来了...."); //日志输出
        
        return "Hello, Spring Boot 2!"+"你好："+name;
    }
}

4.2、dev-tools
 

        
            org.springframework.boot
            spring-boot-devtools
            true
        

项目或者页面修改以后：Ctrl+F9； 

4.3、Spring Initailizr（项目初始化向导）

1、选择我们需要的开发场景

2、自动依赖引入

3、自动创建项目结构

4、自动编写好主配置类