From 51086e7aef0ced5642f97256ff2cb601f489048f Mon Sep 17 00:00:00 2001 From: youthlql <1826692270@qq.com> Date: Sun, 4 Jul 2021 00:30:21 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=EF=BC=9A=E7=BB=93=E6=9E=84?= =?UTF-8?q?=E5=9E=8B7=E7=A7=8D=E8=AE=BE=E8=AE=A1=E6=A8=A1=E5=BC=8F?= =?UTF-8?q?=EF=BC=8C2=E7=AF=87=E6=96=87=E7=AB=A0=E8=AF=A6=E8=A7=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 6 +- ...模式-04.01-结构型-代理&桥接&装饰器&适配器.md | 2246 +++++++++++++++++ .../设计模式-04.02-结构型-门面&组合&享元.md | 1133 +++++++++ 3 files changed, 3384 insertions(+), 1 deletion(-) create mode 100644 docs/design_patterns/structural_type/设计模式-04.01-结构型-代理&桥接&装饰器&适配器.md create mode 100644 docs/design_patterns/structural_type/设计模式-04.02-结构型-门面&组合&享元.md diff --git a/README.md b/README.md index 8329e86..63a30fc 100644 --- a/README.md +++ b/README.md @@ -147,7 +147,7 @@ AQS剩余部分,以及阻塞队列源码暂时先搁置一下。 -# 设计模式【更新中-6.27更新】 +# 设计模式【更新中-7.4更新】 [1.设计模式-设计思想](docs/design_patterns/design_ideas/设计模式-01.设计思想.md) @@ -159,6 +159,10 @@ AQS剩余部分,以及阻塞队列源码暂时先搁置一下。 [3.设计模式-创建型-工厂&建造者&原型](docs/design_patterns/creational/设计模式-03.02-创建型-工厂&建造者&原型.md) +[4.设计模式-结构型-代理&桥接&装饰器&适配器](docs/design_patterns/structural_type/设计模式-04.01-结构型-代理&桥接&装饰器&适配器.md) + +[4.设计模式-结构型-门面&组合&享元](docs/design_patterns/structural_type/设计模式-04.02-结构型-门面&组合&享元.md) + diff --git a/docs/design_patterns/structural_type/设计模式-04.01-结构型-代理&桥接&装饰器&适配器.md b/docs/design_patterns/structural_type/设计模式-04.01-结构型-代理&桥接&装饰器&适配器.md new file mode 100644 index 0000000..3e41c88 --- /dev/null +++ b/docs/design_patterns/structural_type/设计模式-04.01-结构型-代理&桥接&装饰器&适配器.md @@ -0,0 +1,2246 @@ +--- +title: 设计模式-04.01-结构型-代理&桥接&装饰器&适配器 +tags: + - 设计模式 + - 代理模式 + - 桥接模式 + - 装饰器模式 + - 适配器模式 +categories: + - 设计模式 + - 04.结构型 +keywords: 设计模式,代理模式,桥接模式,装饰器模式,适配器模式 +description: 对代理模式,桥接模式,装饰器模式,适配器模式这4个模式进行了比较详细的讲述。其实学习设计模式主要是为了后序看源码 +cover: 'https://cdn.jsdelivr.net/gh/youthlql/lqlp@master/design_patterns/logo.jpg' +abbrlink: 926a065c +date: 2021-07-04 00:51:58 +--- + + + + + +# 引言 + +创建型模式比较好理解,后面的结构型和行为型设计模式不是那么好理解。如果遇到不好理解的设计模式,我一般会在开头举比较简单的Demo案例来帮助理解。 + +# 代理模式【常用】 + +1. 前面几节,我们讲了设计模式中的创建型模式。创建型模式主要解决对象的创建问题,封装复杂的创建过程,解耦对象的创建代码和使用代码。 +2. 其中,单例模式用来创建全局唯一的对象。工厂模式用来创建不同但是相关类型的对象(继承同一父类或者接口的一组子类),由给定的参数来决定创建哪种类型的对象。建造者模式是用来创建复杂对象,可以通过设置不同的可选参数,“定制化”地创建不同的对象。原型模式针对创建成本比较大的对象,利用对已有对象进行复制的方式进行创建,以达到节省创建时间的目的。 +3. 现在,我们讲另外一种类型的设计模式:结构型模式。结构型模式主要总结了一些类或对象组合在一起的经典结构,这些经典的结构可以解决特定应用场景的问题。结构型模式包括:代理模式、桥接模式、装饰器模式、适配器模式、门面模式、组合模式、享元模式。今天我们要讲其中的代理模式。它也是在实际开发中经常被用到的一种设计模式。 +4. 代理模式有不同的形式, 主要有三种 **静态代理**、**动态代理** (JDK 代理、接口代理)和 **Cglib** **代理** (可以在内存 动态的创建对象,而不需要实现接口, 他是属于动态代理的范畴) 。下面先通过几个比较简单的例子理解一下代理模式 + + + + + +## 静态代理 + +实例具体要求 + +1. 定义一个接口:ITeacherDao +2. 目标对象 TeacherDAO 实现接口 ITeacherDAO +3. 使用静态代理方式,就需要在代理对象 TeacherDAOProxy 中也实现 ITeacherDAO +4. 调用的时候通过调用代理对象的方法来调用目标对象. +5. 特别提醒:静态代理类与被代理类要实现相同的接口,然后通过调用相同的方法来调用目标对象的方法 + + + +> **ITeacherDao** + +```java +//接口 +public interface ITeacherDao { + + void teach(); // 授课的方法 +} +``` + + + +> **TeacherDao** ---> 被代理类 + +```java +public class TeacherDao implements ITeacherDao { + + @Override + public void teach() { + // TODO Auto-generated method stub + System.out.println(" 老师授课中 。。。。。"); + } +} +``` + + + +> **TeacherDaoProxy** ---> 代理类 + +```java +//代理对象,静态代理 +public class TeacherDaoProxy implements ITeacherDao{ + + private ITeacherDao target; // 目标对象,通过接口来聚合 + + + //构造器 + public TeacherDaoProxy(ITeacherDao target) { + this.target = target; + } + + + + @Override + public void teach() { + // TODO Auto-generated method stub + System.out.println("开始代理 完成某些操作。。。。。 ");//方法 + target.teach(); + System.out.println("提交。。。。。");//方法 + } + +} +``` + + + +> Client + +```java +public class Client { + + public static void main(String[] args) { + // TODO Auto-generated method stub + //创建目标对象(被代理对象) + TeacherDao teacherDao = new TeacherDao(); + + //创建代理对象, 同时将被代理对象传递给代理对象 + TeacherDaoProxy teacherDaoProxy = new TeacherDaoProxy(teacherDao); + + //通过代理对象,调用到被代理对象的方法 + //即:执行的是代理对象的方法,代理对象再去调用目标对象的方法 + teacherDaoProxy.teach(); + } + +} +``` + + + + + +## 动态代理 + +1. 代理对象,不需要实现接口,但是目标对象要实现接口,否则不能用动态代理 +2. 代理对象的生成,是利用 JDK 的 API,动态的在内存中构建代理对象 +3. 动态代理也叫做:JDK 代理、接口代理 +4. 代理类所在包:java.lang.reflect.Proxy +5. JDK 实现代理只需要使用 **newProxyInstance** 方法,但是该方法需要接收三个参数,完整的写法是: + +static Object newProxyInstance(ClassLoader loader, Class[] interfaces,InvocationHandler h ) + + + +> ITeacherDao + +```java +//接口 +public interface ITeacherDao { + + void teach(); // 授课方法 + void sayHello(String name); +} +``` + + + +> TeacherDao + +```java +public class TeacherDao implements ITeacherDao { + + @Override + public void teach() { + // TODO Auto-generated method stub + System.out.println(" 老师授课中.... "); + } + + @Override + public void sayHello(String name) { + // TODO Auto-generated method stub + System.out.println("hello " + name); + } + +} +``` + + + +> ProxyFactory + +```java +import java.lang.reflect.InvocationHandler; +import java.lang.reflect.Method; +import java.lang.reflect.Proxy; + +public class ProxyFactory { + + //维护一个目标对象 , Object + private Object target; + + //构造器 , 对target 进行初始化 + public ProxyFactory(Object target) { + + this.target = target; + } + + //给目标对象 生成一个代理对象 + public Object getProxyInstance() { + + /* 说明 + public static Object newProxyInstance(ClassLoader loader, + Class[] interfaces, + InvocationHandler h) + + 1. ClassLoader loader : 指定当前目标对象使用的类加载器, 获取加载器的方法固定 + 2. Class[] interfaces: 目标对象实现的接口类型,使用泛型方法确认类型 + 3. InvocationHandler h : 事情处理,执行目标对象的方法时,会触发事情处理器方法, + 会把当前执行的目标对象方法作为参数传入 + */ + return Proxy.newProxyInstance(target.getClass().getClassLoader(), + target.getClass().getInterfaces(), + new InvocationHandler() { + + @Override + public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { + // TODO Auto-generated method stub + System.out.println("JDK代理开始~~"); + //反射机制调用目标对象的方法 + Object returnVal = method.invoke(target, args); + System.out.println("JDK代理提交"); + return returnVal; + } + }); + } +} +``` + + + +> Client + +``` +public class Client { + + public static void main(String[] args) { + // TODO Auto-generated method stub + //创建目标对象 + ITeacherDao target = new TeacherDao(); + + //给目标对象,创建代理对象, 可以转成 ITeacherDao + ITeacherDao proxyInstance = (ITeacherDao)new ProxyFactory(target).getProxyInstance(); + + // proxyInstance=class com.sun.proxy.$Proxy0 内存中动态生成了代理对象 + System.out.println("proxyInstance=" + proxyInstance.getClass()); + + //通过代理对象,调用目标对象的方法 + //proxyInstance.teach(); + + proxyInstance.sayHello(" tom "); + } + +} +``` + + + +## cglib代理 + +1. 静态代理和 JDK 代理模式都要求目标对象是实现一个接口,但是有时候目标对象只是一个单独的对象,并没有实现任何的接口,这个时候可使用目标对象子类来实现代理-这就是Cglib代理 + +2. Cglib代理也叫作**子类代理****,**它是在内存中构建一个子类对象从而实现对目标对象功能扩展, 有些书也将Cglib代理归属到动态代理。 + +3. Cglib 是一个强大的高性能的代码生成包,它可以在运行期扩展 java 类与实现 java 接口.它广泛的被许多 AOP 的 框架使用,例如 Spring AOP,实现方法拦截 + +4. 在 AOP 编程中如何选择代理模式: + + - 目标对象需要实现接口,用 JDK 代理 + + - 目标对象不需要实现接口,用 Cglib 代理 + +5. Cglib 包的底层是通过使用字节码处理框架 ASM 来转换字节码并生成新的类 + +6. 需要引入 cglib 的 jar 文件,在内存中动态构建子类,注意代理的类不能为 final,否则报错 + + `java.lang.IllegalArgumentException`,目标对象的方法如果为 final/static,那么就不会被拦截,即不会执行目标对象额外的业务方法. + + + +> TeacherDao + +```java +public class TeacherDao { + + public String teach() { + System.out.println(" 老师授课中 , 我是cglib代理,不需要实现接口 "); + return "hello"; + } +} +``` + + + +> ProxyFactory + +```java +import java.lang.reflect.Method; +import net.sf.cglib.proxy.Enhancer; +import net.sf.cglib.proxy.MethodInterceptor; +import net.sf.cglib.proxy.MethodProxy; + +public class ProxyFactory implements MethodInterceptor { + + //维护一个目标对象 + private Object target; + + //构造器,传入一个被代理的对象 + public ProxyFactory(Object target) { + this.target = target; + } + + //返回一个代理对象: 是 target 对象的代理对象 + public Object getProxyInstance() { + //1. 创建一个工具类 + Enhancer enhancer = new Enhancer(); + //2. 设置父类 + enhancer.setSuperclass(target.getClass()); + //3. 设置回调函数 + enhancer.setCallback(this); + //4. 创建子类对象,即代理对象 + return enhancer.create(); + + } + + + //重写 intercept 方法,会调用目标对象的方法 + @Override + public Object intercept(Object arg0, Method method, Object[] args, MethodProxy arg3) throws Throwable { + // TODO Auto-generated method stub + System.out.println("Cglib代理模式 ~~ 开始"); + Object returnVal = method.invoke(target, args); + System.out.println("Cglib代理模式 ~~ 提交"); + return returnVal; + } + +} +``` + + + +> Client + +```java +public class Client { + + public static void main(String[] args) { + // TODO Auto-generated method stub + //创建目标对象 + TeacherDao target = new TeacherDao(); + //获取到代理对象,并且将目标对象传递给代理对象 + TeacherDao proxyInstance = (TeacherDao)new ProxyFactory(target).getProxyInstance(); + + //执行代理对象的方法,触发intecept 方法,从而实现 对目标对象的调用 + String res = proxyInstance.teach(); + System.out.println("res=" + res); + } + +} +``` + +## 代理模式的原理解析 + +1. 代理模式(Proxy Design Pattern)的原理和代码实现都不难掌握。它在不改变原始类(或叫被代理类)代码的情况下,通过引入代理类来给原始类附加功能【**装饰器是增强功能,代理是附加新的功能**】。我们通过一个简单的例子来解释一下这段话。 +2. 我们开发了一个 MetricsCollector 类,用来收集接口请求的原始数据,比如访问时间、处理时长等。在业务系统中,我们采用如下方式来使用这个 MetricsCollector 类: + +```java +public class UserController { + //...省略其他属性和方法... + private MetricsCollector metricsCollector; // 依赖注入 + + public UserVo login(String telephone, String password) { + long startTimestamp = System.currentTimeMillis(); + + // ... 省略login逻辑... + + long endTimeStamp = System.currentTimeMillis(); + long responseTime = endTimeStamp - startTimestamp; + RequestInfo requestInfo = new RequestInfo("login", responseTime, startTimestamp); + metricsCollector.recordRequest(requestInfo); + + //...返回UserVo数据... + } + + public UserVo register(String telephone, String password) { + long startTimestamp = System.currentTimeMillis(); + + // ... 省略register逻辑... + + long endTimeStamp = System.currentTimeMillis(); + long responseTime = endTimeStamp - startTimestamp; + RequestInfo requestInfo = new RequestInfo("register", responseTime, startTimestamp); + metricsCollector.recordRequest(requestInfo); + + //...返回UserVo数据... + } +} +``` + +1. 很明显,上面的写法有两个问题。第一,性能计数器框架代码侵入到业务代码中,跟业务代码高度耦合。如果未来需要替换这个框架,那替换的成本会比较大。第二,收集接口请求的代码跟业务代码无关,本就不应该放到一个类中。业务类最好职责更加单一,只聚焦业务处理。 +2. 为了将框架代码和业务代码解耦,代理模式就派上用场了。代理类 UserControllerProxy 和原始类 UserController 实现相同的接口 IUserController。UserController 类只负责业务功能。代理类 UserControllerProxy 负责在业务代码执行前后附加其他逻辑代码,并通过委托的方式调用原始类来执行业务代码。具体的代码实现如下所示: + +```java +public interface IUserController { + UserVo login(String telephone, String password); + UserVo register(String telephone, String password); +} + +public class UserController implements IUserController { + //...省略其他属性和方法... + + @Override + public UserVo login(String telephone, String password) { + //...省略login逻辑... + //...返回UserVo数据... + } + + @Override + public UserVo register(String telephone, String password) { + //...省略register逻辑... + //...返回UserVo数据... + } +} + +public class UserControllerProxy implements IUserController { + private MetricsCollector metricsCollector; + private UserController userController; + + public UserControllerProxy(UserController userController) { + this.userController = userController; + this.metricsCollector = new MetricsCollector(); + } + + @Override + public UserVo login(String telephone, String password) { + long startTimestamp = System.currentTimeMillis(); + + // 委托 + UserVo userVo = userController.login(telephone, password); + + long endTimeStamp = System.currentTimeMillis(); + long responseTime = endTimeStamp - startTimestamp; + RequestInfo requestInfo = new RequestInfo("login", responseTime, startTimestamp); + metricsCollector.recordRequest(requestInfo); + + return userVo; + } + + @Override + public UserVo register(String telephone, String password) { + long startTimestamp = System.currentTimeMillis(); + + UserVo userVo = userController.register(telephone, password); + + long endTimeStamp = System.currentTimeMillis(); + long responseTime = endTimeStamp - startTimestamp; + RequestInfo requestInfo = new RequestInfo("register", responseTime, startTimestamp); + metricsCollector.recordRequest(requestInfo); + + return userVo; + } +} + +//UserControllerProxy使用举例 +//因为原始类和代理类实现相同的接口,是基于接口而非实现编程 +//将UserController类对象替换为UserControllerProxy类对象,不需要改动太多代码 +IUserController userController = new UserControllerProxy(new UserController()); +``` + +1. 参照基于接口而非实现编程的设计思想,将原始类对象替换为代理类对象的时候,为了让代码改动尽量少,在刚刚的代理模式的代码实现中,代理类和原始类需要实现相同的接口。但是,如果原始类并没有定义接口,并且原始类代码并不是我们开发维护的(比如它来自一个第三方的类库),我们也没办法直接修改原始类,给它重新定义一个接口。在这种情况下,我们该如何实现代理模式呢? +2. 对于这种外部类的扩展,我们一般都是采用继承的方式。这里也不例外。我们让代理类继承原始类,然后扩展附加功能。原理很简单,不需要过多解释,你直接看代码就能明白。具体代码如下所示: + +```java + +public class UserControllerProxy extends UserController { + private MetricsCollector metricsCollector; + + public UserControllerProxy() { + this.metricsCollector = new MetricsCollector(); + } + + public UserVo login(String telephone, String password) { + long startTimestamp = System.currentTimeMillis(); + + UserVo userVo = super.login(telephone, password); + + long endTimeStamp = System.currentTimeMillis(); + long responseTime = endTimeStamp - startTimestamp; + RequestInfo requestInfo = new RequestInfo("login", responseTime, startTimestamp); + metricsCollector.recordRequest(requestInfo); + + return userVo; + } + + public UserVo register(String telephone, String password) { + long startTimestamp = System.currentTimeMillis(); + + UserVo userVo = super.register(telephone, password); + + long endTimeStamp = System.currentTimeMillis(); + long responseTime = endTimeStamp - startTimestamp; + RequestInfo requestInfo = new RequestInfo("register", responseTime, startTimestamp); + metricsCollector.recordRequest(requestInfo); + + return userVo; + } +} +//UserControllerProxy使用举例 +UserController userController = new UserControllerProxy(); +``` + + + +## 动态代理的原理解析 + +1. 不过,刚刚的代码实现还是有点问题。一方面,我们需要在代理类中,将原始类中的所有的方法,都重新实现一遍,并且为每个方法都附加相似的代码逻辑。另一方面,如果要添加的附加功能的类有不止一个,我们需要针对每个类都创建一个代理类。 +2. 如果有 50 个要添加附加功能的原始类,那我们就要创建 50 个对应的代理类。这会导致项目中类的个数成倍增加,增加了代码维护成本。并且,每个代理类中的代码都有点像模板式的“重复”代码,也增加了不必要的开发成本。那这个问题怎么解决呢? +3. 我们可以使用动态代理来解决这个问题。所谓动态代理(Dynamic Proxy),就是我们不事先为每个原始类编写代理类,而是在运行的时候,动态地创建原始类对应的代理类,然后在系统中用代理类替换掉原始类。那如何实现动态代理呢? +4. 如果你熟悉的是 Java 语言,实现动态代理就是件很简单的事情。因为 Java 语言本身就已经提供了动态代理的语法(实际上,动态代理底层依赖的就是 Java 的反射语法)。我们来看一下,如何用 Java 的动态代理来实现刚刚的功能。具体的代码如下所示。其中,MetricsCollectorProxy 作为一个动态代理类,动态地给每个需要收集接口请求信息的类创建代理类。 + +```java + +public class MetricsCollectorProxy { + private MetricsCollector metricsCollector; + + public MetricsCollectorProxy() { + this.metricsCollector = new MetricsCollector(); + } + + public Object createProxy(Object proxiedObject) { + Class[] interfaces = proxiedObject.getClass().getInterfaces(); + DynamicProxyHandler handler = new DynamicProxyHandler(proxiedObject); + return Proxy.newProxyInstance(proxiedObject.getClass().getClassLoader(), interfaces, handler); + } + + private class DynamicProxyHandler implements InvocationHandler { + private Object proxiedObject; + + public DynamicProxyHandler(Object proxiedObject) { + this.proxiedObject = proxiedObject; + } + + @Override + public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { + long startTimestamp = System.currentTimeMillis(); + Object result = method.invoke(proxiedObject, args); + long endTimeStamp = System.currentTimeMillis(); + long responseTime = endTimeStamp - startTimestamp; + String apiName = proxiedObject.getClass().getName() + ":" + method.getName(); + RequestInfo requestInfo = new RequestInfo(apiName, responseTime, startTimestamp); + metricsCollector.recordRequest(requestInfo); + return result; + } + } +} + +//MetricsCollectorProxy使用举例 +MetricsCollectorProxy proxy = new MetricsCollectorProxy(); +IUserController userController = (IUserController) proxy.createProxy(new UserController()); +``` + + + +实际上,Spring AOP 底层的实现原理就是基于动态代理。用户配置好需要给哪些类创建代理,并定义好在执行原始类的业务代码前后执行哪些附加功能。Spring 为这些类创建动态代理对象,并在 JVM 中替代原始类对象。原本在代码中执行的原始类的方法,被换作执行代理类的方法,也就实现了给原始类添加附加功能的目的。 + + + +## 代理模式的应用场景 + + + +### 业务系统的非功能性需求开发 + +代理模式最常用的一个应用场景就是,在业务系统中开发一些非功能性需求,比如:监控、统计、鉴权、限流、事务、幂等、日志。我们将这些附加功能与业务功能解耦,放到代理类中统一处理,让程序员只需要关注业务方面的开发。实际上,前面举的搜集接口请求信息的例子,就是这个应用场景的一个典型例子。 + +如果你熟悉 Java 语言和 Spring 开发框架,这部分工作都是可以在 Spring AOP 切面中完成的。前面我们也提到,Spring AOP 底层的实现原理就是基于动态代理。 + + + + + +### 代理模式在 RPC、缓存中的应用 + +实际上,RPC 框架也可以看作一种代理模式,GoF 的《设计模式》一书中把它称作远程代理。通过远程代理,将网络通信、数据编解码等细节隐藏起来。客户端在使用 RPC 服务的时候,就像使用本地函数一样,无需了解跟服务器交互的细节。除此之外,RPC 服务的开发者也只需要开发业务逻辑,就像开发本地使用的函数一样,不需要关注跟客户端的交互细节。 + + + + + +### 代理模式在缓存中的应用 + +1. 假设我们要开发一个接口请求的缓存功能,对于某些接口请求,如果入参相同,在设定的过期时间内,直接返回缓存结果,而不用重新进行逻辑处理。比如,针对获取用户个人信息的需求,我们可以开发两个接口,一个支持缓存,一个支持实时查询。对于需要实时数据的需求,我们让其调用实时查询接口,对于不需要实时数据的需求,我们让其调用支持缓存的接口。那如何来实现接口请求的缓存功能呢? +2. 最简单的实现方法就是刚刚我们讲到的,给每个需要支持缓存的查询需求都开发两个不同的接口,一个支持缓存,一个支持实时查询。但是,这样做显然增加了开发成本,而且会让代码看起来非常臃肿(接口个数成倍增加),也不方便缓存接口的集中管理(增加、删除缓存接口)、集中配置(比如配置每个接口缓存过期时间)。 +3. 针对这些问题,代理模式就能派上用场了,确切地说,应该是动态代理。如果是基于 Spring 框架来开发的话,那就可以在 AOP 切面中完成接口缓存的功能。在应用启动的时候,我们从配置文件中加载需要支持缓存的接口,以及相应的缓存策略(比如过期时间)等。当请求到来的时候,我们在 AOP 切面中拦截请求,如果请求中带有支持缓存的字段(比如 http://…?..&cached=true),我们便从缓存(内存缓存或者 Redis 缓存等)中获取数据直接返回。 + + + + + + + +# 桥接模式【常用】 + +1. 上一节我们学习了第一种结构型模式:代理模式。它在不改变原始类(或者叫被代理类)代码的情况下,通过引入代理类来给原始类附加功能。代理模式在平时的开发经常被用到,常用在业务系统中开发一些非功能性需求,比如:监控、统计、鉴权、限流、事务、幂等、日志。 +2. 今天,我们再学习另外一种结构型模式:桥接模式。桥接模式的代码实现非常简单,但是理解起来稍微有点难度,并且应用场景也比较局限,所以,相当于代理模式来说,桥接模式在实际的项目中并没有那么常用,你只需要简单了解,见到能认识就可以,并不是我们学习的重点。 +3. 我们依旧是先看比较简单的例子 + +## Demo案例-手机操作问题 + +### 需求 + +现在对不同手机类型的不同品牌实现操作编程(比如:开机、关机、上网,打电话等),如图: + + + + + +### 传统方案解决手机操作问题分析 + +传统方法对应的类图 + + + +1. 扩展性问题(**类爆炸**),如果我们再增加手机的样式(旋转式),就需要增加各个品牌手机的类,同样如果我们增加一个手机品牌,也要在各个手机样式类下增加。 +2. 违反了单一职责原则,当我们增加手机样式时,要同时增加所有品牌的手机,这样增加了代码维护成本. +3. 解决方案-使用**桥接模**式 +4. Bridge 模式基于类的最小设计原则,通过使用封装、聚合及继承等行为让不同的类承担不同的职责。它的主要特点是把抽象(Abstraction)与行为实现(Implementation)分离开来,从而可以保持各部分的独立性以及应对他们的功能扩展 + +### 使用桥接模式的代码 + +#### Brand【接口】 + +```java +//接口 +public interface Brand { + void open(); + void close(); + void call(); +} +``` + +#### Phone【抽象类】 + +```java +public abstract class Phone { + + //组合品牌 + private Brand brand; + + //构造器 + public Phone(Brand brand) { + super(); + this.brand = brand; + } + + protected void open() { + this.brand.open(); + } + protected void close() { + brand.close(); + } + protected void call() { + brand.call(); + } + +} +``` + +#### Vivo + +```java +public class Vivo implements Brand { + + @Override + public void open() { + // TODO Auto-generated method stub + System.out.println(" Vivo手机开机 "); + } + + @Override + public void close() { + // TODO Auto-generated method stub + System.out.println(" Vivo手机关机 "); + } + + @Override + public void call() { + // TODO Auto-generated method stub + System.out.println(" Vivo手机打电话 "); + } + +} +``` + +#### XiaoMi + +```java +public class XiaoMi implements Brand { + + @Override + public void open() { + // TODO Auto-generated method stub + System.out.println(" 小米手机开机 "); + } + + @Override + public void close() { + // TODO Auto-generated method stub + System.out.println(" 小米手机关机 "); + } + + @Override + public void call() { + // TODO Auto-generated method stub + System.out.println(" 小米手机打电话 "); + } + +} +``` + + + +#### FoldedPhone + +```java +//折叠式手机类,继承 抽象类 Phone +public class FoldedPhone extends Phone { + + //构造器 + public FoldedPhone(Brand brand) { + super(brand); + } + + public void open() { + super.open(); + System.out.println(" 折叠样式手机 "); + } + + public void close() { + super.close(); + System.out.println(" 折叠样式手机 "); + } + + public void call() { + super.call(); + System.out.println(" 折叠样式手机 "); + } +} +``` + + + +#### UpRightPhone + +```java +public class UpRightPhone extends Phone { + + //构造器 + public UpRightPhone(Brand brand) { + super(brand); + } + + public void open() { + super.open(); + System.out.println(" 直立样式手机 "); + } + + public void close() { + super.close(); + System.out.println(" 直立样式手机 "); + } + + public void call() { + super.call(); + System.out.println(" 直立样式手机 "); + } +} +``` + + + +#### Client + +``` +public class Client { + + public static void main(String[] args) { + + //获取折叠式手机 (样式 + 品牌 ) + + Phone phone1 = new FoldedPhone(new XiaoMi()); + + phone1.open(); + phone1.call(); + phone1.close(); + + System.out.println("======================="); + + Phone phone2 = new FoldedPhone(new Vivo()); + + phone2.open(); + phone2.call(); + phone2.close(); + + System.out.println("=============="); + + UpRightPhone phone3 = new UpRightPhone(new XiaoMi()); + + phone3.open(); + phone3.call(); + phone3.close(); + + System.out.println("=============="); + + UpRightPhone phone4 = new UpRightPhone(new Vivo()); + + phone4.open(); + phone4.call(); + phone4.close(); + } + +} +``` + + + +> 这种简单的demo例子可能比较好理解桥接模式,下面来看看原理和实际应用 + +## 桥接模式的原理解析 + +1. 桥接模式,也叫作桥梁模式,英文是Bridge Design Pattern。这个模式可以说是 23 种设计模式中最难理解的模式之一了。我查阅了比较多的书籍和资料之后发现,对于这个模式有两种不同的理解方式。 +2. 当然,这其中“最纯正”的理解方式,当属 GoF 的《设计模式》一书中对桥接模式的定义。毕竟,这 23 种经典的设计模式,最初就是由这本书总结出来的。在 GoF 的《设计模式》一书中,桥接模式是这么定义的:“Decouple an abstraction from its implementation so that the two can vary independently。”翻译成中文就是:“将抽象和实现解耦,让它们可以独立变化。” +3. 关于桥接模式,很多书籍、资料中,还有另外一种理解方式:“一个类存在两个(或多个)独立变化的维度,我们通过组合的方式,让这两个(或多个)维度可以独立进行扩展。”通过组合关系来替代继承关系,避免继承层次的指数级爆炸。这种理解方式非常类似于,我们之前讲过的“组合优于继承”设计原则,所以,这里我就不多解释了。我们重点看下 GoF 的理解方式。 +4. GoF 给出的定义非常的简短,单凭这一句话,估计没几个人能看懂是什么意思。所以,我们通过 JDBC 驱动的例子来解释一下。JDBC 驱动是桥接模式的经典应用。我们先来看一下,如何利用 JDBC 驱动来查询数据库。具体的代码如下所示: + + + +```java + Class.forName("com.mysql.jdbc.Driver"); // 加载及注册JDBC驱动程序 + String url = "jdbc:mysql://localhost:3306/sample_db?user=root&password=your_password"; + Connection con = DriverManager.getConnection(url); + Statement stmt = con.createStatement(); + String query = "select * from test"; + ResultSet rs = stmt.executeQuery(query); + while (rs.next()) { + rs.getString(1); + rs.getInt(2); + } +``` + + + +1. 如果我们想要把 MySQL 数据库换成 Oracle 数据库,只需要把第一行代码中的 com.mysql.jdbc.Driver 换成 oracle.jdbc.driver.OracleDriver 就可以了。当然,也有更灵活的实现方式,我们可以把需要加载的 Driver 类写到配置文件中,当程序启动的时候,自动从配置文件中加载,这样在切换数据库的时候,我们都不需要修改代码,只需要修改配置文件就可以了。 +2. 不管是改代码还是改配置,在项目中,从一个数据库切换到另一种数据库,都只需要改动很少的代码,或者完全不需要改动代码,那如此优雅的数据库切换是如何实现的呢? +3. 源码之下无秘密。要弄清楚这个问题,我们先从 com.mysql.jdbc.Driver 这个类的代码看起。我摘抄了部分相关代码,放到了这里,你可以看一下。 + + + +```java +package com.mysql.jdbc; +import java.sql.SQLException; + +public class Driver extends NonRegisteringDriver implements java.sql.Driver { + static { + try { + java.sql.DriverManager.registerDriver(new Driver()); + } catch (SQLException E) { + throw new RuntimeException("Can't register driver!"); + } + } + + /** + * Construct a new driver and register it with DriverManager + * @throws SQLException if a database error occurs. + */ + public Driver() throws SQLException { + // Required for Class.forName().newInstance() + } +} + +``` + + + +结合 com.mysql.jdbc.Driver 的代码实现,我们可以发现,当执行 Class.forName(“com.mysql.jdbc.Driver”) 这条语句的时候,实际上是做了两件事情。第一件事情是要求 JVM 查找并加载指定的 Driver 类,第二件事情是执行该类的静态代码,也就是将 MySQL Driver 注册到 DriverManager 类中。 + + + +现在,我们再来看一下,DriverManager 类是干什么用的。具体的代码如下所示。当我们把具体的 Driver 实现类(比如,com.mysql.jdbc.Driver)注册到 DriverManager 之后,后续所有对 JDBC 接口的调用,都会委派到对具体的 Driver 实现类来执行。而 Driver 实现类都实现了相同的接口(java.sql.Driver ),这也是可以灵活切换 Driver 的原因。 + + + +```java +public class DriverManager { + private static final CopyOnWriteArrayList registeredDrivers = = new CopyOnWriteArrayList(); + + // ... + static { + loadInitialDrivers(); + println("JDBC DriverManager initialized"); + } + + // ... + public static synchronized void registerDriver(java.sql.Driver driver) throws SQLException { + if (driver != null) { + registeredDrivers.addIfAbsent(new DriverInfo(driver)); + } else { + throw new NullPointerException(); + } + } + + public static Connection getConnection(String url, String user, String password) + throws SQLException { + java.util.Properties info = new java.util.Properties(); + if (user != null) { + info.put("user", user); + } + if (password != null) { + info.put("password", password); + } + + return (getConnection(url, info, Reflection.getCallerClass())); + } + // ... +} + +``` + + + +桥接模式的定义是“将抽象和实现解耦,让它们可以独立变化”。那弄懂定义中“抽象”和“实现”两个概念,就是理解桥接模式的关键。那在 JDBC 这个例子中,什么是“抽象”?什么是“实现”呢? + + + +实际上,JDBC 本身就相当于“抽象”。注意,这里所说的“抽象”,指的并非“抽象类”或“接口”,而是跟具体的数据库无关的、被抽象出来的一套“类库”。具体的 Driver(比如,com.mysql.jdbc.Driver)就相当于“实现”。注意,这里所说的“实现”,也并非指“接口的实现类”,而是跟具体数据库相关的一套“类库”。JDBC 和 Driver 独立开发,通过对象之间的组合关系,组装在一起。JDBC 的所有逻辑操作,最终都委托给 Driver 来执行。 + + + + + + + +## 桥接模式的应用举例 + +在前面,我们讲过一个 API 接口监控告警的例子:根据不同的告警规则,触发不同类型的告警。告警支持多种通知渠道,包括:邮件、短信、微信、自动语音电话。通知的紧急程度有多种类型,包括:SEVERE(严重)、URGENCY(紧急)、NORMAL(普通)、TRIVIAL(无关紧要)。不同的紧急程度对应不同的通知渠道。比如,SERVE(严重)级别的消息会通过“自动语音电话”告知相关人员。 + + + +在当时的代码实现中,关于发送告警信息那部分代码,我们只给出了粗略的设计,现在我们来一块实现一下。我们先来看最简单、最直接的一种实现方式。代码如下所示: + +```java + +public enum NotificationEmergencyLevel { + SEVERE, + URGENCY, + NORMAL, + TRIVIAL +} + +public class Notification { + private List emailAddresses; + private List telephones; + private List wechatIds; + + public Notification() {} + + public void setEmailAddress(List emailAddress) { + this.emailAddresses = emailAddress; + } + + public void setTelephones(List telephones) { + this.telephones = telephones; + } + + public void setWechatIds(List wechatIds) { + this.wechatIds = wechatIds; + } + + public void notify(NotificationEmergencyLevel level, String message) { + if (level.equals(NotificationEmergencyLevel.SEVERE)) { + // ...自动语音电话 + } else if (level.equals(NotificationEmergencyLevel.URGENCY)) { + // ...发微信 + } else if (level.equals(NotificationEmergencyLevel.NORMAL)) { + // ...发邮件 + } else if (level.equals(NotificationEmergencyLevel.TRIVIAL)) { + // ...发邮件 + } + } +} + +// 在API监控告警的例子中,我们如下方式来使用Notification类: +public class ErrorAlertHandler extends AlertHandler { + public ErrorAlertHandler(AlertRule rule, Notification notification) { + super(rule, notification); + } + + @Override + public void check(ApiStatInfo apiStatInfo) { + if (apiStatInfo.getErrorCount() + > rule.getMatchedRule(apiStatInfo.getApi()).getMaxErrorCount()) { + notification.notify(NotificationEmergencyLevel.SEVERE, "..."); + } + } +} + +``` + + + +1. Notification 类的代码实现有一个最明显的问题,那就是有很多 if-else 分支逻辑。实际上,如果每个分支中的代码都不复杂,后期也没有无限膨胀的可能(增加更多 if-else 分支判断),那这样的设计问题并不大,没必要非得一定要摒弃 if-else 分支逻辑。 +2. 不过,Notification 的代码显然不符合这个条件。因为每个 if-else 分支中的代码逻辑都比较复杂,发送通知的所有逻辑都扎堆在 Notification 类中。我们知道,类的代码越多,就越难读懂,越难修改,维护的成本也就越高。很多设计模式都是试图将庞大的类拆分成更细小的类,然后再通过某种更合理的结构组装在一起。 +3. 针对 Notification 的代码,我们将不同渠道的发送逻辑剥离出来,形成独立的消息发送类(MsgSender 相关类)。其中,Notification 类相当于抽象,MsgSender 类相当于实现,两者可以独立开发,通过组合关系(也就是桥梁)任意组合在一起。所谓任意组合的意思就是,不同紧急程度的消息和发送渠道之间的对应关系,不是在代码中固定写死的,我们可以动态地去指定(比如,通过读取配置来获取对应关系)。 + + + +按照这个设计思路,我们对代码进行重构。重构之后的代码如下所示: + +```java + +public interface MsgSender { + void send(String message); +} + +public class TelephoneMsgSender implements MsgSender { + private List telephones; + + public TelephoneMsgSender(List telephones) { + this.telephones = telephones; + } + + @Override + public void send(String message) { + // ... + } +} + +public class EmailMsgSender implements MsgSender { + // 与TelephoneMsgSender代码结构类似,所以省略... +} + +public class WechatMsgSender implements MsgSender { + // 与TelephoneMsgSender代码结构类似,所以省略... +} + +public abstract class Notification { + protected MsgSender msgSender; + + public Notification(MsgSender msgSender) { + this.msgSender = msgSender; + } + + public abstract void notify(String message); +} + +public class SevereNotification extends Notification { + public SevereNotification(MsgSender msgSender) { + super(msgSender); + } + + @Override + public void notify(String message) { + msgSender.send(message); + } +} + +public class UrgencyNotification extends Notification { + // 与SevereNotification代码结构类似,所以省略... +} + +public class NormalNotification extends Notification { + // 与SevereNotification代码结构类似,所以省略... +} + +public class TrivialNotification extends Notification { + // 与SevereNotification代码结构类似,所以省略... +} + +``` + + + +## 桥接模式的注意事项和细节 + +1. 实现了抽象和实现部分的分离,从而极大的提供了系统的灵活性,让抽象部分和实现部分独立开来,这有助于系统进行分层设计,从而产生更好的结构化系统。 +2. 对于系统的高层部分,只需要知道抽象部分和实现部分的接口就可以了,其它的部分由具体业务来完成。 +3. 桥接模式替代多层继承方案,可以减少子类的个数,降低系统的管理和维护成本 +4. 桥接模式的引入增加了系统的理解和设计难度,由于聚合关联关系建立在抽象层,要求开发者针对抽象进行设计和编程 +5. 桥接模式要求**正确识别出系统中两个独立变化的维度(抽象、和实现)**,因此其使用范围有一定的局限性,即需要有这样的应用场景。 + + + +# 装饰器模式【常用】 + + + +我们学习了桥接模式,桥接模式有两种理解方式。第一种理解方式是“将抽象和实现解耦,让它们能独立开发”。这种理解方式比较特别,应用场景也不多。另一种理解方式更加简单,类似“组合优于继承”设计原则,这种理解方式更加通用,应用场景比较多。不管是哪种理解方式,它们的代码结构都是相同的,都是一种类之间的组合关系。 + +今天,我们通过剖析 Java IO 类的设计思想,再学习一种新的结构型模式,装饰器模式。它的代码结构跟桥接模式非常相似,不过,要解决的问题却大不相同。 + +> 不过还是先看一个简单的demo案例,会比较好理解 + + + +## Demo案例-咖啡订单项目 + +### 星巴克咖啡订单项目 + +1. 咖啡种类/单品咖啡:Espresso(意大利浓咖啡)、ShortBlack、LongBlack(美式咖啡)、Decaf(无因咖啡) +2. 调料:Milk、Soy(豆浆)、Chocolate +3. 要求在扩展新的咖啡种类时,具有良好的扩展性、改动方便、维护方便 +4. 使用 OO 的来计算不同种类咖啡的费用: 客户可以点单品咖啡,也可以单品咖啡+调料组合。 + + + +### 方案一 + + + + + +1. Drink 是一个抽象类,表示饮料 +2. des 就是对咖啡的描述, 比如咖啡的名字 +3. cost() 方法就是计算费用,Drink 类中做成一个抽象方法. +4. Decaf 就是单品咖啡, 继承 Drink, 并实现 cost +5. Espress && Milk 就是单品咖啡+调料, 这个组合很多 +6. 问题:**这样设计,会有很多类,当我们增加一个单品咖啡,或者一个新的调料,类的数量就会倍增,就会出现类爆炸** + +### 方案二 + +前面分析到方案 1 因为咖啡单品+调料组合会造成类的倍增,因此可以做改进,将调料内置到 Drink 类,这样就不会造成类数量过多。从而提高项目的维护性(如图) + + + + + +1. 方案 2 可以控制类的数量,不至于造成很多的类 +2. 在增加或者删除调料种类时,代码的维护量很大 +3. 考虑到用户可以添加多份 调料时,可以将 hasMilk 返回一个对应 int +4. 考虑使用 **装饰者** 模式 + +> 注意:装饰器模式是对功能的增强,而不是附加新的功能。代理模式才是附加新的功能。 + + + +### 装饰器模式代码 + + + +#### Drink【抽象类-主体Component】 + +```java +public abstract class Drink { + + public String des; // 描述 + private float price = 0.0f; + public String getDes() { + return des; + } + public void setDes(String des) { + this.des = des; + } + public float getPrice() { + return price; + } + public void setPrice(float price) { + this.price = price; + } + + //计算费用的抽象方法 + //子类来实现 + public abstract float cost(); + +} +``` + + + +#### Decorator + +```java +public class Decorator extends Drink { + private Drink obj; + + public Decorator(Drink obj) { //组合 + // TODO Auto-generated constructor stub + this.obj = obj; + } + + @Override + public float cost() { + // TODO Auto-generated method stub + // getPrice 自己价格 + return super.getPrice() + obj.cost(); + } + + @Override + public String getDes() { + // TODO Auto-generated method stub + // obj.getDes() 输出被装饰者的信息 + return des + " " + getPrice() + " && " + obj.getDes(); + } + +} +``` + +#### Coffee + +``` +public class Coffee extends Drink { + + @Override + public float cost() { + // TODO Auto-generated method stub + return super.getPrice(); + } +} +``` + +#### ShortBlack + +```java +public class ShortBlack extends Coffee{ + + public ShortBlack() { + setDes(" shortblack "); + setPrice(4.0f); + } +} +``` + +#### LongBlack + +```java +public class LongBlack extends Coffee { + + public LongBlack() { + setDes(" longblack "); + setPrice(5.0f); + } +} +``` + +#### DeCaf + +```java +public class DeCaf extends Coffee { + + public DeCaf() { + setDes(" 无因咖啡 "); + setPrice(1.0f); + } +} +``` + +#### Espresso + +```java +public class Espresso extends Coffee { + + public Espresso() { + setDes(" 意大利咖啡 "); + setPrice(6.0f); + } +} +``` + +#### Chocolate + +```java +//具体的Decorator, 这里就是调味品 +public class Chocolate extends Decorator { + + public Chocolate(Drink obj) { + super(obj); + setDes(" 巧克力 "); + setPrice(3.0f); // 调味品 的价格 + } + +} +``` + +#### Milk + +```java +public class Milk extends Decorator { + + public Milk(Drink obj) { + super(obj); + // TODO Auto-generated constructor stub + setDes(" 牛奶 "); + setPrice(2.0f); + } + +} +``` + +#### Soy + +```java +public class Soy extends Decorator{ + + public Soy(Drink obj) { + super(obj); + // TODO Auto-generated constructor stub + setDes(" 豆浆 "); + setPrice(1.5f); + } + +} +``` + +#### CoffeeBar + +```java +public class CoffeeBar { + + public static void main(String[] args) { + // TODO Auto-generated method stub + // 装饰者模式下的订单:2份巧克力+一份牛奶的LongBlack + + // 1. 点一份 LongBlack + Drink order = new LongBlack(); + System.out.println("费用1=" + order.cost()); + System.out.println("描述=" + order.getDes()); + + // 2. order 加入一份牛奶 + order = new Milk(order); + + System.out.println("order 加入一份牛奶 费用 =" + order.cost()); + System.out.println("order 加入一份牛奶 描述 = " + order.getDes()); + + // 3. order 加入一份巧克力 + + order = new Chocolate(order); + + System.out.println("order 加入一份牛奶 加入一份巧克力 费用 =" + order.cost()); + System.out.println("order 加入一份牛奶 加入一份巧克力 描述 = " + order.getDes()); + + // 3. order 加入一份巧克力 + + order = new Chocolate(order); + + System.out.println("order 加入一份牛奶 加入2份巧克力 费用 =" + order.cost()); + System.out.println("order 加入一份牛奶 加入2份巧克力 描述 = " + order.getDes()); + + System.out.println("==========================="); + + Drink order2 = new DeCaf(); + + System.out.println("order2 无因咖啡 费用 =" + order2.cost()); + System.out.println("order2 无因咖啡 描述 = " + order2.getDes()); + + order2 = new Milk(order2); + + System.out.println("order2 无因咖啡 加入一份牛奶 费用 =" + order2.cost()); + System.out.println("order2 无因咖啡 加入一份牛奶 描述 = " + order2.getDes()); + + + } + +} +``` + + + +## 装饰者模式原理 + +1. 装饰者模式就像打包一个快递 + +主体:比如:陶瓷、衣服 (Component) // 被装饰者 + +包装:比如:报纸填充、塑料泡沫、纸板、木板(Decorator) + +2. Component 主体:比如类似前面的 Drink + +3. ConcreteComponent 和 Decorator + +ConcreteComponent:具体的主体, 比如前面的各个单品咖啡 + +4. Decorator: 装饰者,比如各调料. + +在Component 与 ConcreteComponent 之间,如果 ConcreteComponent 类很多,还可以设计一个缓冲层,将 共有的部分提取出来,抽象层一个类 + +## Java IO 类的“奇怪”用法 + +Java IO 类库非常庞大和复杂,有几十个类,负责 IO 数据的读取和写入。如果对 Java IO 类做一下分类,我们可以从下面两个维度将它划分为四类。具体如下所示: + +| | 字节流 | 字符流 | +| ------ | ------------ | ------ | +| 输入流 | InputStream | Reader | +| 输出流 | OutputStream | Writer | + +针对不同的读取和写入场景,Java IO 又在这四个父类基础之上,扩展出了很多子类。具体如下所示: + + + + + +> 说明 +> +> 1. InputStream 是抽象类, 类似我们前面讲的 Drink +> 2. FileInputStream 是 InputStream 子类,类似我们前面的 DeCaf, LongBlack +> 3. FilterInputStream 是 InputStream 子类:类似我们前面 的 Decorator 修饰者 +> 4. DataInputStream 是 FilterInputStream 子类,具体的修饰者,类似前面的 Milk, Soy 等 +> 5. FilterInputStream 类 有 protected volatile InputStream in; 即含被装饰者 +> 6. 分析得出在jdk 的io体系中,就是使用装饰者模式 + +在我初学 Java 的时候,曾经对 Java IO 的一些用法产生过很大疑惑,比如下面这样一段代码。我们打开文件 test.txt,从中读取数据。其中,InputStream 是一个抽象类,FileInputStream 是专门用来读取文件流的子类。BufferedInputStream 是一个支持带缓存功能的数据读取类,可以提高数据读取的效率。 + + + +```java +InputStream in = new FileInputStream("/user/test.txt"); +InputStream bin = new BufferedInputStream(in); +byte[] data = new byte[128]; +while (bin.read(data) != -1) { + //... +} +``` + +初看上面的代码,我们会觉得 Java IO 的用法比较麻烦,需要先创建一个 FileInputStream 对象,然后再传递给 BufferedInputStream 对象来使用。我在想,Java IO 为什么不设计一个继承 FileInputStream 并且支持缓存的 BufferedFileInputStream 类呢?这样我们就可以像下面的代码中这样,直接创建一个 BufferedFileInputStream 类对象,打开文件读取数据,用起来岂不是更加简单? + + + +```java +InputStream bin = new BufferedFileInputStream("/user/test.txt"); +byte[] data = new byte[128]; +while (bin.read(data) != -1) { + //... +} +``` + + + + + +## 基于继承的设计方案 + +如果 InputStream 只有一个子类 FileInputStream 的话,那我们在 FileInputStream 基础之上,再设计一个孙子类 BufferedFileInputStream,也算是可以接受的,毕竟继承结构还算简单。但实际上,继承 InputStream 的子类有很多。我们需要给每一个 InputStream 的子类,再继续派生支持缓存读取的子类。 + + + +除了支持缓存读取之外,如果我们还需要对功能进行其他方面的增强,比如下面的 DataInputStream 类,支持按照基本数据类型(int、boolean、long 等)来读取数据。 + +```java +FileInputStream in = new FileInputStream("/user/test.txt"); +DataInputStream din = new DataInputStream(in); +int data = din.readInt(); +``` + +在这种情况下,如果我们继续按照继承的方式来实现的话,就需要再继续派生出 DataFileInputStream、DataPipedInputStream 等类。如果我们还需要既支持缓存、又支持按照基本类型读取数据的类,那就要再继续派生出 BufferedDataFileInputStream、BufferedDataPipedInputStream 等 n 多类。这还只是附加了两个增强功能,如果我们需要附加更多的增强功能,那就会导致组合爆炸,类继承结构变得无比复杂,代码既不好扩展,也不好维护。这也是我们不推荐使用继承的原因。 + + + +## 基于装饰器模式的设计方案 + + + +在前面,我们还讲到“组合优于继承”,可以“使用组合来替代继承”。针对刚刚的继承结构过于复杂的问题,我们可以通过将继承关系改为组合关系来解决。下面的代码展示了 Java IO 的这种设计思路。不过,我对代码做了简化,只抽象出了必要的代码结构,如果你感兴趣的话,可以直接去查看 JDK 源码。 + +```java +import java.io.IOException; + +public abstract class InputStream { + // ... + public int read(byte b[]) throws IOException { + return read(b, 0, b.length); + } + public int read(byte b[], int off, int len) throws IOException { + // ... + } + + public long skip(long n) throws IOException { + // ... + } + + public int available() throws IOException { + return 0; + } + + public void close() throws IOException {} + + public synchronized void mark(int readlimit) {} + + public synchronized void reset() throws IOException { + throw new IOException("mark/reset not supported"); + } + + public boolean markSupported() { + return false; + } +} + +public class BufferedInputStream extends InputStream { + protected volatile InputStream in; + + protected BufferedInputStream(InputStream in) { + this.in = in; + } + + // ...实现基于缓存的读数据接口... +} + +public class DataInputStream extends InputStream { + protected volatile InputStream in; + + protected DataInputStream(InputStream in) { + this.in = in; + } + + // ...实现读取基本类型数据的接口 +} + +``` + +看了上面的代码,你可能会问,那装饰器模式就是简单的“用组合替代继承”吗?当然不是。从 Java IO 的设计来看,装饰器模式相对于简单的组合关系,还有两个比较特殊的地方。 + + + +**第一个比较特殊的地方是:装饰器类和原始类继承同样的父类,这样我们可以对原始类“嵌套”多个装饰器类。**比如,下面这样一段代码,我们对 FileInputStream 嵌套了两个装饰器类:BufferedInputStream 和 DataInputStream,让它既支持缓存读取,又支持按照基本数据类型来读取数据。 + + + +```java +InputStream in = new FileInputStream("/user/test.txt"); +InputStream bin = new BufferedInputStream(in); +DataInputStream din = new DataInputStream(bin); +int data = din.readInt(); +``` + + + +**第二个比较特殊的地方是:装饰器类是对功能的增强,这也是装饰器模式应用场景的一个重要特点。**实际上,符合“组合关系”这种代码结构的设计模式有很多,比如之前讲过的代理模式、桥接模式,还有现在的装饰器模式。尽管它们的代码结构很相似,但是每种设计模式的意图是不同的。就拿比较相似的代理模式和装饰器模式来说吧,代理模式中,代理类附加的是跟原始类无关的功能,而在装饰器模式中,装饰器类附加的是跟原始类相关的增强功能。 + +```java +// 代理模式的代码结构(下面的接口也可以替换成抽象类) +public interface IA { + void f(); +} + +public class A impelements IA { + public void f() { + //... + } +} + +public class AProxy impements IA { + private IA a; + + public AProxy(IA a) { + this.a = a; + } + + public void f() { + // 新添加的代理逻辑 + a.f(); + // 新添加的代理逻辑 + } +} + +// 装饰器模式的代码结构(下面的接口也可以替换成抽象类) +public interface IA { + void f(); +} + +public class A impelements IA { + + public void f() { + //... + } +} + +public class ADecorator impements IA { + private IA a; + public ADecorator(IA a) { + this.a = a; + } + + public void f() { + // 功能增强代码 + a.f(); + // 功能增强代码 + } +} +``` + + + +1. 实际上,如果去查看 JDK 的源码,你会发现,BufferedInputStream、DataInputStream 并非继承自 InputStream,而是另外一个叫 FilterInputStream 的类。那这又是出于什么样的设计意图,才引入这样一个类呢? +2. 我们再重新来看一下 BufferedInputStream 类的代码。InputStream 是一个抽象类而非接口,而且它的大部分函数(比如 read()、available())都有默认实现,按理来说,我们只需要在 BufferedInputStream 类中重新实现那些需要增加缓存功能的函数就可以了,其他函数继承 InputStream 的默认实现。但实际上,这样做是行不通的。 +3. 对于即便是不需要增加缓存功能的函数来说,BufferedInputStream 还是必须把它重新实现一遍,简单包裹对 InputStream 对象的函数调用。具体的代码示例如下所示。如果不重新实现,那 BufferedInputStream 类就无法将最终读取数据的任务,委托给传递进来的 InputStream 对象来完成。这一部分稍微有点不好理解,你自己多思考一下。 + + + +```java +public class BufferedInputStream extends InputStream { + protected volatile InputStream in; + + protected BufferedInputStream(InputStream in) { + this.in = in; + } + + // f()函数不需要增强,只是重新调用一下InputStream in对象的f() + public void f() { + in.f(); + } +} +``` + + + +实际上,DataInputStream 也存在跟 BufferedInputStream 同样的问题。为了避免代码重复,Java IO 抽象出了一个装饰器父类 FilterInputStream,代码实现如下所示。InputStream 的所有的装饰器类(BufferedInputStream、DataInputStream)都继承自这个装饰器父类。这样,装饰器类只需要实现它需要增强的方法就可以了,其他方法继承装饰器父类的默认实现。 + + + +```java + +public class FilterInputStream extends InputStream { + protected volatile InputStream in; + + protected FilterInputStream(InputStream in) { + this.in = in; + } + + public int read() throws IOException { + return in.read(); + } + + public int read(byte b[]) throws IOException { + return read(b, 0, b.length); + } + + public int read(byte b[], int off, int len) throws IOException { + return in.read(b, off, len); + } + + public long skip(long n) throws IOException { + return in.skip(n); + } + + public int available() throws IOException { + return in.available(); + } + + public void close() throws IOException { + in.close(); + } + + public synchronized void mark(int readlimit) { + in.mark(readlimit); + } + + public synchronized void reset() throws IOException { + in.reset(); + } + + public boolean markSupported() { + return in.markSupported(); + } + +} +``` + + + + + +# 适配器模式【常用】 + +1. 前面我们学了代理模式、桥接模式、装饰器模式,今天,我们再来学习一个比较常用的结构型模式:适配器模式。这个模式相对来说还是比较简单、好理解的,应用场景也很具体,总体上来讲比较好掌握。 +2. 关于适配器模式,今天我们主要学习它的两种实现方式,类适配器和对象适配器,以及 5 种常见的应用场景。同时,我还会通过剖析 slf4j 日志框架,来给你展示这个模式在真实项目中的应用。除此之外,在文章的最后,我还对代理、桥接、装饰器、适配器,这 4 种代码结构非常相似的设计模式做简单的对比,对这几节内容做一个简单的总结。 +3. 适配器模式(Adapter Pattern)将某个类的接口转换成客户端期望的另一个接口表示,**主的目的是兼容性**,让原本因接口不匹配不能一起工作的两个类可以协同工作。其别名为包装器(Wrapper) 。适配器模式属于结构型模式。主要分为三类:**类适配器模式、对象适配器模式、接口适配器模**式 + + + +## Demo案例-充电器 + +基本介绍:Adapter 类,通过继承 src 类,实现 dst 类接口,完成 src->dst 的适配。 + +- 以生活中充电器的例子来讲解适配器,充电器本身相当于 Adapter,220V 交流电相当于 src (即被适配者),我们 的目 dst(即 目标)是 5V 直流电 + +### 类适配器代码实现 + +#### Voltage220V + +```java +//被适配的类 +public class Voltage220V { + //输出220V的电压 + public int output220V() { + int src = 220; + System.out.println("电压=" + src + "伏"); + return src; + } +} +``` + +#### IVoltage5V + +```java +//适配接口 +public interface IVoltage5V { + public int output5V(); +} +``` + +#### Phone + +```java +public class Phone { + + //充电 + public void charging(IVoltage5V iVoltage5V) { + if(iVoltage5V.output5V() == 5) { + System.out.println("电压为5V, 可以充电~~"); + } else if (iVoltage5V.output5V() > 5) { + System.out.println("电压大于5V, 不能充电~~"); + } + } +} +``` + +#### VoltageAdapter + +```java +//适配器类 +public class VoltageAdapter extends Voltage220V implements IVoltage5V { + + @Override + public int output5V() { + // TODO Auto-generated method stub + //获取到220V电压 + int srcV = output220V(); + int dstV = srcV / 44 ; //转成 5v + return dstV; + } + +} +``` + +#### Client + +```java +public class Client { + + public static void main(String[] args) { + // TODO Auto-generated method stub + System.out.println(" === 类适配器模式 ===="); + Phone phone = new Phone(); + phone.charging(new VoltageAdapter()); + } + +} +``` + + + +### 对象适配器实现 + +基本思路和类的适配器模式相同,只是将 Adapter 类作修改,不是继承 src 类,而是持有 src 类的实例,以解决 兼容性的问题。 即:持有 src 类,实现 dst 类接口,完成 src->dst 的适配 ,在系统中尽量使用**关联关系(聚合,组合)来替代继承**关系。 + + + +上面的例子代码基本没用什么改变,改变的只有以下两个类 + +#### VoltageAdapter + +```java +// 适配器类 +public class VoltageAdapter implements IVoltage5V { + + private Voltage220V voltage220V; // 关联关系-聚合 + + // 通过构造器,传入一个 Voltage220V 实例 + public VoltageAdapter(Voltage220V voltage220v) { + + this.voltage220V = voltage220v; + } + + @Override + public int output5V() { + + int dst = 0; + if (null != voltage220V) { + int src = voltage220V.output220V(); // 获取220V 电压 + System.out.println("使用对象适配器,进行适配~~"); + dst = src / 44; + System.out.println("适配完成,输出的电压为=" + dst); + } + + return dst; + } +} +``` + +#### Client + +```java +public class Client { + + public static void main(String[] args) { + // TODO Auto-generated method stub + System.out.println(" === 对象适配器模式 ===="); + Phone phone = new Phone(); + phone.charging(new VoltageAdapter(new Voltage220V())); + } +} +``` + + + + + +## 适配器模式的原理与实现 + +顾名思义,这个模式就是用来做适配的,它将不兼容的接口转换为可兼容的接口,让原本由于接口不兼容而不能一起工作的类可以一起工作。对于这个模式,有一个经常被拿来解释它的例子,就是 USB 转接头充当适配器,把两种不兼容的接口,通过转接变得可以一起工作。 + + + +原理很简单,我们再来看下它的代码实现。适配器模式有两种实现方式:类适配器和对象适配器。其中,类适配器使用继承关系来实现,对象适配器使用组合关系来实现。具体的代码实现如下所示。其中,ITarget 表示要转化成的接口定义。Adaptee 是一组不兼容 ITarget 接口定义的接口,Adaptor 将 Adaptee 转化成一组符合 ITarget 接口定义的接口。 + +```java +// 类适配器: 基于继承 +public interface ITarget { + void f1(); + void f2(); + void fc(); +} + +public class Adaptee { + + public void fa() { + //... + } + + public void fb() { + //... + } + + public void fc(){ + //... + } + +} + +public class Adaptor extends Adaptee implements ITarget { + + public void f1() { + super.fa(); + } + + public void f2() { + //...重新实现f2()... + } + +// 这里fc()不需要实现,直接继承自Adaptee,这是跟对象适配器最大的不同点 +} + +// 对象适配器:基于组合 +public interface ITarget { + void f1(); + void f2(); + void fc(); +} +public class Adaptee { + + public void fa() { + //... + } + + public void fb() { + //... + } + + public void fc(){ + //... + } + +} + +public class Adaptor implements ITarget { + private Adaptee adaptee; + + public Adaptor(Adaptee adaptee) { + this.adaptee = adaptee; + } + + public void f1() { + adaptee.fa(); //委托给Adaptee + } + + public void f2() { + //...重新实现f2()... + } + + public void fc() { + adaptee.fc(); + } +} +``` + + + +针对这两种实现方式,在实际的开发中,到底该如何选择使用哪一种呢?判断的标准主要有两个,一个是 Adaptee 接口的个数,另一个是 Adaptee 和 ITarget 的契合程度。 + +- 如果 Adaptee 接口并不多,那两种实现方式都可以。 +- 如果 Adaptee 接口很多,而且 Adaptee 和 ITarget 接口定义大部分都相同,那我们推荐使用类适配器,因为 Adaptor 复用父类 Adaptee 的接口,比起对象适配器的实现方式,Adaptor 的代码量要少一些。 +- 如果 Adaptee 接口很多,而且 Adaptee 和 ITarget 接口定义大部分都不相同,那我们推荐使用对象适配器,因为组合结构相对于继承更加灵活。 + + + +## 适配器模式应用场景总结 + +1. 原理和实现讲完了,都不复杂。我们再来看,到底什么时候会用到适配器模式呢? + +2. 一般来说,适配器模式可以看作一种“补偿模式”,用来补救设计上的缺陷。应用这种模式算是“无奈之举”。如果在设计初期,我们就能协调规避接口不兼容的问题,那这种模式就没有应用的机会了。 +3. 前面我们反复提到,适配器模式的应用场景是“接口不兼容”。那在实际的开发中,什么情况下才会出现接口不兼容呢?我建议你先自己思考一下这个问题,然后再来看下面的总结 。 + + + +### 封装有缺陷的接口设计 + +1. 假设我们依赖的外部系统在接口设计方面有缺陷(比如包含大量静态方法),引入之后会影响到我们自身代码的可测试性。为了隔离设计上的缺陷,我们希望对外部系统提供的接口进行二次封装,抽象出更好的接口设计,这个时候就可以使用适配器模式了。 + +2. 具体我还是举个例子来解释一下,你直接看代码应该会更清晰。具体代码如下所示: + +```java +public class CD { //这个类来自外部sdk,我们无权修改它的代码 + //... + public static void staticFunction1() { //... } + + public void uglyNamingFunction2() { //... } + + public void tooManyParamsFunction3(int paramA, int paramB, ...) { //... } + + public void lowPerformanceFunction4() { //... } + +} + +// 使用适配器模式进行重构 +public class ITarget { + + void function1(); + void function2(); + void fucntion3(ParamsWrapperDefinition paramsWrapper); + void function4(); + //... +} + +// 注意:适配器类的命名不一定非得末尾带Adaptor + +public class CDAdaptor extends CD implements ITarget { + //... + public void function1() { + super.staticFunction1(); + } + + public void function2() { + super.uglyNamingFucntion2(); + } + + public void function3(ParamsWrapperDefinition paramsWrapper) { + super.tooManyParamsFunction3(paramsWrapper.getParamA(), ...); + } + + public void function4() { + //...reimplement it... + } +} +``` + + + +### 统一多个类的接口设计 + +1. 某个功能的实现依赖多个外部系统(或者说类)。通过适配器模式,将它们的接口适配为统一的接口定义,然后我们就可以使用多态的特性来复用代码逻辑。具体我还是举个例子来解释一下。 +2. 假设我们的系统要对用户输入的文本内容做敏感词过滤,为了提高过滤的召回率,我们引入了多款第三方敏感词过滤系统,依次对用户输入的内容进行过滤,过滤掉尽可能多的敏感词。但是,每个系统提供的过滤接口都是不同的。这就意味着我们没法复用一套逻辑来调用各个系统。这个时候,我们就可以使用适配器模式,将所有系统的接口适配为统一的接口定义,这样我们可以复用调用敏感词过滤的代码。 +3. 你可以配合着下面的代码示例,来理解我刚才举的这个例子。 + +```java +import java.util.ArrayList; +import java.util.List; + +public class ASensitiveWordsFilter { // A敏感词过滤系统提供的接口 + // text是原始文本,函数输出用***替换敏感词之后的文本 + public String filterSexyWords(String text) { + // ... + } + + public String filterPoliticalWords(String text) { + // ... + } +} + +public class BSensitiveWordsFilter { // B敏感词过滤系统提供的接口 + public String filter(String text) { + // ... + } +} + +public class CSensitiveWordsFilter { // C敏感词过滤系统提供的接口 + public String filter(String text, String mask) { + // ... + } +} + +// 未使用适配器模式之前的代码:代码的可测试性、扩展性不好 +public class RiskManagement { + private ASensitiveWordsFilter aFilter = new ASensitiveWordsFilter(); + private BSensitiveWordsFilter bFilter = new BSensitiveWordsFilter(); + private CSensitiveWordsFilter cFilter = new CSensitiveWordsFilter(); + + public String filterSensitiveWords(String text) { + String maskedText = aFilter.filterSexyWords(text); + maskedText = aFilter.filterPoliticalWords(maskedText); + maskedText = bFilter.filter(maskedText); + maskedText = cFilter.filter(maskedText, "***"); + return maskedText; + } +} + +// 使用适配器模式进行改造 +public interface ISensitiveWordsFilter { // 统一接口定义 + String filter(String text); +} + +public class ASensitiveWordsFilterAdaptor implements ISensitiveWordsFilter { + private ASensitiveWordsFilter aFilter; + + public String filter(String text) { + String maskedText = aFilter.filterSexyWords(text); + maskedText = aFilter.filterPoliticalWords(maskedText); + return maskedText; + } +} + +// ...省略BSensitiveWordsFilterAdaptor、CSensitiveWordsFilterAdaptor... +// 扩展性更好,更加符合开闭原则,如果添加一个新的敏感词过滤系统, +// 这个类完全不需要改动;而且基于接口而非实现编程,代码的可测试性更好。 +public class RiskManagement { + private List filters = new ArrayList<>(); + + public void addSensitiveWordsFilter(ISensitiveWordsFilter filter) { + filters.add(filter); + } + + public String filterSensitiveWords(String text) { + String maskedText = text; + for (ISensitiveWordsFilter filter : filters) { + maskedText = filter.filter(maskedText); + } + + return maskedText; + } +} + +``` + + + +### 替换依赖的外部系统 + +当我们把项目中依赖的一个外部系统替换为另一个外部系统的时候,利用适配器模式,可以减少对代码的改动。具体的代码示例如下所示: + +```java +// 外部系统A +public interface IA { +//... + void fa(); +} +public class A implements IA { +//... + public void fa() { + //... + } +} + +// 在我们的项目中,外部系统A的使用示例 +public class Demo { + private IA a; + public Demo(IA a) { + this.a = a; + } + //... + +} + +Demo d = new Demo(new A()); + +// 将外部系统A替换成外部系统B +public class BAdaptor implemnts IA { + private B b; + public BAdaptor(B b) { + this.b= b; + } + + public void fa() { + //... + b.fb(); + } +} + +// 借助BAdaptor,Demo的代码中,调用IA接口的地方都无需改动, +// 只需要将BAdaptor如下注入到Demo即可。 +Demo d = new Demo(new BAdaptor(new B())); +``` + + + +### 兼容老版本接口 + +1. 在做版本升级的时候,对于一些要废弃的接口,我们不直接将其删除,而是暂时保留,并且标注为 deprecated,并将内部实现逻辑委托为新的接口实现。这样做的好处是,让使用它的项目有个过渡期,而不是强制进行代码修改。这也可以粗略地看作适配器模式的一个应用场景。同样,我还是通过一个例子,来进一步解释一下。 +2. JDK1.0 中包含一个遍历集合容器的类 Enumeration。JDK2.0 对这个类进行了重构,将它改名为 Iterator 类,并且对它的代码实现做了优化。但是考虑到如果将 Enumeration 直接从 JDK2.0 中删除,那使用 JDK1.0 的项目如果切换到 JDK2.0,代码就会编译不通过。为了避免这种情况的发生,我们必须把项目中所有使用到 Enumeration 的地方,都修改为使用 Iterator 才行。 +3. 单独一个项目做 Enumeration 到 Iterator 的替换,勉强还能接受。但是,使用 Java 开发的项目太多了,一次 JDK 的升级,导致所有的项目不做代码修改就会编译报错,这显然是不合理的。这就是我们经常所说的不兼容升级。为了做到兼容使用低版本 JDK 的老代码,我们可以暂时保留 Enumeration 类,并将其实现替换为直接调用 Itertor。代码示例如下所示: + +```java +public class Collections { + public static Emueration emumeration(final Collection c) { + return new Enumeration() { + Iterator i = c.iterator(); + + public boolean hasMoreElments() { + return i.hashNext(); + } + + public Object nextElement() { + return i.next(): + } + } + } +} +``` + + + +### 适配不同格式的数据 + +前面我们讲到,适配器模式主要用于接口的适配,实际上,它还可以用在不同格式的数据之间的适配。比如,把从不同征信系统拉取的不同格式的征信数据,统一为相同的格式,以方便存储和使用。再比如,Java 中的 Arrays.asList() 也可以看作一种数据适配器,将数组类型的数据转化为集合容器类型。 + +```java +List stooges = Arrays.asList("Larry", "Moe", "Curly"); +``` + + + + + +### 剖析适配器模式在 Java 日志中的应用 + +1. Java 中有很多日志框架,在项目开发中,我们常常用它们来打印日志信息。其中,比较常用的有 log4j、logback,以及 JDK 提供的 JUL(java.util.logging) 和 Apache 的 JCL(Jakarta Commons Logging) 等。 +2. 大部分日志框架都提供了相似的功能,比如按照不同级别(debug、info、warn、erro……)打印日志等,但它们却并没有实现统一的接口。这主要可能是历史的原因,它不像 JDBC 那样,一开始就制定了数据库操作的接口规范。 +3. 如果我们只是开发一个自己用的项目,那用什么日志框架都可以,log4j、logback 随便选一个就好。但是,如果我们开发的是一个集成到其他系统的组件、框架、类库等,那日志框架的选择就没那么随意了。 +4. 比如,项目中用到的某个组件使用 log4j 来打印日志,而我们项目本身使用的是 logback。将组件引入到项目之后,我们的项目就相当于有了两套日志打印框架。每种日志框架都有自己特有的配置方式。所以,我们要针对每种日志框架编写不同的配置文件(比如,日志存储的文件地址、打印日志的格式)。如果引入多个组件,每个组件使用的日志框架都不一样,那日志本身的管理工作就变得非常复杂。所以,为了解决这个问题,我们需要统一日志打印框架。 +5. 如果你是做 Java 开发的,那 Slf4j 这个日志框架你肯定不陌生,它相当于 JDBC 规范,提供了一套打印日志的统一接口规范。不过,它只定义了接口,并没有提供具体的实现,需要配合其他日志框架(log4j、logback……)来使用。 +6. 不仅如此,Slf4j 的出现晚于 JUL、JCL、log4j 等日志框架,所以,这些日志框架也不可能牺牲掉版本兼容性,将接口改造成符合 Slf4j 接口规范。Slf4j 也事先考虑到了这个问题,所以,它不仅仅提供了统一的接口定义,还提供了针对不同日志框架的适配器。对不同日志框架的接口进行二次封装,适配成统一的 Slf4j 接口定义。具体的代码示例如下所示: + +```java +// slf4j统一的接口定义 +package org.slf4j; +public interface Logger { + public boolean isTraceEnabled(); + public void trace(String msg); + public void trace(String format, Object arg); + public void trace(String format, Object arg1, Object arg2); + public void trace(String format, Object[] argArray); + public void trace(String msg, Throwable t); + public boolean isDebugEnabled(); + public void debug(String msg); + public void debug(String format, Object arg); + public void debug(String format, Object arg1, Object arg2); + public void debug(String format, Object[] argArray); + public void debug(String msg, Throwable t); + +//...省略info、warn、error等一堆接口 +} + + +// log4j日志框架的适配器 +// Log4jLoggerAdapter实现了LocationAwareLogger接口, +// 其中LocationAwareLogger继承自Logger接口, +// 也就相当于Log4jLoggerAdapter实现了Logger接口。 +package org.slf4j.impl; +public final class Log4jLoggerAdapter extends MarkerIgnoringBase + implements LocationAwareLogger, Serializable { + + final transient org.apache.log4j.Logger logger; // log4j + + public boolean isDebugEnabled() { + return logger.isDebugEnabled(); + } + + public void debug(String msg) { + logger.log(FQCN, Level.DEBUG, msg, null); + } + + public void debug(String format, Object arg) { + if (logger.isDebugEnabled()) { + FormattingTuple ft = MessageFormatter.format(format, arg); + logger.log(FQCN, Level.DEBUG, ft.getMessage(), ft.getThrowable()); + } + } + + public void debug(String format, Object arg1, Object arg2) { + if (logger.isDebugEnabled()) { + FormattingTuple ft = MessageFormatter.format(format, arg1, arg2); + logger.log(FQCN, Level.DEBUG, ft.getMessage(), ft.getThrowable()); + } + } + + public void debug(String format, Object\[\] argArray) { + if (logger.isDebugEnabled()) { + FormattingTuple ft = MessageFormatter.arrayFormat(format, argArray); + logger.log(FQCN, Level.DEBUG, ft.getMessage(), ft.getThrowable()); + } + } + + public void debug(String msg, Throwable t) { + logger.log(FQCN, Level.DEBUG, msg, t); + } + +//...省略一堆接口的实现... +} +``` + + + +1. 所以,在开发业务系统或者开发框架、组件的时候,我们统一使用 Slf4j 提供的接口来编写打印日志的代码,具体使用哪种日志框架实现(log4j、logback……),是可以动态地指定的(使用 Java 的 SPI 技术,这里我不多解释,你自行研究吧),只需要将相应的 SDK 导入到项目中即可。 +2. 不过,你可能会说,如果一些老的项目没有使用 Slf4j,而是直接使用比如 JCL 来打印日志,那如果想要替换成其他日志框架,比如 log4j,该怎么办呢?实际上,Slf4j 不仅仅提供了从其他日志框架到 Slf4j 的适配器,还提供了反向适配器,也就是从 Slf4j 到其他日志框架的适配。我们可以先将 JCL 切换为 Slf4j,然后再将 Slf4j 切换为 log4j。经过两次适配器的转换,我们能就成功将 log4j 切换为了 logback。 + + + +## 代理、桥接、装饰器、适配器 4 种设计模式的区别 + +1. 代理、桥接、装饰器、适配器,这 4 种模式是比较常用的结构型设计模式。它们的代码结构非常相似。笼统来说,它们都可以称为 Wrapper 模式,也就是通过 Wrapper 类二次封装原始类。 + +2. 尽管代码结构相似,但这 4 种设计模式的用意完全不同,也就是说要解决的问题、应用场景不同,这也是它们的主要区别。这里我就简单说一下它们之间的区别。 + + + +- 代理模式:在不改变原始类接口的条件下,为原始类定义一个代理类,主要目的是控制访问,而非加强功能,这是它跟装饰器模式最大的不同。 +- 桥接模式:目的是将接口部分和实现部分分离,从而让它们可以较为容易、也相对独立地加以改变。 +- 装饰者模式:在不改变原始类接口的情况下,对原始类功能进行增强,并且支持多个装饰器的嵌套使用。 +- 适配器模式:是一种事后的补救策略。适配器提供跟原始类不同的接口,而代理模式、装饰器模式提供的都是跟原始类相同的接口。 + + + + + diff --git a/docs/design_patterns/structural_type/设计模式-04.02-结构型-门面&组合&享元.md b/docs/design_patterns/structural_type/设计模式-04.02-结构型-门面&组合&享元.md new file mode 100644 index 0000000..d0879e8 --- /dev/null +++ b/docs/design_patterns/structural_type/设计模式-04.02-结构型-门面&组合&享元.md @@ -0,0 +1,1133 @@ +--- +title: 设计模式-04.02-结构型-门面&组合&享元 +tags: + - 设计模式 + - 门面模式 + - 组合模式 + - 享元模式 +categories: + - 设计模式 + - 04.结构型 +keywords: 设计模式,门面模式,组合模式,享元模式 +description: 对代理模式,门面模式,组合模式,享元模式这3个设计模式进行了比较详细的讲述。 +cover: 'https://cdn.jsdelivr.net/gh/youthlql/lqlp@master/design_patterns/logo.jpg' +abbrlink: 5ea604e0 +date: 2021-07-05 16:51:58 +--- + + + + + +# 门面模式(外观模式)【不常用】 + +1. 门面模式原理和实现都特别简单,应用场景也比较明确,主要在接口设计方面使用。 + +2. 如果你平时的工作涉及接口开发,不知道你有没有遇到关于接口粒度的问题呢? +3. 为了保证接口的可复用性(或者叫通用性),我们需要将接口尽量设计得细粒度一点,职责单一一点。但是,如果接口的粒度过小,在接口的使用者开发一个业务功能时,就会导致需要调用 n 多细粒度的接口才能完成。调用者肯定会抱怨接口不好用。 +4. 相反,如果接口粒度设计得太大,一个接口返回 n 多数据,要做 n 多事情,就会导致接口不够通用、可复用性不好。接口不可复用,那针对不同的调用者的业务需求,我们就需要开发不同的接口来满足,这就会导致系统的接口无限膨胀。 +5. 那如何来解决接口的可复用性(通用性)和易用性之间的矛盾呢?通过今天对于门面模式的学习,我想你心中会有答案。 + + + +## 门面模式的原理与实现 + +1. 门面模式,也叫外观模式,英文全称是 Facade Design Pattern。在 GoF 的《设计模式》一书中,门面模式是这样定义的: + +> Provide a unified interface to a set of interfaces in a subsystem. Facade Pattern defines a higher-level interface that makes the subsystem easier to use. + +2. 翻译成中文就是:门面模式为子系统提供一组统一的接口,定义一组高层接口让子系统更易用。这个定义很简洁,我再进一步解释一下。 +3. 假设有一个系统 A,提供了 a、b、c、d 四个接口。系统 B 完成某个业务功能,需要调用 A 系统的 a、b、d 接口。利用门面模式,我们提供一个包裹 a、b、d 接口调用的门面接口 x,给系统 B 直接使用。 +4. 不知道你会不会有这样的疑问,让系统 B 直接调用 a、b、d 感觉没有太大问题呀,为什么还要提供一个包裹 a、b、d 的接口 x 呢?关于这个问题,我通过一个具体的例子来解释一下。 +5. 假设我们刚刚提到的系统 A 是一个后端服务器,系统 B 是 App 客户端。App 客户端通过后端服务器提供的接口来获取数据。我们知道,App 和服务器之间是通过移动网络通信的,网络通信耗时比较多,为了提高 App 的响应速度,我们要尽量减少 App 与服务器之间的网络通信次数。 +6. 假设,完成某个业务功能(比如显示某个页面信息)需要“依次”调用 a、b、d 三个接口,因自身业务的特点,不支持并发调用这三个接口。 +7. 如果我们现在发现 App 客户端的响应速度比较慢,排查之后发现,是因为过多的接口调用过多的网络通信。针对这种情况,我们就可以利用门面模式,让后端服务器提供一个包裹 a、b、d 三个接口调用的接口 x。App 客户端调用一次接口 x,来获取到所有想要的数据,将网络通信的次数从 3 次减少到 1 次,也就提高了 App 的响应速度。 +8. 这里举的例子只是应用门面模式的其中一个意图,也就是解决性能问题。实际上,不同的应用场景下,使用门面模式的意图也不同。接下来,我们就来看一下门面模式的各种应用场景。 + + + +## Demo案例-影院管理 + +- 组建一个家庭影院: + +- DVD 播放器、投影仪、自动屏幕、环绕立体声、爆米花机,要求完成使用家庭影院的功能,其过程为: + +- 直接用遥控器:统筹各设备开关 + + - 开爆米花机 + - 放下屏幕 + + - 开投影仪 + + - 开音响 + + - 开 DVD,选 dvd + + - 去拿爆米花 + + - 调暗灯光 + + - 播放 + + - 观影结束后,关闭各种设备 + + + +### 传统方案 + + + +1. 在 ClientTest 的 main 方法中,创建各个子系统的对象,并直接去调用子系统(对象)相关方法,会造成调用过程 混乱,没有清晰的过程 不利于在 ClientTest 中,去维护对子系统的操作 + +2. 解决思路:**定义一个高层接口**,给**子系统中的一组接口提供一个一致的界面**(比如在高层接口提供四个方法 ready, play, pause, end ),用来访问子系统中的一群接口 + +3. 也就是说 就是通过定义一个一致的接口(界面类),用以屏蔽内部子系统的细节,使得调用端只需跟这个接口发 生调用,而无需关心这个子系统的内部细节 => **外观模式** +4. 外观类(Facade): 为调用端提供统一的调用接口, 外观类知道哪些子系统负责处理请求,从而将调用端的请求代 理给适当子系统对象 +5. 调用者(Client): 外观接口的调用者 +6. 子系统的集合:指模块或者子系统,处理 Facade 对象指派的任务,他是功能的实际提供者 + + + +### 门面模式代码 + +#### TheaterLight + +```java +public class TheaterLight { + + private static TheaterLight instance = new TheaterLight(); + + public static TheaterLight getInstance() { + return instance; + } + + public void on() { + System.out.println(" TheaterLight on "); + } + + public void off() { + System.out.println(" TheaterLight off "); + } + + public void dim() { + System.out.println(" TheaterLight dim.. "); + } + + public void bright() { + System.out.println(" TheaterLight bright.. "); + } +} +``` + +#### Stereo + +```java +public class Stereo { + + private static Stereo instance = new Stereo(); + + public static Stereo getInstance() { + return instance; + } + + public void on() { + System.out.println(" Stereo on "); + } + + public void off() { + System.out.println(" Screen off "); + } + + public void up() { + System.out.println(" Screen up.. "); + } + + //... +} +``` + +#### Screen + +```java +public class Screen { + + private static Screen instance = new Screen(); + + public static Screen getInstance() { + return instance; + } + + public void up() { + System.out.println(" Screen up "); + } + + public void down() { + System.out.println(" Screen down "); + } + +} +``` + +#### Projector + +``` +public class Projector { + + private static Projector instance = new Projector(); + + public static Projector getInstance() { + return instance; + } + + public void on() { + System.out.println(" Projector on "); + } + + public void off() { + System.out.println(" Projector ff "); + } + + public void focus() { + System.out.println(" Projector is Projector "); + } + + //... +} +``` + +#### Popcorn + +``` +public class Popcorn { + + private static Popcorn instance = new Popcorn(); + + public static Popcorn getInstance() { + return instance; + } + + public void on() { + System.out.println(" popcorn on "); + } + + public void off() { + System.out.println(" popcorn ff "); + } + + public void pop() { + System.out.println(" popcorn is poping "); + } +} +``` + +#### DVDPlayer + +``` +public class DVDPlayer { + + //使用单例模式, 使用饿汉式 + private static DVDPlayer instance = new DVDPlayer(); + + public static DVDPlayer getInstanc() { + return instance; + } + + public void on() { + System.out.println(" dvd on "); + } + public void off() { + System.out.println(" dvd off "); + } + + public void play() { + System.out.println(" dvd is playing "); + } + + //.... + public void pause() { + System.out.println(" dvd pause .."); + } +} +``` + + + +#### HomeTheaterFacade + +```java + +public class HomeTheaterFacade { + + // 定义各个子系统对象 + private TheaterLight theaterLight; + private Popcorn popcorn; + private Stereo stereo; + private Projector projector; + private Screen screen; + private DVDPlayer dVDPlayer; + + // 构造器 + public HomeTheaterFacade() { + super(); + this.theaterLight = TheaterLight.getInstance(); + this.popcorn = Popcorn.getInstance(); + this.stereo = Stereo.getInstance(); + this.projector = Projector.getInstance(); + this.screen = Screen.getInstance(); + this.dVDPlayer = DVDPlayer.getInstanc(); + } + + // 操作分成 4 步 + + public void ready() { + popcorn.on(); + popcorn.pop(); + screen.down(); + projector.on(); + stereo.on(); + dVDPlayer.on(); + theaterLight.dim(); + } + + public void play() { + dVDPlayer.play(); + } + + public void pause() { + dVDPlayer.pause(); + } + + public void end() { + popcorn.off(); + theaterLight.bright(); + screen.up(); + projector.off(); + stereo.off(); + dVDPlayer.off(); + } +} +``` + + + +```java +public class Client { + + public static void main(String[] args) { + // TODO Auto-generated method stub + // 这里直接调用。。 很麻烦 + HomeTheaterFacade homeTheaterFacade = new HomeTheaterFacade(); + homeTheaterFacade.ready(); + homeTheaterFacade.play(); + + homeTheaterFacade.end(); + } +} +``` + +## 门面模式的应用场景举例 + +1. 在 GoF 给出的定义中提到,“门面模式让子系统更加易用”,实际上,它除了解决易用性问题之外,还能解决其他很多方面的问题。关于这一点,我总结罗列了 3 个常用的应用场景,你可以参考一下,举一反三地借鉴到自己的项目中。 +2. 除此之外,我还要强调一下,门面模式定义中的“子系统(subsystem)”也可以有多种理解方式。它既可以是一个完整的系统,也可以是更细粒度的类或者模块。关于这一点,在下面的讲解中也会有体现。 + + + +### 解决易用性问题 + +1. 门面模式可以用来封装系统的底层实现,隐藏系统的复杂性,提供一组更加简单易用、更高层的接口。比如,Linux 系统调用函数就可以看作一种“门面”。它是 Linux 操作系统暴露给开发者的一组“特殊”的编程接口,它封装了底层更基础的 Linux 内核调用。再比如,Linux 的 Shell 命令,实际上也可以看作一种门面模式的应用。它继续封装系统调用,提供更加友好、简单的命令,让我们可以直接通过执行命令来跟操作系统交互。 +2. 我们前面也多次讲过,设计原则、思想、模式很多都是相通的,是同一个道理不同角度的表述。实际上,从隐藏实现复杂性,提供更易用接口这个意图来看,门面模式有点类似之前讲到的迪米特法则(最少知识原则)和接口隔离原则:两个有交互的系统,只暴露有限的必要的接口。除此之外,门面模式还有点类似之前提到封装、抽象的设计思想,提供更抽象的接口,封装底层实现细节。 + + + + + +### 解决性能问题 + +1. 关于利用门面模式解决性能问题这一点,刚刚我们已经讲过了。我们通过将多个接口调用替换为一个门面接口调用,减少网络通信成本,提高 App 客户端的响应速度。所以,关于这点,我就不再举例说明了。我们来讨论一下这样一个问题:从代码实现的角度来看,该如何组织门面接口和非门面接口? +2. 如果门面接口不多,我们完全可以将它跟非门面接口放到一块,也不需要特殊标记,当作普通接口来用即可。如果门面接口很多,我们可以在已有的接口之上,再重新抽象出一层,专门放置门面接口,从类、包的命名上跟原来的接口层做区分。如果门面接口特别多,并且很多都是跨多个子系统的,我们可以将门面接口放到一个新的子系统中。 + + + +### 解决分布式事务问题 + +1. 关于利用门面模式来解决分布式事务问题,我们通过一个例子来解释一下。 +2. 在一个金融系统中,有两个业务领域模型,用户和钱包。这两个业务领域模型都对外暴露了一系列接口,比如用户的增删改查接口、钱包的增删改查接口。假设有这样一个业务场景:在用户注册的时候,我们不仅会创建用户(在数据库 User 表中),还会给用户创建一个钱包(在数据库的 Wallet 表中)。 +3. 对于这样一个简单的业务需求,我们可以通过依次调用用户的创建接口和钱包的创建接口来完成。但是,用户注册需要支持事务,也就是说,创建用户和钱包的两个操作,要么都成功,要么都失败,不能一个成功、一个失败。 +4. 要支持两个接口调用在一个事务中执行,是比较难实现的,这涉及分布式事务问题。虽然我们可以通过引入分布式事务框架或者事后补偿的机制来解决,但代码实现都比较复杂。而最简单的解决方案是,利用数据库事务或者 Spring 框架提供的事务(如果是 Java 语言的话),在一个事务中,执行创建用户和创建钱包这两个 SQL 操作。这就要求两个 SQL 操作要在一个接口中完成,所以,我们可以借鉴门面模式的思想,再设计一个包裹这两个操作的新接口,让新接口在一个事务中执行两个 SQL 操作。 + + + +# 组合模式【不常用】 + +1. 组合模式跟我们之前讲的面向对象设计中的“组合关系(通过组合来组装两个类)”,完全是两码事。这里讲的“组合模式”,主要是用来处理树形结构数据。这里的“数据”,你可以简单理解为一组对象集合,待会我们会详细讲解。 +2. 正因为其应用场景的特殊性,数据必须能表示成树形结构,这也导致了这种模式在实际的项目开发中并不那么常用。但是,一旦数据满足树形结构,应用这种模式就能发挥很大的作用,能让代码变得非常简洁。 + + + + + +## 组合模式的原理与实现 + +1. 在 GoF 的《设计模式》一书中,组合模式是这样定义的: + +> Compose objects into tree structure to represent part-whole hierarchies.Composite lets client treat individual objects and compositions of objects uniformly. + +2. 翻译成中文就是:将一组对象组织(Compose)成树形结构,以表示一种“部分 - 整体”的层次结构。组合让客户端(在很多设计模式书籍中,“客户端”代指代码的使用者。)可以统一单个对象和组合对象的处理逻辑。接下来,对于组合模式,我举个例子来给你解释一下。 + +3. 假设我们有这样一个需求:设计一个类来表示文件系统中的目录,能方便地实现下面这些功能: + +- 动态地添加、删除某个目录下的子目录或文件; + +- 统计指定目录下的文件个数; + +- 统计指定目录下的文件总大小。 + +4. 我这里给出了这个类的骨架代码,如下所示。其中的核心逻辑并未实现,你可以试着自己去补充完整,再来看我的讲解。在下面的代码实现中,我们把文件和目录统一用 FileSystemNode 类来表示,并且通过 isFile 属性来区分。 + + + +```java +public class FileSystemNode { + private String path; + private boolean isFile; + private List subNodes = new ArrayList<>(); + + public FileSystemNode(String path, boolean isFile) { + this.path = path; + this.isFile = isFile; + } + + public int countNumOfFiles() { + // TODO:... + } + + public long countSizeOfFiles() { + // TODO:... + } + + public String getPath() { + return path; + } + + public void addSubNode(FileSystemNode fileOrDir) { + subNodes.add(fileOrDir); + } + + public void removeSubNode(FileSystemNode fileOrDir) { + int size = subNodes.size(); + int i = 0; + for (; i < size; ++i) { + if (subNodes.get(i).getPath().equalsIgnoreCase(fileOrDir.getPath())) { + break; + } + } + + if (i < size) { + subNodes.remove(i); + } + } +} + +``` + + + +想要补全其中的 countNumOfFiles() 和 countSizeOfFiles() 这两个函数,并不是件难事,实际上这就是树上的递归遍历算法。对于文件,我们直接返回文件的个数(返回 1)或大小。对于目录,我们遍历目录中每个子目录或者文件,递归计算它们的个数或大小,然后求和,就是这个目录下的文件个数和文件大小。 + +```java +public int countNumOfFiles() { + if (isFile) { + return 1; + } + int numOfFiles = 0; + for (FileSystemNode fileOrDir : subNodes) { + numOfFiles += fileOrDir.countNumOfFiles(); + } + return numOfFiles; +} + +public long countSizeOfFiles() { + if (isFile) { + File file = new File(path); + if (!file.exists()) return 0; + return file.length(); + } + + long sizeofFiles = 0; + for (FileSystemNode fileOrDir : subNodes) { + sizeofFiles += fileOrDir.countSizeOfFiles(); + } + return sizeofFiles; +} +``` + +单纯从功能实现角度来说,上面的代码没有问题,已经实现了我们想要的功能。但是,如果我们开发的是一个大型系统,从扩展性(文件或目录可能会对应不同的操作)、业务建模(文件和目录从业务上是两个概念)、代码的可读性(文件和目录区分对待更加符合人们对业务的认知)的角度来说,我们最好对文件和目录进行区分设计,定义为 File 和 Directory 两个类。 + + + +按照这个设计思路,我们对代码进行重构。重构之后的代码如下所示: + +```java +public abstract class FileSystemNode { + protected String path; + + public FileSystemNode(String path) { + this.path = path; + } + + public abstract int countNumOfFiles(); + public abstract long countSizeOfFiles(); + + public String getPath() { + return path; + } +} + +public class File extends FileSystemNode { + + public File(String path) { + super(path); + } + + @Override + public int countNumOfFiles() { + return 1; + } + + @Override + public long countSizeOfFiles() { + java.io.File file = new java.io.File(path); + if (!file.exists()) return 0; + return file.length(); + } +} + +public class Directory extends FileSystemNode { + + private List subNodes = new ArrayList<>(); + + public Directory(String path) { + super(path); + } + + @Override + public int countNumOfFiles() { + int numOfFiles = 0; + for (FileSystemNode fileOrDir : subNodes) { + numOfFiles += fileOrDir.countNumOfFiles(); + } + return numOfFiles; + } + + @Override + public long countSizeOfFiles() { + long sizeofFiles = 0; + for (FileSystemNode fileOrDir : subNodes) { + sizeofFiles += fileOrDir.countSizeOfFiles(); + } + return sizeofFiles; + } + + public void addSubNode(FileSystemNode fileOrDir) { + subNodes.add(fileOrDir); + } + + public void removeSubNode(FileSystemNode fileOrDir) { + int size = subNodes.size(); + int i = 0; + for (; i < size; ++i) { + if (subNodes.get(i).getPath().equalsIgnoreCase(fileOrDir.getPath())) { + break; + } + } + + if (i < size) { + subNodes.remove(i); + } + } +} + +``` + + + +文件和目录类都设计好了,我们来看,如何用它们来表示一个文件系统中的目录树结构。具体的代码示例如下所示: + +```java +public class Demo { + + public static void main(String[] args) { + + /** + * / + * + *

