springboot实现自动配置

最新推荐文章于 2024-04-12 09:00:00 发布
最新推荐文章于 2024-04-12 09:00:00 发布
阅读量958 收藏
点赞数 1
分类专栏： java # springboot 文章标签： springboot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_22211217/article/details/98487446
版权

目录

一  前言

二 实现原理

（1）springboot启动类注解解析

（2）参考

三  实现

方式一：使用spring.factories文件，通过配置enable实现开关

1、目录结构

2、关键代码

3、测试

方式二：使用注解@EnableXXX实现开关

1、目录结构

2、关键代码

3、测试

四  项目git

https://github.com/HandsomeMars/springboot-autoconfig-demo 

一  前言

1、今天想写一个自动配置的模块，参考了一系列文章，感觉非常失望。

问题如下：
1、混淆了自动配置注解：@EanbleXXX注解 加与不加都会生效配置 其实现关键是自动配置上通过其他条件加载完成 
2、无效代码：太多的模仿代码，让人云里雾里;以及不完整测试，只测开启不测关闭

2、自己看了springboot官方文档，写了两种形式的自动配置

开发环境
环境版本
springboot2.0.3.release
maven3.5.2
jdk1.8


 

二 实现原理


（1）springboot启动类注解解析

springboot启动类中@SpringBootApplication
包含：
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan

其中@EnableAutoConfiguration
包含：
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})

其中
AutoConfigurationImportSelector
实现了从所有包下的 META-INF/spring.factories
读取自动配置类信息，通过类加载初始化所描述的bean

由上即可知自动配置的最简单的实现方式

1、新建META-INFO/spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zyj.config.Custom2AutoConfig #需要被初始化的类

2、查询api可知，等效写法：实现如下接口，通过@Import等方式初始化

org.springframework.context.annotation.ImportSelector

@Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
 //逻辑判断 返回对应的配置类包全路径
        if(annotationMetadata.getAnnotationTypes().contains(EnableCustomAutoConfig.class.getName())){
            System.out.println("没错你是最棒的");
            return new String[]{CustomAutoConfig.class.getName()};
        }else{
            return new String[0];
        }

    }

（2）参考

https://docs.spring.io/spring-boot/docs/2.0.3.RELEASE/reference/htmlsingle/#boot-features-locating-auto-configuration-candidates

 https://docs.spring.io/spring-boot/docs/2.0.3.RELEASE/reference/htmlsingle/#boot-features-custom-starter

 

三  实现

方式一：使用spring.factories文件，通过配置enable实现开关

1、目录结构

─src
  ├─main
  │  ├─java
  │  │  └─com
  │  │      └─zyj
  │  │          │  SpringbootAutoconfigByfileApplication.java  ##可忽略
  │  │          │
  │  │          └─config
  │  │                  Custom2AutoConfig.java  ##关键配置类
  │  │                  Custom2Properties.java  ##参数配置类
  │  │                  Custom2Server.java      ##模拟服务（可忽略）
  │  │
  │  └─resources
  │      │  application.properties              ##可忽略
  │      │
  │      └─META-INF
  │              spring.factories               ##关键配置文件，指定初始化关键配置类
  │
  └─test
      └─java
          └─com
              └─zyj
                      SpringbootAutoconfigByfileApplicationTests.java ##可忽略

 

2、关键代码

pom依赖

<!--关键依赖 @ConfigurationProperties-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-configuration-processor</artifactId>
			<optional>true</optional>
		</dependency>
		<!--更加自动配置框架而定-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>

Custom2Properties.java

package com.zyj.config;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * @author by zyj
 * @version V1.0
 * @Description:
 * @Date 2019/8/5 14:35
 */
/**解析spring配置文件中custom2开头的配置信息*/
@ConfigurationProperties(prefix="custom2")
public class Custom2Properties {
    private boolean enable;

    private String test;

    public String getTest() {
        return test;
    }

    public void setTest(String test) {
        this.test = test;
    }

    public boolean isEnable() {
        return enable;
    }

