適配器模式在Mybatis中的妙用
寫在前面:設計模式源于生活,而又高于生活!
什么是適配器模式
定義:將一個系統的接口轉換成另外一種形式,從而使原來不能直接調用的接口變得可以調用。
適配器模式角色劃分
適配器模式涉及3個角色:
- 源(Adaptee):需要被適配的對象或類型,相當于插頭。
- 適配器(Adapter):連接目標和源的中間對象,相當于插頭轉換器。
- 目標(Target):期待得到的目標,相當于插座。
適配器模式包括3種形式:類適配器模式、對象適配器模式、接口適配器模式(或又稱作缺省適配器模式)。
適配器模式應用場景
- 新老版本接口的兼容
- Mybatis多種日志框架的整合
適配器創建的方式
- 對象適配器(組合模式)
- 類適配器(繼承模式)
適配器快速入門例子
比如早期的時候V1版本訂單接口的入參為Map類型,隨著業務的更新和迭代在V2版本的時候該訂單接口的入參需要支持List的類型?請問不改變的該接口代碼的情況下,如何支持List類型。
1.源(Adaptee):需要被適配的對象或類型,相當于插頭。
- public void froOrderMap(Map map) {
- for (int i = 0; i < map.size(); i++) {
- // 使用I作為MapKey獲取數據
- String value = (String) map.get(i);
- System.out.println("value:" + value);
- }
- }
2.目標(Target):期待得到的目標,相當于插座。
- public interface List<E> extends Collection<E> {
- ......
- int size();
- E get(int index);
- E set(int index, E element);
- }
3.適配器(Adapter):連接目標和源的中間對象,相當于插頭轉換器
- public class ListAdapter extends HashMap {
- private List list;
- public ListAdapter(List list) {
- this.list = list;
- }
- @Override
- public int size() {
- return list.size();
- }
- @Override
- public Object get(Object key) {
- return list.get(Integer.valueOf(key.toString()).intValue());
- }
- }
測試運行效果
- public class Test {
- public static void main(String[] args) {
- // 1.獲取集合類型用戶
- List member = new MemberService().getMember();
- //new OrderService().froOrderMap(member);
- ListAdapter listAdapter = new ListAdapter(member);
- new OrderService().froOrderMap(listAdapter);
- }
- }
使用適配器模式實現日志收集
比如設計一個日志收集系統,可能會考慮文件寫入、也可能考慮寫入MQ、也可能考慮寫入數據庫等。
對象適配器方式實現
定義基本實體類
- @Data
- public class LogBean {
- /**
- * 日志ID
- */
- private String logId;
- /**
- * 日志內容
- */
- private String logText;
- }
1.源目標接口
- public interface LogWriteFileService {
- /**
- * 將日志寫入到文件中
- */
- void logWriteFile();
- /**
- * 從本地文件中讀取日志
- *
- * @return
- */
- List<LogBean> readLogFile();
- }
2.源目標接口實現類
- public class LogWriteFileServiceImpl implements LogWriteFileService {
- @Override
- public void logWriteFile() {
- System.out.println(">>>將日志寫入文件中...");
- }
- @Override
- public List<LogBean> readLogFile() {
- LogBean log1 = new LogBean();
- log1.setLogId("0001");
- log1.setLogText("Tomcat啟動成功..");
- LogBean log2 = new LogBean();
- log2.setLogId("0002");
- log2.setLogText("Jetty啟動成功..");
- List<LogBean> listArrayList = new ArrayList<LogBean>();
- listArrayList.add(log1);
- listArrayList.add(log2);
- return listArrayList;
- }
- }
3.目標接口
- public interface LogWriteDbService {
- /**
- * 將日志寫入到數據庫中
- */
- public void writeDbFile(LogBean logBean);
- }
4.適配器
- //LogAdapter :適配器
- //LogWriteDbService:目標
- public class LogAdapter implements LogWriteDbService {
- //源接口
- private LogWriteFileService logWriteFileService;
- public LogAdapter(LogWriteFileService logWriteFileService) {
- this.logWriteFileService = logWriteFileService;
- }
- @Override
- public void writeDbFile(LogBean logBean) {
- // 1.從文件中讀取日志文件
- List<LogBean> logBeans = logWriteFileService.readLogFile();
- //目標
- // 2.寫入到數據庫中
- logBeans.add(logBean);
- System.out.println(">>>將數據寫入到數據庫中..");
- // 3.寫入到本地文件中
- logWriteFileService.logWriteFile();
- }
- }
適配器模式優缺點
適配器模式的優點
- 更好的復用性
- 系統需要使用現有的類,而此類的接口不符合系統的需要。那么通過適配器模式就可以讓這些功能得到更好的復用。
- 更好的擴展性
- 在實現適配器功能的時候,可以調用自己開發的功能,從而自然地擴展系統的功能。
適配器模式的缺點
- 過多的使用適配器,會讓系統非常零亂,不易整體進行把握。比如,明明看到調用的是A接口,其實內部被適配成了B接口的實現,一個系統如果太多出現這種情況,無異于一場災難。因此如果不是很有必要,可以不使用適配器,而是直接對系統進行重構。
Mbatis 日志收集分析
Java開發中經常用到的日志框架有很多,Log4j、Log4j2、slf4j等等,Mybatis定義了一套統一的日志接口供上層使用,并為上述常用的日志框架提供了相應的適配器
在Mybatis的日志模塊中就是使用了適配器模式。Mybatis內部在使用日志模塊時,使用了其內部接口 org.apache.ibatis.logging.Log,但是常用的日志框架的對外接口各不相同,Mybatis為了復用和集成這些第三方日志組件,在其日志模塊中,提供了多種Adapter,將這些第三方日志組件對外接口適配成org.apache.ibatis.logging.Log,這樣Myabtis 就可以通過Log接口調用第三方日志了
源碼分析圖
源碼剖析
Mybatis Log接口:相當于源接口
- package org.apache.ibatis.logging;
- 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);
- }
Mybatis源接口實現類
適配器第一種
- package org.apache.ibatis.logging.slf4j;
- import org.apache.ibatis.logging.Log;
- import org.slf4j.Logger;
- //Slf4jLoggerImpl :相當于適配器
- //Log :相當于源接口
- class Slf4jLoggerImpl implements Log {
- //Logger:相當于目標接口
- private Logger log;
- public Slf4jLoggerImpl(Logger logger) {
- //源=目標
- log = logger;
- }
適配器第二種
- package org.apache.ibatis.logging.log4j2;
- import org.apache.ibatis.logging.Log;
- import org.apache.logging.log4j.LogManager;
- import org.apache.logging.log4j.Logger;
- import org.apache.logging.log4j.spi.AbstractLogger;
- //Log4j2Impl :相當于適配器
- //Log :相當于源接口
- public class Log4j2Impl implements Log {
- private Log log;
- //構造器
- public Log4j2Impl(String clazz) {
- //目標接口
- Logger logger = LogManager.getLogger(clazz);
- //判斷類型去實現:相當于目標
- if (logger instanceof AbstractLogger) {
- log = new Log4j2AbstractLoggerImpl((AbstractLogger) logger);
- } else {
- //源=目標
- log = new Log4j2LoggerImpl(logger);
- }
- }
目標接口:Logger