代码整洁之道

总结看完《代码整洁之道》这本书之后得到的CheckList,可以用来指导之后的代码review和重构。

命名

  1. 名副其实,替换更好的名字
  2. 使用有意义的变量名
  3. 用可搜索的名字
  4. 类名使用名词,方法名使用动词,方法名+参数使用动词短语
  5. 一个概念一个词
  6. 良好的描述技巧,共同的文化背景。

函数

  1. 函数要短小。一个函数只含有一个if-else
  2. 只做一件事
  3. 一个函数一个抽象层级。
  4. 描述性的名称。
  5. 参数越少越好。
  6. 使用异常代替错误码。
  7. 消除重复,提取出公共方法。
  8. 持续打磨,精益求精。

注释

  1. 注释是代码表达的失败
  2. 一般注释都不会得到维护。

格式

  1. 单个文件(class)的最大限制是500行,多数应该小于200行。
  2. 像报纸一样,先给出大纲,再逐个给出细节实现。
  3. 不同概念的代码块用空格区分开。
  4. 减少不必要的空行或注释分散注意力。
  5. 团队内使用统一的IDEA格式器,避免代码风格不一致。

对象和数据结构

  1. 对象暴露行为,隐藏数据(Service类)。数据结构暴露数据,没有明显的行为(DTO类).

  2. 遵守德墨忒尔律,模块不应该了解它所操作对象的内部情形。
    比如这样的代码:

final String  outputDir = ctxt.getOptions().getScratchDir().getAbsolutePath()

可以修改为:

Options opts = ctxt.getOptions();
File scratchFile = opts.getScratchDir();
final String outputDir = scratchFile.getAbsolutePath();

这样的代码依然不好,只是要获取outputDir而已,为什么这个函数要关心Options和File对象?
所以更好的实现方式是,把获取outputDir的实现交给ctxt封装起来。

String outputDir =  ctxt.getOutputDir();

错误处理

  1. 使用异常而不是返回码,可以避免很多冗余的检查。

  2. 避免使用可控异常,这违反了开闭原则,当底层实现新增一种异常的时候,上层代码也要跟着一起修改。

publc String getSomething throws NullPointException(){};
  1. 给出异常的上下文环境,否则抛出的异常没有任何意义。

  2. 依照需要定义异常代理类。通过代理类来处理各种异常情况。

  3. 定义常规流程,使用策略模式来处理异常情况。

  4. 别返回null值,使用空的对象或容器来代替,避免if判断和空指针异常。

边界

  1. 封装对于第三方接口和类的调用,这样就把可能的改动限制在封装对象内部,避免第三方接口的修改对自身系统带来的过分影响。

  2. 或者可以使用Adapter模式,将我们的接口转换为第三方提供的接口,这样也实现了对第三方接口的包装。

  1. 类应该短小,体现出来就是一个类应该只有一个权责,当你发现无法准确定义一个类的name时,就该拆分这个类了。

  2. 单一权责原则认为,一个类有且只有一条修改的理由。

  3. 什么是高内聚?一个类内部应该只有少数变量,这些变量在所有函数中都被使用到。保持高内聚就会得到很多短小的类。

  4. 面向修改编程,将系统的修改设计为新增扩展类(开闭原则)。

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

推荐阅读更多精彩内容

  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,560评论 18 399
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,585评论 18 139
  • 第5章 引用类型(返回首页) 本章内容 使用对象 创建并操作数组 理解基本的JavaScript类型 使用基本类型...
    大学一百阅读 3,204评论 0 4
  • 一:新建项目导入第三方库 二:点击Link Binary With Libraries的“+”. 三:为GData...
    OSong阅读 267评论 0 0
  • 山长水远,不期来日只待今朝。 所思所想所念 一愿家人长健 二愿和合美满 三愿能得长相伴 岁岁得安
    意莫安阅读 634评论 0 0