在 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个记录量:
- userId 记录操作人
- 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);
}
}
新增和修改操作一下,看到对应的新增用户和修改用户记录都写入了。这样每个表都具备了简单操作记录
推荐阅读
-
在 ccframe 系统中进行链接跟踪,实施用户 ID 跟踪
-
纯干货分享 | 研发效能提升——敏捷需求篇-而敏捷需求是提升效能的方式中不可或缺的模块之一。 云智慧的敏捷教练——Iris Xu近期在公司做了一场分享,主题为「敏捷需求挖掘和组织方法,交付更高业务价值的产品」。Iris具有丰富的团队敏捷转型实施经验,完成了企业多个团队从传统模式到敏捷转型的落地和实施,积淀了很多的经验。 这次分享主要包含以下2个部分: 第一部分是用户影响地图 第二部分是事件驱动的业务分析Event driven business analysis(以下简称EDBA) 用户影响地图,是一种从业务目标到产品需求映射的需求挖掘和组织的方法。 在软件开发过程中可能会遇到一些问题,比如大家使用不同的业务语言、技术语言,造成角色间的沟通阻碍,还会导致一些问题,比如需求误解、需求传递错误等;这会直接导致产品的功能需求和要实现的业务目标不是映射关系。 但在交付期间,研发人员必须要将这些需求实现交付,他们实则并不清楚这些功能需求产生的原因是什么、要解决客户的哪些痛点。研发人员往往只是拿到了解决方案,需要把它实现,但没有和业务侧一起去思考解决方案是否正确,能否真正的帮助客户解决问题。而用户影响地图通常是能够连接业务目标和产品功能的一种手段。 我们在每次迭代里加入的假设,也就是功能需求。首先把它先实现,再逐步去验证我们每一个小目标是否已经实现,再看下一个目标要是什么。那影响地图就是在这个过程中帮我们不断地去梳理目标和功能之间的关系。 我们在软件开发中可能存在的一些问题 针对这些问题,我们如何避免?先简单介绍做敏捷转型的常规思路: 先做团队级的敏捷,首先把产品、开发、测试人员,还有一些更后端的人员比如交互运维的同学放在一起,组成一个特训团队做交付。这个团队要包含交付过程中所涉及的所有角色。 接着业务敏捷要打通整个业务环节和研发侧的一个交付。上图中可以看到在敏捷中需求是分层管理的,第一层是业务需求,在这个层级是以用户目标和业务目标作为输入进行规划,同时需要去考虑客户的诉求。业务人员通过获取到的业务需求,进一步的和团队一起将其分解为产品需求。所以业务需求其实是我们真正去发布和运营的单元,它可以被独立发布到我们的生产环境上。我们的产品需求其实就是产品的具体功能,它是我们集成和测试的对象,也就是我们最终去部署到系统上的一个基本单元。产品需求再到了我们的开发团队,映射到迭代计划会上要把它分解为相应的技术任务,包括我们平时所说的比如一些前端的开发、后端的开发、测试都是相应的技术任务。所以业务敏捷要达到的目标是需要去持续顺畅高质量的交付业务价值。 将这几个点串起来,形成金字塔结构。最上层我们会把业务目标放在整个金字塔的塔尖。这个业务目标是通过用户的目标以及北极星指标确立的。确认业务目标后再去梳理相应的业务流程,最后生产。另外产品需求包含了操作流程和业务规则,具需求交付时间、工程时间以及我们的一些质量标准的要求。 谈到用户影响的地图,在敏捷江湖上其实有一个传说,大家都有一个说法叫做敏捷需求的“任督二脉”。用户影响地图其实就是任脉,在黑客马拉松上用过的用户故事地图其实叫督脉。所以说用户影响地图是在用户故事地图之前,先帮我们去梳理出我们要做哪些东西。当我们真正识别出我们要实现的业务活动之后,用户故事地图才去梳理我们整个的业务工作流,以及每个工作流节点下所要包含的具体功能和用户故事。所以说用户影响地图需要解决的问题,我们包括以下这些: 首先是范围蔓延,我们在整张地图上,功能和对应的业务目标是要去有一个映射的。这就避免了一些在我们比如有很多干系人参与的会议上,那大家都有不同想法些立场,会提出很多需求(正确以及错误的需求)。这个时候我们会依据目标去看这些需求是否真的是会影响我们的目标。 这里提到的错误需求,比如是利益相关的人提出的、客户认为产品应该有的、某个产品经理需求分析师认为可以有的....但是这些功能在用户影响地图中匹配不到对应目标的话,就需要降低优先级或弃掉。另外,通常我们去制定解决方案的时候,会考虑较完美的实现,导致解决方案括很多的功能。这个时候关键目标至关重要,会帮助我们梳理筛选、确定优先级。 看一下用户影响到地图概貌 总共分为一个三层的结构: 第一层why,你的业务目标哪个是最重要的,为什么?涉及到的角色有哪些? 第二层how ,怎样产生影响?影响用户角色什么样的行为? (不需要去列出所有的影响,基于业务目标) 第三层what,最关键的是在梳理需求时不需一次把所有细节想全,这通常团队中经常遇到的问题。 我们用这个例子来看一下 这是一个客服中心的影响地图,业务目标是 3个月内不增加客服人数的前提下能支持1.5倍的用户数。此业务目标设定是符合 smart 原则的,specific非常的具体,miserable 是可以衡量的,action reoriented是面向活动的, real list 也是很实际的。 量化的目标会指引我们接下来的行动,梳理一个业务目标,尽量去量化,比如 :我们通过打造一条什么样的流水线,能够提高整个部署的效率,时间是原来的 1/2 。这样才是一个能量化的有意义的目标。 回到这幅图, how 层级识别出来的内容,客服角色:想要对它施加的影响,把客户引导到论坛上,帮助客户更容易的跟踪问题,更快速的去定位问题。初级用户:方论坛上找到问题。高级用户:在论坛上回答问题。通过我们这些用户角色,进行活动,完成在不增加客户客服人数的前提下支持更多的用户数量。 最后一个层级,才是我们日常接触比较多的真正的功能的特性和需求,比如引导到客户到论坛上,其实这个产品就需要有一个常见问题的论坛的链接。这个层次需要我们团队进一步地在交付,在每个迭代之前做进一步的梳理,细化成相应的用户故事。 这个是云智慧团队中,自己做的影响地图的范例,可以看下整个的层级结构。序号表示优先级。 那我们用户影响地图可以总结为: