首页 > 代码库 > logback自定义转换的问题

logback自定义转换的问题

上个星期领导交给我一个任务,就是写logback自定义转换实现以下要求

[IP][文件名][行号][YYMMDD][HHMMSS.sss][线程名称][socket号][代码包和函数名.行号]-[卡号|单位|商户|终端|交易类型][message]
eg:

输出结果
[192.168.1.134][comm.20880.log][100][16-11-07][19:20:01.002][fixThread001][00000000000020002222222222222001][com.bridge.method.66]-[1000198909875654|10000011|9887777||00000001|1212][hello world!]

logback的配置文件(自定义后在以下添加)
[%ip][文件名][行号][%.-1level][%date{ISO8601}][%baseMessageConvert][%][%30.30logger{10}|%M|%L] -%m%n

我们了解以下什么是logback:

  

概述:LogBack是一个日志框架,它与Log4j可以说是同出一源,都出自Ceki Gülcü之手
 
logback和Slf4j和log4j之间是什么关系:
Slf4j是The Simple Logging Facade for Java的简称,是一个简单日志门面抽象框架,它本身只提供了日志Facade API和一个简单的日志类实现,一般常配合Log4j,LogBack,java.util.logging使用。Slf4j作为应用层的Log接入时,程序可以根据实际应用场景动态调整底层的日志实现框架(Log4j/LogBack/JdkLog…)。
LogBack和Log4j都是开源日记工具库,LogBack是Log4j的改良版本,比Log4j拥有更多的特性,同时也带来很大性能提升。详细数据可参照下面地址: Reasons to prefer logback over log4j
LogBack官方建议配合Slf4j使用,这样可以灵活地替换底层日志框架。
TIPS:为了优化log4j,以及更大性能的提升,Apache基金会已经着手开发了log4j 2.0, 其中也借鉴和吸收了logback的一些先进特性,目前log4j2还处于beta阶段。
 
LogBack的结构
LogBack被分为3个组件,logback-core, logback-classic 和 logback-access。
其中logback-core提供了LogBack的核心功能,是另外两个组件的基础。
logback-classic则实现了Slf4j的API,所以当想配合Slf4j使用时,需要将logback-classic加入classpath。
logback-access是为了集成Servlet环境而准备的,可提供HTTP-access的日志接口。
 
 
 
然后要明白logback 的相关配置
 
根节点<configuration>包含的属性
  • scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true.
  • scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟.
  • debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
XML代码:
<configuration scan="true" scanPeriod="60 second" debug="false"> <!-- 其他配置省略--> </configuration>
根节点<configuration>的子节点
LogBack的配置大概包括3部分:appender, logger和root。
技术分享
设置上下文名称<contextName>
每个logger都关联到logger上下文,默认上下文名称为“default”。但可以使用<contextName>设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。
XML代码:
<configuration scan="true" scanPeriod="60 second" debug="false"> <contextName>myAppName</contextName> <!-- 其他配置省略--> </configuration>
 
设置变量 <property>
用来定义变量值的标签,<property> 有两个属性,name和value;其中name的值是变量的名称,value的值时变量定义的值。通过<property>定义的值会被插入到logger上下文中。定义变量后,可以使“${}”来使用变量。
例如使用<property>定义上下文名称,然后在<contentName>设置logger上下文时使用。
<configuration scan="true" scanPeriod="60 second" debug="false"> <property name="APP_Name" value="http://www.mamicode.com/myAppName" /> <contextName>${APP_Name}</contextName> <!-- 其他配置省略--> </configuration>
获取时间戳字符串 <timestamp>
两个属性 key:标识此<timestamp> 的名字;datePattern:设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循Java.txt.SimpleDateFormat的格式。
例如将解析配置文件的时间作为上下文名称:
<configuration scan="true" scanPeriod="60 second" debug="false"> <timestamp key="bySecond" datePattern="yyyyMMdd‘T‘HHmmss"/> <contextName>${bySecond}</contextName> <!-- 其他配置省略--> </configuration>
 
 
<logger>
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<logger>仅有一个name属性,一个可选的level和一个可选的addtivity属性。
  • name:用来指定受此logger约束的某一个包或者具体的某一个类。
  • level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特殊值INHERITED或者同义词NULL,代表强制执行上级的级别。
