单一职责原则

这是SOLID原则这一系列的第二篇文章,主要来描述单一职责(SRP)原则。SRP指出“每一个类或者类似的代码块应该只有一个职责,所以只有一个原因会使其改变”。

单一职责原则(SRP)声明"一个类的改变的原因绝对不能超过一个"。这意味着你的类或者结构体都应该只有一个工作要做。类中的一切都应该与单一的目的相关。这并不意味着你的类中只包含一个函数或一个属性。只要它符合单一职责,他可以有很多成员。当因为某一原因而发生改变的时候,多个类的成员可能需要修改。也可能造成多个类将需要更新。应用到SRP的应用可以大大改善你的代码。一个关键的变化是你项目中的类将变得更小更整洁。创建紧密集中在单一职责上的类会产生更容易理解和维护的代码。

小而内聚的类的另外一个好处是包含错误的几率降低了。这减少了对更改的需求,因而代码变得不那么脆弱了。Class只履行一项职责,多个Class将一起工作来实现更大的任务。

示例代码

为了演示SRP的应用,我们可以考虑一个违反它的C#类示例,并解释如何遵循原则重构类:

public class OxygenMeter
{
    public double OxygenSaturation { get; set; }
 
    public void ReadOxygenLevel()
    {
        using (MeterStream ms = new MeterStream("O2"))
        {
            int raw = ms.ReadByte();
            OxygenSaturation = (double)raw / 255 * 100;
        }
    }
 
    public bool OxygenLow()
    {
        return OxygenSaturation <= 75;
    }
 
    public void ShowLowOxygenAlert()
    {
        Console.WriteLine("Oxygen low ({0:F1}%)", OxygenSaturation);
    }
}

上面的代码是与硬件设备进行通信以监测某些水中的氧含量的类。该类包括一个名为“ReadOxygenLevel”的方法,该方法从氧监测硬件生成的流中获取值。它转换取到的value为一个百分比然后保存在OxygenSaturation属性中。第二种方法“OxygenLow”检查氧饱和度,以确保其超过最低水平的75%。ShowLowOxygenAlert”显示包含当前饱和度值的alert。
  OxygenMeter类中至少有三个更改原因。如果替代了氧气监测硬件,则需要更新ReadOxygenLevel方法。 如果确定低氧的过程发生变化,也许包括温度变量,则该类将需要更新。 最后,如果告警要求比将文本输出到控制台更复杂,则ShowLowOxygenAlert方法将需要重写。

代码重构

重构代码我们将功能分离到三个类中。第一个是“OxygenMeter”类。 这将包含OxygenSaturation属性和ReadOxygenLevel方法。你可以决定将这些成员分成不同的类。 在这种情况下,我们会把它们保持在一起,因为它们是密切相关的。删除其他方法,以便更改的唯一原因是更换监控硬件。
  第二个类叫“OxygenSaturationChecker”。该类包括将氧气水平与最小可接受值进行比较的单一方法。该方法与原始版本相同,只是添加了一个注入含有要测试的饱和度级别的OxygenMeter对象的参数。类改变的唯一原因是测试过程发生变化。最后一个类为“OxygenAlerter”。 这显示包括当前氧饱和度水平的alert。 再次注入OxygenMeter的依赖关系。 类改变的一个原因是如果报警系统被更新。注意:下面的重构示例代码打破了其他SOLID原则,以便SRP的应用程序可见。

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

推荐阅读更多精彩内容