自定义starter

一、简介

1、启动器starter命名

#官方
spring-boot-starter-jdbc
spring-boot-starter-web
spring-boot-starter-freemarker
#第三方
sms-spring-boot-starter
myLog-spring-boot-starter

2、什么是SpringBoot starter机制

SpringBoot中的starter是一种非常重要的机制(自动化配置)，能够抛弃以前繁杂的配置，将其统一集成进starter，
应用者只需要在maven中引入starter依赖，SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。
starter让我们摆脱了各种依赖库的处理，需要配置各种信息的困扰。SpringBoot会自动通过classpath路径下的类发现需要的Bean，
并注册进IOC容器。SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。
所有这些依赖模块都遵循着约定成俗的默认配置，并允许我们调整这些配置，即遵循“约定大于配置”的理念。

3、为什么要自定义starter

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

4、什么时候需要创建自定义starter

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

常见场景：
1.通用模块-短信发送模块
2.基于AOP技术实现日志切面
3.分布式雪花ID，Long–>string，解决精度问题
jackson2/fastjson
4.微服务项目的数据库连接池配置
5.微服务项目的每个模块都要访问redis数据库，每个模块都要配置redisTemplate
也可以通过starter解决

5、自动加载核心注解说明

二、自定义starter短信模块

自定义starter的开发流程

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

1、创建Starter项目

1.命名规范
SpringBoot官方命名方式
格式：spring-boot-starter-{模块名}
举例：spring-boot-starter-web
自定义命名方式
格式：{模块名}-spring-boot-starter
举例：mystarter-spring-boot-starter

2.必须引入的依赖

<dependency>
   <groupId>org.springframework.bootgroupId>
   <artifactId>spring-boot-configuration-processorartifactId>
   <optional>trueoptional>
dependency>
1
2
3
4
5
6
7

2、编写相关属性类：SmsProperties

package com.xnx.smsspringbootstart.properties;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * @author xnx
 * @create 2022-11-03 9:38
 *
 * 短信发送时一般要提供短信账户凭证
 * spring:
 *     application:
 *         name: sms-spring-boot-start
 * 当需要使用自定义sms模块时，在yml文件中进行配置
 * spboot:
 *     sms:
 *         xxx: sms-spring-boot-start
 *
 *  ConfigurationProperties默认是会报错的，然后需要在strter项目配置类中解决
 */
@ConfigurationProperties(prefix = "spboot.sms")
public class SmsProperties {
    private String accessKeyId;//短信发送接口的账户

    private String accesskeySecret;//短信发送接口的凭证

    public String getAccessKeyId() {
        return accessKeyId;
    }

    public void setAccessKeyId(String accessKeyId) {
        this.accessKeyId = accessKeyId;
    }

    public String getAccesskeySecret() {
        return accesskeySecret;
    }

    public void setAccesskeySecret(String accesskeySecret) {
        this.accesskeySecret = accesskeySecret;
    }



}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

3、编写Starter项目的业务功能

SmsService.java

package com.xnx.smsspringbootstart.service;

/**
 * @author xnx
 * @create 2022-11-03 9:45
 */
public interface SmsService {
    /**
     * 发送短信
     *
     * @param phone        要发送的手机号
     * @param signName     短信签名-在短信控制台中找
     * @param templateCode 短信模板-在短信控制台中找
     * @param data         要发送的内容
     */
    void send(String phone, String signName, String templateCode, String data);
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

SmsServiceImpl.java

package com.xnx.smsspringbootstart.service;

/**
 * @author xnx
 * @create 2022-11-03 9:46
 */
public class SmsServiceImpl implements SmsService{
    private String accessKeyId;//访问ID、即帐号
    private String accessKeySecret;//访问凭证，即密码

    public SmsServiceImpl(String accessKeyId, String accessKeySecret) {
        this.accessKeyId = accessKeyId;
        this.accessKeySecret = accessKeySecret;
    }

