log4j.properties详解加日志规范

java常用日志框架

Log4j Apache Log4j是一个基于Java的日志记录工具。它是由Ceki Gülcü首创的，现在则是Apache软件基金会的一个项目。 Log4j是几种Java日志框架之一
Log4j 2 Apache Log4j 2是apache开发的一款Log4j的升级产品
Commons Logging Apache基金会所属的项目，是一套Java日志接口，之前叫Jakarta Commons Logging，后更名为Commons Logging
Slf4j 类似于Commons Logging，是一套简易Java日志门面，本身并无日志的实现。（Simple Logging Facade for Java，缩写Slf4j）
Logback 一套日志组件的实现(slf4j阵营)
Jul (Java Util Logging),自Java1.4以来的官方日志实现。

在src下建立 log4j.properties，其内容如下

#设置日志级别和输出端别名
log4j.rootLogger=INFO,console,fil
#设置输出端为“控制台”，以下是此输出端的具体定
log4j.appender.console=org.apache.log4j.ConsoleAppender
设置布局模式为“灵活布局”
log4j.appender.console.layout=org.apache.log4j.PatternLayout
#设置日志信息的输出格式
log4j.appender.console.layout.ConversionPattern=%d %5p [%t] (%F:%L) - %m%
设置输出端为“日志文件”，以下是此输出端的具体定义
log4j.appender.file=org.apache.log4j.FileAppender
设置日志文件存放的路径
log4j.appender.file.File=src/log.txt
#设置日志文件最大容量为2KB，最好结合RollingFileAppender使用
#log4j.appender.file.MaxFileSize=2KB
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d %5p [%t] (%F:%L) - %m%n

设置日志级别和输出端别名

ERROR 为严重错误 主要是程序的错误
WARN 为一般警告，比如session丢失
INFO 为一般要显示的信息，比如登录登出
DEBUG 为程序的调试信息
log4j.rootLogger=INFO,console,fil

设置输出端为“控制台”，以下是此输出端的具体定

org.apache.log4j.ConsoleAppender（控制台)

1. Threshold=WARN:指定日志消息的输出最低层次。
2. ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
3. Target=System.err：默认情况下是：System.out,指定输出控

org.apache.log4j.FileAppender（文件）

1. Threshold=WARN:指定日志消息的输出最低层次。
2. ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
3. File=mylog.txt:指定消息输出到mylog.txt文件
4. Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件）

1. Threshold=WARN:指定日志消息的输出最低层次。
2. ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
3. File=mylog.txt:指定消息输出到mylog.txt文件。
4. Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
5. DatePattern=’.‘yyyy-ww:每周滚动一次文件，即每周产生一个新的文件。当然也可以指定按月、周、天、时和分。即对应的格式如下
   1)’.‘yyyy-MM:每月
   2)’.‘yyyy-ww:每周
   3)’.‘yyyy-MM-dd:每天
   4)’.‘yyyy-MM-dd-a:每天两次
   5)’.‘yyyy-MM-dd-HH:每小时
   6)’.'yyyy-MM-dd-HH-mm:每分钟

org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）

1. Threshold=WARN:指定日志消息的输出最低层次。
2. ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
3. File=log.txt:指定消息输出到log.txt文件。
4. Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
5. MaxFileSize=100KB:后缀可以是KB, MB 或者是
   GB.在日志文件到达该大小时，将会自动滚动，即将原来的内容移到log.log.1文件
6. MaxBackupIndex=2:指定可以产生的滚动文件的最大数

org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
log4j.appender.console=org.apache.log4j.ConsoleAppender

设置布局模式为“灵活布局”

org.apache.log4j.HTMLLayout（以HTML表格形式布局）

1. LocationInfo=true:默认值是false,输出java文件名称和行号
2. Title=my app file:默认值是 Log4J Log Messages.

org.apache.log4j.PatternLayout（可以灵活地指定布局模式）
ConversionPattern=%m%n :指定怎样格式化指定的消息。
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串）
LocationInfo=true:默认值是false,输出java文件和行号
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
log4j.appender.console.layout=org.apache.log4j.PatternLayout

设置日志信息的输出格式

这里需要说明的就是日志信息格式中几个符号所代表的含义：
－X号: X信息输出时左对齐；
%p:输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,
%d:输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM ddHH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%r:输出自应用启动到输出该log信息耗费的毫秒数
%c:输出日志信息所属的类目，通常就是所在类的全名
%t:输出产生该日志事件的线程名
%l:输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog.main(TestLog.java:10)
%x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
%%:输出一个"%“字符
%F:输出日志消息产生时所在的文件名称
%L:输出代码中的行号
%m:输出代码中指定的消息,产生的日志具体信息
%n:输出一个回车换行符，Windows平台为”\r\n"，Unix平台为"\n"输出日志信息换
可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。
2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，"-"号指定左对齐。
3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。
4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边交远销出的字符截掉。
log4j.appender.console.layout.ConversionPattern=%d %5p [%t] (%F:%L) - %m%
设置输出端为“日志文件”，以下是此输出端的具体定义
log4j.appender.file=org.apache.log4j.FileAppender
设置日志文件存放的路径
log4j.appender.file.File=src/log.txt
设置日志文件最大容量为2KB，最好结合RollingFileAppender使用
log4j.appender.file.MaxFileSize=2KB
log4j.appender.file.layout=org.apache.log4j.PatternLayout
log4j.appender.file.layout.ConversionPattern=%d %5p [%t] (%F:%L) - %m%n

日志API规范

Log对象的声明和初始化

private static final Logger logger = LoggerFactory.getLogger(Xxx.class);

不得使用System.out, System.err,e.printStackTrace()进行日志记录，请改使用logger.debug、logger.error

错误的日志输出方法会丢失掉最重要的StackTrace信息，正确的记录异常信息

try {  
    ......
} catch (Exception e) 
    log.error(e);   //错误  
    log.error(e, e); //错误    
    log.error(""+ e);  //错误    
    log.error(e.toString());  //错误   
    log.error(e.getMessage());  //错误     
    log.error(null, e);  //错误     
    log.error("", e);   //不可取   
    log.error("{}", e);   //错误    
    log.error("{}", e.getMessage());     //错误
    log.error("Log error message:" + 入参传入值, e)； //强烈推荐方法
}