SpringBoot零基础详解八：自定义starter

 

八：自定义starter

1：starter的原理和必要的概念

1、这个场景需要使用到的依赖是什么？

2、如何编写自动配置

@Configuration  //指定这个类是一个配置类
@ConditionalOnXXX  //在指定条件成立的情况下自动配置类生效
@AutoConfigureAfter  //指定自动配置类的顺序
@Bean  //给容器中添加组件

@ConfigurationPropertie结合相关xxxProperties类来绑定相关的配置
@EnableConfigurationProperties //让xxxProperties生效加入到容器中

自动配置类要能加载
将需要启动就加载的自动配置类，配置在META-INF/spring.factories
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\

3、模式：

启动器只用来做依赖导入；

专门来写一个自动配置模块；

启动器依赖自动配置；别人只需要引入启动器（starter）

自定义启动器的名称规范：如mybatis-spring-boot-starter；自定义启动器名-spring-boot-starter

 

2：自己编写一个启动器

1：创建空项目

2：创建启动器模块和自动配置模块

3：启动器模块依赖自动配置模块

启动器模块的pom.xml文件,启动器只配置引入了自动配置模块就可以了

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.wkl.starter</groupId>
    <artifactId>wkl-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!--  启动器模块  -->
    <dependencies>
        <!--引入自动配置模块-->
        <dependency>
            <groupId>com.wkl.starter</groupId>
            <artifactId>wkl-spring-boot-starter-autoconfigurer</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

</project>

4：自动配置类的pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.wkl.starter</groupId>
    <artifactId>wkl-spring-boot-starter-autoconfigurer</artifactId>
    <version>1.0-SNAPSHOT</version>


    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <!--引入spring-boot-starter；所有starter的基本配置-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>


</project>

5：自动配置模块的方法类

6：自动配置模块对应的配置文件实体类

 7：自动配置模块的自动配置类，也就是xxxAotoConfiguration类

8：在自动配置模块中将xxxAutoConfiguration类加入META-INF/spring.factories

参考之前的springboot自动配置原理将自动配置类（xxxAutoConfiguration） 加入META-INF/spring.factories

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.wkl.starter.HelloServiceAutoConfiguration

 9：将启动器和自动配置类加入到maven仓库

因为启动器模块引用了自动配置模块，所以先加自动配置的模块

10：创建新项目进行测试