软件架构设计原则

本贴最后更新于 202 天前,其中的信息可能已经沧海桑田

1.1 开闭原则

开闭原则(Open-Closed Principle,COP)是指一个软件实体(如类、模块和函数)应该对扩展开放,对修改关闭。所谓的关闭,也正是对扩张和修改两个行为的一个原则。它强调的是用抽象构建框架,用实现扩展细节,可以提高软件系统的客服用心及可维护性。开闭原则是对面向对象设计最基础的设计原则,它知道我们如何建立稳定、灵活的系统。例如版本更新,我们尽可能不修改源代码,但是可以增加新功能。

在现实生活中开闭原则也有体现。比如,很多互联网公司都实行弹性作息时间,只规定每天工作 8 小时。意思就是说,对于每天工作 8 小时这个规定是关闭的,但是你什么时候来、什么时候走时开放的。早来早走,晚来晚走。

开闭原则的核心思想就是面向抽象编程,接下来我们来看一段代码。

以咕泡学院的课程体系为例,首先创建一个课程接口 ICourse:

public interface ICourse {
    Integer getId();

    String getName();

    Double getPrice();
}

整个课程生态有 Java 架构、大数据、人工智能、前端、软件测试等,我们来创建一个 Java 架构课程的类 JavaCourse:

public class JavaCourse implements ICourse {
    private final Integer id;
    private final String name;
    private final Double price;

    public JavaCourse(Integer id, String name, Double price) {
        this.id = id;
        this.name = name;
        this.price = price;
    }

    public Integer getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public Double getPrice() {
        return price;
    }
}

现在我们要给 Java 架构课程做活动,价格优惠。如果修改 JavaCourse 中的 getPrice( ) 方法,则存在一定的风险,可能影响其他方法的调用结果。我们如何在不修改原有代码的前提下,实现价格优惠这个功能呢?现在,我们再写一个处理优惠逻辑的类 JavaDiscountCourse(思考一下为什么要叫 JavaDiscountCourse,而不叫 DiscountCourse):

public class JavaDiscountCourse extends JavaCourse {

    public JavaDiscountCourse(Integer id, String name, Double price) {
        super(id, name, price);
    }

    public Double getOriginPrice() {
        return super.getPrice();
    }

    public Double getPrice() {
        return super.getPrice() * 0.61;
    }

}

回顾一下,简单看一下类结构图,如下图所示。

image

1.2 依赖倒置原则

依赖倒置原则(Dependence Inversion Principle,DIP)是指设计代码结构时,高层模块不应该依赖低层模块,二者都应该依赖其抽象。抽象不应该依赖细节,细节应该依赖抽象。通过依赖倒置,可以减少类与类之间的耦合性,提高系统的稳定性,提高代码的可读性和可维护性,并且能够降低修改程序说造成的风险。接下来看一个案例,还是以 Course(课程)为例,先来创建一个类 Tom:

public class Tom {
    public void studyJavaCourse() {
        System.out.println("Tom在学习Java课程");
    }

    public void studyPythonCourse() {
        System.out.println("Tom在学习Python课程");
    }
}

来调用一下:

    public static void main(String[] args) {
        Tom tom = new Tom();
        tom.studyJavaCourse();
        tom.studyPythonCourse();
    }

Tom 热爱学习,目前正在学习 Java 课程和 Python 课程。大家都知道,学习也是会上瘾的。随着学习兴趣的“暴涨”,现在 Tom 还想学习 AI(人工智能)的课程。这时候,因为业务扩展,要从低层到高层(调用层)依次修改代码。在 Tom 类中增加 studyAiCourse()方法,在高层也要追加调用。如此一来,系统发布以后,实际上是非常不稳定的,在修改代码的同时也会带来意想不到的风险。接下来我们优化代码,创建一个课程抽象类 ICourse 接口:

public interface ICourse {
    void study();
}

然后编写 JavaCourse 类:

public class JavaCourse implements ICourse {
    @Override
    public void study() {
        System.out.println("Tom在学习Java课程");
    }
}

