编写可读代码的艺术 1

代码应该容易理解

这个是我上一轮写Story的一个例子

我们有一些场景也要使用类似pivot view的样子,但是和传统的pivot view也有很多的区别,这时候就需要手动group by很多vo上面的字段

public class TariffVo {
    private String dim1;
    private String dim2;
    private String dim3;
    private String ctnSize;
    private String ctnType;
    private String unitPrice;
    private Map<String, String> sizeTypeWithPrice = new HashMap<>();
}

这里就需要group by dim1,2,3。所以说要重写hashCode和equals方法

以前我会过于想去遵循那个叫"return first"?规则,equals会写成下面这个样子

public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        TariffVo tariffVo = (TariffVo) o;
        if (!Objects.equals(dim1, tariffVo.dim1)) {
            return false;
        }
        ....
}

直到上次我用了IDEA的自带重写equals方法

public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        TariffVo tariffVo = (TariffVo) o;
        return Objects.equals(dim1, tariffVo.dim1)
                && Objects.equals(dim2, tariffVo.dim2)
                && Objects.equals(dim3, tariffVo.dim3);
}

这个地方的优势在于,它没有"非"逻辑,让人一下就看懂了,就是这几个字段都要一样。当然我一开始的写法也很简单,只不过理解上稍微复杂了一点

命名

这是一件非常考验英语的事情,之前我们讨论过"合并"应该怎么翻译。我觉得代码中应该主要用的是merge和combine。merge更像是两个比较复杂的结构混合在一起了,比如git。Java里我觉得Map更像Merge,好像Java8里Map就多了merge方法。combine就是两串东西拼成了一串,就是List了。

example 1

书中有一个例子我觉得可以拿来讨论一下,它说一以下词汇都是make的可以替代词:

  • create
  • build
  • generate
  • compose
  • new

这里面除了new我都用过,而且非常不固定,主要看第一个想起来的单词是哪个。现在仔细想想compose更像是一个有参数的?create build generate就完全想不出来有什么区别了

example 2

我之前因为需要,写了一个ListUtil.splitList方法,两个参数: List<T> inputList, int eachGroupCount

后来我看别人写代码发现google库提供了Lists.partition方法,一样的功能。但是我还是觉得,split更好一点,jdk的String官方就是split

example 3

书中还提到了迭代器的命名。我也是之前刚刚看了一段别人写的代码,它就是for i for j。同时有i j的时候,虽然是比较简单的逻辑,但是分清i和j还是让我眼睛难受了一阵的。

example 4

Java里面,Date的getTime就是一个很让人困惑的命名,是不是可以叫getMilliSeconds?

之前自己写代码的时候也很不解,LocalDate和LocalDateTime的format函数的参数都是DateTimeFormatter。当我使用LocalDate的时候就有点傻了,有点不明白为什么还要传DateTime

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

推荐阅读更多精彩内容