写语义化的代码

案例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将更加明了

总结

  • 代码是写个人看的,尽量多想想怎么语义化代码
  • 能简单就别啰嗦,代码量不代表质量
  • 保持重构的意识。不一定要伤筋动骨的重构,可以根据实际情况,进行局部重构
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

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