scala项目中使用log4j2建立日志系统

一、    关于Log4J

2015年5月,Apache宣布Log4J 1.x 停止更新。最新版为1.2.17。

如今,Log4J 2.x已更新至2.7。

官方网址:http://logging.apache.org/log4j/2.x/

二、    Log4J能做什么?

1.    将信息送到控制台,文件,GUI组件等。

2.    控制每条信息的输出格式。

3.    将信息分类,定义信息级别,细致地控制日志的输出。

三、    Log4J2的安装

1.    去官网下载log4j2,解压

2.    最基本的Jar包:

log4j-api-2.7.jar

log4j-core-2.7.jar

3. 将jar文件复制到Web项目的WEB-INF/lib目录下。

四、    配置文件介绍

1.    日志级别

trace:追踪,就是程序推进一下,可以写个trace输出

debug:调试,一般作为最低级别,trace基本不用。

info:输出重要的信息,使用较多

warn:警告,有些信息不是错误信息,但也要给程序员一些提示。

error:错误信息。用的也很多。

fatal:致命错误。级别较高,这种级别不用调试了,重写吧……

机制:如果一条日志信息的级别大于等于配置文件的级别,就记录。

2.    输出源

CONSOLE(输出到控制台)、FILE(输出到文件)等。

3.    布局方式

SimpleLayout:以简单的形式显示

HTMLLayout:以HTML表格显示

PatternLayout:自定义形式显示

在Log4J2中基本采用PatternLayout自定义日志布局。

自定义格式:

%t:线程名称

%p:日志级别

%c:日志消息所在类名

%m:消息内容

%M:输出执行方法

%d:发生时间,%d{yyyy-MM-dd HH:mm:ss,SSS},输出类似:2011-10-18 22:10:28,921

%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。

%L:代码中的行数

%n:换行

<PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M -%msg%xEx%n"/>

c{precision}

logger{precision}

class{precision}àOutputs the name of the logger thatpublished the logging event.

Conversion Pattern

Logger Name

Result

%c{1}

org.apache.commons.Foo

Foo

%c{2}

org.apache.commons.Foo

commons.Foo

%c{10}

org.apache.commons.Foo

org.apache.commons.Foo

%c{-1}

org.apache.commons.Foo

apache.commons.Foo

%c{-2}

org.apache.commons.Foo

commons.Foo

%c{-10}

org.apache.commons.Foo

org.apache.commons.Foo

%c{1.}

org.apache.commons.Foo

o.a.c.Foo

%c{1.1.~.~}

org.apache.commons.test.Foo

o.a.~.~.Foo

%c{.}

org.apache.commons.test.Foo

....Foo

p|level{level=label,level=label, ...} p|level{length=n} p|level{lowerCase=true|false}à you can define the length of the levellabel:

m{nolookups}{ansi}|msg{nolookups}{ansi}|message{nolookups}{ansi}àsupplied message

xEx|xException|xThrowableàsuppress printing of the exception

 

五、    配置使用

1.    配置文件命名与存储位置(Log4J没有默认的配置文件)

系统选择configuration文件的优先级如下(放在src文件夹):

classpath下名为 log4j-test.json 或者log4j-test.jsn文件

classpath下名为 log4j2-test.xml

classpath下名为 log4j.json 或者log4j.jsn文件

classpath下名为 log4j2.xml

 

很多人认为src就是classpath,java项目中Classpath路径到底指的是哪里?

1)   src不是classpath,WEB-INF/classes,lib才是classpath,WEB-INF/是资源目录, 客户端不能直接访问。

2)   WEB-INF/classes目录存放src目录java文件编译之后的class文件,xml、properties等资源配置文件,这是一个定位资源的入口。

3)   lib和classes同属classpath,两者的访问优先级为: lib>classes。

2.使用方法,案例

package com.log4j2;  
  
import org.apache.logging.log4j.Logger;  
import org.apache.logging.log4j.LogManager;  
  
public class test {  
  
    static Logger logger = LogManager.getLogger(test.class.getName());  
      
