Clean Code

##好书推荐——[Clean Code](https://www.slideshare.net/hebel/clean-code-vortrag032009pdf)

- - - - -

###整理

1. 整洁代码

- 整洁代码力求集中,每个函数、每个类和每个模块都全神贯注于一件事。

- 整洁代码简单直接,从不隐藏设计者的意图。

- 整洁代码应当有单元测试和验收测试。它使用有意义的命名,代码通过其字面表达含义。

- 消除重复代码,提高代码表达力。

- 时时保持代码整洁。

2. 有意义的命名

- 使用体现本意的命名能让人更容易理解和修改代码。

- 较短的命名如果能表达足够的意义,通常比较长的命名好,尽量减少命名上不必要的文字。

- 命名的长度应该与范围大小对应,一个常用的变量或常数,最好给它一个容易被搜索到的名字。

3. 函数

- 规则:

- 每行应该少于150字符,函数应该少于20行。

- 每个函数都要清楚的告诉读者它本身的意图,并带领到下一个函数。

- 一个函数应该只做一件事(高内聚),无副作用。

- 自顶向下阅读代码,如同是在阅读报刊文章。

- 长而具有描述性的函数名称,好过描述性的长注释。

- 少用输出参数。

- 拒绝boolean型标识参数。

- CopyUtil.copyToDB(isWorkDB) --> CopyUtil.copyToWorkDB( ), CopyUtil.copyToLiveDB( )

- 使用异常代替返回错误码,错误处理代码就能从主路径代码中分离出来得到简化。

- 写代码很像是写文章。先想怎么写就怎么写,然后再打磨:分解函数、修改名称、消除重复。

- 编程其实是一门语言设计艺术,大师级程序员把程序系统当做故事来讲。使用准确、清晰、富有表达力的代码来帮助你讲故事。

4. 注释

- 别给糟糕的代码加注释----重写吧。

- 把力气花在写清楚明白的代码上,直接保证无需编写注释。

- 注释只应该描述附近的代码,不要在区域性的注解内放入系统全局的注解。

- 好的注释:

- 法律信息

- 提供信息

- 解释意图

- 警示

- TODO注释

5. 格式

- 代码格式很重要。代码格式关乎沟通,而沟通是专业开发者的头等大事。

- 向报纸格式学习代码编写。

6. 对象和数据结构

- 对象把数据隐藏于抽象之后,只提供操作数据的函数。

- 数据结构暴露其数据,没有提供有意义的函数。

- The Law of Demeter(得墨忒耳定律):模块不应去了解它所操作的对象内部细节。

7. 错误处理

- 使用异常而非返回错误码。

- try-catch-finally, log出错信息。

- 不要返回null,不要传递null。

- NULL Object模式, 例:Collections.emptyList( );

8. 边界

- 边界上代码需要清晰的分割和定义了期望的测试。

- 学习型测试:不要在产品里实验新的东西,而是另外写测试函数,来了解第三方库。

- 学习型测试不会花费我们太多时间,而且能确定第三方库是否能够按照我们预期去执行。

- 如果没有这种边界测试,来减轻更新时的整合负担,我们只能一直停留在旧版本。

9. 单元测试

- 有了测试,就不会害怕修改代码会造成代码的结果不如预期。

- 测试代码跟产品代码一样重要,一样需要整洁,确保可读性。

- 一个测试代码只测试一个功能。

- TDD定律:

- 在编写不能通过的单元测试前,不可编写生产代码。

- 只可编写刚好无法通过的单元测试,不能编译也算不通过。

- 只可编写刚好足以通过当前失败测试的生产代码。

10. 类

- 自顶向下原则:让程序读起来就像是一篇报纸文章。

- method可以是protected,以便于单元测试。不要过度执着于代码的封装。

- 我们架构的系统,在未来想增加或修改功能时,尽可能不修改到其他函数库。

- SRP:类或模块应有且仅有一个加以修改的原因。类名应准确描述其职责。高内聚。

- 变量名、方法名、类名都是给代码添加注释的一种手段。

- 开放闭合原则OCP、依赖倒置原则DIP。

- 类应该要对扩展有开放性,对修改有封闭性。

- 类应该要依靠于抽象概念,而不是依靠于集体细节。

11. 系统

- 将系统的构造与使用分开

12. 跌进

- 紧耦合的代码难以编写单元测试。

- 单元测试消除了对清理代码会破坏代码的恐惧。

- 写出自己能理解的代码很容易,软件项目的主要成本在于长期维护。

- 代码应当清晰表达其作者的意图;测试代码可以通过实例起到文档作用。

13. 并发编程

14. 逐步改进

- 编程是一种技艺。要编写整洁代码,必须先容忍脏代码,然后清理!

- 写出好文章就是一个逐步改进的过程。

15. JUit

16. 重构SerialDate

17. 味道与启发

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

推荐阅读更多精彩内容