6.自定义starter

最新推荐文章于 2024-06-13 10:26:45 发布

Java炒雪糕

最新推荐文章于 2024-06-13 10:26:45 发布

阅读量77

点赞数

文章标签： spring boot 后端 java

本文链接：https://blog.csdn.net/weixin_52361952/article/details/132397361

版权

自定义starter

1.简介
2.自定义starter短信模块
3.自定义starterAOP日志模块
4.总结

1.简介

1.1.启动器starter命名

#官方已经整合的
spring-boot-starter-jdbc
spring-boot-starter-web
spring-boot-starter-freemarker
#第三方整合官方的
sms-spring-boot-starter
myLog-spring-boot-starter

1.2.什么是SpringBoot starter机制

SpringBoot中的starter是一种非常重要的机制(自动化配置)，能够抛弃以前繁杂的配置，将其统一集成进starter，

应用者只需要在maven中引入starter依赖，SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。

starter让我们摆脱了各种依赖库的处理，需要配置各种信息的困扰。SpringBoot会自动通过classpath路径下的类发现需要的Bean，
并注册进IOC容器。SpringBoot提供了针对日常企业应用研发各种场景的spring-boot-starter依赖模块。

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

1.3.为什么要自定义starter

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

1.4.什么时候需要创建自定义starter

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

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

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

在这里插入图片描述

2.自定义starter短信模块

2.1.自定义starter的开发流程

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

2.2.创建Starter项目

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.2.1.创建模块

在这里插入图片描述

2.2.2.修改pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.7.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.zjzaki</groupId>
    <artifactId>sms-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>sms-spring-boot-starter</name>
    <description>sms-spring-boot-starter</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

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

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude>
                            <groupId>org.projectlombok</groupId>
                            <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

2.3.新建properties包,创建相关属性类

SmsProperties.java

package com.zjzaki.sms.properties;

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

/**
 * @Author zjzaki
 * @Package com.zjzaki.sms.properties
 * @Date 2023-08-11 16:59:23
 */
@ConfigurationProperties(prefix = "spcloud.sms")
public class SmsProperties {
    //访问ID及账号
    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;
    }
}

2.4.编写Starter项目的业务功能

2.4.1.新建service包

1.创建SmsService.java

package com.zjzaki.sms.service;

/**
 * @Author zjzaki
 * @Package com.zjzaki.sms.service
 * @Date 2023-08-11 17:01:50
 */
public interface SmsService {
    /**
     * 发送短信
     *
     * @param phone        要发送的手机号
     * @param signName     短信签名-在短信控制台中找
     * @param templateCode 短信模板-在短信控制台中找
     * @param data         要发送的内容
     */
    void send(String phone, String signName, String templateCode, String data);
}

2.4.2.在service包下,新建impl包

1.创建SmsServiceImpl.java

package com.zjzaki.sms.service.impl;

import com.zjzaki.sms.service.SmsService;

/**
 * @Author zjzaki
 * @Package com.zjzaki.sms.service.impl
 * @Date 2023-08-11 17:03:17
 */
public class SmsServiceImpl implements SmsService {

    /**
     * 访问ID、即帐号
     */
    private String accessKeyId;

    /**
     * //访问凭证，即密码
     */
    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);
    }
}

2.5.编写自动配置类SmsAutoConfig.java

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

2.5.1.新建config包

1.新建SmsAutoConfig.java

package com.zjzaki.sms.config;

import com.zjzaki.sms.properties.SmsProperties;
import com.zjzaki.sms.service.SmsService;
import com.zjzaki.sms.service.impl.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 zjzaki
 * @Package com.zjzaki.sms.config
 * @Date 2023-08-11 17:05:35
 */
@Configuration
@EnableConfigurationProperties({SmsProperties.class})
public class SmsAutoConfig {

    @Autowired
    private SmsProperties smsProperties;

    @Bean
    public SmsService smsService(){
        return new SmsServiceImpl(smsProperties.getAccessKeyId(),
                smsProperties.getAccessKeySecret());
    }
}

2.6.编写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.zjzaki.sms.config.SmsAutoConfig

2.7.打包安装

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

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

在这里插入图片描述

此时在本地的maven仓库中会看到生成包

ps:package只能打包到target里 install不仅可以打包到target还可以打包到本地仓库如果想要复用肯定得打包到本地仓库

2.8.其它项目引用

2.8.1.在spboot04的pom依赖中添加

<dependency>
    <groupId>com.zjzaki</groupId>
    <artifactId>sms-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

