SpringBoot创建自定义starter详解

更新时间：2024年01月22日 11:02:46 作者：岸河

这篇文章主要介绍了SpringBoot创建自定义starter详解,Starter是Spring Boot中的一个非常重要的概念,Starter相当于模块,它能将模块所需的依赖整合起来并对模块内的Bean根据环境(条件)进行自动配置,需要的朋友可以参考下

自定义starter

背景

（1）有时在公司内部有时候自研中间件，需要被其他项目依赖，这个时候直接引入starter，可以实现自动化配置，可以做到对其他项目代码无污染入侵。

（2）Spring Boot大量使用了starter模式，比如spring-boot-starter-redis，spring-boot-starter-jdbc，spring-boot-starter-data-jpa，spring-boot-starter-amqp，我们自己做一遍，了然于心，更能够加深对Spring Boot的编程思想的理解与学习。

1.首先我们使用IDEA的Spring Initializr直接创建工程，引入web依赖

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

2.然后自带的删掉启动类，测试类，下面的maven插件。我们创建的starter属于依赖包，不需要启动类。否则在后续打jar包的时候会报错

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

3.创建配置类，可以为引入的starter配置相关属性

@ConfigurationProperties(prefix = "spring.user")
public class UserProperties {
    private String name;
    private Integer age;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
}

4.创建Client端，定义相关方法操控属性，模拟进行数据处理。

public class UserClient {
    private UserProperties userProperties;
    public UserClient() {
    }
    public UserClient(UserProperties userProperties) {
        this.userProperties = userProperties;
    }
    public String getName(){
        return userProperties.getName();
    }
    public Integer getAge(){
        return userProperties.getAge();
    }
}

5.自动创建客户端，创建UserClient实例

注意：@ConditionalOnProperty是用来控制是否启用配置，它的name或者value属性意义相同，区别是name是数组，value只绑定一个属性。当name或者value的属性为havingValue指定值的时候配置才会生效，否则配置不生效。即在下面的配置中，只有当enabled为true的时候配置才生效。

@Configuration
@EnableConfigurationProperties(value = UserProperties.class)
public class UserAutoConfigure {
    @Bean
    @ConditionalOnProperty(prefix = "spring.user", value = "enabled", havingValue = "true")
    public UserClient userClient(UserProperties userProperties) {
        return new UserClient(userProperties);
    }
}

6.激活配置类。在别的项目中如果想激活配置类有两种办法，一个是通过spring.factories文件，一个是通过注解实现，下面来分别实现这两种。

通过spring.factories文件

在resources下创建META-INF目录，在其下面创建spring.factories文件,如下声明自己自动配置类UserAutoConfigure的路径

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.anhe.springbootstarteruser.properties.UserAutoConfigure

或者通过注解实现，只需要在主类上添加@EnableUserClient注解，不需要编写spring.factories文件，就可以激活配置类，注解定义如下：

关键在于@Import注解，他也申明了自动配置类UserAutoConfigure的路径

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import({UserAutoConfigure.class})
public @interface EnableUserClient {
}

7.配置application.properties提示信息，我们更倾向于在添加配置的时候能够看到配置信息或者默认值之类的，可以按如下方法配置：

在META-INF下创建文件spring-configuration-metadata.json，内容如下：

{
  "properties": [
    {
      "name": "spring.user.name",
      "defaultValue": "cxytinadi"
    },
    {
      "name": "spring.user.enabled",
      "type": "java.lang.Boolean",
      "defaultValue": false
    },
    {
      "name": "spring.user.age",
      "type": "java.lang.Integer",
      "defaultValue": 18
    }
  ]
}

然后在其他项目配置的时候就会自动出现提示，包括配置的默认值。

8.然后在Terminal输入：

mvn clean install

相关jar包就会打包到本地仓库，本地其他项目就可以直接使用。

9.demo示例：

其他项目引入依赖：

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

application.properties加入配置

spring.user.age=20
spring.user.name=tystsyts
spring.user.enabled=true

如果直接是配置注解启动，需要在主类上加上@EnableUserClient注解，然后在新项目编写controller验证：

@RestController
public class UserController {
    @Autowired
    private UserClient userClient;
    @GetMapping("/user")
    public Map<String,Object> getUserInfo() {
        Map<String, Object> map = new HashMap<>();
        map.put("name",userClient.getName());
        map.put("age",userClient.getAge());
        return map;
    }
}

浏览器访问//localhost:8080/user就可以获取到结果

{
  "name": "tystsyts",
  "age": 20
}

到此这篇关于SpringBoot创建自定义starter详解的文章就介绍到这了,更多相关SpringBoot自定义starter内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

详解一个简单的Servlet容器的设计与实现
Servlet算是Java Web开发请求链路调用栈中底层的一个技术，而了解一个Servlet容器的实现有助于更好的理解JavaWeb开发，所以下面就来看看如何设计与实现一个简单的Servlet容器吧
2023-07-07
详解MyBatis中主键回填的两种实现方式
这篇文章主要介绍了详解MyBatis中主键回填的两种实现方式，主键回填其实是一个非常常见的需求，特别是在数据添加的过程中，我们经常需要添加完数据之后，需要获取刚刚添加的数据 id，有兴趣的可以参考一下
2019-04-04
Java代码优化细节
这篇文章主要为大家详细介绍了Java代码优化细节，通过不同细节对java代码进行优化，感兴趣的小伙伴们可以参考一下
2016-08-08
java中String字符串删除空格的七种方式
在Java中从字符串中删除空格有很多不同的方法，本文主要介绍了java中String字符串删除空格的七种方式，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-08-08
Java动态脚本Groovy获取Bean技巧
这篇文章主要给大家分享的是Java动态脚本Groovy获取Bean技巧，在Java代码中当我们需要一个Bean对象，通常会使用spring中@Autowired注解，用来自动装配对象。下面我们一起进入文章学习个表格多详细内容吧
2021-12-12
详细聊聊Mybatis中万能的Map
最近有个需求,就是使用mybatis时,向mysql中插入数据,其参数为map类型,下面这篇文章主要给大家介绍了关于Mybatis中万能的Map的相关资料,需要的朋友可以参考下
2021-12-12
java设计模式之工厂模式实例详解
这篇文章主要介绍了java设计模式之工厂模式,结合具有实例形式分析了java工厂模式的概念、原理、实现与使用方法,需要的朋友可以参考下
2017-09-09
Java 队列实现原理及简单实现代码
这篇文章主要介绍了Java 队列实现原理及简单实现代码的相关资料,需要的朋友可以参考下
2016-10-10
Eclipse2020安装了最新版本的JDK却无法打开的问题
这篇文章主要介绍了Eclipse2020安装了最新版本的JDK却无法打开，提示版本太老的完美解决方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-12-12
springboot实现执行sql语句打印到控制台
这篇文章主要介绍了springboot实现执行sql语句打印到控制台的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-06-06