再实现 PythonCourse 类:

public class PythonCourse {
    public void study() {
        System.out.println("Tom在学习Python课程");
    }
}

修改 Tom 类:

public class Tom {
    public void study(ICourse course) {
        course.study();
    }
}

来看调用代码:

    public static void main(String[] args) {
        Tom tom = new Tom();
        tom.study(new JavaCourse());
        tom.study(new PythonCourse());
    }

这时候再来看代码,Tom 的兴趣无论怎么暴涨,对于新的课程,只需要新建一个类,通过传参的方式告诉 Tom,而不需要修改底层代码。实际上这是一种大家非常熟悉的方式,叫依赖注入。注入的方式还有构造器方式和 Setter 方式。我们来看构造器注入方式:

public class Tom {
    private final ICourse course;

    public Tom(ICourse course) {
        this.course = course;
    }

    public void study() {
        course.study();
    }
}

看调用代码:

    public static void main(String[] args) {
        Tom tom = new Tom(new JavaCourse());
        tom.study();
    }

根据构造器方式注入,在调用时,每次都要创建实例。如果 Tom 是全局单例,则我们就只能选择用 Setter 方式来注入,继续修改 Tom 类的代码:

public class Tom {
    private ICourse course;

    public void setCourse(ICourse course) {
        this.course = course;
    }

    public void study() {
        course.study();
    }
}

看调用代码:

    public static void main(String[] args) {
        Tom tom = new Tom();
        tom.setCourse(new JavaCourse());
        tom.study();
        tom.setCourse(new PythonCourse());
        tom.study();
    }

现在我们再来看最终的类图,如下图所示。

image

大家要切记:以抽象为基准比以细节为基准搭建起来的架构要稳定得多,因此在拿到需求之后,要面向接口编程,先顶层再细节地设计代码结构。

1.3 单一职责原则

单一职责(Simple Responsibility Pinciple,SRP)是指不要存在多于一个导致类变更的原因。假设我们有一个类负责两个职责,一旦发生需求变更,修改其中一个职责的逻辑代码,有可能导致另一个职责的功能发生故障。这样一来,这个类就存在两个导致类变更的原因。如何解决这个问题呢?将两个职责用两个类实现,进行解耦。后期需求变更维护互不影响。这样的设计,可以降低类的复杂度,提高类的可读性,提高系统的可维护性,降低变更引起的风险。总体来说,就是一个类、接口或方法只负责一项职责。

接下来,我们来看代码实例,我们的课程有直播课和录播课。直播课不能快进和快退,录播课程可以任意地反复观看,功能职责不一样。还是先创建一个 Course 类:

public class Course {
    public void study(String courseName) {
        if ("直播课".equals(courseName)) {
            System.out.println(courseName + "不能快进");
        } else {
            System.out.println(courseName + "可以反复回看");
        }
    }
}

看调用代码:

    public static void main(String[] args) {
        Course course = new Course();
        course.study("直播课");
        course.study("录播课");
    }

从上面的代码来看,Course 类承担了两种处理逻辑。假如现在要对课程进行加密,直播课程和录播课程的加密逻辑不一样,必须修改代码。而修改代码的逻辑势必会相互影响,容易带来不可控的风险。我们对职责进行解耦,来看代码,分别创建两个类:LiveCourse 和 ReplayCourse。

LiveCourse 类的代码如下:

public class LiveCourse {
    public void study(String courseName) {
        System.out.println(courseName + "不能快进看");
    }
}

ReplayCourse 类的代码如下:

public class ReplayCourse {
    public void study(String courseName) {
        System.out.println(courseName + "可以反复回看");
    }
}

调用代码如下:

    public static void main(String[] args) {
        LiveCourse liveCourse = new LiveCourse();
        liveCourse.study("直播课");

        ReplayCourse replayCourse = new ReplayCourse();
        replayCourse.study("录播课");
    }

