ccframe系统的链路追踪，用户ID追踪的实现

需求

之前ccframe cloud V1用的是springcloud微服务，只需要在header将jwttoken一直传下去就没事，最近弄V2转dubbo发现用户id没有自动保存进数据库表。于是开始研究dubbo如何追踪，顺便把链路追踪ID的问题给一并解决掉。

理论

MDC

MDC（Mapped Diagnostic Context，映射调试上下文）是Slf4j(提供了接口定义和核心实现，日志库负责适配器的实现)提供的一种方便在多线程条件下记录日志的功能。

MDC 可以看成是一个与当前线程绑定的Map，可以往其中添加键值对。MDC 中包含的内容可以被同一线程中执行的代码所访问。当前线程的子线程会继承其父线程中的 MDC 的内容。当需要记录日志时，只需要从 MDC 中获取所需的信息即可。MDC 的内容则由程序在适当的时候保存进去。对于一个 Web 应用来说，通常是在请求被处理的最开始保存这些数据。

简而言之，MDC就是日志框架提供的一个InheritableThreadLocal，项目代码中可以将键值对放入其中，然后使用指定方式取出打印即可。

RpcContext

RpcContext 本质上是一个使用 ThreadLocal 实现的临时状态记录器，RPC请求时会自动给传递给下游服务，当RPC请求结束的时候，当前线程的RpcContex会清空

实现

原理图

生成追踪信息

了解了MDC的原理可知，MDC数据是线程级别的，那么我们可以放在一次线程调用最靠前的位置。对于当前的ccframe系统，我们使用了spring security，而spring security的filter在请求比较靠前的位置，因此我们可以在JwtHeadFilter进行对应的处理。在解析完用户的信息后，将链路ID及会员ID放入MDC。链路ID这里采用Htool的短NanoId形式，因为本身请求会有时间属性，我们只需要在短时间（一次链路请求时间范围），例如几分钟内，不重复即可方便关联日志。这里采用2个记录量：

  1. userId 记录操作人
  2. traceId 记录一次链路请求
package org.ccframe.commons.auth;

import cn.hutool.core.lang.id.NanoId;
import com.alibaba.fastjson.JSON;
import io.jsonwebtoken.JwtException;
import org.apache.dubbo.common.utils.StringUtils;
import org.apache.dubbo.rpc.RpcContext;
import org.apache.http.HttpStatus;
import org.ccframe.commons.util.IpUtil;
import org.ccframe.commons.util.JwtUtil;
import org.ccframe.commons.util.UUIDUtil;
import org.ccframe.config.GlobalEx;
import org.ccframe.subsys.core.domain.code.RoleCodeEnum;
import org.ccframe.subsys.core.dto.Result;
import org.redisson.api.RBucket;
import org.redisson.api.RedissonClient;
import org.redisson.client.codec.StringCodec;
import org.slf4j.MDC;
import org.springframework.context.MessageSource;
import org.springframework.http.MediaType;
import org.springframework.security.core.authority.SimpleGrantedAuthority;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.security.web.authentication.WebAuthenticationDetails;
import org.springframework.web.filter.OncePerRequestFilter;
import org.springframework.web.servlet.LocaleResolver;

import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.stream.Collectors;

public class JwtHeadFilter extends OncePerRequestFilter {

	private final RedissonClient redissonClient;

	private final LocaleResolver localeResolver;

	private final MessageSource messageSource;

	public JwtHeadFilter(RedissonClient redissonClient, MessageSource messageSource, LocaleResolver localeResolver) {
		this.redissonClient = redissonClient;
		this.localeResolver = localeResolver;
		this.messageSource = messageSource;
	}

