TDD小组 重构题目[CacheKey]

题目:


输入:类名(全类名),方法名。
返回:用于cache的key值
要求:key值为DBO$+类名+方法名。不能超过50字符如果大于50,去掉包名。还大于,去掉类名。然后超长,截断方法名。

单元测试代码:


@Test
public void should_GenerateKey() throws Exception {
    assertThat(cacheKey.generateKey("com.email.dao.Repository26", "saveProduct13"), is("DBO$com.email.dao.Repository26.saveProduct13"));
    assertThat(cacheKey.generateKey("com.email.dao.Repository26", "saveLooooongProduct21"), is("DBO$Repository26.saveLooooongProduct21"));
    assertThat(cacheKey.generateKey("com.email.dao.LoooooooooooogRepository40", "saveLooooongProduct21"), is("DBO$saveLooooongProduct21"));
    assertThat(cacheKey.generateKey("com.email.dao.LoooooooooooogRepository40", "saveLooooooooooooooooooooooooooooooongProduct47"), is("DBO$saveLooooooooooooooooooooooooooooooongProduc.~"));
}

原始代码 V0:


// CacheKey.java
public String generateKey(String service, String method) {
        String head = "DBO$";
        String key = "";
        int len = head.length() + service.length() + method.length();
        if (len <= 50) {
            key = head + service + "." + method;
        } else {
            service = service.substring(service.lastIndexOf(".") + 1);
            len = head.length() + service.length() + method.length();
            key = head + service + "." + method;
            if (len > 50) {
                key = head  + method;
                if (key.length() > 50) {
                    key = key.substring(0, 48) + ".~";
                }
            }
        }
        return key;
    }

重构思路:


其实原始代码的思路还是比较清晰,利用变量key存储结果,组合出不同情况下可能的CacheKey,利用临时变量len判断是否达到题目要求。 在这个过程中,发生变化的量实在有点多,if...else...的嵌套层数也很深,所以导致代码阅读起来比较费事儿。
所以第一步,就是试图去干掉这些坏味道,找寻能够复用的逻辑。
这一步最重要是用到了Replace Nested Conditional with Guard Clauses方法。当发现一堆嵌套的if...else...并且不断地在这中间给某一变量赋值时候,就可以考虑是否可以用这个重构方法了,思路是把赋值的地方return,然后减少if...else...嵌套层数。
其余的改动如提取常量就不说了,这样我们得到了改进的第一版。

V1:


// CacheKey.java
public static final String HEAD = "DBO$";  
public static final int LIMIT = 50;

private String generateKey(String service, String method) {
    if (length(service, method) <= LIMIT) {
        return HEAD + service + "." + method;
    }
    service = service.substring(service.lastIndexOf(".") + 1);
    if (length(service, method) <= LIMIT) {
        return HEAD + service + "." + method;
    }
    service = "";
    if (length(service, method) <= LIMIT) {
        return HEAD + service + method;
    }
    return (HEAD + service + method).substring(0, 48) + ".~";
}

private int length(String service, String method) {
    return HEAD.length() + service.length() + method.length();
}

重写思路:

重构到V1版本,代码可读性已经有了质的提升了。
通过代码我们可以很清晰地了解到它的意图(“哦,原来就是求字符串长度,然后每次去和LIMIT这个限制去比较,如果小于LIMIT就返回,不然就往下走”)。这样的代码已经算是很成功的重构了,不信你去看着原始代码,然后试图去用比括弧里面内心OS更少的字数去描述它。
接下去的想法是既然模式已经出现了(三个长得一样的if判断),那还有没有更好的办法去复用上这段逻辑,况且不断变化的service这个变量感觉也怪别扭。

V2:


// CacheKey.java
public static final String HEAD = "DBO$";  
public static final int LIMIT = 50;
public String generateKey(String service, String method) {
    return new StrLimit(LIMIT)
            .tryString(StringUtils.left((HEAD + method), LIMIT - 2)+ ".~")
            .tryString(HEAD + method)
            .tryString(HEAD + getClassName(service) + method)
            .tryString(HEAD + getPackageName(service) + getClassName(service) + method)
            .get();
}

private String getPackageName(String service) {
    return service.substring(0, service.lastIndexOf(".")) + ".";
}

private String getClassName(String service) {
    return service.substring(service.lastIndexOf(".") + 1) + ".";
}
// StrLimit.class
public class StrLimit {
    private int limit;
    private String tempString;
    
    public StrLimit(int limit) {
        this.limit = limit;
    }

    public StrLimit tryString(String s) {
        if (s.length() <= limit) {
            this.tempString = s;
        }
        return this;
    }

    public String get() {
        return this.tempString;
    }
}

