写语义化的代码

案例1:看不懂的判断语句

第一眼看到if这个判断逻辑,我们只知道这个是在判断id的长度,至于为什么这么判断,它表达的业务含义是什么,无从得知。

if (String.valueOf(vo.getId()).length() < 15 ) {
   doA();
} else {
   doB();
}

方案1:写注释

可以通过写注释的方式,来说明你的意图。这种方式其实也有缺点,因为注释很可能会落后于代码变更。

//在这边加上判断对应的功能或业务含义
if (String.valueOf(vo.getId()).length() < 15 ) {
   doA();
} else {
   doB();
}

方案2:判断逻辑提取成方法

if (isXXX(vo.getId())) {
   doA();
} else {
   doB();
}
....
/**
*  当方法名无法一目了然时,在此处增加方法注释
*/
public boolean isXXX(int id){
  return String.valueOf(vo.getId()).length() < 15 ;
}
  • 尽量做到方法名直接体现业务含义(自描述),不要担心方法名太长
  • 如果抽出来的方法无法自描述,那就对方法增加注释(万不得已的做法
  • 在Intellij IDEA,可以通过crtl+alt+m抽取方法

案例2:看不懂的数字(字符串)-魔法数

所谓的魔法数,通俗来讲,就是只有写代码的人知道含义的常数(其实过了n天后,写代码的人估计也不记得了) ,这种常数没有带任何注释或说明,从常数本身也无法猜出含义。

 Person person = new Person();
 person.setSex(1);

我们从setSex方法可以知道,这边是在设置性别,但是方法参数确是一个常量1,显然我们没法一眼看出1代表的是男还是女,亦或是未知。此时,我们得翻翻上下文,或者看下sex的值哪个地方有用到,想想就很吐血

方案1:提取常数,定义为常量

private static final int SEX_MAN = 0;
private static final int SEX_WOMAN = 1;
....
 Person person = new Person();
 person.setSex(SEX_WOMAN);
  • 通过把常数提取为常量,并语义化命名常量
  • 在Intellij IDEA,可以通过ctrl+alt+c提取为常量

方案2:定义为枚举

public enum Sex {
  MAN, WOMAN
}
....
 Person person = new Person();
 person.setSex(Sex.WOMAN);
  • 对于可以枚举的常数,使用enum将更加明了

总结

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

推荐阅读更多精彩内容

  • 一,重构,第一个案例 这一章作者先用一个影片出租程序的案例,来演示重构的过程 每个Customer顾客可以租多部M...
    高稷阅读 10,776评论 1 19
  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,089评论 1 32
  • 年底回家处理家中事务,因为雾霾天气,高速一直封闭状态,又不能再拖延了,在爸妈的一再叮嘱下,不能开车回,这天气太危险...
    阳光vs静好阅读 279评论 3 3
  • 1. 镜头NA 2. 声音NA 3. 表演郭富城把一个内心懦弱的主角演了出来,周润发还是英姿飒爽的大侠形象。 4....
    Alf018阅读 324评论 0 0
  • 吴蕙兰阅读 251评论 0 0