    @Override
    public void send(String phone, String signName, String templateCode, String data) {
        System.out.println("接入短信系统，accessKeyId=" + accessKeyId + ",accessKeySecret=" + accessKeySecret);
        System.out.println("短信发送，phone=" + phone + ",signName=" + signName + ",templateCode=" + templateCode + ",data=" + data);
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

4、编写自动配置类SmsAutoConfig.java

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

package com.xnx.smsspringbootstart.config;

import com.xnx.smsspringbootstart.properties.SmsProperties;
import com.xnx.smsspringbootstart.service.SmsService;
import com.xnx.smsspringbootstart.service.SmsServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author xnx
 * @create 2022-11-03 9:47
 */
@Configuration
@EnableConfigurationProperties({SmsProperties.class})
public class SmsAutoConfig {
    @Autowired
    private SmsProperties smsProperties;
//    将短信发送的业务类交给spring容器进行管理
    @Bean
    public SmsService smsService(){
        return new SmsServiceImpl(smsProperties.getAccessKeyId(),smsProperties.getAccesskeySecret());
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

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

spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.xnx.smsspringbootstart.config.SmsAutoConfig

1
2

6、打包安装

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

<plugin>
	<groupId>org.springframework.bootgroupId>
	<artifactId>spring-boot-maven-pluginartifactId>
	<configuration>
		<classifier>execclassifier>
	configuration>
plugin>
1
2
3
4
5
6
7

记得添加packing

如图所示即为成功

7、其它项目引用

#构建项目测试用的spboot项目，勾选组件lombok以及spring-boot-starter-web
#添加自定义starter依赖如下

①pom文件

<dependency>
            <groupId>com.xnxgroupId>
            <artifactId>sms-spring-boot-startartifactId>
            <version>0.0.1-SNAPSHOTversion>
        dependency>
1
2
3
4
5

②application.yml

server:
    port: 8080
spring:
    application:
        name: spbootxy
spboot:
    sms:
        access-key-id: xx
        access-key-secret: 123456
1
2
3
4
5
6
7
8
9

③SmsController.java

package com.xnx.spbootxy.controller;

import com.xnx.smsspringbootstart.service.SmsService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author xnx
 * @create 2022-11-03 10:19
 */
@RestController
public class SmsController {
    @Autowired
    private SmsService smsService;
    @RequestMapping("/sms/send")
    public String send(){
        smsService.send("18166183938","签名","336600","你好,短信启动器创建成功");
        return "test success";
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

④测试

三、自定义starterAOP日志模块

自定义starter的开发流程

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

1、创建Starter项目

1.命名规范
SpringBoot官方命名方式
格式：spring-boot-starter-{模块名}
举例：spring-boot-starter-web
自定义命名方式
格式：{模块名}-spring-boot-starter
举例：mystarter-spring-boot-starter

2.必须引入的依赖

<dependency>
   <groupId>org.springframework.bootgroupId>
   <artifactId>spring-boot-configuration-processorartifactId>
   <optional>trueoptional>
dependency>   

 <dependency>
	<groupId>org.springframework.bootgroupId>
	<artifactId>spring-boot-starter-aopartifactId>
dependency>
1
2
3
4
5
6
7
8
9
10
11
12

2、编写相关属性类：MyLogProperties.java

package com.xnx.mylogspringbootstarter.propertites;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * @author xnx
 * @create 2022-11-03 10:33
 */
@ConfigurationProperties(prefix = "spboot.mylog")
public class MyLogProperties {
    private boolean enabled;

    public boolean isEnabled() {
        return enabled;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

3、编写Starter项目的业务功能

WebLogAspect

package com.xnx.mylogspringbootstarter.aop;

import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;

/**
 * @author xnx
 * @create 2022-11-03 10:35
 */
@Aspect
@Component
@Slf4j
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);
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

4、编写自动配置类

MyLogAutoConfig.java

package com.xnx.mylogspringbootstarter.config;

import com.xnx.mylogspringbootstarter.propertites.MyLogProperties;
import com.xnx.mylogspringbootstarter.aop.WebLogAspect;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author xnx
 * @create 2022-11-03 10:37
 */
@Configuration
@EnableConfigurationProperties({MyLogProperties.class})
@ConditionalOnProperty(prefix = "spboot.mylog",
        value = "enabled")
public class MyLogAutoConfig {
    @Bean
    @ConditionalOnMissingBean
    public WebLogAspect webLogAspect(){
        return new WebLogAspect();
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

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

spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.xnx.mylogspringbootstarter.config.MyLogAutoConfig
1

6、打包安装

同第二点的第6点

7、其它项目引用

#构建项目测试用的spboot项目，勾选组件lombok以及spring-boot-starter-web
#添加自定义starter依赖如下

①pom依赖

<dependency>
            <groupId>com.xnxgroupId>
            <artifactId>mylog-spring-boot-starterartifactId>
            <version>0.0.1-SNAPSHOTversion>
        dependency>
1
2
3
4
5

②application.yml

server:
    port: 8080
spring:
    application:
        name: spbootxy
spboot:
    sms:
        access-key-id: xx
        access-key-secret: 123456
    mylog:
        enabled: true
1
2
3
4
5
6
7
8
9
10
11

③SmsController.java

同上第二点的第7点的第③点

8、测试