「这是我参与2022首次更文挑战的第7天,活动详情查看:2022首次更文挑战」。
使用场景
现有类与目标“接口不兼容”,有以下几种场景:
- 封装有缺陷的接口设计
- 统一多个类的接口设计
- 替换依赖的外部系统
- 兼容老版本接口
- 适配不同格式的数据
假如目标接口如下
public interface Target {
void m1();
void m2();
void m3();
}
而我们的类如下
public class Source {
public void ma() {
System.out.println("hello1");
}
public void mb() {
System.out.println("hello2");
}
public void m3() {
System.out.println("hello3");
}
}
很显然 Source
类中的方法名与Target
接口中并不完全相同,因此我们不能直接使Source
类实现Target
接口。来达到将Source
转化为Target
的能力。为了达到这个目的,我们就需要使用适配器模式。
适配器模式有两种实现方式:
- 通过继承
- 通过组合
通过继承
类图
Adaptor继承Source类并实现Target接口,对target中的接口进行实现。
需要注意的是Adaptor类中并没有实现Target中的所有方法,因为m3()
方法Source已经有了实现,可以直接继承获得,这是与组合方式最大的不同。
代码实现
Target
和Source
类与上相同
Adaptor
public class Adaptor extends Source implements Target {
@Override
public void m1() {
super.ma();
}
@Override
public void m2() {
super.mb();
}
}
Main
public class Main {
public static void main(String[] args) {
Target target = new Adaptor();
target.m1();
target.m2();
target.m3();
}
}
通过组合
类图
Adaptor类包含一个Source成员变量,通过构造函数注入,并实现Target接口,注意这里需要实现Target的所有方法。
代码实现
Target
和Source
类与上相同
Adaptor
public class Adaptor implements Target {
private Source source;
public Adaptor(Source source) {
this.source = source;
}
@Override
public void m1() {
source.ma();
}
@Override
public void m2() {
source.mb();
}
@Override
public void m3() {
source.m3();
}
}
Main
public class Main {
public static void main(String[] args) {
Source source = new Source();
Target target = new Adaptor(source);
target.m1();
target.m2();
target.m3();
}
}
适配器模式在 Java 日志中的应用
Slf4j 这个日志框架你肯定不陌生,它提供了一套打印日志的统一接口规范。不过,它只定义了接口,并没有提供具体的实现,需要配合其他日志框架(log4j、logback……)来使用。
Slf4j 的出现晚于 JUL、JCL、log4j 等日志框架,所以,这些日志框架也不可能牺牲掉版本兼容性,将接口改造成符合 Slf4j 接口规范。Slf4j 也事先考虑到了这个问题,所以,它不仅仅提供了统一的接口定义,还提供了针对不同日志框架的适配器。对不同日志框架的接口进行二次封装,适配成统一的 Slf4j 接口定义。
代码示例:
// 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);
}
//...省略一堆接口的实现...
}
所以,在开发业务系统或者开发框架、组件的时候,我们统一使用 Slf4j 提供的接口来编写打印日志的代码,具体使用哪种日志框架实现(log4j、logback……),是可以动态地指定的(使用 Java 的 SPI 技术),只需要将相应的 SDK 导入到项目中即可。
代理、桥接、装饰器、适配器 4 种设计模式的区别
代理、桥接、装饰器、适配器,这 4 种模式是比较常用的结构型设计模式。它们的代码结构非常相似。笼统来说,它们都可以称为 Wrapper 模式,也就是通过 Wrapper 类二次封装原始类。
尽管代码结构相似,但这 4 种设计模式的用意完全不同,也就是说要解决的问题、应用场景不同,这也是它们的主要区别。
代理模式: 代理模式在不改变原始类接口的条件下,为原始类定义一个代理类,主要目的是控制访问,而非加强功能,这是它跟装饰器模式最大的不同。
桥接模式: 桥接模式的目的是将接口部分和实现部分分离,从而让它们可以较为容易、也相对独立地加以改变。
装饰器模式: 装饰者模式在不改变原始类接口的情况下,对原始类功能进行增强,并且支持多个装饰器的嵌套使用。
适配器模式: 适配器模式是一种事后的补救策略。适配器提供跟原始类不同的接口,而代理模式、装饰器模式提供的都是跟原始类相同的接口。