SpringBoot少量注解及自定义Starter步骤介绍

Java注解(Annotation)

Java注解分类
  2.1 JDK基本注解
  2.2 JDK元注解
  2.3 自定义注解

JDK元注解
   元注解用于修饰其他的注解(纪委：管干部的干部)
  4.1 @Retention：定义注解的保留策略
      @Retention(RetentionPolicy.SOURCE)             //注解仅存在于源码中，在class字节码文件中不包含
      @Retention(RetentionPolicy.CLASS)              //默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，
      @Retention(RetentionPolicy.RUNTIME)            //注解会在class字节码文件中存在，在运行时可以通过反射获取到

@Target：指定被修饰的Annotation可以放置的位置(被修饰的目标)
      @Target(ElementType.TYPE)                      //接口、类
      @Target(ElementType.FIELD)                     //属性
      @Target(ElementType.METHOD)                    //方法
      @Target(ElementType.PARAMETER) parameter           //方法参数

@Target({ElementType.METHOD, ElementType.TYPE})，也就是此注解可以在方法和类上面使用
  
  4.4 @Inherited：指定被修饰的Annotation将具有继承性 

    自定义starter:

## 为短信发送功能创建一个starter
5. 自定义starter的开发流程
   1.创建Starter项目(spring-initl 2.1.14)
   2.定义Starter需要的配置类(Properties)
   3.编写Starter项目的业务功能
   4.编写自动配置类
   5.编写spring.factories文件加载自动配置类
   6.打包安装
   7.其它项目引用

   1.创建Starter项目
     starter项目和SpringBoot工程结构没有什么区别，下面就把一些特殊的要求罗列一下
     1.命名规范
       SpringBoot官方命名方式
       格式：spring-boot-starter-{模块名}
       举例：spring-boot-starter-web
       自定义命名方式
       格式：{模块名}-spring-boot-starter
       举例：mystarter-spring-boot-starter
     2.必须引入的依赖
       <!--表示两个项目之间依赖不传递；不设置optional或者optional是false，表示传递依赖-->
       <!--例如：project1依赖a.jar(optional=true),project2依赖project1,则project2不依赖a.jar-->
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-configuration-processor</artifactId>
           <optional>true</optional>
       </dependency>       
    
   2.编写相关属性类(XxxProperties)：SmsProperties.java
     1.@ConfigurationProperties注解基本用法
       前缀定义了哪些外部属性将绑定到类的字段上
       根据 Spring Boot 宽松的绑定规则，类的属性名称必须与外部属性的名称匹配
       我们可以简单地用一个值初始化一个字段来定义一个默认值
       类本身可以是私有的
       类的字段必须有公共 setter 方法   

     注意：SmsProperties代码写完后会报如下错误，这是正常的，因为还有配置类AutoConfig和一个注解@EnableConfigurationProperties没有加
           Not registered via @EnableConfigurationProperties or marked as Spring component

   3.编写Starter项目的业务功能 
     ISmsService和SmsServiceImpl
      

   4.编写自动配置类AutoConfig 
    1. @Configuration：
       定义一个配置类
    2. @EnableConfigurationProperties：
       @EnableConfigurationProperties注解的作用是@ConfigurationProperties注解生效。
       如果只配置@ConfigurationProperties注解，在IOC容器中是获取不到properties配置文件转化的bean的
                   

   5.编写spring.factories文件加载自动配置类
     1.在resources下新建META-INF文件夹，然后创建spring.factories文件
     2.在该文件中加入如下配置，该配置指定上步骤中定义的配置类为自动装配的配置
       org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zking.zzcloudspringbootstarter.config.AutoConfig

       注1：其中AutoConfig是starter配置文件的类限定名，多个之间逗号分割，还可以\进行转义即相当于去掉后面换行和空格符号  
            # Auto Configure
            org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
              com.baomidou.mybatisplus.autoconfigure.MybatisPlusLanguageDriverAutoConfiguration,\
              com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration 
 
   6.打包安装
     打包时需要注意一下，SpringBoot项目打包的JAR是可执行JAR，它的类放在BOOT-INF目录下，
     如果直接作为其他项目的依赖，会找不到类。可以通过修改pom文件来解决，代码如下：
     <plugin>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-maven-plugin</artifactId>
         <configuration>
             <classifier>exec</classifier>
         </configuration>
     </plugin>

   7.其它项目引用