自定义Starter

最新推荐文章于 2024-08-19 16:27:24 发布
最新推荐文章于 2024-08-19 16:27:24 发布
阅读量114 收藏
点赞数
分类专栏： idea 文章标签： spring boot java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_66924116/article/details/127716178
版权

目录

一、Springboot  starter简介

 启动器命名

使用SpringBoot starter机制的意义？

那什么时候用呢？

二、sms短信启动器starter制作

三、sms短信调用启动器starter测试

四、Aop日志starter制作及测试

自定义starter的开发流程

一、Springboot  starter简介

 启动器命名

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

SpringBoot starter机制是？

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

使用SpringBoot starter机制的意义？

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

那什么时候用呢？

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

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

二、sms短信启动器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.boot</groupId>
   <artifactId>spring-boot-configuration-processor</artifactId>
   <optional>true</optional>
</dependency>

2.编写相关属性类：SmsProperties.java

package com.lucy.smsspringbootstarter.properties;
 
import org.springframework.boot.context.properties.ConfigurationProperties;
 
/**
 * @author lucy
 * @create 2022-11-03 20:55
 *
 * 配置类
 * 短信发送时，一般是提供短信账户凭证
 * spring
 *      application
 *              name:sms-spring-boot-starter
 * spboot:
 *      sms:
 *          name:sms-spring-boot-starter
 *
 *  ConfigurationProperties默认是会报错的，然后需要在starter项目配置内
 */
@ConfigurationProperties(prefix = "spboot.sms")
public class SmsProperties {
 
    private String accessKeyId;///访问ID及账号
 
    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;
    }
}

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

package com.lucy.smsspringbootstarter.service;
 
public interface SmsService {
    /**
     * 发送短信
     *
     * @param phone        要发送的手机号
     * @param signName     短信签名-在短信控制台中找
     * @param templateCode 短信模板-在短信控制台中找
     * @param data         要发送的内容
     */
    void send(String phone, String signName, String templateCode, String data);
}

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

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

package com.lucy.smsspringbootstarter.config;
 
import com.lucy.smsspringbootstarter.properties.SmsProperties;
import com.lucy.smsspringbootstarter.service.SmsService;
import com.lucy.smsspringbootstarter.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 lucy
 * @create 2022-11-03 21:12
 */
@Configuration
@EnableConfigurationProperties({SmsProperties.class})
public class SmsAutoConfig {
    @Autowired
    private SmsProperties smsProperties;
 
//    将短信发送的业务类交给Spring容器进行管理
    @Bean
    public SmsService smsService(){
        return new SmsServiceImpl(smsProperties.getAccessKeyId(),
                smsProperties.getAccessKeySecret());
    }
}

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

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.lucy.smsspringbootstarter.config.SmsAutoConfig

6.打包安装

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

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

右键run maven——>clean install即可

三、sms短信调用启动器starter测试

7.其它项目引用

再新建一个项目作为湘雅医院——spbootxy，

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

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

 yml文件

server:
    port: 8080
spring:
    application:
        name: sms-spring-boot-starter
 
spboot:
    sms:
        access-key-id: lucy
        access-key-secret: 123456

SmsController ：

package com.lucy.spbootxy.controller;
 
import com.lucy.smsspringbootstarter.service.SmsService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author lucy
 * @create 2022-11-03 22:03
 */
@RestController
public class SmsController {
    @Autowired
    public SmsService smsService;
 
    @RequestMapping("/sms/send")
    public String sendSms(){
        smsService.send("19374048518","签名","33660","你好,短信启动器创建成功！！");
        return "success";
    }
 
 
}

测试启动项目

 

四、Aop日志starter制作及测试

自定义starter的开发流程

1.创建Starter项目(spring-initl 2.1.14)

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

依赖：

        <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>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>


2.定义Starter需要的配置类(Properties)

 

package com.lucy.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;
 
@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);
    }
}


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

package com.lucy.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;
 
