枚举类的final修饰

今天开发跟我反馈了一个很奇怪的问题,说有个对象的状态属性是枚举类,设置了该对象的状态后,插入数据库,这个状态没了,凭空消失了,变成了空白字符串。这让人感觉非常奇怪,整个问题排查后得到的结论和枚举类的规范有关系

问题代码

让我们先看看出问题的部分代码是什么样子的:

@Override
public String insert(PayRequest payRequest) {// 省略部分无关代码PayRequestDO payRequestDO = convertor.toDO(payRequest);payMapper.insert(payRequestDO);return payRequest.getPayNo();
}

这个方法很简单,就是把传过来的 PayRequest 对象转成 PayRequestDO 对象,然后插入数据库。

PayRequest 和 PayRequestDO 都是普通的 pojo 对象,没什么复杂的,只是 PayRequestDO 的 status 换成了 String:

public class PayRequest {private String payId;private String payNo;private Status status;// 省略其它属性和 getter setter
}
public class PayRequestDO {private String payId;private String payNo;private String status;// 省略其它属性和 getter setter
}

至于 PayConvertor#toDO 方法,也很简单,就是属性拷贝:

public PayRequestDO toDO(PayRequest payRequest) {PayRequestDO payRequestDO = new PayRequestDO();payRequestDO.setPayId(payRequest.getPayId());payRequestDO.setPayNo(payRequest.getPayNo());payRequestDO.setStatus(payRequest.getStatus().getCode());// 省略其它代码return payRequestDO;
}

开发一再强调,入参的 PayRequest 里面的 status 一定是有值的,而且是写死的,根本不可能是空,然后这些代码也多次检查过了,mybatis 的 mapper xml 写的也绝对没有问题,但是插入数据库就是没值,WHY ?

排查问题

先简单花些时间,排除掉一些写了代码没发布、或是部署错了版本等等类似的低级问题,确保服务器上面跑的代码就是上面贴出来的代码,这一点非常非常重要,永远是查问题时第一件要做的事情(其实大部分的问题在这一步就可以得到解决)。

这里提供两种快速确定线上的代码版本的方案:
方案一:使用 git-commit-id-plugin maven 插件
开启 spring boot 的 info actuator:

 配置开放的 Actuator 端点,开放 endpoint 需要注意数据安全,可以配置不同的 management port 或脱敏敏感内容
management.endpoints.web.exposure.include=info

mvn packge 构建并以 java -jar 启动后,接下来就可以访问 localhost:8080/actuator/info 来获得当前的 git 提交信息:

{"git":{"commit":{"time":{"epochSecond":17011234567,"nano":0},"id":"1234567"},"branch":"master"}
}

通过这个 commit id 就可以找到代码具体是哪个版本。

方案二:
如果提前没有集成过 git maven 插件,或者没有打开 info endpoint。你还可以把 fat jar 包 down 下来,通过反编译来确定代码版本。当然也有一些在线就可以 dump 代码的方案,例如下面即将出场的 Arthas 有个 jad 命令,还有 JDK 自带的 HSDB,也可以直接 dump 内存中的 class 到本地磁盘,感兴趣可以自行搜索。

------------------------------ 分割线 ------------------------------

排除掉了低级问题,接下来我们分析问题出在哪里。因为问题的表现就是插到数据库里面值丢了,我们可以先看下 db 的 digest 日志分析下:

2023-12-04 21:06:04.221|PayCenter|00|8||N|trace8423002774916857900o38o50|payCente

通过上面的 digest 日志的 sql 可以看出来,insert sql 里面的 status 字段,传的就已经是 ‘’ 空白字符了,这说明问题不是发生在 orm 框架里面,这里排除掉了 xml 中 sql 的语句写的不对的问题。所以问题一定发生在插入数据库之前的业务方法中。

