Java设计模式及应用场景之《适配器模式》

一、适配器模式定义

将一个类的接口变换成客户端所期待的另一种接口，从而使原本因接口不匹配而无法在一起工作的两个类能够在一起工作。

二、适配器模式的结构和说明

1、对象适配器

2、类适配器

• Target 目标角色
  该角色定义把其他类转换为何种接口，也就是我们的期望接口。
• Adaptee 源角色
  已经存在的接口，通常能满足客户端的功能需求，但是接口与客户要求的不一致，需要被适配。
• Adapter 适配器角色
  通过继承或者类关联的方式，把Adaptee适配成Client需要的Target。

三、类适配器与对象适配器的区别

  类适配器使用对象继承的方式，对象适配器是对象的组合关系，也可以说是对象的关联关系，这是两者的根本区别。（实际项目中对象适配器使用到的场景相对较多。）

四、适配器模式示例–Mybatis日志模块

  我们以Mybatis日志模块为例，来介绍一下适配器模式的应用。
  Mybatis自己本身不提供日志功能，而是依赖其它日志框架来实现，如log4j,log4j2,commons-logging,slf4j等等。
  由于各个厂商提供的日志api、日志级别等都不尽相同，所以mybatis对所有支持的日志框架使用对象适配器模式做了封装。

org.apache.ibatis.logging.Log （Target 目标角色 ）

/**
 * Mybatis定义的统一日志接口
 */
public interface Log {

    boolean isDebugEnabled();

    boolean isTraceEnabled();

    void error(String s, Throwable e);

    void error(String s);

    void debug(String s);

    void trace(String s);

    void warn(String s);

}

org.apache.ibatis.logging.log4j.Log4jImpl （Adapter 适配器角色）

/**
 * 针对log4j的适配器，实现了Log接口，并封装了 org.apache.log4j.Logger对象
 */
public class Log4jImpl implements Log {

    private static final String FQCN = Log4jImpl.class.getName();

    /**
     * Adaptee 源角色
     * org.apache.log4j日志组件对象
     */
    private final Logger log;

    public Log4jImpl(String clazz) {
        log = Logger.getLogger(clazz);
    }

    @Override
    public boolean isDebugEnabled() {
        return log.isDebugEnabled();
    }

    @Override
    public boolean isTraceEnabled() {
        return log.isTraceEnabled();
    }

    @Override
    public void error(String s, Throwable e) {
        log.log(FQCN, Level.ERROR, s, e);
    }

    @Override
    public void error(String s) {
        log.log(FQCN, Level.ERROR, s, null);
    }

    @Override
    public void debug(String s) {
        log.log(FQCN, Level.DEBUG, s, null);
    }

    @Override
    public void trace(String s) {
        log.log(FQCN, Level.TRACE, s, null);
    }

    @Override
    public void warn(String s) {
        log.log(FQCN, Level.WARN, s, null);
    }

}

  以上，针对log4j的适配器已经完成，其它日志组件的适配器基本相似。Mybatis在LogFactory的静态方法里按照特定的顺序，寻找并加载第三方日志组件，获取日志适配器对象时，只需要调用 getLog(Class<?> clazz) 方法即可。

/**
 * 获取Log接口具体实现的工厂
 */
public final class LogFactory {

    public static final String MARKER = "MYBATIS";

    /**
     * 记录当前使用的第三方日志框架的适配器的构造方法
     */
    private static Constructor<? extends Log> logConstructor;

    /**
     * 尝试加载第三方日志组件适配器
     * 第三方日志组件加载优先级如下：slf4J→commonsLoging→Log4J2→Log4J→JdkLog
     */
    static {
        tryImplementation(LogFactory::useSlf4jLogging);
        tryImplementation(LogFactory::useCommonsLogging);
        tryImplementation(LogFactory::useLog4J2Logging);
        tryImplementation(LogFactory::useLog4JLogging);
        tryImplementation(LogFactory::useJdkLogging);
        tryImplementation(LogFactory::useNoLogging);
    }

    private LogFactory() {
        // disable construction
    }

    /**
     * 获取当前使用的第三方日志框架的适配器对象
     */
    public static Log getLog(Class<?> clazz) {
        return getLog(clazz.getName());
    }

    public static Log getLog(String logger) {
        try {
            return logConstructor.newInstance(logger);
        } catch (Throwable t) {
            throw new LogException("Error creating logger for logger " + logger + ".  Cause: " + t, t);
        }
    }

    public static synchronized void useCustomLogging(Class<? extends Log> clazz) {
        setImplementation(clazz);
    }

    public static synchronized void useSlf4jLogging() {
        setImplementation(org.apache.ibatis.logging.slf4j.Slf4jImpl.class);
    }

    public static synchronized void useCommonsLogging() {
        setImplementation(org.apache.ibatis.logging.commons.JakartaCommonsLoggingImpl.class);
    }

    public static synchronized void useLog4JLogging() {
        setImplementation(org.apache.ibatis.logging.log4j.Log4jImpl.class);
    }

    public static synchronized void useLog4J2Logging() {
        setImplementation(org.apache.ibatis.logging.log4j2.Log4j2Impl.class);
    }

    public static synchronized void useJdkLogging() {
        setImplementation(org.apache.ibatis.logging.jdk14.Jdk14LoggingImpl.class);
    }

    public static synchronized void useStdOutLogging() {
        setImplementation(org.apache.ibatis.logging.stdout.StdOutImpl.class);
    }

    public static synchronized void useNoLogging() {
        setImplementation(org.apache.ibatis.logging.nologging.NoLoggingImpl.class);
    }

    /**
     * 尝试加载日志框架
     */
    private static void tryImplementation(Runnable runnable) {
        if (logConstructor == null) {
            try {
                runnable.run();
            } catch (Throwable t) {
                // ignore
            }
        }
    }

    private static void setImplementation(Class<? extends Log> implClass) {
        try {
            // 获取指定适配器的构造方法
            Constructor<? extends Log> candidate = implClass.getConstructor(String.class);
            // 实例化适配器
            Log log = candidate.newInstance(LogFactory.class.getName());
            if (log.isDebugEnabled()) {
                log.debug("Logging initialized using '" + implClass + "' adapter.");
            }
            // 记录第三方日志组件适配器的构造方法，用于之后获取日志对象
            logConstructor = candidate;
        } catch (Throwable t) {
            throw new LogException("Error setting Log implementation.  Cause: " + t, t);
        }
    }

}

五、适配器模式的优缺点

优点

• 更好的复用性
  如果功能已经存在，只是接口不兼容，通过适配器模式就可以让这些功能得到更好的复用。
• 更好的扩展性
  在实现适配器功能时，可以调用自己开发的功能，从而自然的扩展系统的功能。

缺点

• 过多的适配器类，会让系统变得凌乱，不容易进行整体把握。
  如我们调用的是A接口，内部确被适配成了B接口。如果系统内出现过多这种情况，就会变得非常凌乱。

六、适配器模式的应用场景

• 系统需要使用现有已投产的类，而这些类的接口不符合系统的需要。
• 想要建立一个可以重复使用的类，用于与一些彼此之间没有太大关联的一些类，包括一些可能在将来引进的类一起工作。
• Java中的数据库连接工具JDBC，JDBC定义一个客户端通用的抽象接口，每一个具体数据库引擎（如SQL Server、Oracle、MySQL等）的JDBC驱动软件都是一个介于JDBC接口和数据库引擎接口之间的适配器软件。
• 例子中的Mybatis日志模块。