七大软件设计原则
6.28 复习第一次
7.13 复习第二次
课程目标
1、通过对节课内容的学习,了解设计原则的重要性。
2、掌握七大设计原则的具体内容。
内容定位
学习设计原则,学习设计模式的基础。在实际开发过程中,并不是一定要求所有代码都遵循设计原则,我们要考虑人力、时间、成本、质量,不是刻意追求完美,要在适当的场景遵循设计原则,体现的是一种平衡取舍,帮助我们设计出更加优雅的代码结构。
开闭原则(允许实现接口扩充功能,不允许再原有代码修改)
package com.example.mq.study;
interface ICourse {
Integer getId();
String getName();
Double getPrice();
}
class JavaCourse implements ICourse {
private Integer id;
private String name;
private Double price;
public JavaCourse(Integer id, String name, Double price) {
this.id = id;
this.name = name;
this.price = price;
}
@Override
public Integer getId() {
return this.id;
}
@Override
public String getName() {
return this.name;
}
@Override
public Double getPrice() {
return this.price;
}
}
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.6;
}
}
开闭原则(Open-Closed Principle, OCP)是指一个软件实体如类、模块和函数应该对扩展开放,对修改关闭。所谓的开闭,也正是对扩展和修改两个行为的一个原则强调的是用抽象构建框架,用实现扩展细节。可以提高软件系统的可复用性及可维护性。开闭原则,是面向对象设计中最基础的设计原
则。它指导我们如何建立稳定灵活的系统,例如我们版本更新,我尽可能不修改源代码,但是可以增加新功能
在现实生活中对于开闭原则也有体现。比如,很多互联网公司都实行弹性制作息时间,规定每天工作 8 小时。意思就是说,对于每天工作 8 小时这个规定是关闭的,但是你什么时候来,什么时候走是开放的。早来早走,晚来晚走。
实现开闭原则的核心思想就是面向抽象编程,接下来我们来看一段代码:
public interface ICourse {
Integer getId();
String getName();
Double getPrice();
}
整个课程生态有 Java 架构、大数据、人工智能、前端、软件测试等,我们来创建一个 Java 架构课程的类 JavaCourse:
public class JavaCourse implements ICourse{
private Integer Id;
private String name;
private Double price;
public JavaCourse(Integer id, String name, Double price) {
this.Id = id;
this.name = name;
this.price = price;
}
public Integer getId() {
return this.Id;
}
public String getName() {
return this.name;
}
public Double getPrice() {
return this.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;
}
}
总结:允许扩展,不允许修改
例子:java课程 扩展 打折功能 || 计算面积扩展 圆形和正方形功能
开闭原则是面向对象设计中的重要原则,它要求软件实体(类、模块、函数等)应该对扩展开放,对修改关闭。下面是一个简单的 Java 代码示例,体现了开闭原则:
// 抽象图形类
abstract class Shape {
public abstract double area();
}
// 圆形类
class Circle extends Shape {
private double radius;
public Circle(double radius) {
this.radius = radius;
}
@Override
public double area() {
return Math.PI * radius * radius;
}
}
// 矩形类
class Rectangle extends Shape {
private double width;
private double height;
public Rectangle(double width, double height) {
this.width = width;
this.height = height;
}
@Override
public double area() {
return width * height;
}
}
// 计算图形面积的工具类
class AreaCalculator {
public double calculateArea(Shape shape) {
return shape.area();
}
}
// 测试类
public class Main {
public static void main(String[] args) {
Shape circle = new Circle(5);
Shape rectangle = new Rectangle(3, 4);
AreaCalculator calculator = new AreaCalculator();
System.out.println("Circle area: " + calculator.calculateArea(circle));
System.out.println("Rectangle area: " + calculator.calculateArea(rectangle));
}
}
在上面的代码中,我们定义了一个抽象的 Shape
类作为基类,然后创建了 Circle
和 Rectangle
两个子类来实现具体的图形类。通过这种方式,我们可以轻松地扩展新的图形类,而不需要修改 AreaCalculator
类中的计算逻辑,从而符合开闭原则。
依赖倒置原则(高层模块不应该依赖底层模块,二者都应该依赖其抽象 抽象不应该依赖细节;细节应该依赖抽象)
package com.example.mq.study;
interface ICourse {
void study();
}
class JavaCourse implements ICourse {
@Override
public void study() {
System.out.println("学习java课程");
}
}
class PythonCourse implements ICourse {
@Override
public void study() {
System.out.println("学习Python课程");
}
}
class Tom {
private ICourse iCourse;
// public Tom (ICourse iCourse) {
// this.iCourse = iCourse;
// }
// public void study(ICourse iCourse) {
// iCourse.study();
// }
// public static void main(String[] args) {
// Tom tom = new Tom(new JavaCourse());
// }
public void setiCourse(ICourse iCourse) {
this.iCourse = iCourse;
}
public static void main(String[] args) {
Tom tom = new Tom();
tom.setiCourse(new JavaCourse());
tom.iCourse.study();
tom.setiCourse(new PythonCourse());
tom.iCourse.study();
}
}
依赖倒置原则(Dependence Inversion Principle,DIP)是指设计代码结构时,高层模块不应该依赖底层模块,二者都应该依赖其抽象。抽象不应该依赖细节;细节应该依赖抽象。通过依赖倒置,可以减少类与类之间的耦合性,提高系统的稳定性,提高代码的可读性和可维护性,并能够降低修改程序所造成的风险。接下来看一个案例,还是以课程为例,先来创建一个类 Tom:
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 接口:
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 implements ICourse {
@Override
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());
}
IOC构造方法注入 ★
我们这时候再看来代码,Tom 的兴趣无论怎么暴涨,对于新的课程,我只需要新建一个类,通过传参的方式告诉 Tom,而不需要修改底层代码。实际上这是一种大家非常熟悉的方式,叫依赖注入。注入的方式还有构造器方式和 setter 方式。我们来看构造器注入方式:
public class Tom {
private 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 类的代码
IOC setter方法注入 ★
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();
}
现在我们再来看最终的类图:
大家要切记:以抽象为基准比以细节为基准搭建起来的架构要稳定得多,因此大家在拿到需求之后,要面向接口编程,先顶层再细节来设计代码结构。
单一职责原则(不要存在多于一个导致类变更的原因)
当我们谈到单一职责原则时,通常是指一个类只负责一项功能或任务。下面是一个简单的Java代码示例,体现了单一职责原则:
// 定义一个学生类,该类负责管理学生的基本信息
class Student {
private String name;
private int age;
public Student(String name, int age) {
this.name = name;
this.age = age;
}
// 获取学生姓名
public String getName() {
return name;
}
// 获取学生年龄
public int getAge() {
return age;
}
}
// 定义一个学生管理类,该类负责管理学生的操作,如增加、删除、修改学生信息
class StudentManager {
// 添加学生
public void addStudent(Student student) {
// 添加学生的具体实现
}
// 删除学生
public void deleteStudent(Student student) {
// 删除学生的具体实现
}
// 修改学生信息
public void updateStudentInfo(Student student) {
// 修改学生信息的具体实现
}
}
// 定义一个学生信息展示类,该类负责展示学生的信息
class StudentInfoDisplay {
// 展示学生信息
public void displayStudentInfo(Student student) {
// 展示学生信息的具体实现
}
}
在上面的代码中,我们定义了三个类:Student
类负责管理学生的基本信息,StudentManager
类负责管理学生的操作,StudentInfoDisplay
类负责展示学生的信息。每个类都只负责一个特定的功能,从而体现了单一职责原则。
单一职责(Simple Responsibility Pinciple,SRP)是指不要存在多于一个导致类变更的原因。假设我们有一个 Class 负责两个职责,一旦发生需求变更,修改其中一个职责的逻辑代码,有可能会导致另一个职责的功能发生故障。这样一来,这个 Class 存在两个导致类变更的原因。如何解决这个问题呢?
我们就要给两个职责分别用两个 Class 来实现,进行解耦。后期需求变更维护互不影响。这样的设计,可以降低类的复杂度,提高类的可读性,提高系统的可维护性,降低变更引起的风险。总体来说就是一个 Class/Interface/Method 只负责一项职责。
接下来,我们来看代码实例,还是用课程举例,我们的课程有直播课和录播课。直播课不能快进和快退,录播可以可以任意的反复观看,功能职责不一样。还是先创建一个 Course 类
Course 包含 直播 和 录播方法
public class Course {
public void study(String courseName){
if("直播课".equals(courseName)){
System.out.println("不能快进");
}else{
System.out.println("可以任意的来回播放");
}
}
}
看代码调用:
public static void main(String[] args) {
Course course = new Course();
course.study("直播课");
course.study("录播课");
}
从上面代码来看,Course 类承担了两种处理逻辑。假如,现在要对课程进行加密,那么直播课和录播课的加密逻辑都不一样,必须要修改代码。而修改代码逻辑势必会相互影响容易造成不可控的风险。
我们对职责进行分离解耦,来看代码,分别创建两个类ReplayCourse 和 LiveCourse:
Course拆分出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("可以任意的来回播放");
}
}
调用代码:
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();
}
来看一下类图:
下面我们来看一下方法层面的单一职责设计。有时候,我们为了偷懒,通常会把一个方法写成下面这样:
private void modifyUserInfo(String userName,String address){
userName = "Tom";
address = "Changsha";
}
还可能写成这样:
private void modifyUserInfo(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";
}
这修改之后,开发起来简单,维护起来也容易。但是,我们在实际开发中会项目依赖,组合,聚合
这些关系,还有还有项目的规模,周期,技术人员的水平,对进度的把控,很多类都不符合单一职责。
但是,我们在编写代码的过程,尽可能地让接口和方法保持单一职责,对我们项目后期的维护是有很大帮助的
接口隔离原则(用多个专门的接口,而不使用单一的总接口,不应该依赖它不需要的接口)
针对不同动物行为来设计不同的接口,分别设计 IEatAnimal,IFlyAnimal 和 ISwimAnimal 接口,来看代码
小狗实现吃和跑接口 小鱼实现吃和游泳接口
接口隔离原则(Interface Segregation Principle, ISP)是指用多个专门的接口,而不使用单一的总接口,客户端不应该依赖它不需要的接口。这个原则指导我们在设计接口时应当注意一下几点:
1、一个类对一类的依赖应该建立在最小的接口之上。
2、建立单一接口,不要建立庞大臃肿的接口。
3、尽量细化接口,接口中的方法尽量少(不是越少越好,一定要适度)。
接口隔离原则符合我们常说的高内聚低耦合的设计思想,从而使得类具有很好的可读性、可扩展性和可维护性。我们在设计接口的时候,要多花时间去思考,要考虑业务模型,包括以后有可能发生变更的地方还要做一些预判。所以,对于抽象,对业务模型的理解是非常重要的。下面我们来看一段代码,
写一个动物行为的抽象:
IAnimal 接口:
public interface IAnimal {
void eat();
void fly();
void swim();
}
Bird 类实现:
public class Bird implements IAnimal {
@Override
public void eat() {}
@Override
public void fly() {}
@Override
public void swim() {}
}
Dog 类实现:
public class Dog implements IAnimal {
@Override
public void eat() {}
@Override
public void fly() {}
@Override
public void swim() {}
}
可以看出,Bird 的 swim()方法可能只能空着,Dog 的 fly()方法显然不可能的。这时候,我们针对不同动物行为来设计不同的接口,分别设计 IEatAnimal,IFlyAnimal 和 ISwimAnimal 接口,来看代码:
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() {}
}
迪米特法则
course —— employee —— teamleader
迪米特原则(Law of Demeter LoD)是指一个对象应该对其他对象保持最少的了解,又叫最少知道原则(Least Knowledge Principle,LKP),尽量降低类与类之间的耦合。迪米特原则主要强调只和朋友交流,不和陌生人说话。出现在成员变量、方法的输入、输出参数中的类都可以称之为成员朋友类,而出现在方法体内部的类不属于朋友类。
现在来设计一个权限系统,TeamLeader需要查看目前发布到线上的课程数量。这时候,TeamLeader要找到员工 Employee 去进行统计,Employee 再把统计结果告诉 TeamLeader。接下来我们还是来看代码
Course 类:
public class Course {
}
Employee 类:
public class Employee{
public void checkNumberOfCourses(List<Course> courseList){
System.out.println("目前已发布的课程数量是:" + courseList.size());
}
}
TeamLeader 类:
public class TeamLeader{
public void commandCheckNumber(Employee employee){
List<Course> courseList = new ArrayList<Course>();
for (int i= 0; i < 20 ;i ++){
courseList.add(new Course());
}
employee.checkNumberOfCourses(courseList);
}
}
测试代码:
public static void main(String[] args) {
TeamLeader teamLeader = new TeamLeader();
Employee employee = new Employee();
teamLeader.commandCheckNumber(employee);
}
写到这里,其实功能已经都已经实现,代码看上去也没什么问题。根据迪米特原则,TeamLeader只想要结果,不需要跟 Course 产生直接的交流。而 Employee 统计需要引用 Course 对象。TeamLeader和 Course 并不是朋友,从下面的类图就可以看出来:
下面来对代码进行改造:
Employee 类:
public class Employee {
public void checkNumberOfCourses(){
List<Course> courseList = new ArrayList<Course>();
for (int i= 0; i < 20 ;i ++){
courseList.add(new Course());
}
System.out.println("目前已发布的课程数量是:"+courseList.size());
}
}
TeamLeader 类:
public class TeamLeader {
public void commandCheckNumber(Employee employee){
employee.checkNumberOfCourses();
}
}
再来看下面的类图,Course 和 TeamLeader 已经没有关联了。
里氏替换原则
里氏替换原则(Liskov Substitution Principle)是面向对象设计中的一个重要原则,它指出子类对象可以替换父类对象并且程序仍然能够正常运行。换句话说,子类应该能够替换父类并且不影响程序的行为。
以下是一个简单的Java代码示例,体现了里氏替换原则:
class Shape {
public void draw() {
System.out.println("Drawing a shape");
}
}
class Circle extends Shape {
@Override
public void draw() {
System.out.println("Drawing a circle");
}
}
class Rectangle extends Shape {
@Override
public void draw() {
System.out.println("Drawing a rectangle");
}
}
public class Main {
public static void drawShape(Shape shape) {
shape.draw();
}
public static void main(String[] args) {
Shape circle = new Circle();
Shape rectangle = new Rectangle();
drawShape(circle);
drawShape(rectangle);
}
}
在这个例子中,Circle
和 Rectangle
类都是 Shape
类的子类,并且它们都重写了 draw()
方法。在 Main
类中,我们可以将 Circle
和 Rectangle
对象传递给 drawShape()
方法,而不需要修改 drawShape()
方法的实现。这样就体现了里氏替换原则,子类对象可以替换父类对象而不影响程序的行为。
合成复用原则
合成复用原则(Composite Reuse Principle,CRP)是面向对象设计中的一个原则,它强调尽量使用对象组合(合成)而不是继承来实现代码复用。这样可以避免继承带来的耦合性和继承链过长的问题。
下面是一个简单的Java代码示例,体现了合成复用原则:
// 飞行能力接口
interface Flyable {
void fly();
}
// 飞行类
class Fly implements Flyable {
@Override
public void fly() {
System.out.println("飞行中...");
}
}
// 动物类
class Animal {
private Flyable flyable;
public Animal(Flyable flyable) {
this.flyable = flyable;
}
public void performFly() {
flyable.fly();
}
}
// 鸟类
class Bird extends Animal {
public Bird() {
super(new Fly());
}
}
public class Main {
public static void main(String[] args) {
Bird bird = new Bird();
bird.performFly();
}
}
在上面的代码中,我们定义了一个飞行能力接口 Flyable
,以及一个实现了飞行能力的类 Fly
。在 Animal
类中使用了合成的方式,通过组合一个 Flyable
对象来实现飞行能力,而不是通过继承。这样可以更灵活地组合不同的飞行能力,符合合成复用原则。
设计原则总结
学习设计原则,学习设计模式的基础。在实际开发过程中,并不是一定要求所有代码都遵循设计原则,我们要考虑人力、时间、成本、质量,不是刻意追求完美,要在适当的场景遵循设计原则,体现的是一种平衡取舍,帮助我们设计出更加优雅的代码结构