首页 > 其他分享 >带你手写starter组件,搞懂SpringBoot自动配置原理

带你手写starter组件,搞懂SpringBoot自动配置原理

时间:2022-12-23 15:07:59浏览次数:45  
标签:SpringBoot spring 配置 boot yg 搞懂 starter


一. 问题阐述

最近有不少同学问壹哥,使用SpringBoot和使用XML配置到底有什么区别。其实如果我们只从编写代码的逻辑来看,使用SpringBoot同样是按照三层架构,从控制层、逻辑层再到持久层进行开发,这似乎和过去没什么区别。那SpringBoot的优势到底在哪里呢?今天壹哥通过带各位手写一个SpringBoot中的starter启动器,来跟大家分析一下这个问题。

二. 自动配置

SpringBoot的最大优势其实就在于【自动配置】。大家是否还记得,在过去XML配置SSM程序的时代,我们为了把Mybatis整合到Spring的容器中去,做的第一件事就是先配置一个数据源的bean,一般配置代码如下:

<!--1 使用商业的数据源  把数据源配置成bean-->
<bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
<property name="driverClass" value="com.mysql.jdbc.Driver"/>
<property name="jdbcUrl" value="jdbc:mysql://localhost:3306/cs2105?characterEncoding=utf8"/>
<property name="user" value="root"/>
<property name="password" value="root"/>
<property name="maxPoolSize" value="10"/>
</bean>

但当我们使用SpringBoot整合Mybatis之后,我们还配置过数据源的bean吗?很明显,我们再也没有配置过了!那么上面这个数据源的bean,到底是谁帮我们配置到容器里去了呢?答案就是SpringBoot的自动配置SpringBoot的一个核心优势就是:带有大量的自动化配置,大大简化了项目开发的过程,这就是SpringBoot相比传统XML文件配置的优势所在!

三. 自动配置的原理

有的小伙伴又问了,那SpringBoot又是怎么实现自动配置的呢?接下来壹哥将会仿照【druid-spring-boot-starter】手写一个简单starter工程【yg-spring-boot-starter】,通过这样的一个starter项目,壹哥就能让各位理解自动配置是怎么实现的了。本案例的实现有以下几个核心步骤。

1. 创建Maven项目

首先我们要创建一个普通的maven工程,工程名为【yg-spring-boot-starter】,当然你也可以自定义名称,这无所谓。具体创建过程略过,相信大家都会,如果你不知道怎么创建SpringBoot项目,说明你的基础有点弱哦,可以参考壹哥之前的SpringBoot系列教程文章,链接如下:

​​SpringBoot2.x系列教程汇总-从入门到精通​​

2. 添加核心依赖

接下来我们在创建好的yg-spring-boot-starter工程中,添加以下核心依赖包:

<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>

<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
</dependencies>

3. 创建数据源配置类

接着我们在【yg-spring-boot-starter】工程中,仿照DruidDatasource类,编写一个ZKXDatasource类。这里只是为了说明问题,让大家感受如何进行自动配置,所以只保留了最基本的驱动程序、数据库地址等几个关键属性,其他的代码并没有进行实现。

@Data
public class ZKXDataSources {
private String driver;
private String url;
private String password;
private String userName;
}

4. 编写配置类

然后我们要在【yg-spring-boot-starter】中,实现ZKXDatasource配置类,把ZKXDatasource配置成bean,并使用 @ConfigurationProperties注解一次性读取指定前缀的自定义配置内容。

@Configuration
public class AutoConfig {

@Bean
@ConfigurationProperties(prefix = "zkx.datasource")
public DataSources getDataSources(){
return new ZKXDataSources();
}

}

5. 配置spring.factories文件

接着在【yg-spring-boot-starter】工程的resources目录下,创建META-INF文件夹,并且创建壹哥spring.factories清单文件。

带你手写starter组件,搞懂SpringBoot自动配置原理_mybatis

在spring.factoies文件中要添加如下配置:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\com.qf.zds.config. AutoConfig

这个配置的意思是,当我们的【yg-spring-boot-starter】组件被其他工程依赖时,这个文件中罗列出来的bean将会被自动配置。

6. 在别的项目中添加新建的starter组件

现在我们重新创建一个SpringBoot工程项目,在这个新项目中添加我们上面手写的starter依赖【yg-spring-boot-starter】。

<dependency>
<groupId>com.qf</groupId>
<artifactId>yg-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>

7. 配置yml文件

在新建测试工程的application.yml文件中,我们可以加上DataSources的配置信息。

zkx:
datasource:
driver: haha002
url: baidu.com
userName: zoukx
password: 123

8. 进行测试

最后为了验证效果,我们可以编写一个junit测试用例,来检测ZKXDataSources有没有被自动配置成bean。

@Autowired
private ZKXDataSources dataSources;

@Test
public void test01(){
System.out.println(dataSources);
}

测试结果如下:我们可以发现ZKXDataSources已经被自动配置成了bean,控制台上已经输出了我们配置的信息了。

带你手写starter组件,搞懂SpringBoot自动配置原理_数据源_02

四. 总结

至此,我们就实现了手写SpringBoot项目中的starter组件,进而实现了自动配置。其实从仿照druid的Datasource类中就可以发现,SpringBoot的核心机制就是可以自动配置,通过大量的自动配置,大量的bean被自动配置到容器中,这就大大简化了过去手动配置bean的过程,从而简化整个项目的开发过程,这也就是SpringBoot的最大优势所在!

现在你知道SpringBoot是怎么实现自动配置的了吗?如果你还有什么疑问,可以在评论区给壹哥留言,或者关注下面的【Java架构栈】公众号,领取更多学习资料。

标签:SpringBoot,spring,配置,boot,yg,搞懂,starter
From: https://blog.51cto.com/u_7044146/5965712

相关文章