如果未设置此属性,那么当前logger将会继承上级的级别。
  • addtivity:是否向上级logger传递打印信息。默认是true。
<logger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个logger
 
<root>
也是<logger>元素,但是它是根logger。只有一个level属性,应为已经被命名为”root”.
  • level:用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。
<root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个logger。
 
 
 
 
<appender>详解
<appender>是<configuration>的子节点,是负责写日志的组件。<appender>有两个必要属性name和class。name指定appender名称,class指定appender的全限定名。
技术分享
ConsoleAppender
把日志添加到控制台,有以下子节点:
  • <encoder>:对日志进行格式化。(具体参数稍后讲解 )
  • <target>:字符串 System.out 或者 System.err ,默认 System.out .
<configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern> </encoder> </appender> <root level="DEBUG"> <appender-ref ref="STDOUT" /> </root> </configuration>
 
FileAppender
把日志添加到文件,有以下子节点:
  • <file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
  • <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
  • <encoder>:对记录事件进行格式化。(具体参数稍后讲解 )
  • <prudent>:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。
<configuration> <appender name="FILE" class="ch.qos.logback.core.FileAppender"> <file>testFile.log</file> <append>true</append> <encoder> <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> </encoder> </appender> <root level="DEBUG"> <appender-ref ref="FILE" /> </root> </configuration>
RollingFIleAppender
滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:
  • <file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
  • <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
  • <encoder>:对记录事件进行格式化。(具体参数稍后讲解 )
  • <rollingPolicy>:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。
  • <triggeringPolicy >: 告知 RollingFileAppender 何时激活滚动。
  • <prudent>:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。
RollingFIleAppender
滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。有以下子节点:
  • <file>:被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
  • <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
  • <encoder>:对记录事件进行格式化。(具体参数稍后讲解 )
  • <rollingPolicy>:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。
  • <triggeringPolicy >: 告知 RollingFileAppender 何时激活滚动。
  • <prudent>:当为true时,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。
  • TimeBasedRollingPolicy : 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责触发滚动。有以下子节点:
<fileNamePattern>: 必要节点,包含文件名及“%d”转换符,%d”可以包含一个Java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM}。如果直接使用 %d,默认格式是 yyyy-MM-dd。RollingFileAppender 的file字节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;如果没设置file,活动文件的名字会根据fileNamePattern 的值,每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
<maxHistory>: 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且<maxHistory>是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。
 
 
 
<pattern>里面的转换符说明:
 