    public void setEnable(boolean enable) {
        this.enable = enable;
    }


    @Override
    public String toString() {
        StringBuilder stringBuilder=new StringBuilder();
        stringBuilder.append("[");
        stringBuilder.append("enable:"+enable);
        stringBuilder.append(",");
        stringBuilder.append("test:"+test);
        stringBuilder.append("]");
        return stringBuilder.toString();
    }
}

 Custom2AutoConfig.java

package com.zyj.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;

/**
 * @author by zyj
 * @version V1.0
 * @Description:
 * @Date 2019/8/5 11:29
 */
/**类似@Import 加载属性文件（相当于属性文件@Component）*/
/**与下面@Autowired配合*/
@EnableConfigurationProperties(Custom2Properties.class)
public class Custom2AutoConfig {

    @Autowired
    Custom2Properties custom2Properties;

    @Bean
    /**不存在实例才加载,避免重复*/
    @ConditionalOnMissingBean(Custom2Server.class)
    /**classpath出现Custom2Server才加载*/
    @ConditionalOnClass(Custom2Server.class)
    /**配置enable true 默认true才加载*/
    @ConditionalOnProperty(prefix="custom2", value="enable", matchIfMissing = true)
    public Custom2Server custom2Server(){
        Custom2Server testServer=new Custom2Server(custom2Properties);
        return testServer;
    }

}

 Custom2Server.java

package com.zyj.config;

/**
 * @author by zyj
 * @version V1.0
 * @Description:
 * @Date 2019/8/5 14:11
 */
public class Custom2Server {


    /**
     * 初始化
     * @param custom2Properties
     */
    public Custom2Server(Custom2Properties custom2Properties) {
        System.out.println(this.getClass().getName()+"初始化了:打印配置"+ custom2Properties.toString());
    }

}

spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zyj.config.Custom2AutoConfig

3、测试

step1：pom引入自动配置的包

<dependency>
			<groupId>com.zyj</groupId>
			<artifactId>springboot-autoconfig-byfile</artifactId>
		</dependency>

step2：配置application.properties

server.port=8099

#次自动配置方式通过enable控制开关 不写设置为true
custom2.test=测试文件方式自动配置
custom2.enable=true

step3：启动

step4:取消自动配置

server.port=8099

#次自动配置方式通过enable控制开关 不写设置为true
custom2.test=test-auto-by-file
custom2.enable=false

方式二：使用注解@EnableXXX实现开关

1、目录结构

src
├─main
│  ├─java
│  │  └─com
│  │      └─zyj
│  │          │  SpringbootAutoconfigByAnnoApplication.java  ##可忽略
│  │          │
│  │          ├─auto
│  │          │      CustomAutoConfigSelect.java  ##自定义配置类过滤 等价spring.factories
│  │          │      EnableCustomAutoConfig.java  ##自定义配置注解 
│  │          │
│  │          └─config
│  │                  CustomAutoConfig.java       ##自定配置类
│  │                  CustomProperties.java       ##配置属性（可忽略）
│  │                  CustomServer.java           ##配置服务（可忽略）
│  │
│  └─resources
│          application.properties        ##可忽略
│
└─test
    └─java
        └─com
            └─zyj
                    SpringbootAutoconfigApplicationTests.java ##可忽略

2、关键代码

pom依赖

<!--关键依赖 @ConfigurationProperties-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-configuration-processor</artifactId>
			<optional>true</optional>
		</dependency>
		<!--更加自动配置框架而定-->
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>

EnableCustomAutoConfig.java

package com.zyj.auto;

import org.springframework.context.annotation.Import;

import java.lang.annotation.*;

/**
 * @author by zyj
 * @version V1.0
 * @Description:
 * @Date 2019/8/5 11:26
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
/**如果使用注解则引入CustomAutoConfigSelect*/
@Import(CustomAutoConfigSelect.class)
public @interface EnableCustomAutoConfig {
}

CustomAutoConfigSelect.java

