1. HTTP3W博客首页
  2. Java

springboot自定义starters

一、简介

SpringBoot最强大的功能就是把我们常用的场景抽取成了一个个starter(场景启动器),我们通过引入springboot未我们提供的这些场景启动器,我们再进行少量的配置就能使用相应的功能。即使这样,springboot也不能囊括我们所有的使用场景,王五我们需要自定义starter,来简化我们对springboot的使用。

二、如何自定义starter

我们参考mybatis官方提供的mybatis-spring-boot-starter来自定义我们自己的starters;自定义stater往往偏架构设计才会涉及到。

首先,通过@Configuration来标记一个自动配置类,指定这个类是个配置类

@ConditionalOnXXX 指定条件成立的情况下自动配置类生效

@AutoConfigureOrder 指定自动配置类的顺序

@Bean

@ConfigurationProperties 结合相关XXXPorperties来绑定相关的配置

@EnbleConfigurationProperties 让xxxPrperties生效加入到容器中

自定义配置类要能加载,需要将自动配置类,配置在META-INF/spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.wt.starter.HelloAutoConfiguration

三、命名规则

spring官方提示,我们配置自定义的starter的话,命名规则建议遵守: 场景启动器名+spring-boot-starter 命名规则

官方提示,工程往往包含两模块分别为:autoconfigure以及 starter

四、项目实战
该实例主要实现了通过配置文件,来为我们自定义的starter传递参数,进行显示或业务执行; 废话不多说,我们直接上源码,如下所示
springboot自定义starters

源码部分:

HelloAutoConfiguration.java

package com.wt.starter;

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

/**
 * @author :wt
 * @date :Created in 2022/3/13 23:54
 * @description:启动配置类
 * @modified By:
 */
@Configuration
@ConditionalOnProperty(value = "wt.hello.name")//强制配置wt.hello.name
@EnableConfigurationProperties(HelloProperties.class)
public class HelloAutoConfiguration {
    @Autowired
    HelloProperties helloProperties;

    @Bean
    public IndexController indexController(HelloProperties helloProperties){
        return new IndexController(helloProperties);
    }
}
HelloProperties.java
package com.wt.starter;

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

/**
 * @author :wt
 * @date :Created in 2022/3/13 23:57
 * @description:
 * @modified By:
 */
@ConfigurationProperties("wt.hello")
public class HelloProperties {
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}
IndexController.java
package com.wt.starter;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author :wt
 * @date :Created in 2022/3/13 23:56
 * @description:
 * @modified By:
 */
@RestController
public class IndexController {

    HelloProperties helloProperties;

    public IndexController(HelloProperties helloProperties){
        this.helloProperties = helloProperties;
    }

    @RequestMapping("/")
    public String index(){
        return helloProperties.getName()+"欢迎您!!";
    }
}

spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.wt.starter.HelloAutoConfiguration

autoconfiguration模块的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">
    <parent>
        <artifactId>demo_starter</artifactId>
        <groupId>com.example</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>wt-spring-boot-autoconfigure</artifactId>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--导入配置文件处理器,配置文件有绑定,就会有提示-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
    
</project>

starter模块的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">
    <parent>
        <artifactId>demo_starter</artifactId>
        <groupId>com.example</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <description>
        启动器(starter)是一个空的jar文件,
        仅仅提供辅助性依赖管理,
        这些依赖需要自动装配或其他类库
    </description>
    <artifactId>wt-spring-boot-starter</artifactId>

    <dependencies>
        <dependency>
            <groupId>com.example</groupId>
            <artifactId>wt-spring-boot-autoconfigure</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

父类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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <modules>
        <module>wt-spring-boot-starter</module>
        <module>wt-spring-boot-autoconfigure</module>
    </modules>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <!--加上这句标识他是一个maven父项目-->
    <packaging>pom</packaging>
    <groupId>com.example</groupId>
    <artifactId>demo_starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo_starter</name>
    <description>自定义starter</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

五、到此,一个简单的starter自定义成功,我们可以在其他工程里面引用了。

    <dependencies>
        <dependency>
           <artifactId>demo_starter</artifactId>
           <groupId>wt-spring-boot-starter</groupId>
           <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

1、原创文章,作者:诺米,如若转载,请注明出处:https://www.http3w.com/archives/676

2、本站内容若有雷同从属巧合,若侵犯了您的权益,请联系本站删除,E-mail: wtao219@qq.com

发表评论

您的电子邮箱地址不会被公开。

联系我们

254007489

在线咨询:点击这里给我发消息

邮件:wtao219@qq.com

工作时间:周一至周五,9:30-18:30,节假日休息