业务继续发展,课程要做权限。没有付费的学员可以获取课程基本信息,已经付费的学员可以获得视频流,即学习全限。那么在控制课程层面上至少有两个职责。我们可以把展示职责和管理职责分离开来,都实现同一个抽象依赖。设计一个顶层接口,创建 ICourse 接口:

public interface ICourse {

    // 获得基本信息
    String getCourseName();

    // 获得视频流
    byte[] getCourseVideo();

    // 学习课程
    void studyCourse();

    // 退款
    void refundCourse();
}

我们可以把这个接口拆成两个接口:ICourseInfo 和 ICourseManager。

ICourseInfo 接口的代码如下:

public interface ICourseInfo {
    // 获得基本信息
    String getCourseName();

    // 获得视频流
    byte[] getCourseVideo();
}

ICourseManager 接口的代码如下:

public interface ICourseManager {
    // 学习课程
    void studyCourse();

    // 退款
    void refundCourse();
}

来看一下类图,如下图所示。

CourseImpl

下面我们来看一下方法层面的单一职责设计。有时候我们会偷懒,把一个方法写成下面这样:

private void modifyUserInfo(String userName,String address){
	userName = "Tom";
	address = "Changsha";
}

还可能写成这样:

private void modiryUserInfo(String userName,String... fileds){
	userName = "Tom";
// address = "Changsha";
}
private void modifyUserInfo(String userName,String address,boolean bool){
	if(bool){

	}else{

	}

	userName = "Tom";
	address = "Changsha";
}

显然,上面的 modifyUserInfo ( ) 方法承担了多个职责,既可以修改 userName,也可以修改 address,甚至更多,明显不符合单一职责。我们做如下修改,把这个方法拆分成两个方法:

private void modifyUserName(String userName){
	userName = "Tom";
}
private void modifyAddress(String address){
	address = "Changsha";
}

修改之后,开发起来简单,维护起来也容易。我们在实际开发中会有项目依赖、组合、聚合这些关系,还有项目的规模、周期、技术人员的水平、对进度的把控,很多类都不符合单一职责。但是,我们在编写代码的过程,尽可能地让接口和方法保持单一职责,对项目后期的维护是有很大帮助的。

1.4 接口隔离原则

接口隔离原则(Interface Segregation Principle,ISP)是指用多个专门的接口,而不使用单一的总接口,客户端不应该依赖它不需要的接口。这个原则指导我们在设计时应当注意以下几点:

(1)一个类对另一个类的依赖应该建立在最小的接口之上。

(2)建立单一接口,不要建立庞大臃肿的接口。

(3)尽量细化接口,接口中的方法尽量少(不是越少越好,一定要适度)。

接口隔离原则符合我们常说的高内聚、低耦合的设计思想,可以使类具有很好的可读性、扩展性和可维护性。我们在设计接口的时候,要多花时间去思考,要考虑业务模型,包括对以后有可能发生变化的地方还有做一些预判。所以,对于抽象、对于业务模型的理解是非常重要的。下面我们来看一段代码,对一个动物行为进行抽象描述。

IAminal 接口的代码如下:

public interface IAnimal {
    void eat();

    void walk();

    void sleep();
}

Bird 类的代码如下:

public class Bird implements IAnimal {
    @Override
    public void eat() {
  
    }

    @Override
    public void walk() {

    }

    @Override
    public void sleep() {

    }
}

Dog 类的代码如下:

public class Dog implements IAnimal{
    @Override
    public void eat() {
  
    }

    @Override
    public void walk() {

    }

    @Override
    public void sleep() {

    }
}

可以看出,Bird 的 swim()方法可能只能空着,但 Dog 的 fly()方法显然是不可能的。这时候,我们针对不同动物行为来设计不同的接口,分别设计 IEatAnimal、IFlyAnimal 和 ISwimAninal 接口,来看代码。

IEatAnimal 接口的代码如下:

public interface IEatAnimal {
    void eat();
}

IFlyAnimal 接口的代码如下:

public interface IFlyAnimal {
    void fly();
}

