【Spring Boot】Starter机制的使用及案例

一、引言

1、什么是SpringBoot Starter

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

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

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

2、为什么要使用SpringBoot Starter

  1. 简化配置：通过使用Starter，开发者可以减少手动添加和配置依赖的工作量。Starter通常包含了许多相关的依赖项，以及一些配置模板和自动配置功能，使用者可以非常方便地将其引入到应用程序中，并快速地获得相关的功能。
  2. 统一管理：Starter能够将相关依赖和配置统一集成进一个模块，这使得项目的依赖管理更加清晰和有序。
  3. 自动配置：SpringBoot的Starter机制能够自动扫描并加载相应的模块信息，从而减少了开发者手动配置的工作量，提高了开发效率。
  4. 方便团队协作：由于Starter的使用，开发者无需关心复杂的依赖关系和配置，只需关注业务逻辑的开发，这有助于提高团队协作的效率。

3、应用场景

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

常见应用场景：

  1. 通用模块-短信发送模块
  2. 基于AOP技术实现日志切面
  3. 分布式雪花ID，Long转String，解决精度问题
  4. 微服务项目的数据库连接池配置
  5. 微服务项目的每个模块都要访问redis数据库，每个模块都要配置redisTemplate

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

SpringBoot的自动加载核心注解是@SpringBootApplication。这个注解是Spring Boot最核心的注解，用于标识这是一个Spring Boot应用，并开启Spring Boot的各项能力。

实际上，@SpringBootApplication注解主要组合了以下几个核心注解：

  1. @Configuration：表示这是一个配置类，Spring Boot会为这个类生成一个默认的bean定义。
  2. @EnableAutoConfiguration：这是Spring Boot自动配置的核心注解，它会根据项目的依赖情况自动进行bean的定义和属性的配置。
  3. @ComponentScan：这个注解用于扫描当前类所在的包及其子包，找到标注了@Component, @Service, @Repository等注解的类，并将其定义成bean。

5、命名规范

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

二、综合案例

1、模拟短信发送

①创建配置类Properties

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

package com.zl.smsspringbootstart;

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Controller;

@Data
//@Component
//@ConfigurationProperties 会自动去yml文件中找到需要的配置将它放到对应的属性中
@ConfigurationProperties(prefix = "sms")
public class SmsProperties {

    /**
     * 应用标识
     */
//    @Value("${sms.key}")
    private String key;
    /**
     * 应用密钥
     */
//    @Value("${sms.secret}")
    private String secret;
    /**
     * 关闭
     */
    private String enable;

}

②编写短信业务功能

service

package com.zl.smsspringbootstart.service;

public interface ISmsService {

    /**
     * 发送短信
     *
     * @param phone        要发送的手机号
     * @param data         要发送的内容
     */
    void send(String phone, String data);

}

接口实现impl

package com.zl.smsspringbootstart.service.impl;


import com.zl.smsspringbootstart.SmsProperties;
import com.zl.smsspringbootstart.service.ISmsService;

public class SmsServiceImpl implements ISmsService {

    private SmsProperties smsProperties; //null

    public SmsServiceImpl(SmsProperties smsProperties) {
        this.smsProperties = smsProperties;
    }

    @Override
    public void send(String phone, String data) {
        String key = smsProperties.getKey();
        String secret = smsProperties.getSecret();
        System.out.println("接入短信系统，Key=" + key + ",Secret=" + secret);
        System.out.println("短信发送，phone=" + phone + ",data=" + data);
    }

}

③创建自动配置类

@EnableConfigurationProperties注解的作用是@ConfigurationProperties注解生效。

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

package com.zl.smsspringbootstart;

import com.zl.smsspringbootstart.service.ISmsService;
import com.zl.smsspringbootstart.service.impl.SmsServiceImpl;
import org.springframework.beans.factory.annotation.Autowired;
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;

@Configuration
//开启配置加载
@EnableConfigurationProperties({SmsProperties.class})
//添加一个条件 sms.enable
@ConditionalOnProperty(prefix = "sms", name = "enable", havingValue = "true")
public class SmsConfig {

    //控制当前的service是否加载到spring里面去

    @Autowired
    private SmsProperties smsProperties;

    //@Bean 方法会在spring运行的时候自动执行,返回值会被放到spring容器中
    @Bean
    public ISmsService smsService() {
        return new SmsServiceImpl(smsProperties);
    }

}

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

