Java框架之Java SpringBoot自定义starter

0、项目结构

1、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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>cstarter-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>cstarter</name>
    <packaging>jar</packaging>

    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <!--自定义starter必须要引入的依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.5.3</version>
        </dependency>

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

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

</project>

2、在resources目录下创建META-INFO/spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.example.cstarter.CStarterAutoConfiguration

3、CStarterAutoConfiguration.java

package com.example.cstarter;


import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Configuration;



@Configuration
@EnableConfigurationProperties(CStarterProperties.class)
@ConditionalOnProperty(prefix = "mycst", value = "cstarter", matchIfMissing = true)
public class CStarterAutoConfiguration {

}

4、CStarterProperties.java

package com.example.cstarter;


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


import java.util.Objects;


@ConfigurationProperties(prefix = "mycst",ignoreUnknownFields = true)
public class CStarterProperties {

    private String cstarter;

    public CStarterProperties(){

    }

    public String getCstarter() {
        return cstarter;
    }

    public void setCstarter(String cstarter) {
        this.cstarter = cstarter;
    }

    @Override
    public String toString() {
        return "CStarterProperties{" +
                "cstarter='" + cstarter + '\'' +
                '}';
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        CStarterProperties that = (CStarterProperties) o;
        return Objects.equals(cstarter, that.cstarter);
    }

    @Override
    public int hashCode() {
        return Objects.hash(cstarter);
    }
}

5、最后到生成jar包的目录下执行命令将jar包放进本地仓库

mvn install:install-file -DgroupId=com.example -DartifactId=cstarter-spring-boot-starter -Dversion=0.0.1-SNAPSHOT -Dpackaging=jar -Dfile=cstarter-spring-boot-starter-0.0.1-SNAPSHOT.jar