代码整洁之道【9】-- 类

代码整洁之道的前几章都是在讨论如何编写良好的代码行和代码块。
这一章开始探讨代码组织的更高层面:类。

一、类的组织

遵循Java的约定,类应该从一组变量列表开始,接着是函数,大致顺序如下:

1.公有静态常量
2.私有静态变量
3.公有普通变量
4.私有普通变量
5.公共函数
6.私有函数

把某个公共函数调用的私有工具函数放在紧随该公共函数后的位置,这样符合自顶向下规则。

封装:保持变量和工具函数的私有性,但是也并不是墨守成规。有时,我们也需要用到protected类型的变量或工具函数,好让测试代码访问到。

二、类应该精简

跟函数一样,类的首要规则是要更精短。

对于函数我们可以通过行数来衡量大小。对于类,我们通过权责(responsibility)来衡量。

类的名称应该描述其权责。

实际上,命名正是帮助判断类的长度的第一个手段。如果无法为某个类命以精确的名称,这个类大概就太长了。类名越含混,该类可能拥有了过多的职责。

2.1 单一职责原则

单一职责原则定义是:不要存在多于一个导致类变更的原因。通俗地说,即一个类只负责一项职责,类或模块应有且只有一条加以修改的理由。

系统应该由许多短小的类而不是少量巨大的类组成。每个小类封装一个职责,只有一个修改的原因,并与少数其他类一起协同达成期望的系统行为。

关于单一职责原则,感兴趣的读者可自行搜索相关介绍。例如:http://c.biancheng.net/view/1327.html

2.2 内聚

经常听到高内聚低耦合,内聚其实就是指,类应该只有少量成员变量,类中的每个方法都应该操作一个或多个成员变量。通常而言,方法操作的变量越多,就越黏聚到类上。如果一个类中的每个变量都被每个方法使用,则该类具有最大的内聚性。

一般来说,创建这种最大内聚性的类既不可取也不可能,另一方面,我们希望类能有高内聚性,意味着类中的方法和变量相互依赖、互相结合成一个逻辑整体。

如下面这个Stack类所示,这是一个非常内聚的类,三个方法中,只有size()方法没能用到所有成员变量。

public class Stack {
  private int topOfStack = 0;
  List<Integer> elements = new LinkedList<Integer>();

  public int size() {
    return topOfStack;
  }

  public void push(int element) {
    topOfStack++;
    elements.add(element);
  }

  public int pop() throws PoppedWhenEmpty {
    if (topOfStack == 0)
      throw new PoppedWhenEmpty();
    int element = elements.get(--topOfStack);
    elements.remove(topOfStack);
    return element;
  }
}

另外之前函数一章提到过,函数应该尽量短、参数列表尽量短。这有可能会导致类中出现很多只在个别方法中用到的属性,出现这种情况时,应该考虑把这些成员变量和方法分拆到两个或多个类中,让新的类更内聚。

三、为了修改而组织

需求会改变,所以代码也会被修改,所以为了更方便的修改要在设计类的时候进行精心的组织。

在面向对象入门知识中我们学习到,具体类包含实现细节(代码),而抽象类则呈现概念。依赖于具体细节的客户类,当细节改变时,就会有风险。我们可以借助接口和抽象类来隔离这些细节带来的影响。

其实这就是依赖倒置原则(Dependency Inversion Principle , DIP),因为依赖倒置原则的本质,实际上就是认为类应该依赖于抽象,而不是依赖于具体细节。

尽量对设计解耦,做好系统中的元素的相互隔离,做到更加灵活与可复用。

还要考虑面向对象设计的另一个关键原则:OCP(开放-闭合原则),类应该对扩展开放,对修改封闭。在理想系统中,我们通过扩展系统而非修改现有代码来添加新特性。

参考
《代码整洁之道》

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

推荐阅读更多精彩内容