自定义spring boot-starter,实现自动配置,自定义注解扫描注入

一、简介

一句话总结：

1、编写自己的properties类(用来加载属性文件进行默认的配置)和核心服务类（要自动配置的bean）
2、自定义AutoConfiguration 配置类CustomerAutoConfiguration ，通过@Condition*系列注解控制自动配置的条件。
3、然后在src/main/resources新建文件夹META-INF，然后新建一个spring.factories文件
在里面使用org.springframework.boot.autoconfigure.EnableAutoConfiguration指定我们自定义的自动配置类的全路径。
这样，一个自定义的spring-boot-start工程就完成了。

命名规则：

这里说下artifactId的命名问题，Spring 官方 Starter通常命名为 spring-boot-starter-{name} 如 spring-boot-starter-web 。

Spring官方建议非官方Starter命名应遵循 {name}-spring-boot-starter 的格式。

这里配置的是统一异常的相关配置
全局异常：https://blog.csdn.net/wolfishness/article/details/101169980

二、简单分析mybatis-spring-boot-starter的结构：

父包：mybatis-spring-boot 核心功能模块
子包：
mybatis-spring-boot-starter
mybatis-spring-boot-autoconfigure

发现mybatis-spring-boot-starter工程本身是个空项目，只通过pom文件和spring.provides说明依赖关系；
其中spring.provides是依赖文件jar包配置的artifactId值

在mybatis-spring-boot-autoconfigure工程中发现spring.facoties文件，
内容为：

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration

核心代码中只有三个类文件：
1、MybatisAutoConfiguration 自动配置类
2、MybatisProperties 属性文件加载类，通过@EnableConfigurationProperties({MybatisProperties.class})注入到spring容器中，使得在MybatisAutoConfiguration中可以直接注入使用配置属性
3、SpringBootVFS 是类扫描器
打包成jar时，setTypeAliasesPackage(“xxx”)找不到类的问题。MyBatis通过VFS来扫描，
在Spring Boot中由于是嵌套Jar，导致Mybatis默认的VFS实现DefaultVFS无法扫描嵌套Jar中的类，需要改成SpringBootVFS扫描

三、自己搭建springboot-starter

1.添加 maven 依赖

        <!--封装Starter核心依赖  -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.1.3.RELEASE</version>
        </dependency>
        <!--非必需,该依赖作用是在使用IDEA编写配置文件有代码提示-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <version>2.1.3.RELEASE</version>
        </dependency>
        <!-- lombok 插件  -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.6</version>
            <optional>true</optional>
        </dependency>

2.配置类

package com.bosssoft.bes.base.configuration;

import com.bosssoft.bes.base.aop.GlobalExceptionAspect;
import com.bosssoft.bes.base.exception.GlobalException;
import com.bosssoft.bes.base.resolver.GlobalExceptionResolver;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 异常类自动装配
 * @ClassName: ExceptionAutoConfiguration
 * @Description: TODO
 * @Author: lujinshan
 * @Date: 2019/8/15 16:11
 * @Version: 1.0.0
 */
@Configuration
public class ExceptionAutoConfiguration {

    /**
     * 配置异常切面
     * @return
     */
    @Bean
    @ConditionalOnClass(GlobalExceptionAspect.class)
    @ConditionalOnMissingBean(GlobalExceptionAspect.class)
    public GlobalExceptionAspect globalExceptionAspect() {

        return  new GlobalExceptionAspect();
    }

    /**
     * 配置统一异常
     * @return
     */
    @Bean
    @ConditionalOnClass(GlobalExceptionResolver.class)
    @ConditionalOnMissingBean(GlobalException.class)
    public GlobalExceptionResolver globalExceptionResolver(){
        return new GlobalExceptionResolver();
    }
}

spring.factories该文件用来定义需要自动配置的类,SpringBoot启动时会进行对象的实例化,会通过加载类SpringFactoriesLoader加载该配置文件,将文件中的配置类加载到spring容器
在src/main/resources新建META-INF文件夹,在META-INF文件夹下新建spring.factories文件.配置内容如下:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.bosssoft.bes.base.configuration.ExceptionAutoConfiguration

使用方式：使用Maven插件,将项目打包安装到本地仓库

新建测试项目,引入我们自己的Starter,Maven依赖如下：

    <dependency>
      <groupId>com.bosssoft.hr.train</groupId>
      <artifactId>boss-train-spring-cloud-starter</artifactId>
      <version>1.0-SNAPSHOT</version>
    </dependency>

直接在项目中引入该jar包即可使用相关的切面和全局异常处理

四、后续补充

在引入自己封装的Starter的时候,有的人会报错****类的bean没有找到问题,是因为@SpringBootApplication扫描包的范围是启动类所在同级包和子包,但是不包括第三方的jar包.如果需要扫描maven依赖添加的Jar,我们就要单独使用@ComponentScan注解扫描包.
针对这种情况解决方式有两种:

• 第一种:是你封装的Starter项目下父级包名称和测试项目的父级包名一样,例如这两个项目包名都叫com.sans,这样可以不使用@ComponentScan注解,很显然这样做有局限性,不推荐.

• 第二种:是可以单独使用@ComponentScan注解扫描第三方包,但是这里一定要注意@SpringBootApplication注解等价于默认属性使用@Configuration+@EnableAutoConfiguration+@ComponentScan,如果@SpringBootApplication和@ComponentScan注解同时存在，那么@SpringBootApplication注解中@ComponentScan的扫描范围会被覆盖,所以单独使用@ComponentScan的话,必须在该注解上配置项目需要扫描的包的所有范围,即项目包路径+依赖包路径.

/**
 * @ComponentScan注解扫描多个包下示例
 */
@ComponentScan({"com.test","sms.test"})

五、总结

总结下Starter的工作原理:

1. Spring Boot在启动时扫描项目所依赖的JAR包，寻找包含 spring.factories 文件的JAR包
2. 根据 spring.factories 配置加载AutoConfigure类
3. 根据 @Conditional 注解的条件，进行自动配置并将Bean注入Spring Context Spring
   Boot由众多Starter组成，随着版本的推移Starter家族成员也与日俱增。在传统Maven项目中通常将一些层、组件拆分为模块来管理，
   以便相互依赖复用，在Spring Boot项目中我们则可以创建自定义Spring Boot Starter来达成该目的。

可以认为starter是一种服务——使得使用某个功能的开发者不需要关注各种依赖库的处理，不需要具体的配置信息， 由Spring Boot自动通过classpath路径下的类发现需要的Bean，并织入相应的Bean。举个栗子，spring-boot-starter-jdbc这个starter的存在， 使得我们只需要在BookPubApplication下用@Autowired引入DataSource的bean就可以，Spring Boot会自动创建DataSource的实例。