快速入门自定义Starter

快速入门自定义Starter

[TOC]

1.概念

依赖管理是任何复杂项目的关键所在,当项目布局比较大时,纯手工的去做依赖显然比较浪费时间和精力,其中产生各种小问题同样会减少工作核心部分的投入时间

Springboot starter作为Springboot四大神器之一,就是为了解决这一问题而诞生,分而治之,提高代码复用性,让代码的配置看起来更加简洁

(与Apollo结合使用将大大降低因配置而产生的维护难度,提高了配置的治理效率)

2.思路

1.引入SpringBoot配置自动注入的依赖*2

<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>

2.创建配置类(定义properties的内容)

3.创建服务类(需要封装和处理的业务逻辑等)

4.创建自动配置类(将配置类和服务类注入)

5.创建resources/META-INF/spring.factories工厂配置文件,注入自动配置类

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.dony15.config.PersonServiceAutoConfiguration

3.搭建

3-1.配置类

package com.dony15.config;

/**
 * @ClassMame: PersonServiceProperties
 * @Description: 人员信息自动配置属性类
 * @Author 宝全
 * @Date 2018/9/18 10:50
 * @Version 1.0
 */
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix="person.proterties.set")// 定义application.properties配置文件中的配置前缀
public class PersonServiceProperties {
    // 姓名
    private String name;
    // 年龄
    private int age;
    // 性别，不配置的时候默认为person.proterties.set=man
    private String sex = "man";
    // 身高
    private String height;
    // 体重
    private String weight;
    ...get/set略
}

3-2.服务类

package com.dony15.service;

import com.dony15.config.PersonServiceProperties;

/**
 * @ClassMame: PersonService
 * @Description: 编写服务类
 * @Author 宝全
 * @Date 2018/9/18 10:51
 * @Version 1.0
 */
public class PersonService {
    private PersonServiceProperties personServiceProperties;

    public PersonService(PersonServiceProperties personServiceProperties){
        this.personServiceProperties=personServiceProperties;
    }
    public PersonService() {
    }
    public String getPersonName(){
        return personServiceProperties.getName();
    }
    public int getPersonAge(){
        return personServiceProperties.getAge();
    }

    public String getPersonSex(){
        return personServiceProperties.getSex();
    }
}

3-3.自动配置类(核心)

package com.dony15.config;

import com.dony15.service.PersonService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @ClassMame: PersonServiceAutoConfiguration
 * @Description: TODO
 * @Author 宝全
 * @Date 2018/9/18 10:55
 * @Version 1.0
 */
@Configuration //声明配置类
@EnableConfigurationProperties(PersonServiceProperties.class) //开启指定类的配置
@ConditionalOnClass(PersonService.class) //当PersonService这个类在类路径中时，且当前容器中没有这个Bean的情况下，开始自动配置
@ConditionalOnProperty(prefix = "person.proterties.set",value = "enabled",matchIfMissing = true) //指定的属性是否有指定的值
public class PersonServiceAutoConfiguration {
    @Autowired
    private PersonServiceProperties properties;

    @Bean
    @ConditionalOnMissingBean(PersonService.class) //当前容器中没有指定bean的情况下,自动配置PersonService类
    public PersonService personService(){
        return new PersonService(properties);
    }
}

4.使用

至此,一个简单的starter搭建完毕,如下可以引用

maven

<dependency><!-- 引入自己的starter -->
       <groupId>com.dony15</groupId>
       <artifactId>demo-starter</artifactId>
       <version>0.0.1-SNAPSHOT</version>
</dependency>

properties

person.proterties.set.age=18
person.proterties.set.name=常贵
person.proterties.set.height=189
...

然后直接Autowired自动注入即可正常使用