转换符 作用
c {length }
lo {length }
logger {length }
输出日志的logger名,可有一个整形参数,功能是缩短logger名,设置为0表示只输入logger最右边点符号之后的字符串。 Conversion specifier Logger name Result
C {length }
class {length }
输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用,除非执行速度不造成任何问题。
contextName
cn
输出上下文名称。
d {pattern }
date {pattern }
输出日志的打印日志,模式语法与java.text.SimpleDateFormat 兼容。 Conversion Pattern Result
F / file 输出执行记录请求的java源文件名。尽量避免使用,除非执行速度不造成任何问题。
caller{depth} caller{depth, evaluator-1, ... evaluator-n} 输出生成日志的调用者的位置信息,整数选项表示输出信息深度。 例如, %caller{2} 输出为:
0 [main] DEBUG - logging statement Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22) Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)
例如, %caller{3} 输出为:
16 [main] DEBUG - logging statement Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22) Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17) Caller+2 at mainPackage.ConfigTester.main(ConfigTester.java:38)
L / line 输出执行日志请求的行号。尽量避免使用,除非执行速度不造成任何问题。
m / msg / message 输出应用程序提供的信息。
M / method 输出执行日志请求的方法名。尽量避免使用,除非执行速度不造成任何问题。
n 输出平台先关的分行符“\n”或者“\r\n”。
p / le / level 输出日志级别。
r / relative 输出从程序启动到创建日志记录的时间,单位是毫秒
t / thread 输出产生日志的线程名。
replace(p ){r, t} p 为日志内容,r 是正则表达式,将p 中符合r 的内容替换为t 。
例如, "%replace(%msg){‘\s‘, ‘‘}"
%logger mainPackage.sub.sample.Bar mainPackage.sub.sample.Bar
%logger{0} mainPackage.sub.sample.Bar Bar
%logger{5} mainPackage.sub.sample.Bar m.s.s.Bar
%logger{10} mainPackage.sub.sample.Bar m.s.s.Bar
%logger{15} mainPackage.sub.sample.Bar m.s.sample.Bar
%logger{16} mainPackage.sub.sample.Bar m.sub.sample.Bar
%logger{26} mainPackage.sub.sample.Bar mainPackage.sub.sample.Bar
%d 2006-10-20 14:06:49,812
%date 2006-10-20 14:06:49,812
%date{ISO8601} 2006-10-20 14:06:49,812
%date{HH:mm:ss.SSS} 14:06:49.812
%date{dd MMM yyyy ;HH:mm:ss.SSS} 20 oct. 2006;14:06:49.812
 
 
格式修饰符,与转换符共同使用:
可选的格式修饰符位于“%”和转换符之间。
第一个可选修饰符是左对齐 标志,符号是减号“-”;接着是可选的最小宽度 修饰符,用十进制数表示。如果字符小于最小宽度,则左填充或右填充,默认是左填充(即右对齐),填充符为空格。如果字符大于最小宽度,字符永远不会被截断。最大宽度 修饰符,符号是点号"."后面加十进制数。如果字符大于最大宽度,则从前面截断。点符号“.”后面加减号“-”在加数字,表示从尾部截断。
 
 
例如:%-4relative 表示,将输出从程序启动到创建日志记录的时间 进行左对齐 且最小宽度为4。
 
 
 
 最后我把我写的几个关于logback的自定义配置附上希望能对大家有一定的参考
首先我们要先定义一个类,继承ClassicConverter这个类,然后通说里面的一些方法实现我们要获取的东西
如果获取系统之类的信息通过一些方法就可以了,但是要是写和业务相关的字段我们还要写一个方法类封装起来,这样想打印什么的时候就调用一下这个方法set一下就可以了,下面有我写的相关的例子
package com.ykt.comm.util.logback;

import java.util.HashMap;
import java.util.Map;

import ch.qos.logback.classic.pattern.ClassicConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;

import com.google.gson.Gson;

public class BaseMessageConvert extends ClassicConverter {

    public static String SPlIT_CHAR_REG = "\\|";
    @Override
    public String convert(ILoggingEvent event) {
        //调用MessageUtil工具类执行后产生新生成的先成名和socketId以及其他各个字段
        String myThreadName = event.getThreadName();

        String[] baseMessageArray = myThreadName.split(SPlIT_CHAR_REG);

        if (baseMessageArray.length == 1) {
            return "";
        } else {
            //这是指定排序
            Gson gson = new Gson();
            @SuppressWarnings("unchecked")
            Map<String, String> data = http://www.mamicode.com/gson.fromJson(baseMessageArray[1], HashMap.class);
            String socketId = data.get(LogKeyConstant.LOG_KEY_SOCKETID.getpCode());
            String txnType = data.get(LogKeyConstant.LOG_KEY_TXNTYPE.getpCode());
            String seq = data.get(LogKeyConstant.LOG_KEY_SEQ.getpCode());
            String unit = data.get(LogKeyConstant.LOG_KEY_UNIT.getpCode());
            String mchnt = data.get(LogKeyConstant.LOG_KEY_MCHNT.getpCode());
            String pos = data.get(LogKeyConstant.LOG_KEY_POS.getpCode());
            String cardNo = data.get(LogKeyConstant.LOG_KEY_CARDNO.getpCode());
            
            StringBuilder builder = new StringBuilder();
            builder.append("[通讯号:").append(socketId).append("|交易类型:").append(txnType).append("|交易流水:").append(seq).append("|单位号:")
                    .append(unit).append("|商户号:").append(mchnt).append("|终端号:").append(pos).append("|卡号:").append(cardNo)
                    .append("]");
            return builder.toString();
        }

    }
}