	@Override
	protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
			throws ServletException, IOException {

		String traceId = NanoId.randomNanoId(8);
		MDC.put(GlobalEx.TRACE_ID, traceId);
		RpcContext.getContext().setAttachment(GlobalEx.TRACE_ID, traceId); // 同时放入RPC上下文

		String uri = request.getRequestURI();
		String token = null;
		boolean adminUrl = false;
		if(uri.startsWith("/" + GlobalEx.ADMIN_URI_PERFIX)) { //后端用户
			token = request.getHeader(GlobalEx.ADMIN_TOKEN);
			adminUrl = true;
		}else if(uri.startsWith("/" + GlobalEx.API_URI_PERFIX)) { //前端用户
			token = request.getHeader(GlobalEx.API_TOKEN);
		}else {
			filterChain.doFilter(request, response);
			return;
		}
		if (!adminUrl && StringUtils.isEmpty(token)){ // 前台的直接退出了
			filterChain.doFilter(request,response);
			return;
		}

		List<SimpleGrantedAuthority> authorityList = new ArrayList<>();
		TokenUser tokenUser = null;

		if(StringUtils.isNotEmpty(token)){ //有token情况
			try {
				tokenUser = JwtUtil.decodeData(token, TokenUser.class);
				authorityList = tokenUser.getRoleIds().stream().map(item->new SimpleGrantedAuthority("ROLE_"+item)).collect(Collectors.toList());
			}catch(IllegalArgumentException|JwtException e) { //构造无权访问的json返回信息
				response.setStatus(HttpServletResponse.SC_FORBIDDEN);
				response.setContentType(MediaType.APPLICATION_JSON_VALUE);
				response.setCharacterEncoding("UTF-8");
				response.setHeader("Cache-Control", "no-cache, must-revalidate");
				try {
					Locale currentLocale = localeResolver.resolveLocale(request);
					String message = messageSource.getMessage("errors.auth.noAuth", GlobalEx.EMPTY_ARGS, currentLocale); // 未登陆/无权限
					response.getWriter().write(JSON.toJSONString(Result.error(HttpStatus.SC_FORBIDDEN, message, "errors.auth.noAuth", e.getMessage())));
					logger.error(e.getMessage());
					response.flushBuffer();
					return;
				} catch (IOException ioe) {
					logger.error("与客户端通讯异常：" + e.getMessage(), e);
					e.printStackTrace();
				}
			}
		}
		if(adminUrl) { // 后台，尝试匹配IP白名单
			String remoteIp = IpUtil.getRemoteIp(request);
			RBucket<String> whiteIpBucket = redissonClient.getBucket(GlobalEx.CACHKEY_WHITE_IP, StringCodec.INSTANCE);
			String whiteIp = whiteIpBucket.get();
			if(StringUtils.isNotEmpty(remoteIp) && StringUtils.isNotEmpty(whiteIp) && remoteIp.equals(whiteIp)){ // 后台操作匹配白名单权限
				authorityList.add(new SimpleGrantedAuthority("ROLE_" + RoleCodeEnum.WHITE_IP.toCode()));
			}
		}
		if(!authorityList.isEmpty()){
			//认证，根据ROLE集合解析即可
			JwtAuthenticationToken jwtAuthenticationToken =  new JwtAuthenticationToken(
					tokenUser, // 如果只是IP白名单直接访问，tokenUser可能为Null
					authorityList
			);
			MDC.put(GlobalEx.TRACE_USER_ID, tokenUser.getUserId().toString());
			RpcContext.getContext().setAttachment(GlobalEx.TRACE_USER_ID, tokenUser.getUserId().toString()); // 同时放入RPC上下文

			jwtAuthenticationToken.setDetails(new WebAuthenticationDetails(request));
			SecurityContextHolder.getContext().setAuthentication(jwtAuthenticationToken); //授权对象放入上下文
		}
		filterChain.doFilter(request,response);
	}
}

传递信息

生成MDC信息后，我们需要在dubbo服务请求时进行传递。dubbo的RpcContext机制能够保证数据传递到下游的处理服务。唯一要做的是把RpcContext放入到MDC，这样下游服务里的所有日志都具备链路信息了。dubbo有一个扩展机制，可以在消费服务的时候进行切面处理。定义对应的Bean即可

package org.ccframe.commons.helper;

import lombok.extern.slf4j.Slf4j;
import org.apache.dubbo.common.extension.Activate;
import org.apache.dubbo.rpc.*;
import org.ccframe.config.GlobalEx;
import org.slf4j.MDC;

