代码整洁之道 5、6、7、8

第五章 格式

5.1 格式的目的
格式比内容重要,内容在以后可能被修改,而格式风格却会一直影响项目。
5.2 垂直格式
有可能使用大多数为200行,最长500行的单个文件构造出色的系统(并不是不能去使用长文件)。通常短文件比长文件易于理解

  • 5.2.1 向报纸学习
    源文件顶部应该给出高层次的概念和算法。细节依次向下展开,直至找到源文件中最底层的函数与细节
  • 5.2.2 概念间垂直方向上区隔
    用空白行隔开各个概念
  • 5.2.3 垂直方向上的靠近
    靠近的代码反应之间的紧密关系(如:变量声明在一起)
  • 5.2.4 垂直距离
    变量声明:变量声明应该尽可能靠近它的使用位置。本地变量应该在函数的顶部出现
    实体变量:应该在类的顶部声明
    相关函数
    某个函数调用另一个,应该将它们放在一起
    概念相关
    概念相关的代码应该放在一起。相关性越强,彼此的距离应该越短
  • 5.2.5 垂直顺序
    自上向下展示函数调用依赖顺序。被调用应该放在调用函数的下面

5.3 横向格式
代码行长度尽力保持上限为120个字符,即IDEA的虚线位置

  • 5.3.1水平方向上的区隔与靠近
    空格字符将彼此相关的事物连接在一起
    int lineSize = line.length();
  • 5.3.2水平对齐
    不要水平对齐
  • 5.3.3 缩进
  • 5.3.4 空范围
while(dis.read(buf, 0, readBufferSize) != -1)
;```
##第六章 对象与数据结构
#### 6.1 数据抽象
具象点:

public class Point{
public double x;
public double y;
}

抽象点:

public interface Point{
double getX();
double getY();
void setCartesian(double x, double y);
double getR();
double getTheta();
void setPolar(double r, double theta);
}

第一个暴露了实现,即使变量是私有的,也能通过赋值器和取值器来使用变量。
第二个呈现了一种数据结构,固定了一种存取策略,但却对实现一无所知。
#### 6.2 数据结构、对象的反对称性
对象把数据隐藏在抽象之后,暴露操作数据的函数。
数据结构暴露其数据,没有提供有意义的函数
过程式代码便于在不改动现有数据结构的情况下添加新函数。
面向对象函数便于在不改动现有函数的前提下添加新类。
#### 6.3 得墨忒耳律
模块不应该了解它所操作的对象的内部情形。这意味着:对象不应该通过存取器暴露其内部结构。
得墨忒耳认为:类C的方法 f 应该调用以下对象的方法
* C
* 由 f 创建的对象
* 作为参数传入的对象
* 由C的实体变量持有的对象
违反该规则的代码
`final String  outputDir = ctxt.getOption().getScratchDir().getAbsolutePath()`
**6.3.1 火车失事**
上述糟糕的代码看起来像一列火车,被称为火车失事。
**6.3.2 混杂**
避免混合结构一般是对象,一半是数据结构
**6.3.3 隐藏结构**
#### 6.4 数据传送对象
只有公共变量、没有函数的类,这种数据结构称为数据传送对象
## 第七章 错误处理
#### 7.1 使用异常代替返回码
#### 7.2 先写Try-Catch-Finally语句
#### 7.3 使用不可控异常
可控异常违反了开放/关闭原则。在有一个函数抛出一个可控异常时,独有调用该函数的函数都需要抛出该异常
#### 7.4 给出异常发生的环境说明
抛出的每个异常,都应该提供足够的环境说明,以便判断错误的来源和处所。
#### 7.5 依调用者需要定义异常类
#### 7.6 定义常规流程
#### 7.7 别返回null值
#### 7.8 别传递null值
null判断
## 第八章 边界
#### 8.1使用第三方代码
在接口提供者和使用者之间存在与生俱来的张力。提供这追求普适性,能够在多个环境中工作;使用者则想要在满足特定需求的接口。这种张力就会在系统边界上出问题。
如:Map,我们希望接收者不要删除映射图的任何东西,但Map却提供了clear方法
#### 8.4学习型测试的好处不只是免费
学习性测试是一种精确实验,帮助我们对API的理解。
#### 8.5 使用上不存在的代码
存在一种边界,将已知和未知分割开的边界。我们有时候不要去向边界那边望过去
#### 8.6 整洁的代码
对于控制不了的代码,我们需要花费时间去小心投资,确保未来的修改不会代价太大
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269

推荐阅读更多精彩内容

  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,293评论 18 399
  • 国家电网公司企业标准(Q/GDW)- 面向对象的用电信息数据交换协议 - 报批稿:20170802 前言: 排版 ...
    庭说阅读 10,503评论 6 13
  • 2014年的苹果全球开发者大会(WWDC),当Craig Federighi向全世界宣布“We have new ...
    yeshenlong520阅读 2,191评论 0 9
  • 最近一个朋友告诉我,他在考虑要不要离婚。我认识他接近一年了,他一直给我的感觉就是个26°的空调,不冷不热刚刚好,...
    漫漫动动阅读 278评论 0 0
  • “这个世界上有一群这样的茶客,他们整天抱怨卖茶人奸滑,无论他们买的茶多少钱,他们都认为自己买贵了。” 当然这句话,...
    微茶记阅读 511评论 0 0