    public static boolean hello(){  
        logger.trace("entry");  //等同于logger.entry();但此方法在新版本好像已经废弃  
          
        logger.error("Did it again!");  
          
        logger.info("这是info级信息");  
  
        logger.debug("这是debug级信息");  
          
        logger.warn("这是warn级信息");  
          
        logger.fatal("严重错误");  
          
        logger.trace("exit");  
          
        return false;  
    }  
      
    public static void main(String[] args) {  
          
        logger.trace("开始主程序");  
          
        for(int i = 0; i < 10000; i++){  
            logger.info("当前i:"+i);  
            if(!test.hello()){  
                logger.error("hello");  
            }  
        }  
          
        logger.trace("退出程序");  
    }  
}  
log4j2.xml配置
<?xml version="1.0" encoding="UTF-8"?>    
<configuration status="error">  
<!--     先定义所有的appender -->  
    <appenders>  
<!--         这个输出控制台的配置 -->  
        <Console name="Console" target="SYSTEM_OUT">  
<!--             控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch) -->  
            <ThresholdFilter level="trace" onMatch="ACCEPT" onMismatch="DENY"/>  
<!--             这个都知道是输出日志的格式 -->  
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>  
        </Console>  
          
<!--         文件会打印出所有信息,这个log每次运行程序会自动清空,由append属性决定,这个也挺有用的,适合临时测试用 -->  
<!--         append为TRUE表示消息增加到指定文件中,false表示消息覆盖指定的文件内容,默认值是true -->  
        <File name="log" fileName="log/test.log" append="false">  
            <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>  
        </File>  
          
<!--          添加过滤器ThresholdFilter,可以有选择的输出某个级别以上的类别  onMatch="ACCEPT" onMismatch="DENY"意思是匹配就接受,否则直接拒绝  -->  
        <File name="ERROR" fileName="logs/error.log">  
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>  
            <PatternLayout pattern="%d{yyyy.MM.dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>  
        </File>  
  
<!--         这个会打印出所有的信息,每次大小超过size,则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩,作为存档 -->  
        <RollingFile name="RollingFile" fileName="logs/web.log"  
                     filePattern="logs/$${date:yyyy-MM}/web-%d{MM-dd-yyyy}-%i.log.gz">  
            <PatternLayout pattern="%d{yyyy-MM-dd 'at' HH:mm:ss z} %-5level %class{36} %L %M - %msg%xEx%n"/>  
            <SizeBasedTriggeringPolicy size="2MB"/>  
        </RollingFile>  
    </appenders>  
      
<!--     然后定义logger,只有定义了logger并引入的appender,appender才会生效 -->  
    <loggers>  
<!--         建立一个默认的root的logger -->  
        <root level="trace">  
            <appender-ref ref="RollingFile"/>  
            <appender-ref ref="Console"/>  
            <appender-ref ref="ERROR" />  
            <appender-ref ref="log"/>  
        </root>  
  
    </loggers>  
</configuration> 

上面的为java对应的配置和事例

下面好戏开始:

scala使用log4j2需要引入两个原始jar包和一个与scala关联的jar包
分别为: log4j-core,log4j-api,log4j-api-scala_2.11三个包

pom.xml文件配置如下:

<dependency>
	<groupId>org.apache.logging.log4j</groupId>
	<artifactId>log4j-api-scala_${scala.binary.version}</artifactId>
	<version>11.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core -->
<dependency>
	<groupId>org.apache.logging.log4j</groupId>
	<artifactId>log4j-core</artifactId>
	<version>2.10.0</version>
</dependency>
<dependency>
	<groupId>org.apache.logging.log4j</groupId>
	<artifactId>log4j-api</artifactId>
	<version>2.10.0</version>
</dependency>
1.引入之后在scala object 类和包中引用时看官网给的例子是extends base with logging ,后来才知道with是scala中多继承使用的关键字
也就是说使用时直接在类名或者object 名后加上extends logging就可以了。
2.然后在下面的方法中使用logger.debug("信息") 或者 error,warn等就可以了。


其中一部分转自大神的:Log4J2入门·配置详解

https://blog.csdn.net/womeng2009/article/details/53510913


阅读更多

没有更多推荐了,返回首页