package com.ykt.comm.util.logback;

import java.net.InetAddress;
import java.net.UnknownHostException;

import ch.qos.logback.classic.pattern.ClassicConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;



public class IpConvert extends ClassicConverter{

    @Override
    public String convert(ILoggingEvent event) {
        String hostAddress = null;
        try {
            hostAddress = InetAddress.getLocalHost().getHostAddress();
        } catch (UnknownHostException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return hostAddress;
    }}
      

package com.ykt.comm.util.logback;

/**
 * 日志 打印 元素
 *
 * @author victor [socketid|交易类型|交易流水|单位|商户|终端|卡号]
 */
public enum LogKeyConstant {
    LOG_KEY_SOCKETID("SOCKETID", "通讯号"),
    LOG_KEY_TXNTYPE("TXNTYPE", "交易类型"),
    LOG_KEY_SEQ("SEQ", "交易流水"),
    LOG_KEY_UNIT("UNIT", "单位号"),
    LOG_KEY_MCHNT("MCHNT", "商户号"),
    LOG_KEY_POS("POS", "终端号"),
    LOG_KEY_CARDNO("CARDNO", "卡号"),

    ;
    private String pCode;
    private String pName;

    private LogKeyConstant(String pCode, String pName) {
        this.pCode = pCode;
        this.pName = pName;
    }

    public String getpCode() {
        return pCode;
    }

    public void setpCode(String pCode) {
        this.pCode = pCode;
    }

    public String getpName() {
        return pName;
    }

    public void setpName(String pName) {
        this.pName = pName;
    }

    public static boolean containPCode(String pCode) {
        boolean result = false;
        for (LogKeyConstant logKeyConstant : LogKeyConstant.values()) {
            if (pCode.equals(logKeyConstant.pCode)) {
                result = true;
                break;
            }
        }
        return result;
    }
}

package com.ykt.comm.util.logback;

import com.google.gson.Gson;
import com.google.gson.JsonObject;

public class MessageUtil {
    public static String SPlIT_CHAR_REG = "\\|";
    public static String SPlIT_CHAR = "|";

    /**
     * 根据发送过来的key 和 value, 拼装进线程名 key 需要定义宏定义, 处理过程中需要先对 宏进行判定,只有相同数据的宏才能进行设置 处理后的JSON数据需要根据特殊定义排序???
     *
     * @param key
     * @param value
     */
    public static void setMessage(String key, String value) {

        //TODO 对key进行宏定义判定
        if (!LogKeyConstant.containPCode(key)) {
            return;
        }

        Gson gson = new Gson();
        String addStr = null;
        String strArray[] = Thread.currentThread().getName().split(SPlIT_CHAR_REG);
        if (strArray.length == 1) {
            //第一次向线程名赋值数据,先创建一个jsonObject对象
            JsonObject jsonObject = new JsonObject();
            //将key,value参数存入jsonObject对象
            jsonObject.addProperty(key, value);
            //将jsonObject对象转换成json字符串然后赋值给字符串变量addStr
            addStr = gson.toJson(jsonObject);

        } else {
            //第N次向线程名赋值数据
            //若存在|获取数组的第二个元素相当于业务字段的字符串
            String baseMessage = strArray[1];
            //通过这个字符串获取jsonObject对象
            JsonObject jsonObjectAgain = gson.fromJson(baseMessage, JsonObject.class);
            //将参数key value用jsonObjectAgain对象存储
            jsonObjectAgain.addProperty(key, value);
            //将jsonObjectAgain对象转换成json字符串并赋值给addStr
            addStr = gson.toJson(jsonObjectAgain);
            //需要对ADDSTR 根据要求排序

            //[通讯号,交易类型,交易流水,单位,商户,终端,卡号]
        }
        //System.out.println(addStr);
        Thread.currentThread().setName(strArray[0] + SPlIT_CHAR + addStr);
       // System.out.println(Thread.currentThread().getName());
    }
    public static void main(String[] args) {
        MessageUtil.setMessage(LogKeyConstant.LOG_KEY_SOCKETID.getpCode(), "通讯号-xxx");
        MessageUtil.setMessage(LogKeyConstant.LOG_KEY_TXNTYPE.getpCode(), "交易类型-xxx");

    }
    
}

package com.ykt.comm.util.logback;

import ch.qos.logback.classic.pattern.ClassicConverter;
import ch.qos.logback.classic.spi.ILoggingEvent;

/**
 *
 * @author Administrator
 *
 */
public class MyThreadConvert extends ClassicConverter{

