Springboot-06-自定义starter

最新推荐文章于 2024-05-31 10:14:06 发布
最新推荐文章于 2024-05-31 10:14:06 发布
阅读量102 收藏
点赞数
分类专栏： SpringBoot 文章标签： spring boot 后端 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lisfgj/article/details/132266087
版权

文章目录

一. 简介

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解决

自动加载核心注解说明

在这里插入图片描述

二. 自定义starter短信模块

1. 创建Starter项目

1. 根据命名规则进行命名

SpringBoot官方命名方式
格式：spring-boot-starter-{模块名}
举例：spring-boot-starter-web

自定义命名方式
格式：{模块名}-spring-boot-starter
举例：mystarter-spring-boot-starter

2. 必须要引入的依赖

optional true表示两个项目之间依赖不传递；不设置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. 定义Starter需要的配置类

SmsProperties.java

package com.zking.smsspringbootstarter.properties;

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

/**
 * @author小李飞刀
 * @site www.javaxl.com
 */
@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;
    }
}

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

SmsService.java

package com.zking.smsspringbootstarter.service;

/**
 * @author小李飞刀
 * @site www.javaxl.com
 */
public interface SmsService {
    /**
     * 发送短信
     *
     * @param phone        要发送的手机号
     * @param signName     短信签名-在短信控制台中找
     * @param templateCode 短信模板-在短信控制台中找
     * @param data         要发送的内容
     */
    void send(String phone, String signName, String templateCode, String data);
}

SmsServiceImpl.java

package com.zking.smsspringbootstarter.service;


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

4. 编写自动配置类

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

SmsAutoConfig.java

package com.zking.smsspringbootstarter.config;

import com.zking.smsspringbootstarter.properties.SmsProperties;
import com.zking.smsspringbootstarter.service.SmsService;
import com.zking.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;

@Configuration
@EnableConfigurationProperties({SmsProperties.class})
public class SmsAutoConfig {

    @Autowired
    private SmsProperties smsProperties;

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

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. 其他项目引用

  1. 构建项目测试用的spboot项目，勾选组件lombok以及spring-boot-starter-web
  2. 添加自定义starter依赖如下
<dependency>
	<groupId>com.zking</groupId>
	<artifactId>sms-spring-boot-starter</artifactId>
	<version>0.0.1-SNAPSHOT</version>
</dependency>

application.yml

server:
    port: 8080
spring:
    application:
        name: testsmsspboot
spcloud:
    sms:
        access-key-id: 123456
        access-key-secret: xiaoli

SmsController.java

package com.zking.testsmsspboot.web;

import com.zking.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小李飞刀
 * @site www.javaxl.com
 */
@RestController
public class SmsController {
    @Autowired
    private SmsService smsService;
    @RequestMapping("/sms")
    public String sendSms(){
        smsService.send("15970290566","签名","1000","你好自定义短信发送starter");
        return "success";
    }
}

在这里插入图片描述

在这里插入图片描述

三. 自定义starterAOP日志模块

1. 创建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>   

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

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

package com.zking.weblogspringbootstarter.properties;

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

@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. 编写Starter项目的业务功能

WebLogAspect.java

package com.zking.weblogspringbootstarter.config;

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

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

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

WebLogConfig.java

package com.zking.weblogspringbootstarter.config;

import com.zking.weblogspringbootstarter.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;

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

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.zking.weblogspringbootstarter.config.WebLogConfig

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. 其它项目引用

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

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

application.yml

server:
    port: 8080
spring:
    application:
        name: testsmsspboot
spcloud:
    sms:
        access-key-id: 123456
        access-key-secret: xiaoli
    weblog:
        enabled: true

SmsController.java

package com.zking.testsmsspboot.web;

import com.zking.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小李飞刀
 * @site www.javaxl.com
 */
@RestController
public class SmsController {
    @Autowired
    private SmsService smsService;
    @RequestMapping("/sms")
    public String sendSms(){
        smsService.send("15970290566","签名","1000","你好自定义短信发送starter");
        return "success";
    }
}

访问

http://localhost:8080/sms

测试结果如下

在这里插入图片描述

lisfgj
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
my-springboot-starter.zip
04-07
spring boot 自定义starter
Java开发案例-springboot-66-自定义starter-源代码+文档.rar
最新发布
05-31
Java开发案例-springboot-66-自定义starter-源代码+文档.rar Java开发案例-springboot-66-自定义starter-源代码+文档.rar Java开发案例-springboot-66-自定义starter-源代码+文档.rar Java开发案例-springboot-66-...
创建自定义的Spring Boot Starter
fggdgh的博客
06-24 759
自定义Spring Boot Starter
SpringBoot-自定义Starter精华版
小孔靠得住的博客
04-12 1429
​ 开发的自定义 Starter 需求是，项目依赖starterTest-spring-boot-starter,starterTest-spring-boot-starter 又加载HelloAutoConfiguration,HelloAutoConfiguration自动产生HelloService，项目中引入 starterTest-springboot-start后，用户便可以使用HelloAutoConfiguration 产生的 HelloService 了
自定义starter
qq_63531917的博客
11-06 879
官方#第三方SpringBoot中的starter是一种非常重要的机制(自动化配置)，能够抛弃以前繁杂的配置，将其统一集成进starter，应用者只需要在maven中引入starter依赖，SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理，需要配置各种信息的困扰。SpringBoot会自动通过classpath路径下的类发现需要的Bean，并注册进IOC容器。
SpringBoot-创建自己的Starter
雨后是冰雹
12-20 742
创建自己的Starter自定义starter1. 创建一个空的 maven 项目，并引入依赖2. 创建配置属性类3. 创建服务类4. 创建自动配置类5. 创建 META-INF/spring.factories测试Starter springboot 官方提供了很多 starter 来实现自动配置，简化我们的开发，那么我们能不能把自己常用的一些组件也封装成一个starter来实现自动化配置呢？答案是可以的。 自定义starter 1. 创建一个空的 maven 项目，并引入依赖 <dependenci
超简单 定义一个自己的starter
不会骑摩托的程序员不是好的摄影师
10-13 2189
从mybatis提供的自定义的starter结构可以看出，starter就是一个普通的maven项目，引入了需要配置的模块后，帮用户写好接入Spring需要的配置操作，再进行一次封装。用户就可以省去配置的过程，做到引入就自动配置。这一点也符合Spring在官网上，对SpringBoot的介绍_ Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can "ju
如何自定义springboot-starter
sinat_29434159的博客
04-06 2625
springboot自定义starter
自定义 SpringBoot-Starter email-spring-boot-starter.zip
07-13
自己写的starter;使用的apache-commons-email 包内包含源码和已打包的jar,亲测可用,可以直接给126,qq邮箱等直接发邮件,可以包含附件.
spring-boot自定义starter的demo
09-20
自定义完整的starter*demo,包含了import所有用法,selector,register,bean,class以及常规的scan用法
自定义springboot-starter项目源码【cwp-spring-boot-starter】
07-31
自对应springboot-starter组件项目代码。
动手学习|如何创建自己的starter？
BASK2311的博客
03-23 975
不错不错，自动配置简单原理明白了，也能写个starter了，说不定以后能写些东西让别人依赖一下（哈哈哈，开始做梦）。
自定义Starter-创建自己的Starter
m0_67156901的博客
07-14 1725
如果为SpringBoot官方提供的Starter，那么都会将spring-boot-starter放在前面，如spring-boot-starter-web；如果为自定义Starter，则会将spring-boot-starter放在后面，如mybatis-spring-boot-starter。1、maven中执行clean清楚个人数据，然后在执行install将项目安装在maven仓库中。2、在需要使用的项目中只需导入以下坐标，即可直接使用啦！
【SpringBoot】之创建自定义 SpringBoot-Starter
王廷云的博客
09-01 2485
本文介绍了 SpringBoot Starter 的相关内容，同时详细讲解了如何创建一个自定义的 SpringBoot Starter。
使用 Docker 环境变量轻松配置 Spring Boot 应用程序：详细指南
nbsaas-boot基于Request-Response的企业级快速开发框架
05-29 453
通过上述步骤，你可以轻松地将 Spring Boot 应用程序打包到 Docker 容器中，并通过环境变量来配置关键参数，如数据库连接、用户名和密码。这样可以使你的应用程序更加灵活和便于部署。
spring boot 3.x版本 引入 swagger2启动时报错
东皋长歌的专栏
05-31 773
級到Spring Boot 3.x之后，需要从Springfox迁移到SpringDoc，Springfox已经很久没有维护了，不兼容Spring Boot 3.x -->-- 引入1.5.22及以上版本的swagger组件，以解决example默认解析报错（NumberFormatException）的问题 -->Spring Boot版本是3.3.0。那么就针对这个修改pom引入就好了。在pom文件后面加上下面配置。
Spring Boot注解（Annotation）
刘大辉的博客
05-28 454
在Spring Boot中，注解（Annotation）是一种元数据形式，它可以在代码中提供信息，这些信息可以在运行时或编译时被处理。Spring Boot使用注解来实现依赖注入、事务管理、配置等功能。
Java高级---Spring Boot---3快速入门
B6665X的博客
05-28 632
demo├── mvnw└── src├── main│ │ └── (其他Java类文件)│ └── (其他资源文件)└── test└── (测试资源文件)pom.xml: Maven项目对象模型文件，定义项目的构建配置和依赖。: 存放主要的Java源代码。: 存放资源文件，如配置文件。: 存放测试代码。
Java高级---Spring Boot---1引言
B6665X的博客
05-28 669
​ Spring Boot是一个开源的Java框架，由Pivotal团队（现在是VMware的一部分）开发，它是Spring框架的一个模块，旨在。IMPORTANT]Spring Boot的核心目标是让开发者尽可能快速地运行和开发新的Spring项目。自动配置内嵌的HTTP服务器基于Java的配置可执行的JAR​Spring Boot通过提供简化的配置和快速启动的特性，帮助开发者专注于业务逻辑的实现，而不是花费大量时间在环境搭建和配置上，从而提高开发效率和应用程序的质量。
自定义springboot-starter
07-27
- *2* *3* [SpringBoot—自定义Starter篇](https://blog.csdn.net/m0_46571920/article/details/122910726)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值