《Apache MINA 2.0 用户指南》第十二章：日志过滤器

柔光的暖阳◎ 2023-10-16 21:19 10阅读 0赞

后台

用户开放基于Apache MiNa的应用程序，用户可以在应用程序中创建日志管理

### SLF4J ###

MINa采用SLF4j作为日志输出，你可以在这里发现很多关于SLF4j的相关介绍。这个日志工具允许任何形式的日志系统实施。你可能使用 log4j, java.util.logging 或其他日志系统。这部分是告诉我们，在后续的开发过程中，开发者想更改java.util.logging log4j，开发者不需要修改相关程序的源代码。

### 选择合适JARs ###

Apache MINa 日志文件系统绑定SLF4J，这意味着Apache MINA 支持任何日志文件系统。你可以使用自己熟悉的日志文件系统，并且调用它的静态方法生成相关日志文件信。以下表格展示不同日志文件框架，所属的jar文件。

<table style="margin:5px; border-collapse:collapse; color:rgb(119,119,119); font-family:'Lucida Sans',Helvetica,sans-serif,sans; font-size:12px; line-height:18.4799995422363px"> 
 <thead> 
  <tr> 
   <th style="border:1px solid rgb(204,204,204); padding:3px 4px; text-align:center; background-color:rgb(240,240,240)"> Logging framework</th> 
   <th style="border:1px solid rgb(204,204,204); padding:3px 4px; text-align:center; background-color:rgb(240,240,240)"> Required JARs</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Log4J 1.2.x</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px"><strong>sl</strong>f4j-api.jar<strong>,&nbsp;</strong>slf4j-log4j12.jar**</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Log4J 1.3.x</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px"><strong>slf4j-api.jar</strong>,&nbsp;<strong>slf4j-log4j13.jar</strong></td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">java.util.logging</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">slf4j-api.jar<strong>,&nbsp;</strong>slf4j-jdk14.jar**</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Commons Logging</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px"><strong>slf4j-api.jar</strong>,&nbsp;<strong>slf4j-jcl.jar<br> <br> </strong></td> 
  </tr> 
 </tbody> 
</table>

注意事项：

1、slf4j-api.jar 是被任何日志文件框架所使用。

2、重点：在同一个项目路径中，不能引用不同日志文件框架的jar文件(e.g. slf4j-log4j12.jar and slf4j-jdk14.jar); 如果在同一个项目路径引用不同日志框架的jar 文件，会导致不可预知的错误发生。

3、slf4j-api.jar slf4j必须与日志文件框架版本相对应。

#### 覆写Jakarta Commons Logging ####

slf4j还提供一种方法，将当期应用程序的日志文件框架slf4j，修改为Jakarta Commons Logging 日志文件框架并且不需要修改过应用程序的相关源代码。移除commons-loggong jar 文件在应用程序项目路径，在当期应用程序项目中添加jcl104-over-slf4j.jar文件。

### log4j example ###

在这个例子中我们将使用log4j记录系统。

# Set root logger level to DEBUG and its only appender to A1.
    log4j.rootLogger=DEBUG, A1
    
    # A1 is set to be a ConsoleAppender.
    log4j.appender.A1=org.apache.log4j.ConsoleAppender
    
    # A1 uses PatternLayout.
    log4j.appender.A1.layout=org.apache.log4j.PatternLayout
    log4j.appender.A1.layout.ConversionPattern=%-4r [%t] %-5p %c{1} %x - %m%n

该文件将被放置在我们的项目的src目录。如果您使用的是IDE，当你测试你的代码，基本上你想要的配置文件在类路径中的JVM。

接下来我们将设置一个简单的例子，以产生一些日志服务器。在这里，我们创建一个叫 EchoServer 的项目并添加日志文件类

public static void main(String[] args) throws Exception {
         
        IoAcceptor acceptor = new SocketAcceptor();
        DefaultIoFilterChainBuilder chain = acceptor.getFilterChain();
    
    LoggingFilter loggingFilter = new LoggingFilter();
        chain.addLast("logging", loggingFilter);
    
        acceptor.setLocalAddress(new InetSocketAddress(PORT));
        acceptor.setHandler(new EchoProtocolHandler());
        acceptor.bind();
    
        System.out.println("Listening on port " + PORT);
    }

在EchoServer项目中，我们移除了addLogger方法。参考 loggingfilter，你可以在你的应用程序中设置于 IoAcceptor相关联的事件类型所对应的logging 级别。触发IOHandler 指定事件，我们通过调用LoggingFilter类的setLogLevel(IoEventType, LogLevel)方法进行设置。

以下是调用方法所处状态

<table style="margin:5px; border-collapse:collapse; color:rgb(119,119,119); font-family:'Lucida Sans',Helvetica,sans-serif,sans; font-size:12px; line-height:18.4799995422363px"> 
 <thead> 
  <tr> 
   <th style="border:1px solid rgb(204,204,204); padding:3px 4px; text-align:center; background-color:rgb(240,240,240)"> IoEventType</th> 
   <th style="border:1px solid rgb(204,204,204); padding:3px 4px; text-align:center; background-color:rgb(240,240,240)"> Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">SESSION_CREATED</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Called when a new session has been created</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">SESSION_OPENED</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Called when a new session has been opened</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">SESSION_CLOSED</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Called when a session has been closed</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">MESSAGE_RECEIVED</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Called when data has been received</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">MESSAGE_SENT</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Called when a message has been sent</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">SESSION_IDLE</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Called when a session idle time has been reached</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">EXCEPTION_CAUGHT</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Called when an exception has been thrown<br> </td> 
  </tr> 
 </tbody> 
</table>

这里是  LogLevels 的描述

<table style="margin:5px; border-collapse:collapse; color:rgb(119,119,119); font-family:'Lucida Sans',Helvetica,sans-serif,sans; font-size:12px; line-height:18.4799995422363px"> 
 <thead> 
  <tr> 
   <th style="border:1px solid rgb(204,204,204); padding:3px 4px; text-align:center; background-color:rgb(240,240,240)"> LogLevel</th> 
   <th style="border:1px solid rgb(204,204,204); padding:3px 4px; text-align:center; background-color:rgb(240,240,240)"> Description</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">NONE</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">This will result in no log event being created regardless of the configuration</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">TRACE</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Creates a TRACE event in the logging system</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">DEBUG</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Generates debug messages in the logging system</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">INFO</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Generates informational messages in the logging system</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">WARN</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Generates warning messages in the logging system</td> 
  </tr> 
  <tr> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">ERROR</td> 
   <td style="border:1px solid rgb(204,204,204); padding:3px 4px">Generates error messages in the logging system<br> </td> 
  </tr> 
 </tbody> 
</table>

拥有了以上信息，你可以在你的开发的系统中 生成你所需要的系统日志信息。

####     ####