设计模式:面向对象的设计原则下(ISP、DIP、KISS、YAGNI、DRY、LOD)

0ba375bafb018911716a97d97dcd4371.png

本文继续来介绍接口隔离原则(ISP)和依赖倒置原则(DIP),这两个原则都和接口和继承有关。文章最后会简单介绍几个除了 SOLID 原则之外的原则。

接口隔离原则(ISP)

提起接口,开发人员的第一反应可能是面向对象编程语言中的 interface ,但接口更广义的理解会包含:

  • 编程语言中的 interface;

  • RESTful Web API 、Web Service、gRPC 等这种对外提供服务的接口;

  • 类库中的公共方法。

不管是上面的哪一种,要想设计好,就需要用到接口隔离原则了。

接口隔离原则的定义是:

不应强迫使用者依赖于它们不用的方法。

接口被设计出来后,就会有地方对接口进行调用,调用的地方希望接口中提供的方法都是他需要的,所以在接口设计的时候,需要考虑应该将哪些方法放入其中,让调用者使用,这就是对定义的解释。

相反,如果不精心设计,接口就会变得越来越庞大,会带来两个问题:

1、在一个更高层的接口中添加一个方法只是为了某一个子类使用,所有的子类都必须对其实现,或提供一个默认实现;

2、接口中包罗万象,调用者可能会误用其中的方法。

举个例子:我们现在正在开发 SaaS 产品,里面会涉及到对租户的操作,比如租户需要注册、登录等,抽象成接口代码如下:

public interface ITenant
{public void Register(string mobile,string password);public void Login(string mobile,string password);
}
public class Tenant : ITenant
{public void Register(string mobile, string password){throw new NotImplementedException();}public void Login(string mobile, string password){throw new NotImplementedException();}
}

上面的操作是针对租户这个角色的,现在有新的需求来了,对于 SaaS 厂商的管理员来说,希望能禁用租户,一种偷懒的做法就是直接在 ITenant 接口中添加禁用的方法,如下:

public interface ITenant
{public void Register(string mobile,string password);public void Login(string mobile,string password);public void Diabled(string tenantCode);
}
public class Tenant : ITenant
{// ...public void Diabled(string tenantCode){throw new NotImplementedException();}
}

上面的代码就违反了接口隔离原则,因为在普通租户的使用场景下,并不希望能调用到 Diabled 方法,正确的做法是将这个方法抽象到一个新的接口中,如下:

public interface ITenant
{public void Register(string mobile,string password);public void Login(string mobile,string password);}
public interface ITenantForAdmin
{public void Diabled(string tenantCode);
}

可以看出来,改造之后,每个接口的职责更加单一了,好像跟单一职责有点类似,仔细想想,还是有些区别,单一职责原则针对的是方法、类和接口的设计。而接口隔离原则更侧重于接口的设计,另一方面就是思考的角度不同,在上面例子中,按照普通租户和管理员两种不同角色的维度来思考并进行拆分。

依赖倒置原则(DIP)

这个原则的名字中有两个关键词「依赖」和「倒置」,先来看看这两个词是什么意思?

依赖:在面向对象的语言中,所说的依赖通常指类与类之间的关系,比如有个用户类 User 和日志类 Log , 在 User 类中需要记录日志,就需要引入日志类 Log,这样 User 类就对 Log 类产生了依赖,代码如下:

public class User
{private Log _log=new Log();public string GetUserName(){_log.Write("获取用户名称");return "oec2003";}
}
public class Log
{public void Write(string message){Console.WriteLine(message);}
}

倒置:有依赖的倒置,那肯定就有正常的依赖,我们正常的编程思维都是从上而下来编写业务逻辑的,遇到分支就写 if ,遇到循环就写 for ,需要创建对象就 new 一个,就像上面的代码,上面的代码就是一种正常的依赖。User 类依赖了 Log 类,如果倒置了,那就是 User 类不再依赖 Log 类了,下面会进一步来解释。

正常的依赖会带来的问题是:User 类和 Log 类高度耦合,当有一天我们想使用 NLog 或者 Serilog 替换 Log 类时,就需要改动 User 类,说明日志类的实现是不稳定的,而依赖一个不稳定的东西,从架构设计的角度来看,不是一个好的做法。解决此问题就需要用到依赖倒置原则。

先来看看依赖倒置原则的定义:

高层模块不应依赖于低层模块,二者应依赖于抽象。

抽象不应依赖于细节,细节应依赖于抽象。

什么是高层模块?什么是低层模块?按照上面的代码示例,User 类是高层模块,Log 类是低层模块,二者都要依赖于抽象,就需要提取接口了:

public interface ILog
{public void Write(string message);
}
public class Log:ILog
{public void Write(string message){Console.WriteLine(message);}
}
public class User
{private ILog _log;public User(ILog log){_log = log;}public string GetUserName(){_log.Write("获取用户名称");return "oec2003";}
}

调整后的代码 User 类中依赖变成了 ILog 接口,日志的实现类 Log 也依赖 ILog 接口,即从 ILog 接口继承而来,现在都是依赖 ILog 接口,这就是依赖倒置。

