记一段代码的重构
背景代码
在维护项目代码时，使用sonarlint扫描代码时，发现以下代码，提示代码圈复杂度为33，这意味着这段代码可能质量低且难于测试和维护。
圈复杂度是一种代码复杂度的衡量标准。在软件测试的概念里，圈复杂度用来衡量一个模块判定结构的复杂程度，数量上表现为线性无关的路径条数，圈复杂度大说明程度代码可能质量低下且难以测试和维护。
代码如下
public static String objToJSONString1(Object value){
if(value==null){
return "";
}
if(value.getClass().isPrimitive()||
value.getClass().getSuperclass().getName().equals(Number.class.getTypeName()) ||
value.getClass().getName().equals(String.class.getTypeName()) ||
value.getClass().getName().equals(Number.class.getTypeName())
){
String tagValue = value.toString();
if(value.getClass().getSuperclass().getName().equals(Number.class.getTypeName()) ||
value.getClass().getName().equals(Number.class.getTypeName())
){
if(tagValue.contains(".")){
boolean isZeo =true;
String endStr = tagValue.substring((tagValue.lastIndexOf(".")+1));
for(char a: endStr.toCharArray()){
if(a!='0'){
isZeo=false;
break;
}
}
if(isZeo){
if (log.isDebugEnabled()){
log.info("======>old value is {}",tagValue);
}
tagValue = tagValue.substring(0, tagValue.lastIndexOf("."));
if (log.isDebugEnabled()){
log.info("======>new value is {}",tagValue);
}
}
}
}
return tagValue;
}
else{
return JSONUtil.toJsonStr(value);
}
}
插件计算复杂度
idea安装一款插件MetricsReloaded, 在菜单Analyze->Calculation Metrics中，选择需要测试的文件,
image.png
重构过程
既然工具提示代码圈复杂度，我就进一步分析这段代码的功能，发现功能还是比较简单的，就是将object转换为json字符串。比较特殊的是String、Number 、Primitive，如果是这几种类型，就直接输出类型转为string的，其中对于Number类型，如果小数点后面全部是0的，则输出的内容则去掉小数点后面的0，直接输出整数。
这段代码的圈复杂度还有一处，是下面这段代码
if(isZeo){
if (log.isDebugEnabled()){
log.info("======>old value is {}",tagValue);
}
tagValue = tagValue.substring(0, tagValue.lastIndexOf("."));
if (log.isDebugEnabled()){
log.info("======>new value is {}",tagValue);
}
}
这段代码，使用了if嵌套，导致圈复杂度上升。
测试
针对以上流程，编写几个单元测试
- null 类型， 输出""
- 引用类型，ArrayList，输出[]
- String类型，非数字, abcd，输出abcd
- Integer类型，100，输出100
- Double类型，100.5，输出100.5
- Double类型，90.00，输出90
- Boolean类型，True，输出true
- char类型， A， 输出A
@Test
void testObjToJSONStringWithNull() {
String s = ValueUtil.objToJSONString1(null);
assertThat(s).isEmpty();
}
@Test
void testObjToJSONStringNoPrimitiveNumberString() {
String s = ValueUtil.objToJSONString1(new ArrayList<>());
assertThat(s).isEqualTo("[]");
}
@Test
void testObjToJSONStringIsStringNoNumber() {
String s = ValueUtil.objToJSONString1("abcde");
assertThat(s).isEqualTo("abcde");
}
@Test
void testObjToJSONStringIsInteger() {
String s = ValueUtil.objToJSONString1(100);
assertThat(s).isEqualTo("100");
}
@Test
void testObjToJSONStringIsDouble() {
String s = ValueUtil.objToJSONString1(100.5);
assertThat(s).isEqualTo("100.5");
}
@Test
void testObjToJSONStringIsDoublePointZero() {
String s = ValueUtil.objToJSONString1(90.00);
assertThat(s).isEqualTo("90");
}
@Test
void testObjToJSONStringIsBoolean() {
String s = ValueUtil.objToJSONString1(Boolean.TRUE);
assertThat(s).isEqualTo("true");
}
@Test
void testObjToJSONStringIsChar() {
char a = 'A';
String s = ValueUtil.objToJSONString1(a);
assertThat(s).isEqualTo("A");
}
结果发现，Boolean 和 Char 的单元测试不通过。
image.png
进入代码分析，发现是这段代码的问题value.getClass().isPrimitive()，这段代码的意图是判断类型是否为基础类型，查看源代码，发现是使用方式问题，这个方法只能通过静态变量访问，比如Boolean.class.isPrimitive()
image.png
重构
分析上述功能后，对代码进行重构如下
public static String objToJSONString1(Object value){
if(value==null){
return "";
}
String tagValue = value.toString();
if(value instanceof Number){
double original = Double.parseDouble(tagValue);
boolean valueIsInteger = original - ((Number)value).intValue() == 0;
if (valueIsInteger){
tagValue = String.valueOf(((Number)value).intValue());
}
}
return JSONUtil.toJsonStr(tagValue);
}
运行测试，可以发现所有测试均通过
image.png
利用插件，计算圈复杂度，代码只有4，代码可读性、维护性和可测试性都大大增加了，而且通过单元测试，也不需要使用log输出日志，查看转换前和转换后的数字
image.png
总结
分析下来，函数功能是比较简单的，就是Object转换为Json字符串，但是实现方式有很大区别，主要区别还是对整型数字的字符串的实现，一种是完全使用String来完成，一种是借助Number类型取差值。
总结下重构步骤
- 重建前整理代码逻辑
- 编写单元测试，覆盖全路径
- 重构代码
- 运行测试
