手写一个starter

news2024/11/27 1:29:34

文章目录

      • starter命令规则
      • 项目演示
        • 新建工程
        • Pom引入依赖
        • 定义属性配置
        • 定义自动配置类
        • 配置EnableAutoConfiguration
        • 业务实现
        • 项目中使用

什么是Starter？Starter其实就是我们经常在maven中的导入的各种模块，自定义Starter可以快速的满足开发的需求，并且可以重复使用无需粘贴代码，直接从maven仓库中导入即可。那么我们如何自定义一个Starter呢？这里我们以自动记录接口请求时间为例（自定义Starter的知识点只需看主要部分即可）：

starter命令规则

这段话的大概意思就是，麻烦大家遵守这个命名规范：

Srping官方命名格式为：spring-boot-starter-{name}

非Spring官方建议命名格式：{name}-spring-boot-starter

项目演示

新建工程

首先新建一个maven 工程,名称定义为demo-spring-boot-starter
在这里插入图片描述

在这里插入图片描述

Pom引入依赖
<?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 http://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.0.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.llc</groupId>
    <artifactId>demo-spring-boot-starter</artifactId>
    <version>1.0.0</version>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
    </properties>


    <dependencies>
        <!-- 提供了自动装配功能-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <!-- 在编译时会自动收集配置类的条件，写到一个META-INF/spring-autoconfigure-metadata.json中-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
        </dependency>
        <!--记录日志会用到切面，所以需要引入-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <version>2.2.1</version>
                <executions>
                    <execution>
                        <id>attach-sources</id>
                        <goals>
                            <goal>jar-no-fork</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

spring-boot-autoconfigure :提供自动化装配功能，是为了Spring Boot 应用在各个模块提供自动化配置的作用；即加入对应 pom，就会有对应配置其作用；所以我们想要自动装配功能，就需要引入这个依赖。

spring-boot-configuration-processor：将自定义的配置类生成配置元数据，所以在引用自定义STARTER的工程的YML文件中，给自定义配置初始化时，会有属性名的提示；确保在使用@ConfigurationProperties注解时，可以优雅的读取配置信息，引入该依赖后，IDEA不会出现“spring boot configuration annotation processor not configured”的错误；编译之后会在META-INF 下生成一个spring-configuration-metadata.json 文件，大概内容就是定义的配置的元数据;

spring-boot-starter-aop ：记录日志，我们用到切面的功能，所以需要引入。

定义属性配置
package com.llc.config;


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

@Data
@ConfigurationProperties(prefix = "llc")
public class LogProperties {


    /**
     * 是否开启日志
     */
    private boolean enable;


    /**
     * 平台：不同服务使用的区分，默认取 spring.application.name
     */
    @Value("${spring.application.name:#{null}}")
    private String platform;


}

@ConfigurationProperties：该注解和@Value 注解作用类似，用于获取配置文件中属性定义并绑定到Java Bean 或者属性中；换句话来说就是将配置文件中的配置封装到JAVA 实体对象，方便使用和管理。

这边我们定义两个属性，一个是是否开启日志的开关，一个是标识平台的名称。

定义自动配置类
package com.llc.config;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

/**
 *
 * @author llc
 * @date 2023/11/14
 */
@Configuration
@ComponentScan("com.llc")
@ConditionalOnProperty(prefix = "llc",name = "enable",havingValue = "true",matchIfMissing = false)
@EnableConfigurationProperties({LogProperties.class})
public class LogAutoConfiguration {

}

这个类最关键了，它是整个starter 最重要的类，它就是将配置自动装载进spring-boot的。

配置EnableAutoConfiguration

在resources/META-INF/ 目录新建spring.factories 文件，配置内容如下；

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.llc.config.LogAutoConfiguration
业务实现
package com.llc.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestLog {
}

定义切面执行逻辑，这边就简单的打印一下配置文件的属性值+目标执行方法+耗时。

package com.llc.aop;

import com.llc.annotation.RequestLog;
import com.llc.config.LogProperties;
import lombok.AllArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;


@Aspect
@Component
@Slf4j
@AllArgsConstructor
public class LogAspectjProcess {


    LogProperties logProperties;


    /**
     * 定义切点
     */
    @Pointcut("@annotation(com.llc.annotation.RequestLog)")
    public void pointCut() {
    }


    /**
     * 环绕通知
     *
     * @param thisJoinPoint
     * @param requestLog
     * @return Object
     */
    @Around("pointCut() && @annotation(requestLog)")
    public Object around(ProceedingJoinPoint thisJoinPoint, RequestLog requestLog) {


        //执行方法名称
        String taskName = thisJoinPoint.getSignature()
                .toString().substring(
                        thisJoinPoint.getSignature()
                                .toString().indexOf(" "),
                        thisJoinPoint.getSignature().toString().indexOf("("));
        taskName = taskName.trim();
        long time = System.currentTimeMillis();
        Object result = null;
        try {
            result = thisJoinPoint.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        log.info("{} -- method:{} run :{} ms", logProperties.getPlatform(), taskName,
                (System.currentTimeMillis() - time));
        return result;


    }


}

整体项目结构就是这样子

在这里插入图片描述

starter这样就完成了
在这里插入图片描述
上传到maven仓库中。

项目中使用

引入pom