2.8.2.在application.yaml中添加内容

spcloud:
  sms:
    access-key-id: 123456
    access-key-secret: zjzaki

2.8.3.添加SmsController.java

package com.zjzaki.spboot04.controller;

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

/**
 * @Author zjzaki
 * @Package com.zjzaki.spboot04.controller
 * @Date 2023-08-11 17:28:19
 */
@RestController
public class SmsController {

    @Autowired
    private SmsService smsService;
    @RequestMapping("/sms")
    public String sendSms(){
        smsService.send("12345678900","签名","1000","你好自定义短信发送starter");
        return "success";
    }
}

2.8.4.启动项目

浏览器访问: http://localhost:8080/spboot04/sms
在这里插入图片描述

3.自定义starterAOP日志模块

3.1.自定义starter的开发流程

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

3.2.创建Starter项目

3.2.1.创建模块mylog-spring-boot-starter

与2的步骤类似

添加pom依赖

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

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

3.3.新建properties包

1.编写WebLogProperties.java

package com.zjzaki.mylog.properties;

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

/**
 * @Author zjzaki
 * @Package com.zjzaki.mylog.properties
 * @Date 2023-08-11 18:57:59
 */
@ConfigurationProperties(prefix = "spcloud.weblog")
public class WebLogProperties {
    private boolean enabled;

    public WebLogProperties() {
    }

    public boolean isEnabled() {
        return enabled;
    }

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

3.4.新建aspect包

3.4.1.编写WebLogAspect.java

package com.zjzaki.mylog.aspect;

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 zjzaki
 * @Package com.zjzaki.mylog.aspect
 * @Date 2023-08-11 19:02:53
 */
@Aspect
@Component
@Slf4j
public class WebLogAspect {

    @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);
    }
}

3.5.新建config包

3.5.1.新建WebLogConfig.java

package com.zjzaki.mylog.config;

import com.zjzaki.mylog.aspect.WebLogAspect;
import com.zjzaki.mylog.properties.WebLogProperties;
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 zjzaki
 * @Package com.zjzaki.mylog.config
 * @Date 2023-08-11 19:23:24
 * @ConditionalOnProperty
 * 配置属性a:
 * 1:不配置a        matchifmissing=false 不满足      matchifmissing=true 满足
 * 2:配置a=false    matchifmissing=false 不满足      matchifmissing=true 不满足
 * 3:配置a=true     matchifmissing=false 满足        matchifmissing=true 满足
 */
@Configuration
@EnableConfigurationProperties({WebLogProperties.class})
@ConditionalOnProperty(prefix = "spcloud.weblog", value = "enabled")
public class WebLogConfig {

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

3.6.在resources中新建META-INF文件夹

3.6.1.创建spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zjzaki.mylog.config.WebLogConfig

3.7.打包安装

1.pom文件中添加

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

2.如图所示

在这里插入图片描述
3.可以看到在本地maven仓库生成了

3.8.其它项目引用

3.8.1.在spboot04模块的pom文件中添加

<dependency>
    <groupId>com.zjzaki</groupId>
    <artifactId>mylog-spring-boot-starter</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

3.8.2.在application.yml中添加

spcloud:
    weblog:
        enabled: true

3.8.3.重启项目

访问: http://localhost:8080/spboot04/sms
在这里插入图片描述
修改application.yml

spcloud:
    weblog:
        enabled: false

重启项目,访问: http://localhost:8080/spboot04/sms, 可以看到没有日志输出了
在这里插入图片描述

4.总结

自定义starter步骤
1 创建spboot来对应start工程添加pom（比如是一个付费短信包要访问是需要付费的然后付费会给个key给你拿着key门卫才会放你进去）
2定义对应的properties（对应的key 里面的字段就是key 要访问starter首先要满足这个key的字段）（相当于门卫不给key不让访问starter）
3写对应的service及serviceimpl如果不需要写是切面的话就写aspect相关业务（具体业务信息）要基于properties
4写config(相当于给service初始化因为这里面要new一个serviceimpl对象且存值 new serviceImpl(keyname,keypwd)完成初始化)且相关配置要写在这里面) 要基于service
5 去resource下创建一个META-INF 然后添加Spring.factory配置文件里面的值在上面有提等号前面是固定的等号后面是对应config的完整路径（基于config）
6 打包分install和paceage install会打包到target和本地仓库 package 只会打包到target
7打包完之后可以删除因为本地仓库有了然后使用方法和其他的一样先导依赖再加yml配置等
在这里插入图片描述