Java教程:学会写Starter-你就懂了SpringBoot自动配置

一、为什么要写Starter

目前是微服务开发时代,微服务架构,最新编写单元,一定是基于SpringBoot技术,即使不是微服务,目前也基本使用SpringBoot单体应用去掉SSM开发。故在面试中,必问SpringBoot相关技术,其中自动配置是也是必问知识点。当然开发时间越久,开发级别越高,也肯定会在项目中,开发一些自己的组件,所有自己动手写Starter是必备技能。

二、了解Starter的构成

1. starter包含哪些内容

  1. 提供所需要的依赖,解决依赖直接的冲突
  2. 提供自定义配置所需要的类及配置文件
  3. 为了让大家清楚starter的构成,我们来看mybatis-spring-boot-starter包含了哪些内容,如下是mybatis starter的依赖坐标:
    org.mybatis.spring.boot    mybatis-spring-boot-starter    2.1.4

这个mybatis-spring-boot-starter包含了如下内容:

其中xxx-jdbc、mybatis、mybatis-spring是mybatis关键依赖,其中xxx-autoconfigure就是自动配置相关的jar包,里面包含内容如下:

其中XXXAutoConfiguration是自动配置类,MybatisProperties是Mybatis的属性配置类(在springboot的yaml文件中,对mybatis写的配置信息就是此类提供编写的规范,此类进行自动读取)。

META-INF/spring.factories提供的自动配置加载的类列表,内容如下:

# Auto Configureorg.springframework.boot.autoconfigure.EnableAutoConfiguration=\org.mybatis.spring.boot.autoconfigure.MybatisLanguageDriverAutoConfiguration,\org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration

2. starter的命名规范

在自定义starter时,我们还需要遵循命名的规范,让使用者一眼能看出是官方和非官方开发的。

官方的starter写法:spring-boot-starter-*,感兴趣的可以去官方看看常用的starters有哪些?

非官方的starter写法:thirdpartyproject-spring-boot-starter

结论:只要不是spring官方发布的,我们都按非官方的要求编写,都要以-spring-boot-starter结尾。

三、开始动手写Starter

1. 自定义什么starter

在操作数据库的项目中,我们都会选用一些高性能的数据库连接池产品,比如DruidDataSource,官方也提供了整合的starter,比如 "druid-spring-boot-starter"。在这里,我们为了学习自定义starter,准备使用c3p0,因为c3p0的官方没有提供相应的starter,今天带着大家写一个c3p0的starter,通过自定义starter,来学习一下starter的自动配置,要求如下:

  1. 自动配置名字:c3p0-spring-boot-autoconfigure
  2. starter名字: c3p0-spring-boot-starter
  3. 提供使用c3p0的数据库连接属性(让使用者在yaml文件中对连接进行基本配置)
  4. 启动时实现自动装配,实例化一个DataSource,采用c3p0作为连接池

2. 写starter的步骤

  1. 创建一个空项目springboot-starter,把其它模块放在此项目中管理
  2. 创建c3p0-spring-boot-autoconfigure独立模块,提供自动配置需要的相关类[autoconfigure模块]
  3. 创建c3p0-spring-boot-starter模块,引入autoconfigure模块 [starter模块]
  4. 创建spring-boot-test-c3p0模块,依赖c3p0-spring-boot-starter的模块 [测试自定义starter]

3. 实现starter的过程

3.1创建空项目springboot-starter

3.2创建 c3p0-spring-boot-autoconfigure

1)导入依赖坐标

<?xml version="1.0" encoding="UTF-8"?>    4.0.0    com.itheima    c3p0-spring-boot-autoconfigure    1.0-SNAPSHOT            2.4.4        0.9.1.2        jar                                c3p0            c3p0            ${c3p0.version}            provided                                    org.springframework.boot            spring-boot-autoconfigure            ${spring-boot-version}                                    org.springframework.boot            spring-boot-configuration-processor            ${spring-boot-version}            provided            

scope:provided,打包时不包含此依赖,一般autoconfigure模块中,仅包含配置类相关。

2)创建C3p0DataSourceProperties配置文件

