Springboot自定义starter

一、start背景和简介

1.背景

工作中经常需要将多个springboot项目共同的非业务模块抽取出来，比如访问日志、维护请求上下文中的用户信息或者链路id等等。此次模拟的是请求中用户信息维护，方便整个请求中用户信息的取用。

2.作用

根据项目组的实际需求，封装starter，可以简化开发，统一规范的效果。

3.规范

官方的starter包规范：spring-boot-starter-xxx

自定义starter包规范：xxx-spring-boot-starter

二、stater定义

1.创建maven项目（trace-spring-boot-stater），并添加依赖

<?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><groupId>com.su</groupId><artifactId>trace-spring-boot-starter</artifactId><version>1.0-SNAPSHOT</version><!-- 引入 Spring Boot 统一版本父项目管理依赖 --><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.3.4.RELEASE</version></parent><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-autoconfigure</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId><optional>true</optional></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.18.24</version></dependency><dependency><groupId>com.alibaba</groupId><artifactId>transmittable-thread-local</artifactId><version>2.13.2</version></dependency><dependency><groupId>org.apache.commons</groupId><artifactId>commons-lang3</artifactId></dependency></dependencies></project>

2.UserInfo  定义请求上下文内容的类

@Data
public class UserInfo {private String traceId;private String spanId;private String userNo;
}

3.UserContext 实现同一个或父子线程中上下文用户信息的取用

public class UserContext {public static final TransmittableThreadLocal<UserInfo> userInfo = new TransmittableThreadLocal<>();private UserContext() {}public static void set(UserInfo user) {userInfo.set(user);}public static UserInfo get() {return (UserInfo) userInfo.get();}public static void remove() {userInfo.remove();}public static String userNo() {UserInfo userInfo = (UserInfo) UserContext.userInfo.get();return Objects.isNull(userInfo) ? null : userInfo.getUserNo();}
}

4.UserContextInterceptor 拦截器，拦截请求中的信息并存储