package com.zyj.auto;

import com.zyj.config.CustomAutoConfig;
import org.springframework.context.annotation.ImportSelector;
import org.springframework.core.type.AnnotationMetadata;

/**
 * @author by zyj
 * @version V1.0
 * @Description:
 * @Date 2019/8/5 11:28
 */
public class CustomAutoConfigSelect implements ImportSelector{
    @Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        /** 打印springboot使用的注解annotationMetadata.getAnnotationTypes().forEach(System.out::println);*/
        if(annotationMetadata.getAnnotationTypes().contains(EnableCustomAutoConfig.class.getName())){
            //配置自动配置需要加载的类
            return new String[]{CustomAutoConfig.class.getName()};
        }else{
            //没有自动配置则不加载
            return new String[0];
        }

    }
}

CustomProperties.java

package com.zyj.config;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * @author by zyj
 * @version V1.0
 * @Description:
 * @Date 2019/8/5 14:35
 */
/**解析spring配置文件中custom开头的配置信息*/
@ConfigurationProperties(prefix="custom")
public class CustomProperties {
    private boolean enable;

    private String test;

    public String getTest() {
        return test;
    }

    public void setTest(String test) {
        this.test = test;
    }

    public boolean isEnable() {
        return enable;
    }

    public void setEnable(boolean enable) {
        this.enable = enable;
    }


    @Override
    public String toString() {
        StringBuilder stringBuilder=new StringBuilder();
        stringBuilder.append("[");
        stringBuilder.append("enable:"+enable);
        stringBuilder.append(",");
        stringBuilder.append("test:"+test);
        stringBuilder.append("]");
        return stringBuilder.toString();
    }
}

CustomAutoConfig.java

package com.zyj.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;

/**
 * @author by zyj
 * @version V1.0
 * @Description:
 * @Date 2019/8/5 11:29
 */
/**类似@Import 加载属性文件（相当于属性文件@Component）*/
/**与下面@Autowired配合*/
@EnableConfigurationProperties(CustomProperties.class)
public class CustomAutoConfig {

    @Autowired
    CustomProperties customProperties;

    @Bean
    /**不存在实例才加载,避免重复*/
    @ConditionalOnMissingBean(CustomServer.class)
    /**classpath出现CustomServer才加载*/
    @ConditionalOnClass(CustomServer.class)
    /**配置enable true 默认true才加载*/
    @ConditionalOnProperty(prefix="custom", value="enable", matchIfMissing = true)
    public CustomServer customServer(){
        CustomServer testServer=new CustomServer(customProperties);
        return testServer;
    }

}

 CustomServer.java

package com.zyj.config;

/**
 * @author by zyj
 * @version V1.0
 * @Description:
 * @Date 2019/8/5 14:11
 */
public class CustomServer {


    /**
     * 初始化
     * @param customProperties
     */
    public CustomServer(CustomProperties customProperties) {
        System.out.println(this.getClass().getName()+"初始化了:打印配置"+ customProperties.toString());
    }

}

3、测试

step1：pom引入自动配置的包

<dependency>
			<groupId>com.zyj</groupId>
			<artifactId>springboot-autoconfig-byanno</artifactId>
		</dependency>

step2：springboot加注解  （配置application.properties(可忽略) ）

@SpringBootApplication
@EnableCustomAutoConfig/**添加此注解实现自动配置*/
public class SpringbootAutoconfigTestApplication {
//省略
}
server.port=8099

#次自动配置方式通过enable注解即可,enable为再扩展
custom.test=test-auto-by-anno
custom.enable=true

step3：启动

 

step4：关闭自动配置

去除注解即可 

不去注解设置false

server.port=8099

#次自动配置方式通过enable注解即可,enable为再扩展
custom.test=test-auto-by-anno
custom.enable=false

四  项目git

https://github.com/HandsomeMars/springboot-autoconfig-demo 