ISwimAnimal 接口的代码如下:

public interface ISwimAnimal {
    void swim();
}

Dog 只实现 IEatAnimal 和 ISwimAnimal 接口,代码如下:

public class Dog implements ISwimAnimal, IEatAnimal {
    @Override
    public void eat() {

    }

    @Override
    public void swim() {

    }
}

来看一下两种类图的对比,如下图所示,还是非常清晰明了的。

image

1.5 迪米特原则

迪米特原则(Lay of Demeter,LoD)是指一个对象应该对其他对象保持最少得了解,又叫最少知道原则(Least Knowledge Principle,LKP),尽量降低类与类之间的耦合度。迪米特原则主要强调:只和朋友交流,不和陌生人说话。出现在成员变量、方法的输入、输出参数中的类都可以称为成员朋友类,而出现在方法体内部的类不属于朋友类。

现在来设计一个权限系统,Boss 需要查看目前发布在线上的课程数量。这时候,Boss 要找到 TeamLeader 去进行统计,TeamLeader 再把统计结果告诉 Boss。接下来我们还是来看代码。

Course 类的代码如下:

public class Course {
}

TeamLeader 类的代码如下:

public class TeamLeader {
    public void checkNumberOfCourses(List<Course> courseList) {
        System.out.println("目前已发布的课程数量为:" + courseList.size());
    }
}

Boss 类的代码如下:

public class Boss {
    public void commandCheckNumber(TeamLeader teamLeader) {
        // 模拟Boss一页一页往下翻页,TeamLeader实时统计
        List<Course> courseList = new ArrayList<>();
        for (int i = 0; i < 20; i++) {
            courseList.add(new Course());
        }
        teamLeader.checkNumberOfCourses(courseList);
    }
}

测试代码如下:

    public static void main(String[] args) {
        Boss boss = new Boss();
        TeamLeader teamLeader = new TeamLeader();
        boss.commandCheckNumber(teamLeader);
    }

写到这里,其实功能都已经实现,代码看上去也没什么问题。根据迪米特原则,Boss 只想要结果,不需要跟 Course 直接交流。而 TeamLeader 统计需要引用 Course 对象。Boss 和 Course 并不是朋友,从下面的类图就可以看出来。

image

下面对代码进行改造。

TeamLeader 类的代码如下:

public class TeamLeader {
    public void checkNumberOfCourses() {
        List<Course> courseList = new ArrayList<>();
        for (int i = 0; i < 20; i++) {
            courseList.add(new Course());
        }
        System.out.println("目前已发布的课程数量是:" + courseList.size());
    }
}

Boss 类的代码如下:

public class Boss {
    public void commandCheckNumber(TeamLeader teamLeader) {
        teamLeader.checkNumberOfCourses();
    }
}

再来看下面的类图,Course 和 Boss 已经没有关联了。

image

学习软件设计原则,千万不能形成强迫症。碰到业务复杂的场景,我们需要随机应变。

1.6 里氏替换原则

里氏替换原则(Liskov Substitution Principle,LSP)是指如果对每一个类型为 T1 的对象 O1,都有类型为 T2 的对象 O2,使得以 T1 定义的所有程序 P 在所有的对象 O1 都替换成 O2 时,程序 P 的行为没有发生变化,那么类型 T2 是类型 T1 的子类型。

这个定义看上去还是比较抽象的,我们重新理解一下。可以理解为一个软件实体如果适用于一个父类,那么一定适用于其子类,所用引用父类的地方必须能透明地使用其子类的对象,子类对象能够替换父类对象,而程序逻辑不变。根据这个理解,引申含义为:子类可以扩展父类的功能能,但不能改变父类原有的功能。

(1)子类可以实现父类的抽象方法,但不能覆盖父类的非抽象方法。

(2)子类可以增加自己特有的方法。

(3)当子类的方法重载父类的方法时,方法的前置条件(即方法的输入/入参)要比父类方法的输入参数更宽松。