当想要将日志组件替换为 NLog 时,只需要创建一个新的类 NLogAdapter 类继承 ILog 接口,在 NLogAdapter 类中引入 NLog 组件。

public class NLogAdapter:ILog
{private NLog _log=new NLog();public void Write(string message){_log.Write(message);}
}

这样,当日志组件替换的时候,User 类就不用修改了,因为 User 类的构造函数中使用的是 ILog 接口来接收的日志组件的对象,那到底是谁决定传递 Log 对象还是 NLogAdapter 对象呢?这就要引入一个新的概念叫「依赖注入」。

关于依赖注入可以看我之前写的两篇文章:

  • dotNET Core 3.X 依赖注入

  • dotNET Core 3.X 使用 Autofac 来增强依赖注入

依赖倒置是一种架构设计思想,指导架构层面的设计,依赖注入则是一种具体的编码技巧,用来实现这种设计思想。

其他原则

除了 SOLID 五大原则之外,还有一些原则也在指引我们设计好的代码架构方面发挥着作用:

  • KISS

  • YAGNI

  • DRY

  • LOD

KISS

KISS 的全称是:Simple and Stupid ,该原则就是告诉我们,在设计时要尽量保持简单,大道至简嘛。这里的简单不完全是指代码的简洁。现在已经不是单打独斗的时代,大部分情况下开发人员都是在一个团队中协同工作,所以我认为对简单的理解可以分为:

  • 代码的可读性要强,团队要遵循一定的规范;

  • 不要使用一些你认为很“高深”的技巧,应该使用团队都熟知或者较为广泛的编码方式;

  • 避免过度设计,一个很简单的逻辑或者一些一次性的业务为了秀技术而设计的非常复杂是大可不必的。

将复杂的东西能够深入浅出,做到简单、简洁,这是能力的体现。

YAGNI

YAGNI 的全称是:You Ain’t Gonna Need It。直译就是:你不会需要它。核心思想就是指导我们不要做过度设计。

1、当我们能识别到代码的变化点的时候,可以预留扩展点,但不要提前做复杂的实现;

2、持续重构来优化代码,而不是一开始就提取各种通用方法,例如一个私有函数只有一个调用的时候,就放在类里面,离调用者最近的地方,当有不止一处都会使用时,再考虑重构来进行通用方法的抽取。

过度设计会浪费资源,让代码复杂度变大,难以阅读和维护。

DRY

DRY 的全称是:Don’t Repeat Yourself ,就是不要重复自己,提升代码的复用性,告别 CV 大法。

很多初级程序员都喜欢面向 Ctrl+C、Ctrl+V 编程,当需求变化的时候,很容易就遗漏一些场景,但即便是复制粘贴也不完全都是违反 DRY 。

代码的重复有两种情况:

1、代码的逻辑重复,语义也重复:这种违反了 DRY ,需要进行重构;

2、代码的逻辑重复,语义不重复:在某个阶段,两段代码逻辑是相同的,但其实是两种不同的应用场景,语义不一样,就没有违反 DRY。如果对这种代码进行重构提取成公共方法,随着业务发展,两种不同的场景独立演化了,稍不注意,代码中就会出现各种 if 判断,影响可读性和可维护性。

LOD

LOD 全称是:The Least Knowledge Principle ,也被称之为迪米特法则。该法则有两条指导原则:

1、不该有直接依赖关系的类之间,不要有依赖;

2、有依赖关系的类之间,尽量只依赖必要的接口。

其实就是一直流传的代码要高内聚、低耦合,单一职责和接口隔离想要表达的也是这个意思,区别只是侧重点有所不同:

  • 单一职责:针对的是方法、类和接口的设计,关注的是方法、类本身;

  • 接口隔离:针对的是接口拆分、关注的是调用者的角色;

  • 迪米特:关注类之间的关系。

各种原则之间相辅相成,有很多只是有些细微的差别,慢慢理解原理,才能以不变应万变。

做项目和产品的软件开发,为了使代码能易读、可扩展、可复用,我们需要遵循这些原则来进行架构设计,做平台级的产品更是如此,比如我们的低代码平台,如有兴趣欢迎扫下面二维码进群讨论。

8028dbc2df29806ee171a94305fcc12e.png

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/294040.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

ADB server didn't ACK

当我们通过eclipse开发Android应用时,会连接真机会使用模拟器进行仿真,有时候启动失败,会提示这样的错误。 工具/原料 Eclipse CMD命令窗口 方法/步骤 首先通过CMD启动adb服务。这个时候会提示启动失败。 服务启动失败的原因有很多&#xff0…

android方块密码输入框,Android仿微信/支付宝的方块密码输入框

在用到支付类或者验证类app时,都有一个简密的输入框。百度了下有个不错的帖子点击打开链接不过自己也写了个简单的类似的。不废话了。没图说个席八。懒得运行,直接截layout.xml的效果图先。布局文件android:layout_width"fill_parent"android:…

