如何提高Java代码可读性?

可读性强的代码,不仅能让团队成员清晰了解代码意图;而且面对频繁变更的需求,也是维护代码的基础。然而在实践中怎样才能逐渐增强代码的可读性呢?以下几点心得可供参考。

  • 避免巨复杂的表达式

将复杂表达式按照与、或、非逻辑进行拆分,并以合理的变量名对逻辑单元进行注释(以变量名代替注释)。
例如:

if( ("csv".equals(fileName.substring(fileName.lastIndexOf(".") + 1))) || ("json".equals(fileName.substring(fileName.lastIndexOf(".") + 1))){
//..
}else{
//..
}

改写成如下:

boolean isCsv = "csv".equals(fileName.substring(fileName.lastIndexOf(".") + 1);
boolean isJson = "json".equals(fileName.substring(fileName.lastIndexOf(".") + 1);
if(isCsv || isJson){
//..
}else{
//..
}
  • 避免又臭又长的方法

按照一个方法只做一件事原则,将大功能抽象拆分成小功能,在本方法中只关注小功能之间的关系,并递归处理小功能。
例如:将大象装进冰箱,可以抽象成三个步骤:打开冰箱门、放入大象、关上冰箱门,即三个方法。而不是把所有的代码都写到一个上层方法中。

  • 避免超大的类

超大类表现在类的成员变量越来越多、类的方法越来越多,即该类承担的责任越来越大。这个时候就要考虑将一些非本类核心功能的方法抽离出去,或者是将该类的功能合理拆分,并分别由几个小类来实现。
例如:Spark框架中SparkContext是用户的编程入口,也是框架执行的大管家,需要管理DAG划分、Task执行、RPC调用、UI等等。这里的每一部分在分布式框架中都极其复杂,如果实现细节都写在SparkContext中,那么该类将变得极其臃肿形成一个超大类难以维护,因此Spark框架分别将上述功能在DAGScheduler、RpcEndpointRef 、TaskSchedule SparkUI等类中单独实现,并维护几个实例。

  • 避免过重的模块
    与类拆分思路相似,当工程过于复杂后将其拆分成不同模块。
  • 避免魔幻值

代码中每一个变量、常量、函数等都需要一个能够准确表达其含义的名称,这样才能让人理解。一个代表特定含义的值却没有对应的说明,不免让人费解。比如,if(type == 1){//..}else{//..},这里的1其实代表了一个特定的类别,如性别中的男,读代码的人却只能猜。解决此类问题,可以使用静态常量或枚举类型,通过名称对其含义进行准确地说明。

  • 避免参数列表过长

将多个参数封装成对象,即将几个特定的参数封装成一个有意义的对象参数中。
例如:时间参数from和to,可以封装成一个range对象参数,其中包含from和to两个成员变量。

  • 精准的命名

准确的命名,既可以表达其含义,又能够揭示其内在联系
例如:时间参数from和to,不仅见名知义,而且隐含from在to之前的关系(边界检查)

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

推荐阅读更多精彩内容