1.日志概述
日志是什么
日志: 用于记录程序各项操作的文件集合 。取代System.out
打印异常。
为什么会有日志
1、问题追溯,通过日志文件的记录,快速查找问题根源。
2、状态检测,检测我们系统状况,为项目出现的问题做好预警。
3、安全审计
2.log4j概述
什么是log4j
- Log4j是Apache旗下的一款开源的日志框架。
- 通过在项目中使用 Log4J,我们可以控制日志信息输出位置、格式、以及输出的过程。
- 输出位置:控制台、文件、甚至是数据库中。
- 输出过程:通过定义日志的输出级别,可以更灵活的控制日志的输出过程
版本
- log4j的结构、性能被很多新的日志框架所替代。
- 在设计结构上比不上slf4j,
- 在性能上比不上logback
- 所以apache对log4j进行了重构, 为了方便区分他们,给了两个别名:log4j1、log4j2
log4j1
log4j2有两部分组成:log4j-api、log4j-core。
log4j-api和slf4j是相同的,都是日志门面
log4j-core是对log4j-api的实现,和log4j1、logback是相同的
3.log4j入门案例
步骤
- 拷贝坐标
- 拷贝配置文件:
log4j.properties
- 编程测试类
实现
拷贝坐标
<dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency>
拷贝配置文件:log4j.properties
【注意】需要idea设置对properties文件的中文支持
# 2. 输出格式 ## log4j.appender.名称=输出位置(固定值,由log4j提供) ## log4j.appender.名称.Target=方式 ## log4j.appender.名称.layout=布局(固定值) ## log4j.appender.名称.layout.ConversionPattern=格式 # 2.1 将日志输出到控制台 log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.Target=System.out log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c:%L - %m%n # 2.2 将日志输出到文件 log4j.appender.file=org.apache.log4j.FileAppender log4j.appender.file.File=d:/file.log log4j.appender.file.Append=false log4j.appender.file.layout=org.apache.log4j.PatternLayout log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c:%L - %m%n #1.log4j.rootLogger=日志级别, 输出方式1, 输出方式2, ... ## 日志级别:debug、info、warn、error log4j.rootLogger=trace, stdout, file # 3 自定义日志级别 ## log4j.logger.包=日志级别 #log4j.logger.com.ibatis = debug #log4j.logger.com.ibatis.common.jdbc.SimpleDataSource = debug #log4j.logger.com.ibatis.common.jdbc.ScriptRunner = debug #log4j.logger.com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate = debug #log4j.logger.java.sql.Connection = debug #log4j.logger.java.sql.Statement = debug #log4j.logger.java.sql.PreparedStatement = debug #log4j.logger.java.sql.ResultSet =debug log4j.logger.org.apache.ibatis.transaction = info log4j.logger.org.apache.ibatis.io = info log4j.logger.org.apache.ibatis.datasource = info log4j.logger.org.apache.ibatis.logging = info
编程测试类:TestLog4j
package com.czxy.log; import org.apache.log4j.Logger; /** * @author 桐叔 * @email liangtong@itcast.cn * @description */ public class TestLog4j { private static Logger logger = Logger.getLogger(TestLog4j.class); public static void main(String[] args) { logger.trace("追踪"); logger.debug("调试"); logger.info("信息"); logger.warn("警告"); logger.error("错误"); logger.fatal("致命"); } }
总结
- log4j 包括三个主要部件:
- 记录器 Loggers: 用于设置日志级别与输出源
- 输出源 Appenders: 日志要输出的地方
- 布局 Layouts: 日志输出格式
4.log4j1详情:记录器rootLogger
1. #log4j.rootLogger=日志级别, 输出源1, 输出源2, ... 2. log4j.rootLogger=trace, stdout, file
5.log4j1详情:日志级别
- 日志级别:用于控制程序日志输出内容,不同的级别对应不同的方法。
- log4j定义了8个级别的log(除去OFF和ALL,可以说分为6个级别)
级别 Level | 描述 |
ALL | 特殊级别:最低等级的,用于打开所有日志记录 |
TRACE | 指定细粒度比DEBUG更低的信息事件 |
DEBUG | 细粒度信息事件。显示应用程序==调试==相关。 |
INFO | 粗粒度级别,强调程序的运行情况。显示应用程序运行==信息==相关。 |
WARN | 具有潜在危害。显示应用程序==警告==相关。 |
ERROR | 错误事件可能仍然允许应用程序继续运行。显示应用程序==错误==相关。 |
FATAL | 指定非常严重的错误事件,这可能导致应用程序中止。显示应用程序==致命==相关。 |
OFF | 特殊级别:最高等级的,用于关闭所有日志记录 |
优先级从低到高依次为: ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF
如果将log level设置在某一个级别上,那么比此级别优先级高的log都能打印出来。
例如:如果设置优先级为WARN,那么OFF、FATAL、ERROR、WARN 4个级别的log能正常输出
一般只使用4个级别,优先级从高到低为 ERROR > WARN > INFO > DEBUG
6个日志级别,对应Java Logger类的6个方法
6.log4j1详情:输出源appender
ConsoleAppender
# 将日志输出到控制台 log4j.appender.stdout=org.apache.log4j.ConsoleAppender log4j.appender.stdout.Target=System.out log4j.appender.stdout.layout=org.apache.log4j.PatternLayout log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c:%L - %m%n
- 常见属性:
- Target:以什么方式输出到控制台。
- 取值:System.out、System.err
- 默认值:System.out
FileAppender
# 将日志输出到文件 log4j.appender.file=org.apache.log4j.FileAppender log4j.appender.file.File=d:/file.log log4j.appender.file.Append=false log4j.appender.file.layout=org.apache.log4j.PatternLayout log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c:%L - %m%n
- 常见属性:
- file:消息输出文件所在位置
- Append:消息是否追加到指定的文件。
- true:将消息追加到指定文件,默认值。
- false:将消息覆盖指定的文件
DailyRollingFileAppender
# 每日输出到一个新文件 log4j.appender.daily=org.apache.log4j.DailyRollingFileAppender log4j.appender.daily.File=d:/daily.log log4j.appender.daily.Append=true log4j.appender.daily.DatePattern='-'yyyy-MM-dd-HH-mm'.log' log4j.appender.daily.layout=org.apache.log4j.PatternLayout log4j.appender.daily.layout.ConversionPattern=%d{ABSOLUTE} %5p %c:%L - %m%n
常见属性:
DatePattern: 配置回滚文件的后缀格式
'.'yyyy-MM:对应monthly(每月)
'.'yyyy-ww:对应weekly(每周)
'.'yyyy-MM-dd:对应daily(每天)
'.'yyyy-MM-dd-a:对应half-daily(每半天)
'.'yyyy-MM-dd-HH:对应hourly(每小时)
'.'yyyy-MM-dd-HH-mm:对应minutely(每分钟)
JDBCAppender
准备工作:
- 创建表:
CREATE TABLE `log` ( `log_id` INT(11) NOT NULL AUTO_INCREMENT, `project_name` VARCHAR(255) DEFAULT NULL COMMENT '目项名', `create_date` VARCHAR(255) DEFAULT NULL COMMENT '创建时间', `level` VARCHAR(255) DEFAULT NULL COMMENT '优先级', `category` VARCHAR(255) DEFAULT NULL COMMENT '所在类的全名', `file_name` VARCHAR(255) DEFAULT NULL COMMENT '输出日志消息产生时所在的文件名称 ', `thread_name` VARCHAR(255) DEFAULT NULL COMMENT '日志事件的线程名', `line` VARCHAR(255) DEFAULT NULL COMMENT '号行', `all_category` VARCHAR(255) DEFAULT NULL COMMENT '日志事件的发生位置', `message` VARCHAR(4000) DEFAULT NULL COMMENT '输出代码中指定的消息', PRIMARY KEY (`log_id`) );
添加坐标
<dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.32</version> </dependency>
log4j 配置
# 2.4 输出到数据库 log4j.appender.database=org.apache.log4j.jdbc.JDBCAppender log4j.appender.database.URL=jdbc:mysql://localhost:3306/test log4j.appender.database.driver=com.mysql.jdbc.Driver log4j.appender.database.user=root log4j.appender.database.password=1234 log4j.appender.database.Sql=INSERT INTO log(project_name,create_date,level,category,file_name,thread_name,line,all_category,message) values('czxy','%d{yyyy-MM-dd HH:mm:ss}','%p','%c','%F','%t','%L','%l','%m') log4j.appender.database.layout=org.apache.log4j.PatternLayout
常见属性:
url:数据库连接
driver:数据库驱动
user:数据库账号
password:数据库密码
sql:添加日志时执行的插入语句。与值为PatternLayout提供
7.log4j1详情:布局layout
- 布局器 Layouts用于控制日志输出内容的格式
实现类 | 描述 |
org.apache.log4j.HTMLLayout | 以HTML表格形式布局 |
org.apache.log4j.PatternLayout | 可以灵活地指定布局模式 |
org.apache.log4j.SimpleLayout | 包含日志信息的级别和信息字符串 |
org.apache.log4j.TTCCLayout | 包含日志产生的时间、线程、类别等等信息 |
HTMLLayout
# 2.5 将日志以html输出到控制台 log4j.appender.html=org.apache.log4j.ConsoleAppender log4j.appender.html.Target=System.out log4j.appender.html.layout=org.apache.log4j.HTMLLayout log4j.appender.html.layout.title=这是页面标题 log4j.appender.html.layout.locationInfo=false
- 常见属性:
- LocationInfo:输出java文件名称和行号,默认值是false。
- Title:设置html文件标题, 默认值是Log4J Log Messages。
PatternLayout
通过PatternLayout实现类ConversionPattern属性可以设置具体自定义布局。布局格式采用类似 C语言的 printf 函数的打印格式
log4j.appender.file.layout=org.apache.log4j.PatternLayout log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c:%L - %m%n
具体的占位符及其含义
占位符 | 含义 |
%m | 输出代码中指定的日志信息 |
%p | 输出优先级,及 DEBUG、INFO 等 |
%n | 换行符(Windows平台的换行符为 "\r\n",Unix 平台为 "\n") |
%r | 输出自应用启动到输出该 log 信息耗费的毫秒数 |
%c | 输出打印语句所属的类的全名 |
%t | 输出产生该日志的线程全名 |
%d | 输出服务器当前时间,默认为 ISO8601,也可以指定格式, %d{yyyy年MM月dd日HH:mm:ss} 显示指定的日期格式 %d{ABSOLUTE} 显示时分秒毫秒 |
%l | 输出日志时间发生的位置,包括类名、线程、及在代码中的行数。 如:Test.main(Test.java:10) |
%F | 输出日志消息产生时所在的文件名称 |
%L | 输出代码中的行号 |
%% | 输出一个 "%" 字符 |
可以在 % 与字符之间加上修饰符来控制最小宽度、最大宽度和文本的对其方式
%5c | 输出category名称,最小宽度是5,category<5,默认的情况下右对齐 |
%-5c | 输出category名称,最小宽度是5,category<5,"-"号指定左对齐,会有空格 |
%.5c | 输出category名称,最大宽度是5,category>5,就会将左边多出的字符截掉,<5不会有空格 |
%20.30c | category名称<20补空格,并且右对齐,>30字符,就从左边交远销出的字符截掉 |
EnhancedPatternLayout
# 2.6 增强版自定义布局 log4j.appender.enhanced=org.apache.log4j.ConsoleAppender log4j.appender.enhanced.Target=System.out log4j.appender.enhanced.layout=org.apache.log4j.EnhancedPatternLayout log4j.appender.enhanced.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1.}:%L - %m%n
8.log4j1详情:自定义记录器
基本语法
1. #自定义日志级别 2. log4j.logger.包=日志级别
需求
默认效果:
自定义效果:
基本结构
编写DemoMapper
package com.czxy.log.demo.mapper; import org.apache.log4j.Logger; /** * @author 桐叔 * @email liangtong@itcast.cn * @description */ public class DemoMapper { private static Logger logger = Logger.getLogger(DemoMapper.class); public void find() { logger.debug("mapper debug"); logger.info("mapper info"); logger.warn("mapper warn"); logger.error("mapper error"); System.out.println("查询 mapper"); } }
编写DemoService
package com.czxy.log.demo.service; import com.czxy.log.demo.mapper.DemoMapper; import org.apache.log4j.Logger; /** * @author 桐叔 * @email liangtong@itcast.cn * @description */ public class DemoService { private DemoMapper demoMapper = new DemoMapper(); private static Logger logger = Logger.getLogger(DemoService.class); public void find() { logger.debug("service debug"); logger.info("service info"); logger.warn("service warn"); logger.error("service error"); System.out.println("查询service"); demoMapper.find(); } }
编写TestDemo
package com.czxy.log.demo; import com.czxy.log.demo.service.DemoService; /** * @author 桐叔 * @email liangtong@itcast.cn * @description */ public class TestDemo { public static void main(String[] args) { DemoService demoService = new DemoService(); demoService.find(); } }
自定义日志级别
#log4j.logger.包=日志级别 log4j.logger.com.czxy.log.demo.mapper = warn log4j.logger.com.czxy.log.demo.service = info