 <dependency>
            <groupId>com.llc</groupId>
            <artifactId>demo-spring-boot-starter</artifactId>
            <version>1.0.0</version>
 </dependency>

yml配置

在这里插入图片描述

测试
在这里插入图片描述

http://localhost:8080/test

在这里插入图片描述
转载地址：https://zhuanlan.zhihu.com/p/596170608

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

SOME/IP学习笔记3

SOME/IP学习笔记3

目录 1.SOMEIP Transformer 1.1 SOME/IP on-wire format 1.2 协议指定 2. SOMEIP TP 2.1 SOME/IP TP Header 3.小结 1.SOMEIP Transformer 根据autosar CP 相关规范&#xff0c;SOME/IP Transformer主要用于将SOME/IP格式的数据序列化&#xff0c;相当于一个转换器。总体…
阅读更多...
1、NPC 三电平SVPWM simulink仿真

1、NPC 三电平SVPWM simulink仿真

1、SVPWM时间计算函数&#xff0c;是从matlab的SVPWM3L_TimingCalculation.p文件中反汇编出来的函数&#xff1a; function [TgABC_On ,TgABC_Off ,Sn ]SVPWM3L_TimingCalculation_frompfile (Vref ,DeltaVdc ,Fsw ) %#codegen %coder .allowpcode (plain ); TgABC_On [0 ,0 ,…
阅读更多...
超级 App 的前端框架也可以足够轻量

超级 App 的前端框架也可以足够轻量

小程序技术自微信2016年提出并大力推动&#xff0c;如今已经成为了中国前端研发的“潮流”&#xff0c;或者说是“趋势”。早期&#xff0c;微信小程序是微信公众平台推出的一种应用形态。微信小程序开放平台允许开发者在微信内直接开发和发布应用&#xff0c;用户无需下载安装…
阅读更多...
使用Python轻松实现科研绘图

使用Python轻松实现科研绘图

当撰写在学术期刊上发表的文章时&#xff0c;图表的布局和风格应符合预定义的格式要求。这样可以确保该出版物的所有文章都具有一致的风格&#xff0c;并且任何包含的图表在打印时都是高质量的。 Python在科学界广泛使用&#xff0c;并提供了创建科学绘图的好方法。然而&#…
阅读更多...
如何正确使用 JavaScript 中的 slice() 方法

如何正确使用 JavaScript 中的 slice() 方法

在 JavaScript 中&#xff0c;slice() 是一个常用的数组方法&#xff0c;用于从现有数组中提取一部分元素&#xff0c;然后返回一个新的数组。它是一个非常有用的工具&#xff0c;可以帮助你在不改变原始数组的情况下操作数组的子集。本文将介绍 slice() 的基本概念、使用方法、…
阅读更多...
云课五分钟-02第一个代码复现-终端甜甜圈C++

云课五分钟-02第一个代码复现-终端甜甜圈C++

前篇 云课五分钟-01课程在哪里-无需安装网页直达- 代码复现通过云课&#xff0c;会非常快捷。 视频 云课五分钟-02第一个代码复现-终端甜甜圈C 文本 如何使用g 使用g编译和链接C程序的基本步骤如下&#xff1a; 编写源代码&#xff1a;首先&#xff0c;你需要编写C源代码&…
阅读更多...
关于dinput8.dll丢失的问题，提供六种解决办法

关于dinput8.dll丢失的问题，提供六种解决办法

不知dinput8.dll文件大家是否有所了解&#xff0c;或者你的电脑中是否出现过关于dinput8.dll文件丢失问题。如果你的电脑中出现了关于dinput8.dll丢失的问题&#xff0c;那么这篇文章给大家提供六种解决dinput8.dll丢失的办法。希望能够帮助大家解决dinput8.dll丢失。 一.dinpu…
阅读更多...
XETUX 软件 dynamiccontent.properties.xhtml 远程代码执行漏洞

XETUX 软件 dynamiccontent.properties.xhtml 远程代码执行漏洞

XETUX 软件 dynamiccontent.properties.xhtml 远程代码执行漏洞 一、漏洞描述二、FOFA资产三、漏扫复现自动化检测 四、修复建议 免责声明&#xff1a;请勿利用文章内的相关技术从事非法测试&#xff0c;由于传播、利用此文所提供的信息或者工具而造成的任何直接或者间接的后果…
阅读更多...
在PKPM中主梁与次梁有哪些区别？

在PKPM中主梁与次梁有哪些区别？

在PKPM中主梁与次梁有哪些区别&#xff1f; 一、按主菜单1输入次梁比较方便&#xff0c;按主菜单2输入的次梁只能以房间为单元输入&#xff0c;比较麻烦&#xff1b; 二、按主菜单1输入次梁会增加大量无柱连接节点&#xff0c;增加大量房间&#xff0c;平面房间碎小&#xff…
阅读更多...
从申请服务器到Docker部署Java项目至最后运行完结

从申请服务器到Docker部署Java项目至最后运行完结

目录 1.申请服务器篇 2.配置安全组篇 3.Docker安装篇 4.代码编写打包篇 目录结构 Maven Controller DockerFile 开始打包 5.所需文件上传及镜像构建篇 上传准备 上传jar包及DockerFile文件 指令构建 验证 6.镜像启动服务验证篇 启动镜像 使用云服务器地址进行…
阅读更多...
Android Matrix的使用详解（通过矩阵获取到图片缩放比例和角度）

Android Matrix的使用详解（通过矩阵获取到图片缩放比例和角度）

网上查了好久相关的资料&#xff0c;都没有明确的答案。最终通过多次测试结果&#xff0c;结合安卓定义的矩阵含义&#xff0c;推算出来矩阵的数学含义以及相关的计算公式 1.获取Matrix矩阵&#xff1a; Matrix matrix new Matrix(); float[] matrixValues new float[9]; …
阅读更多...
给正在做自动化测试工程师的一些小建议

给正在做自动化测试工程师的一些小建议

什么自动化测试&#xff1f; 做测试好几年了&#xff0c;真正学习和实践自动化测试一年&#xff0c;自我感觉这一个年中收获许多。一直想动笔写一篇文章分享自动化测试实践中的一些经验。终于决定花点时间来做这件事儿。 首先理清自动化测试的概念&#xff0c;广义上来讲&#…
阅读更多...
Vue项目的学习一

Vue项目的学习一

1、Vue项目里面的.js文件里面对象添加属性 例如&#xff1a;在对象&#xff1a;row&#xff0c;需要在对象row里面添加一个属性状态&#xff1a;type&#xff0c;使用里面的Vue.set函数 Vue.set(参数1,参数2,参数3) Vue.set(row,type,false)解析&#xff1a; 参数1&#xff1…
阅读更多...
【Hello Algorithm】单调栈（未完待续）

【Hello Algorithm】单调栈（未完待续）

单调栈解决的问题 我们单调栈的提出主要是为了解决这么一个问题 现在给我们一个数组 现在要求你建立一张表 这张表中能够查询到两个信息 这两个信息分别是 当前数字左边小于该数字并且下标位置最相近的下标当前数字右边小于该数字并且下标位置最相近的下标 同理 大于也可以…
阅读更多...
海康设备接入安防监控系统EasyCVR平台实现语音对讲的必要操作步骤

海康设备接入安防监控系统EasyCVR平台实现语音对讲的必要操作步骤

安防监控系统EasyCVR平台可拓展性强、视频能力灵活&#xff0c;平台可提供视频监控直播、云端录像、云存储、录像检索与回看、智能告警、平台级联、云台控制、语音对讲、智能分析接入等功能。其中&#xff0c;在语音对讲方面&#xff0c;EasyCVR平台目前可兼容海康设备的对讲。…
阅读更多...
Vue3弹性布局（Flex）

Vue3弹性布局（Flex）

效果如下图&#xff1a;在线预览 APIs 参数说明类型默认值必传width区域总宽度string | number‘auto’falseverticalflex 主轴的方向是否垂直&#xff0c;vertical 使用 flex-direction: columnbooleanfalsefalsewrap设置元素单行显示还是多行显示&#xff1b;参考 flex-wrap…
阅读更多...
Word或者WPS批量调整文中图片大小的快捷方法

Word或者WPS批量调整文中图片大小的快捷方法

文章目录 0、前言1、编写宏代码2、在文档中调用宏实现一键批量调整3、就这么简单&#xff01; 0、前言 不知道大家是不是也和我一样&#xff0c;经常需要在编写的Word&#xff08;或者WPS&#xff09;文档里插入大量的图片&#xff0c;但是这些图片的尺寸大小一般都不一样&…
阅读更多...
Accelerate 0.24.0文档 二：DeepSpeed集成

Accelerate 0.24.0文档 二：DeepSpeed集成

文章目录 一、 DeepSpeed简介二、DeepSpeed集成&#xff08;Accelerate 0.24.0&#xff09;2.1 DeepSpeed安装2.2 Accelerate DeepSpeed Plugin2.2.1 ZeRO Stage-22.2.2 ZeRO Stage-3 with CPU Offload2.2.3 accelerate launch参数 2.3 DeepSpeed Config File2.3.1 ZeRO Stage-…
阅读更多...
Git 安装配置

Git 安装配置

目录 Linux 平台上安装 Debian/Ubuntu Centos/RedHat 源码安装 Windows 平台上安装 Mac 平台上安装 Git 配置 用户信息 文本编辑器 差异分析工具 查看配置信息 在使用Git前我们需要先安装 Git。Git 目前支持 Linux/Unix、Solaris、Mac和 Windows 平台上运行。 Git …
阅读更多...
简单描述下微信小程序的相关文件以及类型？

简单描述下微信小程序的相关文件以及类型？

目录 前言 相关文件类型 1. JSON 配置文件 2. WXML 文件 3. WXSS 文件 4. JavaScript 文件 图片、音频、视频等资源文件 小程序配置文件&#xff08;project.config.json&#xff09; 理解 优缺点 优点&#xff1a; 缺点&#xff1a; 总结 结尾 前言 微信小程序…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023