童鞋,[HttpClient发送文件的技术实践]请查收

昨天有童鞋在群里面问:怎么使用HttpClient发送文件?01荒腔走板之前我写了一个《ABP小试牛刀之上传文件》,主要体现的是服务端,上传文件的动作是由前端小姐姐完成的, 我还真没有用HttpClient编程方式发送过文件。不过Ht…

elasticsearch2.2之javaApi

2019独角兽企业重金招聘Python工程师标准>>> 前言:elasticsearch虽然自带rest接口,但是在真正使用过程中可能更多的是通过不同编程语言的客户端进行交互。 因为代码里有或多或少的注释,所以直接贴代码: package elasti…

《程序员的职业素养》读书笔记

书籍地址:http://book.douban.com/subject/11614538/ 一句话点评该书:Bob大叔的职业生涯经验总结,现身说法,可信可敬! (一)专业主义 (1)“专业主义”就意味着担当责…

html 转义反斜杠字符串,JS中处理单个反斜杠(即转义字符的处理)

问题来源:在表单的标签中对输入的字符串进行大写转换。一不小心输入了反斜杠 \如下图所示:输入 chn\ 的时候,在 IE8 下弹出一个js错误。(在实际的项目的表单元素中遇到了,单独这样拿出来测试的时候又不弹出错误。也很是焦灼)索…

C# 值得永久收藏的WPF项目实战(经典)

01—简介之前也写过好多篇CM框架相关的项目实战文章,比如:C# WPF框架Caliburn.Micro快速搭建C# WPF框架Caliburn.Micro入门实例1C# WPF MVVM项目实战(进阶①)C# WPF MVVM项目实战(进阶②)C# WPF MVVM模式下在主窗体显示子窗体并获取结果C# WPF Caliburn.…

InfoQ十周年:不忘初心,继续前行

我们都知道:软件正在改变世界,也已经看到了在加快这种变化时,于软件世界中我们的影响力。在这种热情下,10年前我们带着一些不寻常的信念与情怀创建了InfoQ:\\\\t我们相信:这个社区需要的内容是开发者所撰写…

Oracle 在 多个Virtualbox 虚拟机间 跨不同物理宿主机进行通信

因为单位网络管理的原因,不太方便使用 Virtualbox 的Bridge Adapter 模式,故此欲采用NAT模式,不对外不暴露虚拟机IP。 但是此时会有一个问题:采用NAT模式后,在通常情况下, 从外面看,或者从物理机…

亚马逊 html代码转换,亚马逊七种产品描述常用HTML代码,文字颜色代码让Listing更出彩...

排版风格和排版水平对于亚马逊Listing的运营至关重要。虽说亚马逊以产品为王,但如果消费者打开的是一篇毫无美感的排版,视觉体验不舒服,获取不到吸引他的卖点,转化率将大大降低!没使用HTML代码的卖家,产品描…

java 文件上传至oracle blob字段 实现

2019独角兽企业重金招聘Python工程师标准>>> 指定文件夹下的所有文件上传至oracle的blob字段,java实现 package com.huth;import java.io.File; import java.io.FileNotFoundException; import java.io.IOException; import java.io.FileInputStream; i…

中国这门失传已久的武林绝学,竟让研究它的老外拿了诺贝尔奖

全世界只有3.14 % 的人关注了爆炸吧知识欲练神功学好物理中国武术,博大精深。能够掌握一门武林绝学,是全世界男人的终极梦想。可翻翻公认的武林十大绝学:葵花宝典、六脉神剑、九阳神功....不是断子绝孙,就是杀人于无形&#xff0c…

中国地区三级联动下拉菜单的实现

1.首先是js文件(area.js): 1 function Dsy()2 {3 this.Items {};4 }5 Dsy.prototype.add function(id,iArray)6 {7 this.Items[id] iArray;8 }9 Dsy.prototype.Exists function(id)10 {11 if(typeof(this.Items[id]) "undefined") return false;12 r…

html 图片 填充方式,css怎么让图片填满?

在css中,可以将div的高度和宽度属性设置为100%,同时使用background-size属性设置背景图片为100%,便可以实现背景图片铺满屏幕。css怎么让图片填满?1、新建一个HTML文件,使用div标签创建一个模块,并设置其cl…

solrcloud线上创建collection,修改默认配置

一、先看API,创建collection1、上传配置文件到zookeeper1) 本地内嵌zookeeper集群:java -classpath ./solr-webapp/webapp/WEB-INF/lib/* org.apache.solr.cloud.ZkCLI -cmd upconfig -zkhost localhost:9983,localhost:8574,localhost:9900 …

豆瓣评分9.4!这一部纪录片,探秘中国的未至之境!

全世界只有3.14 % 的人关注了爆炸吧知识Bilibili 联合“美国国家地理”,悄悄出品了一部史诗级动物记录片,忍不住要推荐给大朋友小朋友们——《未至之境》。这部纪录片由B站和国家地理联合创作,从绵延万里的山脉高原到枝繁叶茂的雨林竹海&…