@Slf4j
@Component
public class UserContextInterceptor implements HandlerInterceptor {private static final String TRACE_ID = "traceId";private static final String SPAN_ID = "spanId";private static final String APP_ID = "appId";private static final String USER_NO = "userNo";@Resourceprivate AppIdsConfig appIdsConfig;@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {// 验证请求方的 AppIdString appId = request.getHeader(APP_ID);Set<String> appIdsSet = appIdsConfig.getIdsSet();if (StringUtils.isBlank(appId) || CollectionUtils.isEmpty(appIdsSet) || !appIdsSet.contains(appId)) {returnJson(response, ComResponse.fail(ResponseCodeEnums.AUTHOR_ERROR_CODE));return false;}String spanId = UUIDGenerator.getUUID();String traceId = request.getHeader(TRACE_ID);String userNo = request.getHeader(USER_NO);if (StringUtils.isEmpty(traceId)) {traceId = UUIDGenerator.getUUID();}UserInfo userInfo = new UserInfo();userInfo.setUserNo(userNo);userInfo.setTraceId(traceId);userInfo.setSpanId(spanId);UserContext.set(userInfo);MDC.put(TRACE_ID, traceId);MDC.put(SPAN_ID, spanId);log.info("{requestServer:{},traceId:{},spanId:{}}", appId, traceId, spanId);return true;}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {UserContext.remove();MDC.remove(TRACE_ID);MDC.remove(SPAN_ID);}private void returnJson(HttpServletResponse response, ComResponse<Object> result) {response.setCharacterEncoding("UTF-8");response.setStatus(HttpStatus.UNAUTHORIZED.value());response.setContentType("application/json;charset=UTF-8");try (PrintWriter writer = response.getWriter()) {writer.print(JacksonUtil.toJsonString(result));} catch (IOException e) {log.error("response error", e);}}
}

5.AppIdsConfig配置类，读取配置文件中的信息

注意：使用@ConfigurationProperties的好处是懒加载，如果配置文件中没有配置也不会报错。

如果使用@Value，如果配置文件中找不到，则会报错

@ConfigurationProperties(prefix = "app")
@Component
public class AppIdsConfig {private String ids;private Set<String> idsSet;public String getIds() {return ids;}public void setIds(String ids) {this.ids = ids;if(StringUtils.isNotEmpty(ids)){this.idsSet = org.springframework.util.StringUtils.commaDelimitedListToSet(ids);}else{this.idsSet = Collections.emptySet();}}public Set<String> getIdsSet() {return idsSet;}}

6.配置拦截器

@Configuration
public class TraceConfiguration implements WebMvcConfigurer {@Resourceprivate UserContextInterceptor userContextInterceptor;@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(userContextInterceptor).addPathPatterns("/**").excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/doc.html/**");}@Overridepublic void configureMessageConverters(List<HttpMessageConverter<?>> converters) {MappingJackson2HttpMessageConverter jackson2HttpMessageConverter = new MappingJackson2HttpMessageConverter();ObjectMapper objectMapper = new ObjectMapper();objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);objectMapper.registerModule(new JavaTimeModule());}@Overridepublic void addResourceHandlers(ResourceHandlerRegistry registry) {registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");}
}

7.最后重点，创建配置文件，把需要自动装载的类配置上

我用的springboot3以下版本，所以在resource/META-INF下新建一个spring.factories文件，添加配置：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\com.su.trace.configure.TraceConfiguration

8.maven打包 clean,install/deploy

三、引用stater

在其他项目是使用上边自定义的starter

1.添加依赖

 <dependency><groupId>com.su</groupId><artifactId>trace-spring-boot-starter</artifactId><version>1.0-SNAPSHOT</version></dependency>

2.添加配置文件内容（如果多个项目的配置内容一致，可以考虑将配置信息放到公共配置里）

app.ids=activity,crm,order,product,customer

3.测试类

@Slf4j
@RestController
@RequestMapping("test")
public class TestController {@GetMapping("/trace")public void testTrace(){log.info("userID:{}", UserContext.userNo());}}

4.测试

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

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

相关文章

【WPF.NET开发】创建简单WPF应用

【WPF.NET开发】创建简单WPF应用

本文内容 先决条件什么是 WPF&#xff1f;配置 IDE创建项目设计用户界面 (UI)调试并测试应用程序 通过本文你将熟悉在使用 Visual Studio 开发应用程序时可使用的许多工具、对话框和设计器。 你将创建“Hello, World”应用程序、设计 UI、添加代码并调试错误。在此期间&#…
阅读更多...
策略设计模式

策略设计模式

package com.jmj.pattern.strategy;public interface Strategy {void show(); }package com.jmj.pattern.strategy;public class StrategyA implements Strategy{Overridepublic void show() {System.out.println("买一送一");} }package com.jmj.pattern.strategy;p…
阅读更多...
Raft 算法

Raft 算法

Raft 算法 1 背景 当今的数据中心和应用程序在高度动态的环境中运行&#xff0c;为了应对高度动态的环境&#xff0c;它们通过额外的服务器进行横向扩展&#xff0c;并且根据需求进行扩展和收缩。同时&#xff0c;服务器和网络故障也很常见。 因此&#xff0c;系统必须在正常…
阅读更多...
组件化编程

组件化编程

hello&#xff0c;我是小索奇&#xff0c;精心制作的Vue系列持续发放&#xff0c;涵盖大量的经验和示例&#xff0c;如果对您有用&#xff0c;可以点赞收藏哈~ 组件化编程 组件是什么&#xff1f; 一句话概括就是&#xff1a;实现特定功能的模块化代码单元 vm就是大哥&#xff…
阅读更多...
flink源码分析之功能组件(四)-slot管理组件II

flink源码分析之功能组件(四)-slot管理组件II

简介 本系列是flink源码分析的第二个系列&#xff0c;上一个《flink源码分析之集群与资源》分析集群与资源&#xff0c;本系列分析功能组件&#xff0c;kubeclient&#xff0c;rpc&#xff0c;心跳&#xff0c;高可用&#xff0c;slotpool&#xff0c;rest&#xff0c;metrics&…
阅读更多...
各种外部排序的总结

各种外部排序的总结

多路归并 败者树 置换选择排序 最佳归并树
阅读更多...
linux进程优先级_nice

linux进程优先级_nice

4.1.3.4 进程优先级&#xff1a;nice nice以更改过的优先序来执行程序&#xff0c;如果未指定程序&#xff0c;则会印出目前的排程优先序&#xff0c;内定的 adjustment 为 10&#xff0c;范围为 -20&#xff08;最高优先序&#xff09;到 19&#xff08;最低优先序&#xff0…
阅读更多...
认识K线形态，把握买入卖出时机

认识K线形态，把握买入卖出时机

一、认识K线 1、K线的含义 股票一天之内有4个最关键的价格&#xff0c;开盘价、收盘价、最高价和最低价&#xff0c;把这个价格显示在图上就是K线图。 以金斗云智投电脑版为例&#xff0c;打开软件&#xff0c;任意搜索一支个股&#xff0c;就可以看到这支股票的K线。 股市新…
阅读更多...
数据链路层之网桥

数据链路层之网桥

学习的最大理由是想摆脱平庸&#xff0c;早一天就多一份人生的精彩&#xff1b;迟一天就多一天平庸的困扰。各位小伙伴&#xff0c;如果您&#xff1a; 想系统/深入学习某技术知识点… 一个人摸索学习很难坚持&#xff0c;想组团高效学习… 想写博客但无从下手&#xff0c;急需…
阅读更多...
更改AndroidStudio模拟器位置

更改AndroidStudio模拟器位置

C盘何等的珍贵&#xff0c;可是好多工具&#xff0c;软件非得默认安装在C盘。。导致C盘越来越紧张。。 在日常使用过程中&#xff0c;安装任何软件都会将其安装到非系统盘下&#xff0c;Android模拟器也不能例外。保护好C盘也是日常一个良好的习惯。 Android AVD默认路径&…
阅读更多...
深入理解Servlet(下)

深入理解Servlet(下)

作者简介&#xff1a;大家好&#xff0c;我是smart哥&#xff0c;前中兴通讯、美团架构师&#xff0c;现某互联网公司CTO 联系qq&#xff1a;184480602&#xff0c;加我进群&#xff0c;大家一起学习&#xff0c;一起进步&#xff0c;一起对抗互联网寒冬 在这一篇文章里&#x…
阅读更多...
hive里如何高效生成唯一ID

hive里如何高效生成唯一ID

常见的方式&#xff1a; hive里最常用的方式生成唯一id&#xff0c;就是直接使用 row_number() 来进行&#xff0c;这个对于小数据量是ok的&#xff0c;但是当数据量大的时候会导致&#xff0c;数据倾斜&#xff0c;因为最后生成全局唯一id的时候&#xff0c;这个任务是放在一个…
阅读更多...
工业机器视觉megauging（向光有光）使用说明书（十二，轻量级的visionpro）

工业机器视觉megauging（向光有光）使用说明书（十二，轻量级的visionpro）

关于最后一个工具的介绍&#xff1a;就是这个“相机图像” 我们可以鼠标双击点进去看一看&#xff1a; 在图像上点击&#xff0c;就可以截取一块图像&#xff0c;是可以放大缩小的&#xff0c;这个放大很low&#xff0c;是我以前研究缩放入门时的版本&#xff0c;本想删除&…
阅读更多...
机器学习笔记 - 异常检测之OneClass SVM算法简述

机器学习笔记 - 异常检测之OneClass SVM算法简述

一、异常检测是什么？ 如下图，理想中我们可以找到一个框住大部分正常样本的决策边界，而在边界外部的数据点（蓝点）即视为异常。 但实际情况下数据都没有标签，因此很难定义正常还是不正常。异常检测的主要挑战如下：正常与异常行为之间的界限往往并不明确、不同的应…
阅读更多...
数字媒体技术基础之：常见字体类型

数字媒体技术基础之：常见字体类型

字体 Font在数字设计和排版中起着至关重要的作用&#xff0c;不同的字体类型为文本呈现和创意表达提供了丰富多样的可能性。 .fon 字体 .fon 文件是 Windows 早期系统中使用的一种字体文件格式。 特点&#xff1a; 1、基于像素的位图字体。 2、不支持无损缩放&#xff0c;主要用…
阅读更多...
MATLAB实战 | S函数的设计与应用

MATLAB实战 | S函数的设计与应用

S函数用于开发新的Simulink通用功能模块&#xff0c;是一种对模块库进行扩展的工具。S函数可以采用MATLAB语言、C、C、FORTRAN、Ada等语言编写。在S函数中使用文本方式输入公式、方程&#xff0c;非常适合复杂动态系统的数学描述&#xff0c;并且在仿真过程中可以对仿真进行更精…
阅读更多...
a-table：表格组件常用功能记录——基础积累

a-table：表格组件常用功能记录——基础积累

antdvue是我目前项目的主流&#xff0c;在工作过程中&#xff0c;经常用到table组件。下面就记录一下工作中经常用到的部分知识点。 table组件 <a-table :dataSource"tableData":rowKey"(row) > row.id":scroll"{ y: 550 }"bordered:pag…
阅读更多...
已解决AttributeError: module ‘gradio‘ has no attribute ‘outputs‘

已解决AttributeError: module ‘gradio‘ has no attribute ‘outputs‘

问题描述 Traceback (most recent call last): File "/media/visionx/monica/project/ResShift/app.py", line 118, in <module> gr.outputs.File(label"Download the output")AttributeError: module gradio has no attribute outputs 解决办…
阅读更多...
[英语学习][5][Word Power Made Easy]的精读与翻译优化

[英语学习][5][Word Power Made Easy]的精读与翻译优化

[序言] 今日完成第18页的阅读, 发现大量的翻译错误以及不准确. 需要分两篇文章进行讲解. [英文学习的目标] 提升自身的英语水平, 对日后编程技能的提升有很大帮助. 希望大家这次能学到东西, 同时加入我的社区讨论与交流英语相关的内容. [原著英文与翻译版对照][第18页] Wh…
阅读更多...
Mininet学习记录（常用命令+创建网络拓扑+OpenDaylight显示拓扑结构)

Mininet学习记录（常用命令+创建网络拓扑+OpenDaylight显示拓扑结构)

目录 1.Mininet简介2.Mininet常用命令2.1创建网络拓扑常用参数2.2常用的内部交换命令 3.创建网络拓扑的三种方式3.1通过命令行创建3.2通过miniedit可视化界面创建3.3通过python脚本创建 4.问题总结 1.Mininet简介 Mininet 是由一些虚拟的终端节点 (end-hosts) 、交换机、路由器…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023