Mars'Ares
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
springboot覆盖自动配置
qq_32754539的博客
02-19 3578
覆盖自动配置的Bean 大多数情况下，自动配置的Bean刚好能满足你的需要，不需要去覆盖它们。但某些情况下， Spring Boot在自动配置时还不能很好地进行推断。 保护应用程序 引入maven <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring...
springboot自动配置流程
m0_51287945的博客
11-17 902
springboot自动配置功能
SpringBoot 启动之如何加载并处理 META-INF/spring.factories 文件
bluemysky的博客
12-26 4624
SpringBoot 中如何加载并处理 META-INF/spring.factories 文件。
SpringBoot中META-INF/spring.factories文件和application.properties或application.yml文件的区别
suanfajiegou的博客
03-22 2560
是一个标准的 Java 服务加载机制，用于在 Spring Boot 启动过程中查找和加载所有的自动配置类。该文件中的每条记录都指定了一个或多个自动配置类的全限定名，这些配置类会在 Spring Boot 启动时被加载并应用到应用程序中。则是用于设置应用程序各种配置属性的文件，在 Spring Boot 应用程序中，这些属性通常包括数据库连接信息、服务器端口号、日志级别等等。文件中定义的所有自动配置类，并将其应用到应用程序中。文件中配置的属性值，并覆盖或补充自动配置类中设置的默认属性值。
SpringBoot配置文件
2301_76161469的博客
04-12 1361
其中，yml 和 properties 的区别 类似与商品的新旧包装，properties类型的配置文件就属于旧包装，也就是是创建SpringBoot项目时默认的文件格式（仓库里还有库存)，而yml属于新包装。我们可以发现： 当 .properties 和 .yml 共存时，两个配置文件都会加载，而当配置文件内容存在冲突时，其中，yml是yaml的简写，使用频率较高，yaml与yml的使用方式是。的，因此我们学习了yml文件的使用后，也就能够使用yaml文件。
springboot中META-INF/spring.factories解析加载类
毅香雪海的博客
04-27 1万+
org.springframework.boot.autoconfigure.EnableAutoConfiguration org.springframework.cloud.bootstrap.BootstrapConfiguration
SpringBoot的自动装配
景川的博客
09-23 2095
SpringBoot自动装配： SpringBoot 定义了一套接口规范，这套规范规定：SpringBoot 在启动时会扫描外部引用 jar 包中的文件，将文件中配置的类型信息加载到 Spring 容器，并执行类中定义的各种操作。对于外部 jar 来说，只需要按照 SpringBoot 定义的标准，就能将自己的功能装置进 SpringBoot。
Spring Boot 打包成Jar包运行的原理
欢迎来到我的博客
07-27 542
BOOT-INFO目录：本地项目的代码（BOOT-INF/classes），以及所需的以依赖（BOOT-INFO/lib）META-INFO目录：META-INFO/MANIFEST.MF里包含了jar包的元数据，包含了项目的启动类等信息.相比与传统的Java打包方式，使用SpringBoot打包插件打包成jar包后，可以直接使用。Main-Class ：jar包启动类，这是java规定的字段，存在这个字段的情况下， 在。org目录：该目录下包含的是启动项目的一些类，启动的过程就在这个包里。
浅谈springboot自动配置原理
08-25
然后通过@Import注解导入AutoConfigurationImportSelector类，加载/META-INF/spring.factories文件的信息，筛选出以EnableAutoConfiguration为key的数据，加载到IOC容器中，实现自动配置功能。 ...
SpringBoot自动配置原理分析
最新发布
06-12
学SpringBoot 最重要的是学它的自动配置原理，不然到了后面项目实战就会发现与其他人的差距在哪里，只知其一不知其二。SpringBoot的自动配置原理是其核心特性之一，其重要性主要体现在简化应用程序的开发和部署过程...
全网最深分析SpringBoot MVC自动配置失效的原因
08-18
SpringBoot MVC自动配置失效的原因分析 在SpringBoot应用程序中，MVC自动配置的失效是一个常见的问题，本文将深入分析这个问题的原因，並提供了详细的示例代码和分析过程。 一、自动配置失效的原因 在SpringBoot...
基于springboot的自动更新
03-02
标题中的“基于SpringBoot的自动更新”指的是在SpringBoot应用中实现自动化更新的功能，使得应用程序能够在运行时自动检测并下载最新的版本，无需手动重启服务。这通常涉及到版本控制、网络请求、文件处理等多个技术...
Springboot自动装配实现过程代码实例
08-19
Springboot自动装配实现过程代码实例是指在Spring Boot项目中实现自动装配的过程，包括创建自定义注解、配置类和自动装配Bean的过程。 知识点一：自定义注解 在Spring Boot项目中，可以使用自定义注解来标记组件、...
SpringBoot自动配置原理
Bookwormer的博客
02-13 179
SpringBoot自动配置原理 前言：这篇文章是在看完SpringBoot自动配置原理后记录的，如果有不对的地方烦请多多指正。 SpringBoot应用启动流程 通过调用追踪，我们发现SpringBoot应用启动时，它做了两件事：创建SpringApplication对象、运行run方法，源代码如下： public static ConfigurableApplicationContext run(Class<?>[] primarySources, String[] args) {
Springboot 之 静态资源路径配置
热门推荐
知识林www.zslin.com
10-24 2万+
本文章来自【知识林】静态资源路径是指系统可以直接访问的路径，且路径下的所有文件均可被用户直接读取。在Springboot中默认的静态资源路径有：classpath:/META-INF/resources/，classpath:/resources/，classpath:/static/，classpath:/public/，从这里可以看出这里的静态资源路径都是在classpath中（也就是在项目路径
springBoot自动配置
原之殇
09-27 251
个人笔记，因有道需要会员，就用CSDN了，本人菜鸟，欢迎批评。 spingBoot如何实现自动配置 用简单的一句来说，就是SpringBoot通过@EnableAutoConfiguration注解开启自动配置，加载spring.factories中注册的各种AutoConfiguration类。 了解@EnableAutoConfiguration 在创建SpringBoot启动类的时候我们往往不是直接使用@EnableAutoConfiguration注解，而是使用@SpringBootAppli
META-INF/spring.factories使用测试
毅香雪海的博客
07-18 2455
在之前的文章中已经大致解释META-INF/spring.factories的作用以及加载流程，本章项目需要实现一些示例一下示例。 配置类加载 首先是配置加载实现的加载实现： org.springframework.cloud.bootstrap.BootstrapConfiguration：表示org.springframework.cloud.bootstrap.config.PropertySourceLocator 的实现类实现的配置加载过程。 org.springframework.boo
SpringBoot应用，自动配置源码刨析
weixin_43251629的博客
06-24 870
SpringBoot 约定优于配置思想 又称按约定编程，是一种软件设计规范。本质上是对系统、类库或框架中一些东西假定一个大众化合理的默认值(缺省值)。 只要不偏离默认配置，就不需要额外配置； SpringBoot基本概念 1.springBoot是一种快速启动Spring的一种轻量级框架，可以让我们使用Spring的强大功能，又不需要像Spring那样进行大量配置； 2.SpringBoot是基于Spring4.0版本设计，它解决了依赖包的一个冲突问题还有引用不稳定的问题； SpringBoot的相关特
springboot自动配置个人理解
qq_38040765的博客
12-05 283
自动配置原理 了解springboot的自动配置原理首先要理解springboot的属性注入一级@Import注解。 1.springboot属性注入(这里以注入DruidDataSource为例) 1）.首先在application.yml中声明相关属性 application.yml mysql: driver: com.mysql.jdbc.Driver username: 444...
springboot怎么实现自动配置
03-08
Spring Boot 通过自动配置来简化开发过程，它会根据 classpath 下的 jar 包、配置文件以及注解来自动配置应用程序。开发者可以通过在 application.properties 或 application.yml 中设置属性来覆盖默认配置。此外，...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Mars'Ares

请我喝杯咖啡吧

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值