@Activate(group = {"provider"})
public class TraceProviderFilter implements Filter {
    @Override
    public Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException {
        String traceId = RpcContext.getContext().getAttachment(GlobalEx.TRACE_ID);
        if (traceId != null) {
            MDC.put(GlobalEx.TRACE_ID, traceId);
        };
        String traceUserId = RpcContext.getContext().getAttachment(GlobalEx.TRACE_USER_ID);
        if (traceId != null) {
            MDC.put(GlobalEx.TRACE_USER_ID, traceId);
        };
        try {
            return invoker.invoke(invocation);
        } finally {
            MDC.remove(GlobalEx.TRACE_ID);
            MDC.remove(GlobalEx.TRACE_USER_ID);
        }
    }
}

关联操作数据

这个是原来就实现的自动记录操作人的方案。原理是采用JPA的EntityListeners方案持久化监听器，原方案是在springsecurity的上下文里获取，由于微服务后请求跨机器，因此改从MDC里获取（前面已经把RpcContext放入到MDC了）

这个是数据库操作基类，EntityListeners注解定义

package org.ccframe.commons.base;

import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Getter;
import lombok.Setter;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;
import org.ccframe.commons.helper.EntityOperationListener;
import org.ccframe.config.GlobalEx;
import org.springframework.data.elasticsearch.annotations.DateFormat;
import org.springframework.data.elasticsearch.annotations.Field;
import org.springframework.data.elasticsearch.annotations.FieldType;

import javax.persistence.*;
import java.util.Date;


/**
 * SAAS数据操作基础类
 * @author JIM
 *
 */
@MappedSuperclass
@Setter
@Getter
@EntityListeners({EntityOperationListener.class})
public abstract class BaseEntity implements IBaseEntity {

	private static final long serialVersionUID = -5656014821398158846L;

	public static final String CREATE_TIME = "createTime";
	
	public static final String UPDATE_TIME = "updateTime";
	
	public static final String CREATE_USER_ID = "createUserId"; //创建人
	
	public static final String UPDATE_USER_ID = "updateUserId"; //最后修改人

	public static final String TENANT_ID = "tenantId"; // 租户，所有资源按照租户隔离，提供检测annotation

    @Temporal(TemporalType.TIMESTAMP)
    @Column(name = "CREATE_TIME", nullable = false, length = 0, updatable = false)
	//elasticsearch
    @Field(type = FieldType.Date, format = DateFormat.custom, pattern = GlobalEx.ES_DATE_PATTERN)
    @JsonFormat (shape = JsonFormat.Shape.STRING, pattern = GlobalEx.STANDERD_DATE_FORMAT, timezone = GlobalEx.TIMEZONE)
    private Date createTime;
	
    @Temporal(TemporalType.TIMESTAMP)
    @Column(name = "UPDATE_TIME", nullable = false, length = 0)
	//elasticsearch
    @Field(type = FieldType.Date, format = DateFormat.custom, pattern = GlobalEx.ES_DATE_PATTERN)
    @JsonFormat (shape = JsonFormat.Shape.STRING, pattern = GlobalEx.STANDERD_DATE_FORMAT, timezone = GlobalEx.TIMEZONE)
	private Date updateTime;
	
    @Column(name = "CREATE_USER_ID", nullable = true, length = 10, updatable = false)
    @Field(type = FieldType.Integer)
	private Integer createUserId;

	@Column(name = "UPDATE_USER_ID", nullable = true, length = 10)
	@Field(type = FieldType.Integer)
	private Integer updateUserId;

	@Column(name = "TENANT_ID", nullable = true, length = 10)
	@Field(type = FieldType.Integer)
	private Integer tenantId;

	@Override
	public boolean equals(Object obj) {
		if(!(getClass().isInstance(obj))){
			return false;
		}
		if(this == obj){
			return true;
		}
		BaseEntity other = (BaseEntity)obj;
		return new EqualsBuilder()
		.append(getId(),other.getId())
		.isEquals();
	}
	
	@Override
	public int hashCode() {
		return new HashCodeBuilder()
		.append(getId())
		.toHashCode();
	}

}

然后EntityListeners里实现持久化新增和更新逻辑

package org.ccframe.commons.helper;

import org.ccframe.commons.auth.TokenUser;
import org.ccframe.commons.base.BaseEntity;
import org.ccframe.commons.base.IBaseEntity;
import org.ccframe.config.GlobalEx;
import org.slf4j.MDC;
import org.springframework.security.core.Authentication;
import org.springframework.security.core.context.SecurityContextHolder;

import javax.persistence.PrePersist;
import javax.persistence.PreRemove;
import javax.persistence.PreUpdate;
import java.util.Date;


public class EntityOperationListener {

	private ICcTransactionHelper ccTransactionHelper;

	private ICcTransactionHelper getCcTransactionHelper(){
		if(ccTransactionHelper == null){
			ccTransactionHelper = SpringContextHelper.getBean(ICcTransactionHelper.class);
		}
		return ccTransactionHelper;
	}

	@PrePersist
	protected void onCreate(Object baseEntity) {
			IBaseEntity targetEntity = (IBaseEntity)baseEntity;
		//采用dubbo的MDC透传操作用户userId及请求ID
		String userId = MDC.get(GlobalEx.TRACE_USER_ID);
		if(userId != null) { // MDC上下文里有
			targetEntity.setCreateUserId(Integer.valueOf(userId));
		}
		Date now = new Date();
		targetEntity.setCreateTime(now);
		targetEntity.setUpdateTime(now);

		getCcTransactionHelper().pushSave(targetEntity);
	}

	@PreUpdate
	protected void onUpdate(Object baseEntity) {
		IBaseEntity targetEntity = (IBaseEntity)baseEntity;
		//采用dubbo的MDC透传操作用户userId及请求ID
		String userId = MDC.get(GlobalEx.TRACE_USER_ID);
		if(userId != null) { // MDC上下文里有
			targetEntity.setUpdateUserId(Integer.valueOf(userId));
		}
		targetEntity.setUpdateTime(new Date());

		getCcTransactionHelper().pushSave(targetEntity);
	}
	
	@PreRemove
	protected void onRemove(BaseEntity baseEntity) {
		getCcTransactionHelper().pushDelete(baseEntity);
	}
}

新增和修改操作一下，看到对应的新增用户和修改用户记录都写入了。这样每个表都具备了简单操作记录

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

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

相关文章

Sonar下启动发生错误,elasticsearch启动错误

Sonar下启动发生错误,elasticsearch启动错误

Download | SonarQube | Sonar (sonarsource.com) 1.首先我的sonar版本为 10.4.1 &#xff0c;java版本为17 2.sonar启动需要数据库,我先安装了mysql, 但是目前sonar从7.9开始不支持mysql&#xff0c;且java版本要最少11,推荐使用java17 3.安装postsql,创建sonar数据库 4.启…
阅读更多...
海洋信息管理系统：守护蓝色星球，促进海洋经济新发展

海洋信息管理系统：守护蓝色星球，促进海洋经济新发展

海洋&#xff0c;覆盖地球表面超过七成的广阔水域&#xff0c;是生命之源&#xff0c;也是经济发展的重要空间。然而&#xff0c;随着人类活动的增加&#xff0c;海洋生态环境面临严峻挑战&#xff0c;海洋资源的可持续利用成为全球关注的焦点。在这样的背景下&#xff0c;构建…
阅读更多...
爱奇艺APP Android低端机性能优化

爱奇艺APP Android低端机性能优化

01 背景介绍 在智能手机市场上&#xff0c;高端机型经常备受瞩目&#xff0c;但低端机型亦占据了不可忽视的份额。众多厂商为满足低端市场的需求&#xff0c;不断推出低配系列手机。另外过去几年的中高端机型&#xff0c;随着系统硬件的快速迭代&#xff0c;现已经被归类为低端…
阅读更多...
NPM 命令备忘单

NPM 命令备忘单

