SpringBoot自定义starter

2022-01-28 09:59:16 阅读：151 来源： 互联网

标签：String 自定义 boot version desc public starter SpringBoot

工程简介

自定义Spring boot starter

1、创建自定义starter项目

starter-provider，此项目负责封装成自定义starter的jar包，提供给其他项目引用

1.1、添加maven依赖

    <modelVersion>4.0.0</modelVersion>
    <groupId>com.yubest</groupId>
    <artifactId>version-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>version-spring-boot-starter</name>
    <description>Demo project for Spring Boot</description>
    
     <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>
     </dependencies>

1.2、添加功能代码

//测试用的需要注入的bean
public class Version {

    private String version;

    private String desc;

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }

    public String getInfo() {
        return "Version {version=" + getVersion() + ", desc=" + getDesc() + "}";
    }
}

//配置信息
@ConfigurationProperties(prefix = "yubest.version")
public class VersionProperties {

    private String version;

    private String desc;

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public String getDesc() {
        return desc;
    }

    public void setDesc(String desc) {
        this.desc = desc;
    }
}

//自动装配
@Configuration
@EnableConfigurationProperties(VersionProperties.class)
public class VersionAutoConfiguration {

    @Bean
    public Version version(VersionProperties prop) {
        Version version = new Version();
        version.setVersion(prop.getVersion());
        version.setDesc(prop.getDesc());
        return version;
    }
}

1.3、添加自动装配入口类

在META-INF目录下添加spring.factories文件，内容为：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.yubest.provider.config.VersionAutoConfiguration

或者通过自定义enable注解的方式：

//自定义的自动装配注解
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Import({VersionConfigurationSelector.class})
public @interface EnableVersion {
}

//依赖注入的选择器
public class VersionConfigurationSelector implements ImportSelector {

    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{VersionAutoConfiguration.class.getName()};
    }
}

两种方式，选择其一即可

2、创建自定义starter的引用项目

starter-consumer 是独立的项目，引用 starter-provider 的功能

2.1、添加maven依赖

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

        <dependency>
            <groupId>com.yubest</groupId>
            <artifactId>version-spring-boot-starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

2.2、application.properties中添加配置

yubest.version.version=v1.0.0
yubest.version.desc=添加了自定义starter功能

2.3、添加测试代码

@RestController
public class DemoController {

    @Autowired
    private Version version;

    @GetMapping(value = "/getConfig")
    public Object getConfig() {
        return version.getInfo();
    }
}

@EnableVersion
@SpringBootApplication
public class StarterConsumerApplication {

    public static void main(String[] args) {
        SpringApplication.run(StarterConsumerApplication.class, args);
    }

}

2.4、结果

请求：
curl -X GET \
  http://localhost:8080/getConfig

返回：
Version {version=v1.0.0, desc=添加了自定义starter功能}

仓库：https://gitee.com/hweiyu/spring-boot-custom-starter

标签：String,自定义,boot,version,desc,public,starter,SpringBoot
来源： https://blog.csdn.net/vbhfdghff/article/details/122727043

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9