SpringBoot的自定义starter和SpringBoot Starter机制，以及综合案例和通用模块-短信发送，基于AOP技术实现日志切面

目录

1.SpringBoot Starter机制

1.1.什么是SpringBoot Starter

1.2.为什么要使用SpringBoot Starter

1.3.应用场景

1.4.自动加载核心注解说明

2.综合案例

2.1.命名规范

2.2.通用模块-短信发送

2.2.1.创建配置类Properties

2.2.2.编写短信业务功能

2.2.3.创建自动配置类

2.2.4.编写spring.factories文件加载自动配置类

2.2.5.打包安装

2.2.6.其它项目引用并测试

2.3.基于AOP技术实现日志切面

2.3.1.创建配置类Properties

2.3.2.实现基于AOP技术的日志切面功能

2.3.3.创建自动配置类

2.3.4.编写spring.factories文件

2.3.5.打包安装

---

1.SpringBoot Starter机制

1.1.什么是SpringBoot Starter

SpringBoot中的starter是一种非常重要的机制(自动化配置)，能够抛弃以前繁杂的配置，将其统一集成进starter，应用者只需要在maven中引入starter依赖，SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理，需要配置各种信息的困扰。

SpringBoot会自动通过classpath路径下的类发现需要的Bean，并注册进IOC容器。SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。

所有这些依赖模块都遵循着约定成俗的默认配置，并允许我们调整这些配置，即遵循“约定大于配置”的理念。

1.2.为什么要使用SpringBoot Starter

在我们的日常开发工作中，经常会有一些独立于业务之外的配置模块，我们经常将其放到一个特定的包下，然后如果另一个工程需要复用这块功能的时候，需要将代码硬拷贝到另一个工程，重新集成一遍，麻烦至极。如果我们将这些可独立于业务代码之外的功能配置模块封装成一个个starter，复用的时候只需要将其在pom中引用依赖即可， SpringBoot为我们完成自动装配，简直不要太爽。

1.3.应用场景

在我们的日常开发工作中，可能会需要开发一个通用模块，以供其它工程复用。SpringBoot就为我们提供这样的功能机制，我们可以把我们的通用模块封装成一个个starter，这样其它工程复用的时候只需要在pom中引用依赖即可，由SpringBoot为我们完成自动装配。

常见应用场景：

1）通用模块-短信发送模块

2）基于AOP技术实现日志切面

3）分布式雪花ID，Long转String，解决精度问题

4）微服务项目的数据库连接池配置

5）微服务项目的每个模块都要访问redis数据库，每个模块都要配置redisTemplate

1.4.自动加载核心注解说明

2.综合案例

2.1.命名规范

starter项目和SpringBoot工程结构没有什么区别。必须引入的依赖：

<dependency>
 ? ?<groupId>org.springframework.boot</groupId>
 ? ?<artifactId>spring-boot-configuration-processor</artifactId>
 ? ?<optional>true</optional>
</dependency>

spring-boot-configuration-processor 是一个注解处理器，用于处理 Spring Boot 配置类的注解，并生成配置属性的元数据。它在开发过程中起到以下几个重要的作用：

1. 生成配置属性的元数据: 当你使用 @ConfigurationProperties 注解来声明配置类时，spring-boot-configuration-processor 会解析该注解，并生成与配置属性相关的元数据。这些元数据包括属性的名称、类型、描述、默认值等信息。这些信息可以帮助 IDE 在开发过程中提供代码提示、自动补全和验证功能。

2. 提供配置属性的编译时验证: 使用 @ConfigurationProperties 注解时，你可以使用其他注解（如 @Value、@Valid 等）来描述配置属性的约束条件。spring-boot-configuration-processor 可以处理这些注解，并在编译时进行验证。这样，你可以在开发阶段及早发现配置属性的错误或不一致，而不是在运行时才遇到问题。

3. 简化配置类的编写: 通过使用 spring-boot-configuration-processor，你可以更轻松地编写配置类。它会自动处理 @ConfigurationProperties 注解及其相关注解，生成属性的 getter、setter 方法，并提供默认的配置文件映射规则。这样，你可以专注于定义配置属性的结构和业务逻辑，而不需要手动编写重复的代码。

4. 提升开发体验: spring-boot-configuration-processor 增强了开发工具的功能，例如在 IDE 中提供配置属性的智能提示、文档、类型检查等功能。这可以减少开发过程中的错误，并提高代码的可读性和可维护性。

总而言之，spring-boot-configuration-processor 可以简化 Spring Boot 配置类的开发，提供编译时验证和开发工具的支持，从而改善开发体验并减少潜在的配置错误。它是 Spring Boot 框架中重要的辅助工具，帮助开发者更高效地处理配置属性。

• SpringBoot官方命名方式：

spring-boot-starter-{模块名}

例如：spring-boot-starter-web

• 自定义命名方式：

{模块名}-spring-boot-starter

例如：mystarter-spring-boot-starter

2.2.通用模块-短信发送

2.2.1.创建配置类Properties

请提供accessKeyId和accessKeySecret属性的getter、setter方法。

/**
 * 短信服务配置类
 */
@ConfigurationProperties(prefix="scloud.sms")
public class SmsProperties {
 ? ?private String accessKeyId;//访问ID、即帐号
 ? ?private String accessKeySecret;//访问凭证，即密码
 ? ?
 ? ?//TODO
}

2.2.2.编写短信业务功能

导入ISmsService和SmsServiceImpl短信业务类，请参考课件中的代码。

2.2.3.创建自动配置类

@EnableConfigurationProperties注解的作用是@ConfigurationProperties注解生效。如果只配置@ConfigurationProperties注解，在IOC容器中是获取不到properties配置文件转化的bean的

@Configuration
@EnableConfigurationProperties({SmsProperties.class})
public class AutoConfig {
?
 ? ?@Autowired
 ? ?private SmsProperties smsProperties;
?
 ? ?//通过@Bean注解将其注入到Spring上下文中
 ? ?@Bean
 ? ?public ISmsService smsService(){
 ? ? ? ?//调用SMS短信服务接口时，必须通过账号和密码的方式进行调用。
 ? ? ? ?return new SmsServiceImpl(smsProperties.getAccessKeyId(),smsProperties.getAccessKeySecret());
 ?  }
}

2.2.4.编写spring.factories文件加载自动配置类

在resources下新建META-INF文件夹，然后创建spring.factories文件；

在该文件中加入如下配置，该配置指定上步骤中定义的配置类为自动装配的配置：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.zking.scloudspringbootstarter.config.AutoConfig,\
  com.zking.scloudspringbootstarter.config.WebLogAutoConfig

注意：其中AutoConfig是starter配置文件的类限定名，多个之间逗号分割，还可以\进行转义即相当于去掉后面换行和空格符号。

2.2.5.打包安装

在打包时需要注意一下，SpringBoot项目打包的JAR是可执行JAR，它的类放在BOOT-INF目录下，如果直接作为其他项目的依赖，会找不到类。可以通过修改pom文件来解决，代码如下：

<plugin>
 ? ?<groupId>org.springframework.boot</groupId>
 ? ?<artifactId>spring-boot-maven-plugin</artifactId>
 ? ?<configuration>
 ? ? ? ?<classifier>exec</classifier>
 ? ?</configuration>
</plugin>

2.2.6.其它项目引用并测试

• 引入依赖

<dependency>
 ? ?<groupId>com.zking</groupId>
 ? ?<artifactId>scloud-spring-boot-starter</artifactId>
 ? ?<version>0.0.1-SNAPSHOT</version>
</dependency>

• 配置application.yml

#短信服务
scloud:
  sms:
    access-key-id: zs
    access-key-secret: 123456

• 创建Junit测试

@SpringBootTest
@RunWith(SpringJUnit4ClassRunner.class)
public class SmsServiceImplTest {

    @Autowired
    ISmsService smsService;

    @Before
    public void setUp() throws Exception {
    }

    @Test
    public void send() {
        smsService.send("17883838312","wu","1002","OK");
    }
}

2.3.基于AOP技术实现日志切面

2.3.1.创建配置类Properties

enabled属性用于控制是否开关日志，请提供enabled属性的getter、setter方法。

/**
 * AOP日志配置类
 */
@ConfigurationProperties(prefix ="scloud.weblog")
public class WebLogProperties {

    private boolean enabled;
    
    //TODO
}

2.3.2.实现基于AOP技术的日志切面功能

@Component
@Slf4j
@Aspect
public class WebLogAspect {
    @Pointcut("execution(public * com.zking..controller.*.*(..))")
    @Pointcut("execution(* *..*Controller.*(..))")
    public void webLog(){}

    @Before("webLog()")
    public void doBefore(JoinPoint joinPoint) throws Throwable {
        // 接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes)
                RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();

        // 记录下请求内容
        log.info("开始服务:{}", request.getRequestURL().toString());
        log.info("客户端IP :{}" , request.getRemoteAddr());
        log.info("参数值 :{}", Arrays.toString(joinPoint.getArgs()));
    }

    @AfterReturning(returning = "ret", pointcut = "webLog()")
    public void doAfterReturning(Object ret) throws Throwable {
        // 处理完请求，返回内容
        log.info("返回值 : {}" , ret);
    }
}

2.3.3.创建自动配置类

@Configuration
@EnableConfigurationProperties({WebLogProperties.class})
@ConditionalOnProperty(prefix = "scloud.weblog",
    value="enabled",matchIfMissing = true)
public class WebLogAutoConfig {

    @Bean
    @ConditionalOnMissingBean
    public WebLogAspect webLogAspect(){
        return new WebLogAspect();
    }
}

matchIfMissing属性：默认情况下matchIfMissing为false，也就是说如果未进行属性配置，则自动配置不生效。如果matchIfMissing为true，则表示如果没有对应的属性配置，则自动配置默认生效。

配置属性enabled：

• 不配置enabled：matchifmissing=false 不满足 matchifmissing=true 满足

• 配置enabled=false： matchifmissing=false 不满足 matchifmissing=true 不满足

• 配置enabled=true：matchifmissing=false 满足 matchifmissing=true 满足

2.3.4.编写spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.zking.scloudspringbootstarter.config.AutoConfig,\
  com.zking.scloudspringbootstarter.config.WebLogAutoConfig

2.3.5.打包安装

参考《通用模块-短信发送》中的2.2.5.打包安装。

打包安装完成之后，直接在其他项目引入依赖并配置测试即可。