接下来,我怀疑入参传过来的 PayRequest 里面 status 字段是没值的,我需要看下正在运行中的线程栈中 PayRequest 对象的属性值,这个场景非常适合使用 Arthas 的 watch 方法,我的 idea 里面装了一个 Arthas 的插件(名字叫 Arthas Idea by 汪小哥),我们只需要在 insert 上面右键选择 Arthas Command,选择 Watch 子菜单,就可以拿到 watch 命令了,非常方便。
在这里插入图片描述
接下来我们登录到服务器上,切换到 admin 用户(Arthas 启动要求你用和 java 启动同一个用户),输入刚刚拷贝下来的命令:

watch com.xxxxx.paycenter.service.repository.impl.PayRequestRepositoryImpl insert '{params,returnObj,throwExp}'  -n 1  -x 3

接着我们等待方法执行到 insert,就可以观察 Arthas watch 输出的内容:

method=com.xxxxx.paycenter.service.repository.impl.PayRequestRepositoryImpl$$EnhancerBySpringCGLIB$$4f979dec.insert location=AtExit
ts=2023-11-15 14:54:49; [cost=6.001557ms] result=@ArrayList[@Object[][@PayRequest[serialVersionUID=@Long[1],payId=@String[pay2023001],payNo=@String[20231114000000001],status=@Status[INIT],// ...],],@String[20231114000000001],null,
]

可以清楚地看到,这里入参的时候 status 属性还是有值的:Status.INIT

接下来,我们去看 mapper 的写数据的时候,status 属性还在不在,同样用 Arthas watch 命令:

watch com.xxxxx.paycenter.infrastructure.dal.mapper.PayMapper insert '{params,returnObj,throwExp}'  -n 1  -x 3

接着等待方法执行到 mapper 的 insert,观察 Arthas watch 到的内容:

Affect(class count: 2 , method count: 1) cost in 289 ms, listenerId: 10
method=com.sun.proxy.$Proxy153.insert location=AtExit
ts=2023-11-15 14:51:36; [cost=3.933553ms] result=@ArrayList[@Object[][@PayRequestDO[id=null,payId=@String[pay2023002],payNo=@String[20231114000000002],status=@String[],// ...],],@Integer[1],null,
]

可以看到,很明显,到插入数据库时候,status 已经变成空了!!!

入参的时候有,写入数据库的时候没了,那说明唯一的问题,就在中间的对象转换方法 PayConvertor#toDO 了。
用 Arthas watch 一下 toDO 的入参和出参:

watch com.xxxxx.paycenter.core.convertor.PayConvertor toDO '{params,returnObj,throwExp}'  -n 1  -x 3 

输出:

method=com.xxxxx.paycenter.core.convertor.PayConvertor.toDO location=AtExit
ts=2023-11-15 15:01:35; [cost=0.432887ms] result=@ArrayList[@Object[][@PayRequest[serialVersionUID=@Long[1],payId=@String[pay2023003],payNo=@String[20231114000000003],status=@Status[INIT],// ...],],@PayRequestDO[id=null,payId=@String[pay2023003],payNo=@String[20231114000000003],status=@String[],// ...],null,
]

看输出结果,问题确实发生在 toDO 的内部,数据转换后 status 的属性没了

确切来说,下面这行代码,丢了属性:

payRequestDO.setStatus(payRequest.getStatus().getCode());

找到原因

至此我们发现了原因,大概是 status 属性背后的枚举类 Status,在 getCode 的时候返回了空。
Status 的代码如下:

public enum Status {INIT("INIT", "初始态"),SUCCESS("SUCCESS", "成功"),FAILED("FAILED", "失败"),;private String code;private String desc;Status(String code, String desc) {this.code = code;this.desc = desc;}public String getCode() {return code;}public void setCode(String code) {this.code = code;}public String getDesc() {return desc;}public void setDesc(String desc) {this.desc = desc;}
}

看着枚举类属性的 setter 方法,我不由得陷入了沉思:为什么一个枚举类的属性,要提供 setter 方法?

通常来说枚举类的属性,一定要设置为 final 关键字修饰,不能提供 setter 方法。试想下如果我按照下面的方式通过 setter 把 FAILED 和 SUCCESS 的 code 换过来,那这代码还能不能继续愉快的玩耍下去了?
Status.FAILED.setCode(“SUCCESS”);

Status.SUCCESS.setCode(“FAILED”);
很显然这里提供的 setter 调用直接破坏了枚举类,所以,最好的办法就是为枚举类属性加上 final。

接下来通过 watch Status 的 ‘{target}’ 参数,‘{target}’ 可以打印对象内部的状态,结果输出也进一步验证了我的猜想,Status 枚举类部分枚举的 code 属性已经成了空白字符串了:


watch com.xxxxx.paycenter.core.enums.Status getCode '{target}'  -n 1  -x 3method=com.xxxxx.paycenter.core.enums.Status.getCode location=AtExit
ts=2023-11-15 15:05:36; [cost=0.005638ms] result=@ArrayList[@Status[INIT=@Status[INIT=@Status[INIT],SUCCESS=@Status[SUCCESS],FAILED=@Status[FAILED],code=@String[],desc=@String[],name=@String[INIT],ordinal=@Integer[0],],

根本原因

直接原因基本上已经找到了,接下来我们还需要知道到底是在哪里、出于什么需求调用了枚举类的 setCode 方法,因为我在整个项目里面没有搜到显示的调用,所以修改下枚举的 setCode,增加一些代码以便能在 setCode 被调用的时候打印一下调用栈出来:

public void setCode(String code) {try {throw new RuntimeException();} catch (Exception e) {log.error("code before: {}, after: {}", this.code, code, e);}this.code = code;
}

有的小伙伴反馈抛异常来看堆栈太丑了,这也提供一个不用抛异常的方案:

public void setCode(String code) {StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();log.error("code before: {}, after: {}", this.code, code, formatStackTrace(stackTrace));this.code = code;
}public static String formatStackTrace(StackTraceElement[] stackTrace) {StringBuilder stringBuilder = new StringBuilder();for (StackTraceElement element : stackTrace) {stringBuilder.append(element.getClassName()).append(".").append(element.getMethodName()).append("(").append(element.getFileName()).append(":").append(element.getLineNumber()).append(")").append(System.lineSeparator());}return stringBuilder.toString();
}

增加了代码后发布上去,很快打印出来了堆栈:
在这里插入图片描述
这是 podam 这个第三方的库引起的问题(始作俑者还是我引入的这个库),这个库的作用是可以通过传一个 class 对象,解析出来它的属性,进行赋值,简单来说就是根据 class 生成随机对象随机属性,测试的工具会用到这个功能,这个库在解析枚举类的时候可能没实现好,导致了通过反射调用了枚举的 setter 方法,最终导致了问题。

改进措施

我们从一个数据库插入属性丢失的问题排查,最终发现问题的原因是枚举类写的不规范导致的问题。
首要的是写代码还是要注意规范,最好本地装一些扫描工具,例如 sonar,发现风险一定要尽快按照建议修复。
其次是 podam 这个第三方的库对枚举的实现方式还是有问题的,需要尽快修复掉这个 bug。

如果提交代码的时候就扫描问题,这样可以把问题扼杀在摇篮里面。

在这里插入图片描述

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

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

相关文章

低代码平台选型标准:功能、应用与优劣势分析

在数字化转型的浪潮下,中小企业面临满足市场需求、提高效率和竞争力的挑战。低代码平台做为数字化转型的重要工具,为中小企业带来了快速开发和定制应用程序解决方案。但是,在很多低代码平台中,选择是一个重要的环节。企业应该根据…

docker---资源控制

docker的资源控制 对容器使用宿主机的资源进行限制。 三种控制方向:CPU 内存 磁盘I/O docker使用linux自带的功能cgroup;control groups是linux内核系统提供的一种可以限制记录,隔离进程所使用的物理资源机制。 docker借助此…

自定义TypeHandler 将mysql返回的逗号分隔的String转换到List

sql执行如下&#xff1a; 这里我定义的接受类&#xff1a; 但是这里报了错JSON parse error: Cannot deserialize value of type java.util.ArrayList<java.lang.String>from Object value (token JsonToken.START_OBJECT); nested exception is com.fasterxml.jackson…

通过静态HTTP实现负载均衡

在当今的互联网环境中&#xff0c;随着用户数量的不断增加和业务需求的不断扩大&#xff0c;单台服务器往往无法承受所有的访问压力。为了确保网站的可用性和性能&#xff0c;负载均衡成为了一种常见的解决方案。本文将探讨如何通过静态HTTP实现负载均衡&#xff0c;以提升网站…

AUTOSAR CP Port Driver简介

Port Driver 1 背景2 基于 EB 及 TC39X 配置3 Port API 使用1 背景 Port driver 在 AUTOSAR 中是一个比较冷门的模块,基本上在 MCAL 层级,关注的人也少,他由不像其他模块那样通用型比较强,Port 在每种内核的 MCU 的配置都有区别,甚至有些芯片直接没有 Port 模块,使用其他方…

磁盘的移臂调度方法

refer: 理解&#xff1a; 访问磁盘需要先找到数据&#xff0c;在机械硬盘里并不是直接电子读取&#xff0c;需要移动磁头到相应的数据块上才可以读取&#xff08;磁头移动到目标柱面&#xff0c;即磁道&#xff0c;然后磁片旋转磁头才能访问到相应扇区&#xff0c;进而读取数…

MAT(MemoryAnalyzer)分析内存泄露实战

线上有一个应用&#xff0c;每过一段时间内存就跑满&#xff0c;因为是非主要应用且周期较长&#xff0c;一直是采取的重启策略。近期有时间&#xff0c;就进行了一番分析。 使用MAT对dump文件进行分析 第一步就已经很清晰了 第二步&#xff0c;点击此处 基本上就可以定位是此…

WebStorm:Mac/Win上强大的JavaScript开发工具

WebStorm是JetBrains公司开发的针对Mac和Windows系统的JavaScript开发工具。它为开发者提供了一站式的代码编辑、调试、测试和版本控制等功能&#xff0c;帮助你更高效地进行Web开发。新版本的WebStorm 2023在性能和用户体验方面都做出了重大改进&#xff0c;让你的JavaScript开…

【LeetCode】2703. 返回传递的参数的长度

返回传递的参数的长度 题目题解 题目 请你编写一个函数 argumentsLength&#xff0c;返回传递给该函数的参数数量。 示例 1&#xff1a; 输入&#xff1a;args [5] 输出&#xff1a;1 解释&#xff1a; argumentsLength(5); // 1只传递了一个值给函数&#xff0c;因此它应返…

免费的网页数据抓取工具有哪些?【2024附下载链接】

在网络上&#xff0c;有许多网页数据抓取工具可供选择。本文将探讨其如何全网采集数据并支持指定网站抓取。我们将比较不同的数据采集工具&#xff0c;帮助您找到最适合您需求的工具。 网页数据抓取工具种类 在选择网页数据抓取工具之前&#xff0c;让我们先了解一下这些工具…

Android 11.0 MTK Camera2 设置默认拍照尺寸功能实现

1.前言 在11.0的系统rom定制化开发中,在mtk平台的camera2关于拍照的一些功能修改中,在一些平台默认需要设置最大的分辨率 来作为拍照的分辨率,所以就需要了解拍照尺寸设置流程,然后来实现相关的功能 如图: 2.MTK Camera2 设置默认拍照尺寸功能实现的核心类 \vendor\me…

echarts绘制一个环形图2

其他echarts&#xff1a; echarts绘制一个环形图 echarts绘制一个柱状图&#xff0c;柱状折线图 echarts绘制一个饼图 效果&#xff1a; 组件代码&#xff1a; <template><div class"wrapper"><div ref"doughnutChart2" id"dough…