Spring Boot如何创建自定义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输入：

相关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;
    }
}
           

浏览器访问

http://localhost:8080/user

就可以获取到结果

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

文章源码：https://github.com/tangyongshuang/SpringCloudPractice.git

本人能有有限，如有错误，感谢指正。