代码设计原则之单一原则

前言

设计原则是比设计模式更为抽象的概念,设计模式可以说是设计原则的具象化,因此学习并掌握设计原则,才能更好的使用设计模式。

在实际代码开发中,自己有时也会对该遵循哪种设计原则,运用哪种设计模式而难以抉择。不知你们是否会有这种感觉:遵循了设计原则A,但是又看起来违背了设计原则B。这或许便是对设计原则理解不够深刻,或许我们陷入了一个误区,为了设计原则/设计模式而去编写设计原则/设计模式的代码。
而实际上,设计原则/设计模式本质上是服务于编写高质量代码的,从而提高代码的可维护性、可读性、可扩展性、灵活性、简洁性等。

如何理解单一职责原则(SRP)

A class or module should have a single reponsibility
一个类或者模块只负责完成一个职责(或者功能)

单一职责原则的定义描述非常简单:
一个类只负责完成一个职责或者功能。也就是说,不要设计大而全的类,要设计粒度小、功能单一的类。换个角度来讲就是,一个类包含了两个或者两个以上业务不相干的功能,那我们就说它职责不够单一,应该将它拆分成多个功能更加单一、粒度更细的类。

一看就会,一做就废系列.gif

案例分析一

一个类,只有一个引起它变化的原因。应该只有一个职责。每一个职责都是变化的一个轴线,如果一个类有一个以上的职责,这些职责就耦合在了一起。这会导致脆弱的设计。

在你们的产品首页,是一个返回各种数据的图表面板。下面是返回数据的类,你觉得是否满足单一原则

public class ChartServiceImpl {
    // 获取图表定义
    public List<Chart> getCharts() {...}
    // 获取图表数据
    public List<Data> getChartData() {
          ...
          Chart chart = parseChartConfig(chart);
          ...
    }
    // 解析图表配置
    private Chart parseChartConfig(Chart chart) {...}
}

随着需求的迭代变更,当图表的解析规则发生变化时,就需要改动parseChartConfig方法;当图表的取数逻辑或是数据的处理方式发生变动时,就需要更改getChartData方法。

两种情况,都会引起ChartServiceImpl类的修改。

刚开始,业务简单的时候,我们可以暂时将这些方法放置在一起,写一个粗粒度的类,满足业务需求。当随着业务的复杂,类开始朝着臃肿发展时,你就需要考虑将一些方法剥离出来,就如上面例子的parseChartConfig方法,你可以新建一个类专门去处理图表配置解析,如 ChartConfigParser

类的职责是否越单一越好?

答案当然是否定的,类的粒度拆分得越细,我们需要维护的类就越多,反而导致功能过度分散,而不是内聚了。

看一个解析key字符串为对象和转换key对象为json的例子

public class KeyProcessor {
    // 解析规则,可能存在某些key需要特殊处理等
    private static final Map<String, Object> rules; 
    
    public Key parseJson2Key(Sting keyJson) {
        // 将json根据规则解析成key对象
    }
    
    public String convert2Json(Key key) {
        // 将key根据对着转换成json字符串,用于持久化等
    }
}

如果让类的职责更加单一的话,将上面的类拆分成两个:

public class KeyParser {
    // 解析规则,可能存在某些key需要特殊处理等
    private static final Map<String, Object> rules; 
    
    public Key parseJson2Key(Sting keyJson) {
        // 将json根据规则解析成key对象
    }
}

public class KeyConverter {
    // 解析规则,可能存在某些key需要特殊处理等
    private static final Map<String, Object> rules; 
    
    public String convert2Json(Key key) {
        // 将key根据对着转换成json字符串,用于持久化等
    }
}

拆分后类的职责更加单一了,但是当规则有所变更的时候,就需要同时对两个类进行修改,代码的内聚性没以前高了,维护成本也变高了,也就是说,经过拆分,代码的可维护性变差了,这可不是我们想要的结果。

实际上,不管是应用设计原则还是设计模式,最终的目的还是提高代码的可读性、可扩展性、复用性、可维护性等。我们在考虑应用某一个设计原则是否合理的时候,也可以以此作为最终的考量标准。

回顾总结

1. 如何理解单一职责原则(SRP)?
一个类只负责完成一个职责或者功能。不要设计大而全的类,要设计粒度小、功能单一的类。单一职责原则是为了实现代码高内聚、低耦合,提高代码的复用性、可读性、可维护性。

2. 如何判断类的职责是否足够单一?

  • 类中的代码行数、函数或属性过多,会影响代码的可读性和可维护性,我们就需要考虑对类进行拆分;
  • 类依赖的其他类过多,或者依赖类的其他类过多,不符合高内聚、低耦合的设计思想,我们就需要考虑对类进行拆分;
  • 私有方法过多,我们就要考虑能否将私有方法独立到新的类中,设置为 public 方法,供更多的类使用,从而提高代码的复用性;
  • 比较难给类起一个合适名字,很难用一个业务名词概括,这就说明类的职责定义得可能不够清晰;
  • 类中大量的方法都是集中操作类中的某几个属性,此时应考虑对属性进行拆分
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,525评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,203评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,862评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,728评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,743评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,590评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,330评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,244评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,693评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,885评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,001评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,723评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,343评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,919评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,042评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,191评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,955评论 2 355