/wz/ + * + *

/wz/a.txt + * + *

/wz/b.txt + * + *

/wz/movies/ + * + *

/wz/movies/c.avi + * + *

/xzg/ + * + *

/xzg/docs/ + * + *

/xzg/docs/d.txt + */ + Directory fileSystemTree = new Directory("/"); + Directory node_wz = new Directory("/wz/"); + Directory node_xzg = new Directory("/xzg/"); + fileSystemTree.addSubNode(node_wz); + fileSystemTree.addSubNode(node_xzg); + + + File node_wz_a = new File("/wz/a.txt"); + File node_wz_b = new File("/wz/b.txt"); + Directory node_wz_movies = new Directory("/wz/movies/"); + node_wz.addSubNode(node_wz_a); + node_wz.addSubNode(node_wz_b); + node_wz.addSubNode(node_wz_movies); + + + File node_wz_movies_c = new File("/wz/movies/c.avi"); + node_wz_movies.addSubNode(node_wz_movies_c); + + + Directory node_xzg_docs = new Directory("/xzg/docs/"); + node_xzg.addSubNode(node_xzg_docs); + + + File node_xzg_docs_d = new File("/xzg/docs/d.txt"); + node_xzg_docs.addSubNode(node_xzg_docs_d); + + + System.out.println("/ files num:" + fileSystemTree.countNumOfFiles()); + System.out.println("/wz/ files num:" + node_wz.countNumOfFiles()); + } +} + +``` + +1. 我们对照着这个例子,再重新看一下组合模式的定义:“将一组对象(文件和目录)组织成树形结构,以表示一种‘部分 - 整体’的层次结构(目录与子目录的嵌套结构)。组合模式让客户端可以统一单个对象(文件)和组合对象(目录)的处理逻辑(递归遍历)。” +2. 实际上,刚才讲的这种组合模式的设计思路,与其说是一种设计模式,倒不如说是对业务场景的一种数据结构和算法的抽象。其中,数据可以表示成树这种数据结构,业务需求可以通过在树上的递归遍历算法来实现。 + + + +## 组合模式的应用场景举例 + +1. 刚刚我们讲了文件系统的例子,对于组合模式,我这里再举一个例子。搞懂了这两个例子,你基本上就算掌握了组合模式。在实际的项目中,遇到类似的可以表示成树形结构的业务场景,你只要“照葫芦画瓢”去设计就可以了。 +2. 假设我们在开发一个 OA 系统(办公自动化系统)。公司的组织结构包含部门和员工两种数据类型。其中,部门又可以包含子部门和员工。在数据库中的表结构如下所示: + + + + + + + +1. 我们希望在内存中构建整个公司的人员架构图(部门、子部门、员工的隶属关系),并且提供接口计算出部门的薪资成本(隶属于这个部门的所有员工的薪资和)。 +2. 部门包含子部门和员工,这是一种嵌套结构,可以表示成树这种数据结构。计算每个部门的薪资开支这样一个需求,也可以通过在树上的遍历算法来实现。所以,从这个角度来看,这个应用场景可以使用组合模式来设计和实现。 +3. 这个例子的代码结构跟上一个例子的很相似,代码实现我直接贴在了下面,你可以对比着看一下。其中,HumanResource 是部门类(Department)和员工类(Employee)抽象出来的父类,为的是能统一薪资的处理逻辑。Demo 中的代码负责从数据库中读取数据并在内存中构建组织架构图。 + +```java +public abstract class HumanResource { + protected long id; + protected double salary; + + public HumanResource(long id) { + this.id = id; + } + + public long getId() { + return id; + } + + public abstract double calculateSalary(); + +} + +public class Employee extends HumanResource { + + public Employee(long id, double salary) { + super(id); + this.salary = salary; + } + + @Override + + public double calculateSalary() { + return salary; + } +} + +public class Department extends HumanResource { + private List subNodes = new ArrayList<>(); + + public Department(long id) { + super(id); + } + + @Override + + public double calculateSalary() { + double totalSalary = 0; + for (HumanResource hr : subNodes) { + totalSalary += hr.calculateSalary(); + } + this.salary = totalSalary; + return totalSalary; + + } + + public void addSubNode(HumanResource hr) { + subNodes.add(hr); + } +} + +// 构建组织架构的代码 +public class Demo { + private static final long ORGANIZATION\_ROOT\_ID = 1001; + private DepartmentRepo departmentRepo; // 依赖注入 + private EmployeeRepo employeeRepo; // 依赖注入 + + public void buildOrganization() { + Department rootDepartment = new Department(ORGANIZATION\_ROOT\_ID); + buildOrganization(rootDepartment); + } + + private void buildOrganization(Department department) { + List subDepartmentIds = departmentRepo.getSubDepartmentIds(department.getId()); + for (Long subDepartmentId : subDepartmentIds) { + Department subDepartment = new Department(subDepartmentId); + department.addSubNode(subDepartment); + buildOrganization(subDepartment); + } + + List employeeIds = employeeRepo.getDepartmentEmployeeIds(department.getId()); + for (Long employeeId : employeeIds) { + double salary = employeeRepo.getEmployeeSalary(employeeId); + department.addSubNode(new Employee(employeeId, salary)); + } + } +} +``` + +我们再拿组合模式的定义跟这个例子对照一下:“将一组对象(员工和部门)组织成树形结构,以表示一种‘部分 - 整体’的层次结构(部门与子部门的嵌套结构)。组合模式让客户端可以统一单个对象(员工)和组合对象(部门)的处理逻辑(递归遍历)。” + + + +# 享元模式【不常用】 + +跟其他所有的设计模式类似,享元模式的原理和实现也非常简单。今天,我会通过棋牌游戏和文本编辑器两个实际的例子来讲解。除此之外,我还会讲到它跟单例、缓存、对象池的区别和联系。在后面一下享元模式在 Java Integer、String 中的应用。 + + + +## 享元模式原理与实现 + +1. 所谓“享元”,顾名思义就是被共享的单元。享元模式的意图是复用对象,节省内存,前提是享元对象是不可变对象。 +2. 具体来讲,当一个系统中存在大量重复对象的时候,如果这些重复的对象是不可变对象,我们就可以利用享元模式将对象设计成享元,在内存中只保留一份实例,供多处代码引用。这样可以减少内存中对象的数量,起到节省内存的目的。实际上,不仅仅相同对象可以设计成享元,对于相似对象,我们也可以将这些对象中相同的部分(字段)提取出来,设计成享元,让这些大量相似对象引用这些享元。 +3. 这里我稍微解释一下,定义中的“不可变对象”指的是,一旦通过构造函数初始化完成之后,它的状态(对象的成员变量或者属性)就不会再被修改了。所以,不可变对象不能暴露任何 set() 等修改内部状态的方法。之所以要求享元是不可变对象,那是因为它会被多处代码共享使用,避免一处代码对享元进行了修改,影响到其他使用它的代码。 +4. 接下来,我们通过一个简单的例子解释一下享元模式。 +5. 假设我们在开发一个棋牌游戏(比如象棋)。一个游戏厅中有成千上万个“房间”,每个房间对应一个棋局。棋局要保存每个棋子的数据,比如:棋子类型(将、相、士、炮等)、棋子颜色(红方、黑方)、棋子在棋局中的位置。利用这些数据,我们就能显示一个完整的棋盘给玩家。具体的代码如下所示。其中,ChessPiece 类表示棋子,ChessBoard 类表示一个棋局,里面保存了象棋中 30 个棋子的信息。 + +```java + +public class ChessPiece { // 棋子 + private int id; + private String text; + private Color color; + private int positionX; + private int positionY; + + public ChessPiece(int id, String text, Color color, int positionX, int positionY) { + this.id = id; + this.text = text; + this.color = color; + this.positionX = positionX; + this.positionY = positionX; + } + + public static enum Color { + RED, + BLACK + } + + // ...省略其他属性和getter/setter方法... + +} + +public class ChessBoard { // 棋局 + private Map chessPieces = new HashMap<>(); + + public ChessBoard() { + init(); + } + + private void init() { + chessPieces.put(1, new ChessPiece(1, "車", ChessPiece.Color.BLACK, 0, 0)); + chessPieces.put(2, new ChessPiece(2, "馬", ChessPiece.Color.BLACK, 0, 1)); + // ...省略摆放其他棋子的代码... + } + + public void move(int chessPieceId, int toPositionX, int toPositionY) { + // ...省略... + } +} + +``` + +为了记录每个房间当前的棋局情况,我们需要给每个房间都创建一个 ChessBoard 棋局对象。因为游戏大厅中有成千上万的房间(实际上,百万人同时在线的游戏大厅也有很多),那保存这么多棋局对象就会消耗大量的内存。有没有什么办法来节省内存呢? + +这个时候,享元模式就可以派上用场了。像刚刚的实现方式,在内存中会有大量的相似对象。这些相似对象的 id、text、color 都是相同的,唯独 positionX、positionY 不同。实际上,我们可以将棋子的 id、text、color 属性拆分出来,设计成独立的类,并且作为享元供多个棋盘复用。这样,棋盘只需要记录每个棋子的位置信息就可以了。具体的代码实现如下所示: + +```java +// 享元类 +public class ChessPieceUnit { + private int id; + private String text; + private Color color; + + public ChessPieceUnit(int id, String text, Color color) { + this.id = id; + this.text = text; + this.color = color; + } + + public static enum Color { + RED, + BLACK + } + // ...省略其他属性和getter方法... + +} + +public class ChessPieceUnitFactory { + private static final Map pieces = new HashMap<>(); + + static { + pieces.put(1, new ChessPieceUnit(1, "車", ChessPieceUnit.Color.BLACK)); + pieces.put(2, new ChessPieceUnit(2, "馬", ChessPieceUnit.Color.BLACK)); + // ...省略摆放其他棋子的代码... + } + + public static ChessPieceUnit getChessPiece(int chessPieceId) { + return pieces.get(chessPieceId); + } +} + +public class ChessPiece { + private ChessPieceUnit chessPieceUnit; + private int positionX; + private int positionY; + + public ChessPiece(ChessPieceUnit unit, int positionX, int positionY) { + this.chessPieceUnit = unit; + this.positionX = positionX; + this.positionY = positionY; + } + + // 省略getter、setter方法 +} + +public class ChessBoard { + private Map chessPieces = new HashMap<>(); + + public ChessBoard() { + init(); + } + + private void init() { + chessPieces.put(1, new ChessPiece(ChessPieceUnitFactory.getChessPiece(1), 0, 0)); + chessPieces.put(1, new ChessPiece(ChessPieceUnitFactory.getChessPiece(2), 1, 0)); + // ...省略摆放其他棋子的代码... + } + + public void move(int chessPieceId, int toPositionX, int toPositionY) { + // ...省略... + } +} + +``` + + + +1. 在上面的代码实现中,我们利用工厂类来缓存 ChessPieceUnit 信息(也就是 id、text、color)。通过工厂类获取到的 ChessPieceUnit 就是享元。所有的 ChessBoard 对象共享这 30 个 ChessPieceUnit 对象(因为象棋中只有 30 个棋子)。在使用享元模式之前,记录 1 万个棋局,我们要创建 30 万(30*1 万)个棋子的 ChessPieceUnit 对象。利用享元模式,我们只需要创建 30 个享元对象供所有棋局共享使用即可,大大节省了内存。 +2. 那享元模式的原理讲完了,我们来总结一下它的代码结构。实际上,它的代码实现非常简单,主要是通过工厂模式,在工厂类中,通过一个 Map 来缓存已经创建过的享元对象,来达到复用的目的。 + + + +## 享元模式在文本编辑器中的应用 + +1. 弄懂了享元模式的原理和实现之后,我们再来看另外一个例子,也就是文章标题中给出的:如何利用享元模式来优化文本编辑器的内存占用? +2. 你可以把这里提到的文本编辑器想象成 Office 的 Word。不过,为了简化需求背景,我们假设这个文本编辑器只实现了文字编辑功能,不包含图片、表格等复杂的编辑功能。对于简化之后的文本编辑器,我们要在内存中表示一个文本文件,只需要记录文字和格式两部分信息就可以了,其中,格式又包括文字的字体、大小、颜色等信息。 +3. 尽管在实际的文档编写中,我们一般都是按照文本类型(标题、正文……)来设置文字的格式,标题是一种格式,正文是另一种格式等等。但是,从理论上讲,我们可以给文本文件中的每个文字都设置不同的格式。为了实现如此灵活的格式设置,并且代码实现又不过于太复杂,我们把每个文字都当作一个独立的对象来看待,并且在其中包含它的格式信息。具体的代码示例如下所示: + +```java +public class Character { // 文字 + private char c; + + private Font font; + private int size; + private int colorRGB; + + public Character(char c, Font font, int size, int colorRGB) { + this.c = c; + this.font = font; + this.size = size; + this.colorRGB = colorRGB; + } +} + +public class Editor { + private List chars = new ArrayList<>(); + + public void appendCharacter(char c, Font font, int size, int colorRGB) { + Character character = new Character(c, font, size, colorRGB); + chars.add(character); + } +} + +``` + +1. 在文本编辑器中,我们每敲一个文字,都会调用 Editor 类中的 appendCharacter() 方法,创建一个新的 Character 对象,保存到 chars 数组中。如果一个文本文件中,有上万、十几万、几十万的文字,那我们就要在内存中存储这么多 Character 对象。那有没有办法可以节省一点内存呢? +2. 实际上,在一个文本文件中,用到的字体格式不会太多,毕竟不大可能有人把每个文字都设置成不同的格式。所以,对于字体格式,我们可以将它设计成享元,让不同的文字共享使用。按照这个设计思路,我们对上面的代码进行重构。重构后的代码如下所示: + +```java + +public class CharacterStyle { + private Font font; + private int size; + private int colorRGB; + + public CharacterStyle(Font font, int size, int colorRGB) { + this.font = font; + this.size = size; + this.colorRGB = colorRGB; + } + + @Override + public boolean equals(Object o) { + CharacterStyle otherStyle = (CharacterStyle) o; + return font.equals(otherStyle.font) + && size == otherStyle.size + && colorRGB == otherStyle.colorRGB; + } +} + +public class CharacterStyleFactory { + private static final List styles = new ArrayList<>(); + + public static CharacterStyle getStyle(Font font, int size, int colorRGB) { + CharacterStyle newStyle = new CharacterStyle(font, size, colorRGB); + for (CharacterStyle style : styles) { + if (style.equals(newStyle)) { + return style; + } + } + styles.add(newStyle); + return newStyle; + } +} + +public class Character { + private char c; + private CharacterStyle style; + + public Character(char c, CharacterStyle style) { + this.c = c; + this.style = style; + } +} + +public class Editor { + private List chars = new ArrayList<>(); + + public void appendCharacter(char c, Font font, int size, int colorRGB) { + Character character = new Character(c, CharacterStyleFactory.getStyle(font, size, colorRGB)); + chars.add(character); + } +} + +``` + + + +## 享元模式 vs 单例、缓存、对象池 + +在上面的讲解中,我们多次提到“共享”“缓存”“复用”这些字眼,那它跟单例、缓存、对象池这些概念有什么区别呢?我们来简单对比一下。 + + + +### 我们先来看享元模式跟单例的区别 + +1. 在单例模式中,一个类只能创建一个对象,而在享元模式中,一个类可以创建多个对象,每个对象被多处代码引用共享。实际上,享元模式有点类似于之前讲到的单例的变体:多例。 +2. 我们前面也多次提到,区别两种设计模式,不能光看代码实现,而是要看设计意图,也就是要解决的问题。尽管从代码实现上来看,享元模式和多例有很多相似之处,但从设计意图上来看,它们是完全不同的。应用享元模式是为了对象复用,节省内存,而应用多例模式是为了限制对象的个数。 + + + +### 我们再来看享元模式跟缓存的区别 + +在享元模式的实现中,我们通过工厂类来“缓存”已经创建好的对象。这里的“缓存”实际上是“存储”的意思,跟我们平时所说的“数据库缓存”“CPU 缓存”“MemCache 缓存”是两回事。我们平时所讲的缓存,主要是为了提高访问效率,而非复用。 + + + +### 最后我们来看享元模式跟对象池的区别 + +1. 对象池、连接池(比如数据库连接池)、线程池等也是为了复用,那它们跟享元模式有什么区别呢? +2. 你可能对连接池、线程池比较熟悉,对对象池比较陌生,所以,这里我简单解释一下对象池。像 C++ 这样的编程语言,内存的管理是由程序员负责的。为了避免频繁地进行对象创建和释放导致内存碎片,我们可以预先申请一片连续的内存空间,也就是这里说的对象池。每次创建对象时,我们从对象池中直接取出一个空闲对象来使用,对象使用完成之后,再放回到对象池中以供后续复用,而非直接释放掉。 +3. 虽然对象池、连接池、线程池、享元模式都是为了复用,但是,如果我们再细致地抠一抠“复用”这个字眼的话,对象池、连接池、线程池等池化技术中的“复用”和享元模式中的“复用”实际上是不同的概念。 +4. 池化技术中的“复用”可以理解为“重复使用”,主要目的是节省时间(比如从数据库池中取一个连接,不需要重新创建)。在任意时刻,每一个对象、连接、线程,并不会被多处使用,而是被一个使用者独占,当使用完成之后,放回到池中,再由其他使用者重复利用。享元模式中的“复用”可以理解为“共享使用”,在整个生命周期中,都是被所有使用者共享的,主要目的是节省空间。 + + + +## 剖析享元模式在Java Integer、String中的应用 + +我们先来看下面这样一段代码。你可以先思考下,这段代码会输出什么样的结果。 + +```java + Integer i1 = 56; + Integer i2 = 56; + Integer i3 = 129; + Integer i4 = 129; + System.out.println(i1 == i2); + System.out.println(i3 == i4); +``` + +1. Java提供了自动拆箱与装箱机制,比如int的装箱就是Integer.valueOf(); 拆箱就是i.intValue(); +2. 前 4 行赋值语句都会触发自动装箱操作,也就是会创建 Integer 对象并且赋值给 i1、i2、i3、i4 这四个变量。根据刚刚的讲解,i1、i2 尽管存储的数值相同,都是 56,但是指向不同的 Integer 对象,所以通过“==”来判定是否相同的时候,会返回 false。同理,i3==i4 判定语句也会返回 false。 +3. 不过,上面的分析还是不对,答案并非是两个 false,而是一个 true,一个 false。看到这里,你可能会比较纳闷了。实际上,这正是因为 Integer 用到了享元模式来复用对象,才导致了这样的运行结果。当我们通过自动装箱,也就是调用 valueOf() 来创建 Integer 对象的时候,如果要创建的 Integer 对象的值在 -128 到 127 之间,会从 IntegerCache 类中直接返回,否则才调用 new 方法创建。看代码更加清晰一些,Integer 类的 valueOf() 函数的具体代码如下所示: + +```java + public static Integer valueOf(int i) { + if (i >= IntegerCache.low && i <= IntegerCache.high) + return IntegerCache.cache[i + (-IntegerCache.low)]; + return new Integer(i); + } +``` + +实际上,这里的 IntegerCache 相当于,我们上面讲的生成享元对象的工厂类,只不过名字不叫 xxxFactory 而已。我们来看它的具体代码实现。这个类是 Integer 的内部类,你也可以自行查看 JDK 源码。 + +```java + private static class IntegerCache { + static final int low = -128; + static final int high; + static final Integer cache[]; + + static { + // high value may be configured by property + int h = 127; + String integerCacheHighPropValue = + VM.getSavedProperty("java.lang.Integer.IntegerCache.high"); + if (integerCacheHighPropValue != null) { + try { + int i = parseInt(integerCacheHighPropValue); + i = Math.max(i, 127); + // Maximum array size is Integer.MAX_VALUE + h = Math.min(i, Integer.MAX_VALUE - (-low) -1); + } catch( NumberFormatException nfe) { + // If the property cannot be parsed into an int, ignore it. + } + } + high = h; + + cache = new Integer[(high - low) + 1]; + int j = low; + for(int k = 0; k < cache.length; k++) + cache[k] = new Integer(j++); + + // range [-128, 127] must be interned (JLS7 5.1.7) + assert IntegerCache.high >= 127; + } + + private IntegerCache() {} + } +``` + +1. 为什么 IntegerCache 只缓存 -128 到 127 之间的整型值呢? +2. 在 IntegerCache 的代码实现中,当这个类被加载的时候,缓存的享元对象会被集中一次性创建好。毕竟整型值太多了,我们不可能在 IntegerCache 类中预先创建好所有的整型值,这样既占用太多内存,也使得加载 IntegerCache 类的时间过长。所以,我们只能选择缓存对于大部分应用来说最常用的整型值,也就是一个字节的大小(-128 到 127 之间的数据)。 +3. 实际上,JDK 也提供了方法来让我们可以自定义缓存的最大值,有下面两种方式。如果你通过分析应用的 JVM 内存占用情况,发现 -128 到 255 之间的数据占用的内存比较多,你就可以用如下方式,将缓存的最大值从 127 调整到 255。不过,这里注意一下,JDK 并没有提供设置最小值的方法。 + + + +```java +//方法一: +-Djava.lang.Integer.IntegerCache.high=255 +//方法二: +-XX:AutoBoxCacheMax=255 +``` + +4. 现在,让我们再回到最开始的问题,因为 56 处于 -128 和 127 之间,i1 和 i2 会指向相同的享元对象,所以 i1==i2 返回 true。而 129 大于 127,并不会被缓存,每次都会创建一个全新的对象,也就是说,i3 和 i4 指向不同的 Integer 对象,所以 i3==i4 返回 false。 + + + +5. 实际上,除了 Integer 类型之外,其他包装器类型,比如 Long、Short、Byte 等,也都利用了享元模式来缓存 -128 到 127 之间的数据。比如,Long 类型对应的 LongCache 享元工厂类及 valueOf() 函数代码如下所示: + +6. 在我们平时的开发中,对于下面这样三种创建整型对象的方式,我们优先使用后两种。 + +```java +Integer a = new Integer(123); + +Integer a = 123; + +Integer a = Integer.valueOf(123); +``` + +7. 第一种创建方式并不会使用到 IntegerCache,而后面两种创建方法可以利用 IntegerCache 缓存,返回共享的对象,以达到节省内存的目的。举一个极端一点的例子,假设程序需要创建 1 万个 -128 到 127 之间的 Integer 对象。使用第一种创建方式,我们需要分配 1 万个 Integer 对象的内存空间;使用后两种创建方式,我们最多只需要分配 256 个 Integer 对象的内存空间。 + + + +## 享元模式在 Java String 中的应用 + +1. 刚刚我们讲了享元模式在 Java Integer 类中的应用,现在,我们再来看下,享元模式在 Java String 类中的应用。同样,我们还是先来看一段代码,你觉得这段代码输出的结果是什么呢? + +```java +String s1 = "哈哈哈"; +String s2 = "哈哈哈"; +String s3 = new String("哈哈哈"); + +System.out.println(s1 == s2); +System.out.println(s1 == s3); +``` + +2. 上面代码的运行结果是:一个 true,一个 false。跟 Integer 类的设计思路相似,String 类利用享元模式来复用相同的字符串常量(也就是代码中的“小争哥”)。JVM 会专门开辟一块存储区来存储字符串常量,这块存储区叫作“字符串常量池”。上面代码对应的内存存储结构如下所示:【笔者的JVM系列有专门讲String的各种情况】 + + + +3. 不过,String 类的享元模式的设计,跟 Integer 类稍微有些不同。Integer 类中要共享的对象,是在类加载的时候,就集中一次性创建好的。但是,对于字符串来说,我们没法事先知道要共享哪些字符串常量,所以没办法事先创建好,只能在某个字符串常量第一次被用到的时候,存储到常量池中,当之后再用到的时候,直接引用常量池中已经存在的即可,就不需要再重新创建了。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +