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

适配器模式与装饰器模式在日志框架中的实战运用

news 2026/6/12 7:19:27

适配器模式与装饰器模式在日志框架中的实战运用

一、日志框架切换的"牵一发而动全身"：设计模式解耦的工程价值

在企业级 Java 项目中，日志框架的选型变更是一个高风险操作。项目初期使用 Log4j 2，后来因安全漏洞需要迁移到 Logback，或者因性能需求切换到某个定制日志框架。如果业务代码中直接依赖org.apache.logging.log4j.Logger，切换框架意味着全量修改 import 语句和 API 调用——一个中型项目可能有上千处引用。

更复杂的场景是同一应用中需要同时支持多种日志输出：开发环境输出到控制台，生产环境输出到文件并异步发送到 ELK。不同的输出目标需要不同的格式化和过滤策略，直接在业务代码中处理这些差异会导致逻辑散落、难以维护。适配器模式和装饰器模式是解决这类问题的经典设计模式。

二、两种模式的底层机制与协作关系

适配器模式解决"接口不兼容"的问题：将一个类的接口转换为客户端期望的另一个接口。装饰器模式解决"功能扩展"的问题：动态地给对象添加额外职责，而不改变其接口。

在日志框架中，适配器模式用于统一不同日志框架的 API 差异，装饰器模式用于在不修改核心逻辑的前提下叠加功能（如异步写入、格式化、过滤）。

flowchart TD A[业务代码调用 ILogger 接口] --> B[LoggerAdapter<br/>适配器: 统一日志 API] B --> C{底层日志框架} C -->|Log4j 2| D[Log4j2LoggerAdapter] C -->|Logback| E[LogbackLoggerAdapter] C -->|SLF4J| F[Slf4jLoggerAdapter] D & E & F --> G[LoggerDecorator<br/>装饰器: 功能叠加] G --> H[AsyncLoggerDecorator<br/>异步写入装饰] H --> I[FilterLoggerDecorator<br/>日志过滤装饰] I --> J[FormatLoggerDecorator<br/>格式化装饰] J --> K[底层输出: Console/File/ELK]

三、生产级日志框架适配与装饰的代码实现

3.1 统一日志接口与适配器

/** * 统一日志接口：业务代码只依赖此接口 * 不直接暴露底层日志框架的 API */ public interface ILogger { void info(String message, Object... args); void warn(String message, Object... args); void error(String message, Throwable throwable, Object... args); void debug(String message, Object... args); boolean isDebugEnabled(); } /** * Log4j 2 适配器：将 Log4j 2 的 Logger 适配为 ILogger 接口 * 隐藏 Log4j 2 特有的 API（如 LogManager.getLogger） */ public class Log4j2LoggerAdapter implements ILogger { private final org.apache.logging.log4j.Logger delegate; public Log4j2LoggerAdapter(Class<?> clazz) { this.delegate = org.apache.logging.log4j.LogManager.getLogger(clazz); } @Override public void info(String message, Object... args) { // Log4j 2 使用 ParameterizedMessage，与 SLF4J 的 {} 占位符一致 delegate.info(message, args); } @Override public void error(String message, Throwable throwable, Object... args) { delegate.error(message, throwable, args); } @Override public boolean isDebugEnabled() { return delegate.isDebugEnabled(); } // warn/debug 实现类似... } /** * Logback 适配器：将 Logback 的 Logger 适配为 ILogger 接口 */ public class LogbackLoggerAdapter implements ILogger { private final ch.qos.logback.classic.Logger delegate; public LogbackLoggerAdapter(Class<?> clazz) { this.delegate = (ch.qos.logback.classic.Logger) org.slf4j.LoggerFactory.getLogger(clazz); } @Override public void info(String message, Object... args) { delegate.info(message, args); } @Override public void error(String message, Throwable throwable, Object... args) { delegate.error(message, throwable, args); } @Override public boolean isDebugEnabled() { return delegate.isDebugEnabled(); } }

3.2 日志装饰器链

/** * 日志装饰器基类：实现 ILogger 接口，持有被装饰的 ILogger * 所有装饰器继承此类，只需覆盖需要增强的方法 */ public abstract class LoggerDecorator implements ILogger { protected final ILogger delegate; protected LoggerDecorator(ILogger delegate) { this.delegate = delegate; } @Override public void info(String message, Object... args) { delegate.info(message, args); } @Override public void error(String message, Throwable throwable, Object... args) { delegate.error(message, throwable, args); } @Override public boolean isDebugEnabled() { return delegate.isDebugEnabled(); } } /** * 异步日志装饰器：将日志写入操作异步化 * 使用 Disruptor 高性能队列，避免日志 I/O 阻塞业务线程 */ public class AsyncLoggerDecorator extends LoggerDecorator { private final Disruptor<LogEvent> disruptor; private final RingBuffer<LogEvent> ringBuffer; public AsyncLoggerDecorator(ILogger delegate, int bufferSize) { super(delegate); // 使用 Disruptor 实现高性能异步日志 this.disruptor = new Disruptor<>( LogEvent::new, bufferSize, DaemonThreadFactory.INSTANCE, ProducerType.MULTI, new BlockingWaitStrategy() ); this.ringBuffer = disruptor.getRingBuffer(); disruptor.handleEventsWith(this::consumeEvent); disruptor.start(); } @Override public void info(String message, Object... args) { publishEvent("INFO", message, null, args); } @Override public void error(String message, Throwable throwable, Object... args) { publishEvent("ERROR", message, throwable, args); } /** * 发布日志事件到 Disruptor 队列 * 业务线程只做序列化写入，不阻塞 */ private void publishEvent(String level, String message, Throwable throwable, Object... args) { long sequence = ringBuffer.next(); try { LogEvent event = ringBuffer.get(sequence); event.setLevel(level); event.setMessage(message); event.setThrowable(throwable); event.setArgs(args); event.setTimestamp(System.currentTimeMillis()); } finally { ringBuffer.publish(sequence); } } /** * 消费者线程：从队列取出事件，委托给底层 Logger 写入 */ private void consumeEvent(LogEvent event, long sequence, boolean endOfBatch) { switch (event.getLevel()) { case "INFO" -> delegate.info(event.getMessage(), event.getArgs()); case "ERROR" -> delegate.error(event.getMessage(), event.getThrowable(), event.getArgs()); case "WARN" -> delegate.warn(event.getMessage(), event.getArgs()); case "DEBUG" -> delegate.debug(event.getMessage(), event.getArgs()); } } } /** * 过滤装饰器：根据条件过滤日志 * 例如：过滤敏感信息、限制特定包的日志级别 */ public class FilterLoggerDecorator extends LoggerDecorator { private final Predicate<String> messageFilter; private final Set<String> suppressedPatterns; public FilterLoggerDecorator(ILogger delegate, Predicate<String> filter, Set<String> suppressedPatterns) { super(delegate); this.messageFilter = filter; this.suppressedPatterns = suppressedPatterns; } @Override public void info(String message, Object... args) { if (shouldLog(message)) { delegate.info(sanitize(message), args); } } /** * 判断日志是否应该输出 * 匹配抑制模式的日志直接丢弃 */ private boolean shouldLog(String message) { if (suppressedPatterns.stream().anyMatch(message::contains)) { return false; } return messageFilter.test(message); } /** * 敏感信息脱敏：替换手机号、身份证号等 */ private String sanitize(String message) { return message .replaceAll("(1[3-9]\\d)\\d{4}(\\d{4})", "$1****$2") // 手机号 .replaceAll("(\\d{4})\\d{10}(\\d{4})", "$1**********$2"); // 身份证号 } }

3.3 日志工厂：组装装饰器链

/** * 日志工厂：根据配置组装适配器 + 装饰器链 * 业务代码通过 LoggerFactory 获取 ILogger，无需关心底层实现 */ @Component public class LoggerFactory { private final LogConfigProperties config; public ILogger getLogger(Class<?> clazz) { // 1. 创建适配器（根据配置选择底层框架） ILogger logger = createAdapter(clazz); // 2. 叠加装饰器（顺序很重要：异步应在最外层） if (config.isAsyncEnabled()) { logger = new AsyncLoggerDecorator(logger, config.getAsyncBufferSize()); } if (config.isFilterEnabled()) { logger = new FilterLoggerDecorator( logger, config.getMessageFilter(), config.getSuppressedPatterns() ); } return logger; } private ILogger createAdapter(Class<?> clazz) { return switch (config.getFramework().toUpperCase()) { case "LOG4J2" -> new Log4j2LoggerAdapter(clazz); case "LOGBACK" -> new LogbackLoggerAdapter(clazz); default -> new Slf4jLoggerAdapter(clazz); }; } }