SpringBoot专栏：自定义starters，编写插件之利器（第9讲）

偏执的太偏执、 2022-04-03 19:38 281阅读 0赞

## ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70][] ##

## 1.使用场景 ##

1.starter是springboot中提供的简化企业级开发绝大多数场景的一个工具，利用好strater就可以**消除相关技术的配置得到自动配置好的Bean,**举个例子，在一般使用中，我们使用基本的spring-boot-starter配置基本的springboot项目，也使用spring-boot-starter-web去配置web项目

2.开发自己的auto-configuration，也就是说为spring boot开发一些自动配置的模块的时候，这个时候就需要用到这个技术，   
完全可以通过一个注解或者引入一个jar包就开启这个功能

3.插件的编写也是一个不错的选择

最后，着重说先这个spring.factories  
spring.factories这个主要是提供了一个功能，就是自动配置，不需要使用@EnableXXX来开启，也就是说只要你用了springboot，并且依赖了一个jar包，这个jar包就会自动进行初始化 ，那么这个过程就是使用了spring.factories这个文件配置

## 2、如何编写自动配置 ##

@Configuration //指定这个类是一个配置类
    @ConditionalOnXXX //在指定条件成立的情况下自动配置类生效
    @AutoConfigureAfter //指定自动配置类的顺序
    @Bean //给容器中添加组件
    @ConfigurationPropertie结合相关xxxProperties类来绑定相关的配置
    @EnableConfigurationProperties 解的作用是：使使用 @ConfigurationProperties 注解的类生效。

自动配置类要能加载
    将需要启动就加载的自动配置类，配置在META‐INF/spring.factories
    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    org.springframework.boot.autoconfigure.admin.SpringApplicati

## 3.编写自动配置步骤 ##

**   构建starter模块**（springboot-05-helloservice-autoconfig）和一个测试模块（代码最后共享）

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70 1][]

starter模块

**pom引入**

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

** 编写核心代码如下图：**

接口服务类HelloService、配置文件注入类HelloConfig、启动配置类HelloServiceAutoConfiguration

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70 2][]

**HelloService类**

public class HelloService {
    
        //注意生成get set方法
        HelloConfig helloConfig;
    
        /**
         * 你好，方法
         * @param name  名称
         * @return
         */
        public String sayHello(String name){
            return helloConfig.getPrefix()+"-" +name + "-"+helloConfig.getSuffix();
        }
    
        public HelloConfig getHelloConfig() {
            return helloConfig;
        }
    
        public void setHelloConfig(HelloConfig helloConfig) {
            this.helloConfig = helloConfig;
        }

**HelloConfig类**

@ConfigurationProperties(prefix = "limp.hello")
    public class HelloConfig {
    
        private String prefix;
        private String suffix;
    
        public String getPrefix() {
            return prefix;
        }
    
        public void setPrefix(String prefix) {
            this.prefix = prefix;
        }
    
        public String getSuffix() {
            return suffix;
        }
    
        public void setSuffix(String suffix) {
            this.suffix = suffix;
        }

HelloServiceAutoConfiguration类

@Configuration
    @ConditionalOnWebApplication //web应用才生效
    @EnableConfigurationProperties(HelloConfig.class)
    
    public class HelloServiceAutoConfiguration {
    
        @Autowired
        HelloConfig helloConfig;
    
        /**
         * bean注入
         * @return
         */
        @Bean
        public HelloService helloService(){
            HelloService service = new HelloService();
            service.setHelloConfig(helloConfig);
            return service;
        }

spring.factories 文件重点！！

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    com.limp.starter.HelloServiceAutoConfiguration

经过上面几步，starter基本就定义好了，很是方便，spring.factories之前不是很了解，通过这个案例也会加深下印象。

**备注：说下编写规范（案例中用了一个模块去构建starter的，实际开发中尽量按照规范来）**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70 3][]

## 3.测试调用springboot-05-test-starter ##

pom文件引入自定义的starter

<dependency>
    	<groupId>com.limp</groupId>
    	<artifactId>springboot-05-helloservice-autoconfig</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    </dependency>

配置文件：配置下前缀后缀

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70 4][]

接下来就调用了HelloController

@RestController
    public class HelloController {
        @Autowired
        HelloService helloService;
    
    
        @GetMapping(value = "hello")
        public  String sayhello(String name){
    
           return  helloService.sayHello(name);
        }
    }

测试结果（成功）

![20181223230133547.png][]

End

最后祝大家快速掌握，早日加薪

源码地址：[https://github.com/shinians/springboot-demos][https_github.com_shinians_springboot-demos]

如果帮助，点个关注呗 @架构师速成记

## 问题汇总 ##

评论有如下问题，这边做下简单记录

**1. org.springframework.boot.autoconfigure.EnableAutoConfiguration=\\ com.limp.starter.HelloServiceAutoConfiguration 不加key = org.springframework.boot.autoconfigure.EnableAutoConfiguration 只要测试项目把jar引入了，代码也可以执行，因为 @Configuration 注解会让HelloService 自动注入一个实例到Bean容器中，**

上面如果直接去掉spring.factories中的配置，测试样例是可以正常运行的

因为测试用例和stater demo都在统一路径com.limp下

但是如果test样例变更如下，加载到com.limp.test

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70 5][]

此时启动就会报如下错误，所以不同路径下需要用spring.factories

during context initialization - cancelling refresh attempt: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'helloController': Unsatisfied dependency expressed through field 'helloService'; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.limp.starter.service.HelloService' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Autowired(required=true)}
    2021-02-18 10:13:35.510  INFO 17216 --- [  restartedMain] o.apache.catalina.core.StandardService   : Stopping service [Tomcat]
    2021-02-18 10:13:35.539  INFO 17216 --- [  restartedMain] ConditionEvaluationReportLoggingListener : 
    
    Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.
    2021-02-18 10:13:35.951 ERROR 17216 --- [  restartedMain] o.s.b.d.LoggingFailureAnalysisReporter   : 
    
    ***************************
    APPLICATION FAILED TO START
    ***************************
    
    Description:
    
    Field helloService in com.limp.test.controller.HelloController required a bean of type 'com.limp.starter.service.HelloService' that could not be found.
    
    The injection point has the following annotations:
    	- @org.springframework.beans.factory.annotation.Autowired(required=true)

最后：spring.factories并非无用

2.启动报错

> 一、没有配置spring.factories文件指定自动化配置的类，只有容易启动扫描到自动化配置类HelloServiceAutoConfiguration才会指定自动化配置；
> 
> 二、检查bean实例化的条件是否满足，注意以下注解
> 
>     @ConfigurationProperties(prefix = "limp.hello")
>     @EnableConfigurationProperties(HelloConfig.class)//开启属性注入,通过@autowired注入

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70]: /images/20220403/78faa2640ce24c8f88677028b4df613d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70 1]: /images/20220403/1bb9e65d03e641cd9e455c6a03abd627.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70 2]: /images/20220403/c1251391755f459d85d95d059e3f5f96.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70 3]: /images/20220403/e8177360d9664f1aab6113bf5a75f391.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70 4]: /images/20220403/a8487f32081b4ee9960cf861d92dfab6.png
[20181223230133547.png]: /images/20220403/c0d6efddc5fc47388cd00e8e3e0c23f1.png
[https_github.com_shinians_springboot-demos]: https://github.com/shinians/springboot-demos
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3p6aHVhbl8x_size_16_color_FFFFFF_t_70 5]: /images/20220403/f39dac5ae6e94bde934a6ca2c1bf5d77.png