SpringBoot自定义Starter封装

  • Z时代
  • 2024-01-10
  • 分类：综合

编程

Spring Boot - 自定义Starter封装

> 在Springboot封装一个自定义的Starter的一个Demo，从创建一个模块->封装starter->使用。 @pdai

思路

  • 1 - 创建一个Demo Project，模拟一个需要被封装的DemoModule模块，其中核心方法为exeModuleMethod

  • 2 - 通过starter封装可以直接初始化DemoModule的实例到Spring容器

  • 3 - 在Maven中引入starter，且在yml中配置相应到参数即可直接初始化DemoModule的实例

  • 4 - 在应用中注入DemoModule即可使用其exeModuleMethod方法

新建一个com.pdai.demo项目

  • 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.1.7.RELEASE</version>
        <relativepath /> <!-- lookup parent from repository -->
    </parent>
    <groupid>com.pdai</groupid>
    <artifactid>demo</artifactid>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <!-- 注意不要引入Springboot模块-->
    </dependencies>
    <build>
    </build>
</project>

  • 创建一个测试模块

package com.pdai.demo.module;
/**
 *
 */
public class DemoModule {
    private String version;
    private String name;
    public String exeModuleMethod() {
        return "Demo module, name = " + name + ", version = " + version;
    }
    public String getVersion() {
        return version;
    }
    public void setVersion(String version) {
        this.version = version;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

  • install

封装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 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.1.7.RELEASE</version>
        <relativepath /> <!-- lookup parent from repository -->
    </parent>
    <groupid>com.pdai</groupid>
    <artifactid>demo-springboot-starter</artifactid>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo-springboot-starter</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-autoconfigure</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-configuration-processor</artifactid>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupid>com.pdai</groupid>
            <artifactid>demo</artifactid>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-test</artifactid>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

  • Properties

package com.pdai.demospringbootstarter;
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix = "com.pdai")
public class DemoProperties {
    private String version;
    private String name;
    public String getVersion() {
        return version;
    }
    public void setVersion(String version) {
        this.version = version;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

  • AutoConfiguration

package com.pdai.demospringbootstarter;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableConfigurationProperties(DemoProperties.class)
public class DemoAutoConfiguration {
    @Bean
    public com.pdai.demo.module.DemoModule demoModule(DemoProperties properties){
        com.pdai.demo.module.DemoModule demoModule = new com.pdai.demo.module.DemoModule();
        demoModule.setName(properties.getName());
        demoModule.setVersion(properties.getVersion());
        return demoModule;
    }
}

  • spring.factory

> 在META-INF下创建spring.factory文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=
com.pdai.demospringbootstarter.DemoAutoConfiguration

  • install

使用starter

只需要在application.yml中

  • application.yml

com:
    pdai:
        name: DEMO
        version: v1

  • 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.1.7.RELEASE</version>
        <relativepath /> <!-- lookup parent from repository -->
    </parent>
    <groupid>com.pdai</groupid>
    <artifactid>demo-usage</artifactid>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo-usage</name>
    <description>Demo starter usage</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-web</artifactid>
        </dependency>
        <dependency>
            <groupid>com.pdai</groupid>
            <artifactid>demo-springboot-starter</artifactid>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-test</artifactid>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupid>org.springframework.boot</groupid>
                <artifactid>spring-boot-maven-plugin</artifactid>
            </plugin>
        </plugins>
    </build>
</project>

  • app

package com.pdai.demo.usage;
import com.pdai.demo.module.DemoModule;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@SpringBootApplication
@RestController
public class DemoUsageApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoUsageApplication.class, args);
    }
    @Autowired
    private DemoModule demoModule;
    @GetMapping("demo")
    public String demo(){
        return demoModule.exeModuleMethod();
    }
}

  • 输出

http://localhost:8080/demo

Demo module, name = DEMO, version = v1

代码实例

@see https://github.com/realpdai/springboot-starter-demo

> 更多内容请访问，Java全栈知识体系

以上是 SpringBoot自定义Starter封装 的全部内容， 来源链接： utcz.com/z/511354.html

回到顶部