(4)当子类的方法实现父类的方法时(重写/重载或实现抽象方法),方法的后置条件(即方法的输出/返回值)要比父类更严格或与父类一样。

在讲开闭原则的时候我埋下了一个伏笔,在获取折扣时重写覆盖了父类的 getPrice()方法,增加了一个获取原价格的方法 getOriginPrice(),显然就违背了里氏替换原则。我们修改一下代码,不应该覆盖 getPrice()方法,增加 getDiscountPrice()方法:

public class JavaDiscountCourse extends JavaCourse {
    public JavaDiscountCourse(Integer id, String name, Double price) {
        super(id, name, price);
    }

    public Double getDiscountPrice() {
        return super.getPrice() * 0.61;
    }
}

使用里氏替换原则有以下优点:

(1)约束继承泛滥,是开闭原则的一种体现。

(2)加强程序的健壮性,同时变更时也可以做到非常好的兼容性,提高程序的可维护性和扩展性,降低需求变更时引入的风险。

现在来描述一个经典的业务场景,用正方形、矩形和四边形的关系说明里氏替换原则,我们都知道正方形是一个特殊的长方形,所以就可以创建一个父类 Rectangle:

public class Rectangle {
    private long height;
    private long width;

    public long getWidth() {
        return width;
    }

    public void setWidth(long width) {
        this.width = width;
    }

    public long getHeight() {
        return height;
    }

    public void setHeight(long height) {
        this.height = height;
    }
}

创建正方形类 Square 继承 Rectangle 类:

public class Square extends Rectangle {
    private long length;

    public long getLength() {
        return length;
    }

    public void setLength(long length) {
        this.length = length;
    }

    @Override
    public long getWidth() {
        return length;
    }

    @Override
    public void setWidth(long width) {
        setLength(width);
    }

    @Override
    public long getHeight() {
        return getLength();
    }

    @Override
    public void setHeight(long height) {
        setLength(height);
    }
}

在测试类中创建 resize()方法,长方形的宽应该大于等于高,我们让高一直自增,直到高等于宽,变成正方形:

    public static void resize(Rectangle rectangle) {
        while (rectangle.getWidth() >= rectangle.getHeight()) {
            rectangle.setHeight(rectangle.getHeight() + 1);
            System.out.println("width: " + rectangle.getWidth() + ", height: " + rectangle.getHeight());
        }
        System.out.println("resize方法结束\n" +
                "width: " + rectangle.getWidth() + ", height: " + rectangle.getHeight());
    }

测试代码如下:

    public static void main(String[] args) {
        Rectangle rectangle = new Rectangle();
        rectangle.setWidth(20);
        rectangle.setHeight(10);
        resize(rectangle);
    }

运行结果如下所示:

width: 20, height: 11
width: 20, height: 12
width: 20, height: 13
width: 20, height: 14
width: 20, height: 15
width: 20, height: 16
width: 20, height: 17
width: 20, height: 18
width: 20, height: 19
width: 20, height: 20
width: 20, height: 21
resize方法结束
width: 20, height: 21

我们发现高比宽还大了,这在长方形中是一种非常正常的情况。现在我们把 Rectangle 类替换成它的子类 Square,修改测试代码:

    public static void main(String[] args) {
        Square square = new Square();
        square.setLength(10);
        resize(square);
    }

上述代码运行时出现了死循环,违背了里氏替换原则,将父类替换为子类后,程序运行结果没有达到预期。因此,我们的代码设计是存在一定风险的。里氏替换原则只存在于父类于子类之间,约束继承泛滥。我们再来创建一个基于长方形与正方形共同的抽象四边形接口 Quadrangle:

public interface Quadrangle {
    long getWidth();

    long getHeight();
}

修改长方形类 Rectangle:

public class Rectangle implements Quadrangle {
    private long height;
    private long width;

    @Override
    public long getWidth() {
        return width;
    }

    public void setWidth(long width) {
        this.width = width;
    }

    @Override
    public long getHeight() {
        return height;
    }