在V2版本,专门搞了个类StrLimit来执行判断的逻辑,这样虽然从代码行数来说比V1版本更多了,但不断和LIMIT比较的逻辑被很好地封装在了trySting这个函数内,而且StrLimit这个类与我们题目本身的业务数据和需求并没有很强的耦合关系,所以单独提出来也算ok。
另外加入了getPackageName和getClassName两个函数,能够增加代码的可读性,毕竟在需求里面,包名、类名是有区分的,而入参里面service却同时包含了包名和类名,区分出来更好理解一些。
(需要注意的是那个LIMIT-2中的2代表的是“.~”的字符串长度。)

还有一种思路是从算法角度上去重做:将特殊字符镶嵌在包名、类名、方法名中间,拼接成一条长长的字符串,然后不管3721把它截取指定长度,通过判断剩余字符串中特殊字符的数量来决定最终CacheKey。感觉思路可行,所以也实现了一把:

V3:


// CacheKey.java
public String generateKey2(String service, String method) {
    String afterConcat = concatWithSeparator(service, method);
    String afterCut = cutToLimit(afterConcat);

    int nubOfSEP = StringUtils.countMatches(afterCut, SEPARATOR);
    if (nubOfSEP == 2) {
        return afterCut.startsWith(getPackageName(service)) ?
                HEAD + getPackageName(service) + getClassName(service) + method :
                HEAD + getClassName(service) + method;
    }
    if (nubOfSEP == 1) {
        return HEAD + method;
    }
    if (nubOfSEP == 0) {
        return (HEAD + method).substring(0, 48) + ".~";
    }
    throw new RuntimeException("Should not be here.");
}

private String cutToLimit(String afterConcat) {
    if (afterConcat.length() + HEAD.length() + 2 > LIMIT) {
        return StringUtils.right(afterConcat, LIMIT - 2 - HEAD.length());
    } else {
        return afterConcat;
    }
}

private String concatWithSeparator(String service, String method) {
    return getPackageName(service) + SEPARATOR + getClassName(service) + SEPARATOR + method;
}

好吧,写完之后都被自己恶心到了,这个。
不如V1、V2不说,甚至跟原始代码比都没有什么优势。

最后贴上@VK同学的代码:

private static final String POSTFIX = ".~";
private static final int LIMIT = 50;

public String generateKey(String service, String method) {
    String head = "DBO$";
    String className = service.substring(service.lastIndexOf(".") + 1);
    String packageName = service.substring(0, service.lastIndexOf(".") + 1);

    int remainderLength = LIMIT - head.length();
    if (method.length() > remainderLength) {
        method = method.substring(0, remainderLength - POSTFIX.length()) + POSTFIX;
        remainderLength = 0;
    } else {
        remainderLength -= method.length();
    }

    if (className.length() > remainderLength) {
        className = "";
        remainderLength = 0;
    } else {
        className = className + ".";
        remainderLength -= className.length();
    }

    if (packageName.length() > remainderLength) {
        packageName = "";
    }
    return head + packageName + className + method;
}

还有@lambeta同学的:

private static final int LIMIT = 50;

public String generateKey(String service, String method) {
    String head = "DBO$";
    String simpleName = service.substring(service.lastIndexOf(".") + 1);
    String packageName = service.substring(0, service.lastIndexOf(".") + 1);

    int limitOfMethod = LIMIT - head.length();
    int limitOfClassName = limitOfMethod - method.length();
    int limitOfPackageName = limitOfClassName - simpleName.length();

    return head +
            cond(packageName.length() > limitOfPackageName, () -> "", () -> packageName) +
            cond(simpleName.length() > limitOfClassName, () -> "", () -> simpleName + ".") +
            cond(method.length() > limitOfMethod, () -> method.substring(0, limitOfMethod - 2) + ".~", () -> method);
}

private static String cond(boolean expr, Supplier<String> lhs, Supplier<String> rhs) {
    return expr ? lhs.get() : rhs.get();
}

原题来自于中国软件匠艺小组

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,233评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,013评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,030评论 0 241
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,827评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,221评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,542评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,814评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,513评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,225评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,497评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,998评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,342评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,986评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,812评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,560评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,461评论 2 266

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,099评论 18 139
  • 弗洛伊德算法适用于为图中每一个顶点求最短路径,思路如下 检查图中任何一个 到 任何另一个点能否通过第一个点降低最短...
    RichardW阅读 924评论 0 1
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,563评论 25 707
  • 黄昏时分,我们下了高速,经过三渡桥,赶回舅舅家吃饭。 陌生的村庄炊烟四起,我凭着儿时的记忆寻找回家的路。去年春节还...
    一生如燕阅读 438评论 2 1
  • 我应该一个周没有更新了。那我这一个周在做什么呢。堕落。 一个周每天都窝在房间,成吨的论文不去构思,然后就是天天吃各...
    一个煎饼果子阅读 223评论 1 0