NPM 简介 Node Package Manager (NPM) 是 Node.js 环境中不可或缺的命令行工具&#xff0c;充当包管理器来安装、更新和管理 Node.js 应用程序的库、包和模块。对于每个 Node.js 开发人员来说&#xff0c;无论他们的经验水平如何&#xff0c;它都是一个关键工具。 NPM 的主要…
阅读更多...
校园视频监控系统的设计与实现(论文+源码)_kaic

校园视频监控系统的设计与实现(论文+源码)_kaic

摘 要 本毕业设计的内容是设计并且实现一个基于java技术的校园视频监控系统。它是在Windows下&#xff0c;以MYSQL为数据库开发平台&#xff0c;java技术和Tomcat网络信息服务作为应用服务器。校园视频监控系统的功能已基本实现&#xff0c;主要实现个人中心&#xff0c;用户…
阅读更多...
AI跟踪报道第37期-新加坡内哥谈技术-本周AI新闻: 人工智能竞赛：科技巨头的疯狂角逐！

AI跟踪报道第37期-新加坡内哥谈技术-本周AI新闻: 人工智能竞赛：科技巨头的疯狂角逐！

每周跟踪AI热点新闻动向和震撼发展 想要探索生成式人工智能的前沿进展吗&#xff1f;订阅我们的简报&#xff0c;深入解析最新的技术突破、实际应用案例和未来的趋势。与全球数同行一同&#xff0c;从行业内部的深度分析和实用指南中受益。不要错过这个机会&#xff0c;成为AI领…
阅读更多...
String类中常见面试题

String类中常见面试题

1.string类属于基本类型吗&#xff1f; string类不是基本类型&#xff1b;它属于引用数据类型 2.操作字符串的类有哪些?有什么区别&#xff1f; 有三种&#xff1a;string,stringBuilder,stringBuffer 区别&#xff1a; String:不可变类&#xff0c;字符串一旦被创建就不能…
阅读更多...
OpenCV轻松入门（六）——简单图片处理【马赛克、毛玻璃、浮雕效果】

OpenCV轻松入门（六）——简单图片处理【马赛克、毛玻璃、浮雕效果】

马赛克效果 马赛克指现行广为使用的一种图像&#xff08;视频&#xff09;处理手段&#xff0c;此手段将影像特定区域的色阶细节劣化并造成色块打乱的效果&#xff0c;因为这种模糊看上去有一个个的小格子组成&#xff0c;便形象的称这种画面为马赛克。其目的通常是使之无法辨…
阅读更多...
linux 部署安装mongodb教程

linux 部署安装mongodb教程

现在去官网下载mongodb的tar包,在本地创建文件夹 cd /home wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-rhel70-4.2.17.tgz tar -zxvf mongodb-linux-x86_64-rhel70-4.2.17.tgz mv mongodb-linux-x86_64-rhel70-4.2.17 mongodb cd /home/mongodb mkdir log t…
阅读更多...
window10轻松使用k8s

window10轻松使用k8s

Docker Desktop安装篇 1、win10安装 1、下载安装包 https://www.docker.com/products/docker-desktop/ 官网下载安装包 2、配置win10支持虚拟化 不勾选Hyper-V&#xff0c;容易出错 3、安装WSL配置window支持linux Windows Subsystem for Linux (WSL) 安装 Linux 子系统&am…
阅读更多...
腐蚀Rust 服务端搭建架设个人社区服务器Windows教程

腐蚀Rust 服务端搭建架设个人社区服务器Windows教程

腐蚀Rust 服务端搭建架设个人社区服务器Windows教程 大家好我是艾西&#xff0c;一个做服务器租用的网络架构师也是游戏热爱者。最近在steam发现rust腐蚀自建的服务器以及玩家还是非常多的&#xff0c;那么作为服务器供应商对这商机肯定是不会放过的哈哈哈&#xff01; 艾西这…
阅读更多...
嵌入式实时操作系统的调度机制与优化

嵌入式实时操作系统的调度机制与优化

大家好&#xff0c;今天给大家介绍嵌入式实时操作系统的调度机制与优化&#xff0c;文章末尾附有分享大家一个资料包&#xff0c;差不多150多G。里面学习内容、面经、项目都比较新也比较全&#xff01;可进群免费领取。 嵌入式实时操作系统的调度机制与优化 一、引言 嵌入式实…
阅读更多...
DonkeyDocker-v1-0渗透思路