    public void setHeight(long height) {
        this.height = height;
    }
}

修改正方形类 Square:

public class Square implements Quadrangle {
    private long length;

    public long getLength() {
        return length;
    }

    public void setLength(long length) {
        this.length = length;
    }

    @Override
    public long getWidth() {
        return length;
    }

    @Override
    public long getHeight() {
        return length;
    }
}

此时,如果我们把 resize()方法的参数换成四边形接口 Quadrangle,方法内部就会报错。因为正方形类 Square 已经没有了 setWidth()和 setHeight()方法。因此,为了约束继承泛滥,resize()方法的参数只能用 Rectangle 类。当然,我们在后面的设计模式的内容中还会继续深入讲解。

1.7 合成复用原则

合成复用原则(Composite/Aggregate Reuse Principle,CARP)是指尽量使用对象组合(has-a)/聚合(contains-a)而不是继承关系达到软件复用的目的。可以使系统更加灵活,降低类与类之间的耦合度,一个类的变化对其他类造成的影响相对较少。

继承叫作白箱复用,相当于把所有的实现细节暴露给子类。组合/聚合称为黑箱复用,我们是无法获取到类以外的对象的实现细节的。虽然我们要根据具体的业务场景来做代码设计,但也需要遵循 OOP 模型。以数据库操作为例,先来创建 DBConnection 类:

public class DBConnection {
    public String getConnection() {
        return "MySQL数据库连接";
    }
}

创建 ProductDao 类:

public class ProductDao {
    private DBConnection dbConnection;

    public void setDbConnection(DBConnection dbConnection) {
        this.dbConnection = dbConnection;
    }

    public void addProduct() {
        String conn = dbConnection.getConnection();
        System.out.println("使用" + conn + "增加产品");
    }
}

这是一种非常典型的合成复用原则的应用场景。但是,就目前的设计来说,DBConnection 还不是一种抽象,不便于系统扩展。目前的系统支持 MySQL 数据库连接,假设业务发生变化,数据库操作层要支持 Oracle 数据库。当然,我们可以在 DBConnection 中增加对 Oracle 数据库的支持,但是这违背了开闭原则。其实,我们可以不修改 Dao 的代码,而将 DBConnection 修改为“abstract”的,来看代码:

public abstract class DBConnection {
    public abstract String getConnection();
}

然后将 MySQL 的逻辑抽离:

public class MySQLConnection extends DBConnection {
    @Override
    public String getConnection() {
        return "MySQL数据库连接";
    }
}

再创建 Oracle 支持:

public class OracleConnection extends DBConnection {
    @Override
    public String getConnection() {
        return "Oracle数据库连接";
    }
}

具体选择交给应用层,来看一下类图,如下所示。

image

1.8 设计原则总结

学习设计原则是学习设计模式的基础。在实际开发过程中,并不要求所有代码都遵循设计原则,我们要考虑人力、时间

  • 架构

    我们平时所说的“架构”主要是指软件架构,这是有关软件整体结构与组件的抽象描述,用于指导软件系统各个方面的设计。另外还有“业务架构”、“网络架构”、“硬件架构”等细分领域。

    142 引用 • 442 回帖
  • Spring

    Spring 是一个开源框架,是于 2003 年兴起的一个轻量级的 Java 开发框架,由 Rod Johnson 在其著作《Expert One-On-One J2EE Development and Design》中阐述的部分理念和原型衍生而来。它是为了解决企业应用开发的复杂性而创建的。框架的主要优势之一就是其分层架构,分层架构允许使用者选择使用哪一个组件,同时为 JavaEE 应用程序开发提供集成的框架。

    943 引用 • 1459 回帖 • 26 关注
  • Java

    Java 是一种可以撰写跨平台应用软件的面向对象的程序设计语言,是由 Sun Microsystems 公司于 1995 年 5 月推出的。Java 技术具有卓越的通用性、高效性、平台移植性和安全性。

    3186 引用 • 8212 回帖 • 2 关注

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...