自定义spring boot start

1.创建maven项目
引入如下依赖


            org.springframework.boot
            spring-boot-starter
            2.2.6.RELEASE
        
        
            org.springframework.boot
            spring-boot-configuration-processor
            2.2.6.RELEASE
        

2.定义实体,接收配置文件自定义配置

package com.dyson.service;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * @Author: Wy
 * @Email: [email protected]
 * @Time: 2020/5/6 11:37
 * @Description:
 */
@Data
@Component
@AllArgsConstructor
@NoArgsConstructor
//接受配置文件中dyson.start.config前缀的配置
@ConfigurationProperties(prefix = "dyson.start.config")
public class MyService {
    private String key;
    private String value;
    private String array;
}

3.定义AutoConfiguration, 完成bean加载

package com.dyson.config;

import com.dyson.service.MyService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Author: Wy
 * @Email: [email protected]
 * @Time: 2020/5/6 11:41
 * @Description:
 */
@Configuration
/**
 * 类路径中必须有MyService 这个类时,才进行配置
 */
@ConditionalOnClass(MyService.class)
/**
 * 开启对@ConfigurationProperties注解支持,
 */
@EnableConfigurationProperties(MyService.class)
public class AutoConfig {


    @Bean
    @ConditionalOnMissingBean
    public XXX info(MyService service) {
        service.getKey();
        service.getValue();
        service.getArray();
        return XXX;
    }
}

这里XXX为自定义类,根据实际需要定义并返回对应bean即可
4.在src/main/resources新建文件夹META-INF,然后新建一个spring.factories文件
配置装配路径

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.dyson.config.AutoConfig

以上已完成对spring boot start的定义

自动化配置注解介绍,如下:
@Configuration:这个配置就不用多做解释了,我们一直在使用;
@EnableConfigurationProperties:这是一个开启使用配置参数的注解,value值就是我们配置实体参数映射的ClassType,将配置实体作为配置来源;
SpringBoot内置条件注解
@ConditionalOnXxx相关的注解为条件注解,也是我们配置的关键,可以把这些注解理解为具有Xxx条件:
@ConditionalOnBean:当SpringIoc容器内存在指定Bean的条件
@ConditionalOnClass:当Spring Ioc容器内存在指定Class的条件;
@ConditionalOnExpression:基于SpEL表达式作为判断条件
@ConditionalOnJava:基于JVM版本作为判断条件
@ConditionalOnMissingBean:当SpringIoc容器内不存在指定Bean的条件
@ConditionalOnMissingClass:当SpringIoc容器内不存在指定Class的条件
@ConditionalOnNotWebApplication:当前项目不是Web项目的条件
@ConditionalOnProperty:指定的属性是否有指定的值;
@ConditionalOnResource:类路径是否有指定的值
@ConditionalOnSingleCandidate:当指定Bean在SpringIoc容器内只有一个,或者虽然有多个但是指定首选的Bean;
@ConditionalOnWebApplication:当前项目是Web项目的条件
以上注解都是元注解@Conditional演变而来的,根据不用的条件对应创建以上的具体条件注解。
截止到项目我们还没有完成自动化配置starter,我们先来了解Starter自动化配置原理:
在注解@SpringBootApplication上存在一个开启自动化配置的注解@EnableAutoConfiguration来完成自动化配置,
注解源码如下所示:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    /**
     * Exclude specific auto-configuration classes such that they will never be applied.
     * @return the classes to exclude
     */
    Class[] exclude() default {};

    /**
     * Exclude specific auto-configuration class names such that they will never be
     * applied.
     * @return the class names to exclude
     * @since 1.3.0
     */
    String[] excludeName() default {};

}

在@EnableAutoConfiguration注解内使用到了@import注解来完成导入配置的功能,而EnableAutoConfigurationImportSelector内部则是使用了SpringFactoriesLoader.loadFactoryNames方法进行扫描具有META-INF/spring.factories文件的jar包。我们可以先来看下spring-boot-autoconfigure包内的spring.factories文件内容,如下所示:


自定义spring boot start_第1张图片
image.png

可以看到配置的结构形式是Key=>Value形式,多个Value时使用,隔开,目的是为了完成自动化配置,所以我们spring.factories配置中Key则是需要使用:org.springframework.boot.autoconfigure.EnableAutoConfiguration

补充
配置文件中,自定义配置是有提示的~~


image.png

你可能感兴趣的:(自定义spring boot start)