DonkeyDocker-v1-0渗透思路

MY_BLOG https://xyaxxya.github.io/2024/04/13/DonkeyDocker-v1-0%E6%B8%97%E9%80%8F%E6%80%9D%E8%B7%AF/ date: 2024-04-13 19:15:10 tags: 内网渗透Dockerfile categories: 内网渗透vulnhub 靶机下载地址 https://www.vulnhub.com/entry/donkeydocker-1,189/ 靶机IP&a…
阅读更多...
[Java、Android面试]_18_详解Handler机制 常见handler面试题（非常重要，非常高频！！）

[Java、Android面试]_18_详解Handler机制 常见handler面试题（非常重要，非常高频！！）

本人今年参加了很多面试&#xff0c;也有幸拿到了一些大厂的offer&#xff0c;整理了众多面试资料&#xff0c;后续还会分享众多面试资料。 整理成了面试系列&#xff0c;由于时间有限&#xff0c;每天整理一点&#xff0c;后续会陆续分享出来&#xff0c;感兴趣的朋友可关注收…
阅读更多...
Java基础-知识点04(面试|学习)

Java基础-知识点04(面试|学习)

Java基础-知识点04 Object类wait和notify需要在什么地方使用&#xff1f;说明 toString() 方法的作用和重写时的注意事项。toString() 方法在实际开发中的应用场景和作用。 continue、break 和 return 的区别1、continue&#xff1a;2、break&#xff1a;3、return&#xff1a;…
阅读更多...
plsql developer 一键格式化sql/美化sql

plsql developer 一键格式化sql/美化sql

PL/SQL 格式化工具 以 Oracle SQL Developer 为例&#xff0c;使用一键格式化的步骤如下&#xff1a; 打开 Oracle SQL Developer。在“文件”菜单中&#xff0c;选择“打开文件”&#xff0c;然后选择你的 PL/SQL 文件。打开文件后&#xff0c;你可以通过右键菜单选择“格式…
阅读更多...
常用接口测试工具/免费api

常用接口测试工具/免费api

一 接口编辑文档 常用的接口文档编写apipost 二 免费接口测试 api 1. thecat 含有&#xff1a; The Cat API - Cat as a Service The Cat API 2. public-apis 进入页面往下拉 三 常用接口测试工具 postman 四 常用接口性能测试工具 Jmeter&#xff0c;loadrunner
阅读更多...
STK与matlab交互 Astrogator模块 （11）

STK与matlab交互 Astrogator模块 （11）

一、背景知识 前面由于定轨的大作业&#xff0c;关于Astrogator模块的学习有所滞后&#xff0c;在本节将重新聚焦Astrogator模块&#xff0c;在本节中&#xff0c;首先解决的问题是已知两个卫星的轨道六根数&#xff0c;求解其中某一颗卫星LVLH坐标下另一颗卫星的位置速度。这…
阅读更多...
C语言中的编译和链接

C语言中的编译和链接

系列文章目录 文章目录 ​编辑 系列文章目录 文章目录 前言 一、 翻译环境和运行环境 二、 翻译环境 2.1 编译 2.1.1 预处理 2.1.2 编译 2.1.2.1 词法分析 : 2.1.2.2 语法分析 2.1.2.3 语义分析 2.1.3 汇编 2.2 链接 三、运行环境 前言 在我们平常的写代码时&#xff0c;我们很…
阅读更多...
ARM内核的CPU架构模型

ARM内核的CPU架构模型

1.引言 程序员在编码的时候&#xff0c;如果想有进一步的提升&#xff0c;我认为还是要深入底层理解程序运行原理才好。最近看了一些ARM架构的讲解&#xff0c;总结了如下。虽然是以ARM为原型画的图形&#xff0c;但是对于C和C的编程&#xff0c;还是有一些参考价值的。 2. AR…
阅读更多...
最新文章

Copyright @ 2022~2023