    @Override
    public String convert(ILoggingEvent event) {
        return event.getThreadName().split("\\|")[0];
    }
      
}
<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60000" debug="true">
    <property name="APP_Name" value="http://www.mamicode.com/acc" />
    <!-- 这里的converterClass要把包名写对了否则不能正常打印日志 -->
    <conversionRule conversionWord="ip" converterClass="com.ykt.comm.util.logback.IpConvert" />
    <conversionRule conversionWord="baseMessage" converterClass="com.ykt.comm.util.logback.BaseMessageConvert" />
    <conversionRule conversionWord="myThread" converterClass="com.ykt.comm.util.logback.MyThreadConvert" />
    
    
    <!-- [%date{ISO8601}][%-5level][%thread][%c] -%m%n -->
    <!-- [%date{HH:mm:ss.SSS}][%.-1level][%15.15thread][%30.30logger{10}.%L] -%m%n -->
    <property name="Log_Pattern" value="http://www.mamicode.com/[%ip][%date{ISO8601}][%.-1level][%myThread][%baseMessage][%30.30logger{10}-%method.%line]-%m%n" />    
    <property name="File_Pattern" value="http://www.mamicode.com/logs/%d{yyyyMMdd}/acc/" />  
    <contextName>${APP_Name}</contextName>

    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
        <encoder>  
            <pattern>${Log_Pattern}</pattern>
        </encoder>  
    </appender>
    
    <appender name="root" class="ch.qos.logback.core.rolling.RollingFileAppender">  
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">    
            <fileNamePattern>${File_Pattern}acc-acc.log</fileNamePattern>    
        </rollingPolicy>
        <append>true</append>  
        <Prudent>true</Prudent>
        <encoder><pattern>${Log_Pattern}</pattern></encoder>  
    </appender>
    
    <appender name="dubbo" class="ch.qos.logback.core.rolling.RollingFileAppender">  
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">    
            <fileNamePattern>${File_Pattern}dubbo.log</fileNamePattern>    
        </rollingPolicy>
        <append>true</append>  
        <Prudent>true</Prudent>
        <encoder><pattern>${Log_Pattern}</pattern></encoder>  
    </appender>
    
    
    <!-- addtivity,默认为true,将此loger的打印信息向上级传递;-->
    <!-- 没有设置appender,此loger本身不打印任何信息 -->
    <logger name="com.alibaba" level="ERROR" additivity="false">
        <appender-ref ref="dubbo"/>
        <appender-ref ref="STDOUT"/>
    </logger>
    
    <logger name="com" level="${dubbo.logger.level}" additivity="false">
        <appender-ref ref="root" />
        <appender-ref ref="STDOUT"/>
    </logger>
    
    <!-- trace, debug, info, warn, error -->
    <root level="${dubbo.logger.level}">    
        <appender-ref ref="root" />  
        <appender-ref ref="STDOUT"/>           
    </root>    
 
    <!-- 关闭相关的日志 -->
    <logger name="com.acc.dal.dao" level="OFF" />
    <logger name="org.mybatis.spring" level="OFF" />
    <logger name="org.apache.zookeeper" level="ERROR" />
    
   
</configuration>

logback自定义转换的问题