@Aspect
@Component
@Slf4j
public class WebLogAspect {
    //@Pointcut("execution(public * com.lucy..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);
    }
}



4.编写自动配置类

package com.lucy.mylogspringbootstarter.config;
 
import com.lucy.mylogspringbootstarter.aop.WebLogAspect;
import com.lucy.mylogspringbootstarter.properties.MyLogProperties;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
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 lucy
 * @create 2022-11-03 23:27
 */
 
/**
 * @ConditionalOnProperty
 * 配置属性a:
 * 1:不配置a        matchifmissing=false 不满足      matchifmissing=true 满足
 * 2:配置a=false    matchifmissing=false 不满足      matchifmissing=true 不满足
 * 3:配置a=true     matchifmissing=false 满足        matchifmissing=true 满足
 */
@Configuration
@EnableConfigurationProperties({MyLogProperties.class})
@ConditionalOnProperty(prefix = "spboot.mylog",
        value = "enabled")
public class MyLogAutoConfig {
 
    @Bean
    @ConditionalOnMissingBean
    public WebLogAspect webLogAspect(){
        return new WebLogAspect();
    }
}


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

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.lucy.mylogspringbootstarter.config.MyLogAutoConfig


6.打包安装

导入依赖

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

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


7.其它项目引用

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

 

 <!--导入aop日志启动器-->
        <dependency>
            <groupId>com.lucy</groupId>
            <artifactId>mylog-spring-boot-starter</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

yml文件

server:
    port: 8080
spring:
    application:
        name: spbootxy
spboot:
        sms:
            access-key-id: lucy
            access-key-secret: 123456
        mylog:
            enabled: true

 

白敬亭的鞋44ma
关注
专栏目录
自定义starter
qq_44247968的博客
11-04 2622
SpringBoot中的starter是一种非常重要的机制(自动化配置)，能够抛弃以前繁杂的配置，将其统一集成进starter，应用者只需要在maven中引入starter依赖，SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理，需要配置各种信息的困扰。SpringBoot会自动通过classpath路径下的类发现需要的Bean，并注册进IOC容器。
SpringBoot自定义starter实例代码
08-26
SpringBoot 自定义 Starter 实例代码 SpringBoot 自定义 Starter 实例代码是指通过自定义 Starter 来简化 SpringBoot 的使用。SpringBoot 的强大功能之一是 把常用的场景抽取成了一个个 Starter（场景启动器），...
【springboot】自定义starter
最新发布
BlackPudding_的博客
08-19 560
自定义一个starter，实现获取系统和程序信息。 文件是用来加载自动配置类的，该文件必须放在META-INF/spring/目录下。 创建一个普通的maven项目，使用quickstart进行构建。 这里需要注意jdk版本选择：springboot 2.0 需要选择jdk8+，springboot 3.0 需要选择jdk17+。 导入父容器，进行版本控制；导入自动配置依赖，这是实现starter的核心依赖。 3. 创建属性结构类 这里使用@C
自定义一个starter
qq_35599414的博客
09-06 652
一、springboot starter springboot starter：引入相关依赖和初始化配置（自动配置） 一般可以根据starter区分是spring官方还是第三方： 二、自定义一个简单的starter 一、案例一 1、创建一个hello-spring-boot-starter并配置pom.xml文件 aa ...
spring-boot自定义starter的demo
09-20
自定义完整的starter*demo,包含了import所有用法,selector,register,bean,class以及常规的scan用法
Spring boot创建自定义starter的完整步骤
08-25
Spring Boot的自定义starter是开发人员扩展其功能和定制化应用的一种强大方式。本文将详细介绍创建自定义starter的完整步骤，以及如何利用starter模块来优化项目配置。 首先，理解starter的作用至关重要。starter是...
自定义一个 starter
m0_64201189的博客
04-05 920
实现一个简单的自定义 starter
SpringBoot：自定义starter
ChinaDragon10的博客
02-23 3269
SpringBoot：自定义starter
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值