当前位置：首页 > article >正文

Mybatis框架之适配器模式 (Adapter Pattern)

article 2025/2/21 0:24:47

在 MyBatis 框架中，适配器模式 (Adapter Pattern) 被广泛用于将不兼容的接口整合在一起，使得 MyBatis 能够与各种数据库和外部组件（如日志系统）无缝集成。适配器模式的应用，使得 MyBatis 具有高度的灵活性和可扩展性，能够轻松支持多种数据源和日志框架。

1. 什么是适配器模式 (Adapter Pattern)？

适配器模式 是一种结构型设计模式，用于将一个接口转换为客户端希望的另一个接口，使得原本因接口不兼容而无法工作的类能够一起工作。适配器模式通常用于解决已有类的接口与需求不匹配的问题。

特点：

兼容不同接口：适配器模式可以将现有类的接口转换为客户端需要的接口。
解耦代码：通过适配器来隔离客户端和现有类，减少代码耦合。
提高灵活性：适配器模式能够在不修改现有类的前提下，通过新增适配器类来实现接口兼容。

适配器模式的类型：

对象适配器 (Object Adapter)：通过组合的方式（即包含被适配对象的引用）来实现适配器。
类适配器 (Class Adapter)：通过继承被适配的类来实现适配器（通常在 Java 等单继承语言中不常用）。

2. MyBatis 中适配器模式的应用场景

在 MyBatis 中，适配器模式被应用于多个关键模块，包括：

日志模块：MyBatis 支持多种日志框架（如 SLF4J、Log4J、JDK Logging 等），通过适配器模式实现统一的日志接口。
数据库方言支持：MyBatis 可以与不同的数据库（如 MySQL、Oracle、PostgreSQL）配合使用，通过适配器模式来适配不同的数据库方言。
ResultSetHandler 和 ParameterHandler：用于将 JDBC 的 ResultSet 和参数设置方法适配为 MyBatis 的接口。

3. MyBatis 日志模块中的适配器模式

MyBatis 提供了一个 统一的日志接口 (org.apache.ibatis.logging.Log)，并通过适配器模式来支持各种流行的日志框架。这样，无论使用哪种日志框架，MyBatis 都可以通过相同的日志接口来记录日志信息。

3.1 日志模块的架构

Log 接口：MyBatis 定义的统一日志接口。
具体适配器类：
- Slf4jImpl：适配 SLF4J 框架。
- Log4jImpl：适配 Log4J 框架。
- JdkLoggingImpl：适配 JDK 自带的日志框架。
- NoLoggingImpl：不输出日志的空实现（适配器模式的一种退化实现）。

3.2 日志适配器的代码示例

Log 接口定义：

public interface Log {
    void debug(String message);
    void error(String message);
    void info(String message);
    void warn(String message);
    boolean isDebugEnabled();
    boolean isInfoEnabled();
}

SLF4J 日志适配器 (Slf4jImpl)：

public class Slf4jImpl implements Log {
    private final Logger log;

    public Slf4jImpl(String clazz) {
        this.log = LoggerFactory.getLogger(clazz);
    }

    public void debug(String message) {
        log.debug(message);
    }

    public void error(String message) {
        log.error(message);
    }

    public void info(String message) {
        log.info(message);
    }

    public void warn(String message) {
        log.warn(message);
    }

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

    public boolean isInfoEnabled() {
        return log.isInfoEnabled();
    }
}

日志适配器选择器 (LogFactory)：

public final class LogFactory {
    private static Constructor<? extends Log> logConstructor;

    static {
        tryImplementation(() -> useSlf4jLogging());
        tryImplementation(() -> useLog4JLogging());
        tryImplementation(() -> useJdkLogging());
        if (logConstructor == null) {
            useNoLogging();
        }
    }

    public static Log getLog(Class<?> aClass) {
        try {
            return logConstructor.newInstance(aClass.getName());
        } catch (Throwable t) {
            throw new LogException("Error creating logger for " + aClass.getName(), t);
        }
    }

    private static void tryImplementation(Runnable runnable) {
        if (logConstructor == null) {
            try {
                runnable.run();
            } catch (Throwable ignored) {
            }
        }
    }

    public static void useSlf4jLogging() {
        setImplementation(Slf4jImpl.class);
    }

    public static void useLog4JLogging() {
        setImplementation(Log4jImpl.class);
    }

    public static void useJdkLogging() {
        setImplementation(JdkLoggingImpl.class);
    }

    private static void setImplementation(Class<? extends Log> implClass) {
        try {
            logConstructor = implClass.getConstructor(String.class);
        } catch (Throwable t) {
            throw new LogException("Error setting Log implementation.", t);
        }
    }
}

使用示例：

Log logger = LogFactory.getLog(MyBatisExample.class);
logger.info("This is an info message.");
logger.debug("This is a debug message.");

4. MyBatis 数据库方言中的适配器模式

MyBatis 通过 Dialect 接口来支持不同数据库的方言特性（如分页）。通过适配器模式，MyBatis 可以在同一套代码中支持多种数据库。

示例：MySQL 分页适配器：

public class MySQLDialect implements Dialect {
    @Override
    public String getLimitString(String sql, int offset, int limit) {
        return sql + " LIMIT " + offset + ", " + limit;
    }
}

示例：Oracle 分页适配器：

public class OracleDialect implements Dialect {
    @Override
    public String getLimitString(String sql, int offset, int limit) {
        return "SELECT * FROM ( SELECT temp.*, ROWNUM row_id FROM ( " + 
               sql + " ) temp WHERE ROWNUM <= " + (offset + limit) + 
               ") WHERE row_id > " + offset;
    }
}