在resources下新建META-INF文件夹，然后创建spring.factories文件。在该文件中加入如下配置，该配置指定上步骤中定义的配置类为自动装配的配置：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zl.smsspringbootstart.SmsConfig

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

⑤打包

⑥其他项目引用

  1. 引入依赖 
            <dependency>
            <groupId>com.zl</groupId>
            <artifactId>sms-spring-boot-start</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

  2. 配置application.yml文件
    enable如果为false则不使用

    # 配置
sms:
  key: 11115
  secret: 100006
  enable: true

  3. 创建Junit测试
     

    package com.example.springboot01;

import com.zl.smsspringbootstart.service.ISmsService;
import com.zl.weblog.WebLogProperties;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class Springboot01ApplicationTests {

    //    使用短信功能
    @Autowired
    private ISmsService iSmsService;

    @Test
    void contextLoads() {
        iSmsService.send("137", "123456");
    }

}

  4. 测试结果

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

①创建配置类Properties

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

package com.zl.weblog;

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

// 添加@ConfigurationProperties注解，将配置文件中的属性映射到WebLogProperties类中
@ConfigurationProperties(prefix = "spcloud.weblog")
public class WebLogProperties {
    // 定义一个boolean类型的变量
    private boolean enabled;

    // 构造函数
    public WebLogProperties() {
    }

    // 获取enabled属性
    public boolean isEnabled() {
        return enabled;
    }

    // 设置enabled属性
    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }
}

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

package com.zl.weblog;

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.zl..controller.*.*(..))")
    // 定义一个切入点，拦截com.zl..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);
    }
}

③创建自动配置类

package com.zl.weblog;

//import com.zl.spcloudspringbootstarter.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",matchIfMissing = true)
public class WebLogConfig {

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

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

在resources下新建META-INF文件夹，然后创建spring.factories文件。在该文件中加入如下配置，该配置指定上步骤中定义的配置类为自动装配的配置：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zl.weblog.WebLogConfig

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

⑤打包

⑥其他项目引用

  1. 引入依赖 
    <!--        切面-->
        <dependency>
            <groupId>com.zl</groupId>
            <artifactId>WebLog</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>

  2. 配置application.yml文件
    enable如果为false则不使用

    # 配置
spcloud:
  weblog:
    enabled: true

  3. 创建Controller层测试
    在这里可以使用自己的Controller层测试

    package com.example.springboot01.controller;

import com.example.springboot01.entity.TBook;
import com.example.springboot01.page.PageBean;
import com.example.springboot01.service.TBookService;
import com.github.pagehelper.PageHelper;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/book")
public class TBookController {
    @Autowired
    private TBookService tBookService;


    @RequestMapping("/list")
    public Object list2(PageBean pageBean) {
        List<TBook> tBooks = tBookService.selectAll(pageBean);
        return tBooks;
    }
}

  4. 测试结果

分享就到这里！欢迎搭建在评论区进行讨论！

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/247466.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

【MIMO 从入门到精通】[P3]【Channel Estimation】

【MIMO 从入门到精通】[P3]【Channel Estimation】

前言&#xff1a; MIMO 是无线通讯里面的核心技术之一.这里面主要参考 《Quick Introduction to MIMO Channel Estimation》 Professor and an IEEE Fellow&#xff1a;Iain 讲解一下 MIMO &#xff08;multiple transmit antennas and multiple receivers&#xff09;里面的信…
阅读更多...
电脑出现错误0x80004005怎么解决，解决0x80004005的问题

电脑出现错误0x80004005怎么解决，解决0x80004005的问题

当电脑出现0x80004005错误时&#xff0c;通常是由于系统或应用程序之间的通信问题或文件系统损坏引起的。该错误代码表示未指定错误&#xff0c;在Windows系统中较为常见。 一.解决0x80004005错误的步骤 重新启动电脑 有时候&#xff0c;错误只是一个暂时的问题&#xff0c;重…
阅读更多...
后端项目操作数据库-中枢组件Service调用Mapper实现增删改查-实例

后端项目操作数据库-中枢组件Service调用Mapper实现增删改查-实例

接上篇 使用MyBatis配置Mapper实现增删改查 1.Service的基本作用 Service在代码中的的作用是调用Mapper、被Controller调用。是后端项目中非常重要的组件。 用于设计业务流程、业务逻辑&#xff0c;以保障数据的完整性、有效性、安全性。 2. Service使用举例——“添加相册”…
阅读更多...
MyBatis的逆向工程

MyBatis的逆向工程

MyBatis的逆向工程 正向工程&#xff1a;先创建Java实体类&#xff0c;由框架负责根据实体类生成数据库表。 Hibernate是支持正向工 程的 逆向工程&#xff1a;先创建数据库表&#xff0c;由框架负责根据数据库表&#xff0c;反向生成如下资源&#xff1a; Java实体类 Mapp…
阅读更多...
【Trino权威指南（第二版）】Trino的架构、trino架构组件、 trino连接器架构的细节、trino的查询执行模型

【Trino权威指南（第二版）】Trino的架构、trino架构组件、 trino连接器架构的细节、trino的查询执行模型

文章目录 一. Trino架构1. 架构概览2. 协调器3. 发现服务4. 工作节点 二. 基于连接器的架构三. 查询执行模型1. 解析—>查询计划2. 查询计划 —> 分布式查询计划3. 运行阶段3.1. 基础概念切片&#xff1a;并行单元page 与 exchange算子pipeline切片的driverOperator 3.2.…
阅读更多...
Python高级算法——线性规划（Linear Programming）

Python高级算法——线性规划（Linear Programming）

Python中的线性规划&#xff08;Linear Programming&#xff09;&#xff1a;高级算法解析 线性规划是一种数学优化方法&#xff0c;用于求解线性目标函数在线性约束条件下的最优解。它在运筹学、经济学、工程等领域得到广泛应用。本文将深入讲解Python中的线性规划&#xff0…
阅读更多...
连续型随机变量的概率密度

连续型随机变量的概率密度

如果对于随机变量的分布函数&#xff0c;存在非负可积函数&#xff0c;使得对于任意实数&#xff0c;有&#xff1a; 那么就称为连续型随机变量&#xff0c;称为的概率密度函数&#xff0c;简称密度函数。
阅读更多...
微信小程序合集更更更之实现雪花随机飘落

微信小程序合集更更更之实现雪花随机飘落

实现效果 写在最后&#x1f352; 更多相关内容&#xff0c;关注&#x1f365;苏苏的bug&#xff0c;&#x1f361;苏苏的github&#xff0c;&#x1f36a;苏苏的码云~
阅读更多...
为MES实施建立成功的团队：应对挑战并确保成功

为MES实施建立成功的团队：应对挑战并确保成功

前言 实施MES是一个复杂且具有挑战性的过程&#xff0c;需要协调良好的团队共同努力。 为了取得成功&#xff0c;建立一支具有专业技能、专业知识和共同愿景的团队组合成为致胜的关键。本文将探讨组建MES团队的关键要素&#xff0c;例如&#xff1a; 确定关键利益相关者和决策…
阅读更多...
产品经理之Axure的元件库使用详细案例

产品经理之Axure的元件库使用详细案例

⭐⭐ 产品经理专栏&#xff1a;产品专栏 ⭐⭐ 个人主页&#xff1a;个人主页 ​ 目录 前言 一.Axure的元件库的使用 1.1 元件介绍 1.2 基本元件的使用 1.2.1 矩形、按钮、标题的使用 1.2.2 图片及热区的使用 1.3 表单元件及表格元件的使用 1.3.1表单元件的使用 1.3.…
阅读更多...
VSCode解决本地浏览器需要跨域问题

VSCode解决本地浏览器需要跨域问题

这里写目录标题 测试用代码执行代码后控制台报错现象解决方案 测试用代码 先把测试用的代码贴出来 测试代码结构 index.html <!DOCTYPE html> <html lang"en"> <head><meta charset"UTF-8"><meta http-equiv"X-UA-Com…
阅读更多...
基于CNN+数据增强+残差网络Resnet50的少样本高准确度猫咪种类识别—深度学习算法应用(含全部工程源码)+数据集+模型（四）

基于CNN+数据增强+残差网络Resnet50的少样本高准确度猫咪种类识别—深度学习算法应用(含全部工程源码)+数据集+模型（四）

系列文章目录 基于CNN数据增强残差网络Resnet50的少样本高准确度猫咪种类识别—深度学习算法应用(含全部工程源码)数据集模型&#xff08;一&#xff09; 基于CNN数据增强残差网络Resnet50的少样本高准确度猫咪种类识别—深度学习算法应用(含全部工程源码)数据集模型&#xf…
阅读更多...
飞天使-docker知识点8-docker的资源限制

飞天使-docker知识点8-docker的资源限制

文章目录 容器资源限制示例 容器资源限制 Docker提供了多种资源限制的方式&#xff0c;可以根据应用程序的需求和系统资源的可用性进行选择。以下是一些常见的Docker资源限制及其使用情况&#xff1a;CPU限制&#xff1a;通过设置CPU的配额&#xff08;quota&#xff09;和周期…
阅读更多...
YOLOv8-Seg改进：UniRepLKNetBlock 助力分割 | UniRepLKNet，通用感知大内核卷积网络, 2023.12

YOLOv8-Seg改进：UniRepLKNetBlock 助力分割 | UniRepLKNet，通用感知大内核卷积网络, 2023.12

🚀🚀🚀本文改进： UniRepLKNet，通用感知大内核卷积网络，ImageNet-22K预训练，精度 和速度SOTA，ImageNet达到88%, COCO达到56.4 box AP，ADE20K达到55.6 mIoU UniRepLKNetBlock 与C2f进行结合使用 🚀🚀🚀YOLOv8-seg创新专栏：http://t.csdnimg.cn/KLSdv 学姐带…
阅读更多...
安装NLTK Data

安装NLTK Data

文章目录 NLTK离线安装1. 获取安装包2. 放置nltk_data文件3. Demo4. 参考链接 关注公众号&#xff1a;『AI学习星球』 算法学习、4对1辅导、论文辅导或核心期刊可以通过公众号或CSDN滴滴我 nltk库是python语言为自然语言处理提供的一个功能强大&#xff0c;简单易用的函数库&a…
阅读更多...
AUTOSAR组织引入了Rust语言的原因是什么？有哪些好处？与C++相比它有什么优点？并推荐一些入门学习Rust语言链接等

AUTOSAR组织引入了Rust语言的原因是什么？有哪些好处？与C++相比它有什么优点？并推荐一些入门学习Rust语言链接等

AUTOSAR（汽车开放系统架构）是一个由汽车制造商、供应商和其他来自电子、半导体和软件行业的公司组成的全球发展伙伴关系，自2003年以来一直致力于为汽车行业开发和引入开放、标准化的软件平台。 AUTOSAR 最近宣布成立一个新的工作组，用于探索在汽车软件中使用 Rust 编程语言…
阅读更多...
python初试二

python初试二

连接数据库 Django为多种数据库后台提供了统一的调用API。根据需求不同&#xff0c;Django可以选择不同的数据库后台。MySQL算是最常用的数据库。我们这里将Django和MySQL连接。 在Linux终端下启动mysql: $mysql -u root -p 在MySQL中创立Django项目的数据库&#xff1a; …
阅读更多...
Python—KNN分类算法

Python—KNN分类算法

原文: https://zhuanlan.zhihu.com/p/143092725 1. 概述 KNN 可以说是最简单的分类算法之一&#xff0c;同时&#xff0c;它也是最常用的分类算法之一。注意&#xff1a;KNN 算法是有监督学习中的分类算法&#xff0c;它看起来和另一个机器学习算法 K-means 有点像&#xff0…
阅读更多...
山峰个数 - 华为OD统一考试

山峰个数 - 华为OD统一考试

OD统一考试 分值： 100分 题解： Java / Python / C++ 题目描述 给定一个数组，数组中的每个元素代表该位置的海拔高度。0表示平地，>=1时表示属于某个山峰，山峰的定义为当某个位置的左右海拔均小于自己的海拔时，该位置为山峰。数组起始位置计算时可只满足一边的条件。 …
阅读更多...
【Hive】——CLI客户端(bin/beeline，bin/hive)

【Hive】——CLI客户端(bin/beeline，bin/hive)

1 HiveServer、HiveServer2 2 bin/hive 、bin/beeline 区别 3 bin/hive 客户端 hive-site.xml 配置远程 MateStore 地址 XML <?xml version"1.0" encoding"UTF-8" standalone"no"?> <?xml-stylesheet type"text/xsl" hre…
阅读更多...
最新文章

Copyright @ 2022~2023