@ConfigurationProperties(prefix = "spring.datasource.c3p0")public class C3p0DataSourceProperties {    private String driverClassName;    private String url;    private String username;    private String password;    // 当前仅做测试,其它属性暂时使用默认值    // 提供Setter/Getter方法    public String getDriverClassName() {        return driverClassName;    }    public void setDriverClassName(String driverClassName) {        this.driverClassName = driverClassName;    }    public String getUrl() {        return url;    }    public void setUrl(String url) {        this.url = url;    }    public String getUsername() {        return username;    }    public void setUsername(String username) {        this.username = username;    }    public String getPassword() {        return password;    }    public void setPassword(String password) {        this.password = password;    }}

@ConfigurationProperties: 将从yaml文件读取的属性之前赋值给当前属性配置类对象。

prefix:要求写yaml文件是必须有此前缀。

3)创建C3p0DatasourceAutoConfigure自动配置类

@Configuration@EnableConfigurationProperties(C3p0DataSourceProperties.class)public class C3p0DatasourceAutoConfigure {    @Autowired    private C3p0DataSourceProperties dataSourceProperties;    /**     * 提供基于c3p0配置的DataSource实例     * @return     */    @Bean    public DataSource c3p0DataSource(){        ComboPooledDataSource dataSource = new ComboPooledDataSource();        try {            dataSource.setDriverClass(dataSourceProperties.getDriverClassName());            dataSource.setJdbcUrl(dataSourceProperties.getUrl());            dataSource.setUser(dataSourceProperties.getUsername());            dataSource.setPassword(dataSourceProperties.getPassword());            return dataSource;        } catch (PropertyVetoException e) {            e.printStackTrace();            new RuntimeException(e.getMessage());            return null;        }    }}

4)定义META-INF/spring.factories 文件

在resource目录下创建META-INF文件夹并创建spring.factories

注意:”\ “是换行使用的

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\  com.itheima.c3p0.autoconfigure.C3p0DatasourceAutoConfigure

5)安装到本地仓库

如果在idea中,执行maven插件中的install。

3.3创建 c3p0-spring-boot-stater

stater主要导入autoconfigure模块和相关依赖,不需要编写任何的代码。

1)编写pom文件

<?xml version="1.0" encoding="UTF-8"?>    4.0.0    com.itheima    c3p0-spring-boot-starter    1.0-SNAPSHOT    jar                        com.itheima            c3p0-spring-boot-autoconfigure            1.0-SNAPSHOT                                    c3p0            c3p0            0.9.1.2            

c3p0是这个starter必须的依赖,一般是在Starter中正式引入,这样做的目的是,未来可以在这里进行依赖库的升级,不需要去更新autoconfigure模块。

2)安装到本地仓库

如果在idea中,执行maven插件中的install。

4. 使用c3p0-starter

创建 spring-boot-test-c3p0 模块,依赖c3p0-spring-boot-starter模块

1) pom文件中导入spring-boot及数据库相关依赖,包含c3p0-starter依赖。

                            org.springframework.boot            spring-boot-starter                                    mysql            mysql-connector-java                                    com.itheima            c3p0-spring-boot-starter            1.0-SNAPSHOT        

2)在yaml文件中,配置数据源

spring:  datasource:    c3p0:      driver-class-name: com.mysql.cj.jdbc.Driver      url: jdbc:mysql://localhost:3306/study_springboot?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8      username: root      password: root

2) 在单元测试类中注入数据源,测试获取数据库连接,并测试连接数据库是否成功

此时的数据源实例,就是基于c3p0的实例。

@SpringBootTestclass SpringBootTestC3p0ApplicationTests {    // 注入c3p0DataSource Bean    @Autowired    private DataSource c3p0DataSource;    @Test    void testC3p0(){        try {            // 直接通过数据源获取数据库连接,并测试连接是否成功            Connection connection = c3p0DataSource.getConnection();            PreparedStatement preparedStatement = connection.prepareStatement("SELECT  * from t_user");            ResultSet resultSet = preparedStatement.executeQuery();            while (resultSet.next()){                System.out.println(resultSet.getObject(1)+" "+resultSet.getObject(2));            }            connection.close();        } catch (SQLException e) {            e.printStackTrace();        }    }}

四、结束语

通过以上案例的学习,你是否对SpringBoot自动配置有了清晰的理解。正式开发中,自动配置的情况可能比较复杂,实例化的时候,可能需要很多条件的判断,判断某个类是否存在,判断某个对象是否已经存在。如果要实现这些需求,需要用到Condition,这个是在Spring4.0 增加的条件判断功能,通过这个功能可以实现选择性的执行配置操作(一般就是创建Bean)。感兴趣的同学,先学会最基本的自动配置,然后再进一步学习Condition吧。



发表评论
留言与评论(共有 0 条评论) “”
   
验证码:

相关文章

推荐文章