Java Spring boot结合Log4j将日志存入数据库中

一、介绍

Log4j是Apache的一个开源项目，通过使用Log4j，我们可以控制日志信息输送的目的地是控制台、文件、GUI组件，甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；我们也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，我们能够更加细致地控制日志的生成过程。最令人感兴趣的就是，这些可以通过一个配置文件来灵活地进行配置，而不需要修改应用的代码。

二、定义

• log4j–log for java(java的日志)

  在强调可重用组件开发的今天，除了自己从头到尾开发一个可重用的日志操作类外，Apache为我们提供了一个强有力的日志操作包-Log4j。
  此外，通过Log4j其他语言接口，您可以在C、C++、.Net、PL/SQL程序中使用Log4j，其语法和用法与在Java程序中一样，使得多语言分布式系统得到一个统一一致的日志组件模块。而且，通过使用各种第三方扩展，您可以很方便地将Log4j集成到J2EE、JINI甚至是SNMP应用中。

下面分为三部分

• 第一部分讲解如何配置log4j；
• 第二部分为对log4j.properties配置文件中的各个属性的讲解；
• 第三部分为对log4j的详细讲解。

如果只想配置上log4j，那么只需要看前两个部分就可以，如果想对log4j深入了解，则还需看第三部分。

三、说明

1、log4j.rootCategory=INFO, stdout , R

此句为将等级为INFO的日志信息输出到stdout和R这两个目的地，stdout和R的定义在下面的代码，可以任意起名。等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL，如果配置OFF则不打出任何信息，如果配置为INFO这样只显示INFO、WARN、ERROR的log信息，而DEBUG信息不会被显示，具体讲解可参照第三部分定义配置文件中的logger。

2、log4j.appender.stdout=org.apache.log4j.ConsoleAppender
此句为定义名为stdout的输出端是哪种类型，可以是

- org.apache.log4j.ConsoleAppender（控制台），
- org.apache.log4j.FileAppender（文件），
- org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
- org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件）
- org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

3、log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
此句为定义名为stdout的输出端的layout是哪种类型，可以是

- org.apache.log4j.HTMLLayout（以HTML表格形式布局），
- org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
- org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
- org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

4、log4j.appender.stdout.layout.ConversionPattern= [QC] %p [%t] %C.%M(%L) | %m%n
如果使用pattern布局就要指定的打印信息的具体格式ConversionPattern，打印参数如下：

• %m 输出代码中指定的消息；
• %M 输出打印该条日志的方法名；
• %p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL；
• %r 输出自应用启动到输出该log信息耗费的毫秒数；
• %c 输出所属的类目，通常就是所在类的全名；
• %t 输出产生该日志事件的线程名；
• %n 输出一个回车换行符，Windows平台为"rn”，Unix平台为"n”；
• %d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyyy-MM-dd HH:mm:ss,SSS}，输出类似：2002-10-18 22:10:28,921；
• %l 输出日志事件的发生位置，及在代码中的行数；
  [QC]是log信息的开头，可以为任意字符，一般为项目简称。
  输出的信息
  [TS] DEBUG [main] AbstractBeanFactory.getBean(189) | Returning cached instance of singleton bean ‘MyAutoProxy’

5、log4j.appender.R=org.apache.log4j.DailyRollingFileAppender

• 此句与第3行一样。定义名为R的输出端的类型为每天产生一个日志文件。

6、log4j.appender.R.File=D:\Tomcat 5.5\logs\qc.log

此句为定义名为R的输出端的文件名为D:\Tomcat 5.5\logs\qc.log可以自行修改。

7、log4j.appender.R.layout=org.apache.log4j.PatternLayout
与第4行相同。

8、log4j.appender.R.layout.ConversionPattern=%d-[TS] %p %t %c - %m%n
与第5行相同。

9、log4j.logger.com. neusoft =DEBUG

指定com.neusoft包下的所有类的等级为DEBUG。 可以把com.neusoft改为自己项目所用的包名。

10、log4j.logger.com.opensymphony.oscache=ERROR
11、log4j.logger.net.sf.navigator=ERROR

这两句是把这两个包下出现的错误的等级设为ERROR，如果项目中没有配置EHCache，则不需要这两句。

12、log4j.logger.org.apache.commons=ERROR
13、log4j.logger.org.apache.struts=WARN

这两句是struts的包。

14、log4j.logger.org.displaytag=ERROR

这句是displaytag的包。（QC问题列表页面所用）

15、log4j.logger.org.springframework=DEBUG

此句为Spring的包。

16、log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN
17、log4j.logger.org.hibernate=DEBUG

此两句是hibernate的包。

以上这些包的设置可根据项目的实际情况而自行定制。

四、配置

第一步

1. 加入log4j-1.2.8.jar(可以选择log4j的更高版本)到lib下。
2. 如果使用maven项目，也可以选择在pom.xml中新增依赖：

<!-- log4j相关配置 Start-->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
        <version>1.2.17</version>
    </dependency>
    <!-- log4j相关配置 End-->

第二步

在resources下添加log4j.properties文件

1、核心代码块：

# log4j 日志系统： 将日志内容插入到数据库
# Define the root logger with appender file
log4j.rootLogger=DEBUG, DB, console
# Define the DB appender
log4j.appender.DB=org.apache.log4j.jdbc.JDBCAppender
# Set JDBC URL
# log4j.appender.DB.URL=jdbc:mysql://127.0.0.1/log4j?useUnicode=true&characterEncoding=utf8
log4j.appender.DB.URL=jdbc:mysql://localhost:3306/数据库名?useUnicode=true&characterEncoding=utf-8&serverTimezone=CTT
# Set Database Driver
log4j.appender.DB.driver=com.mysql.cj.jdbc.Driver
# Set DataBase user name and password
log4j.appender.DB.user=root
log4j.appender.DB.password=数据库密码
# Set the SQL statement to be executed.
log4j.appender.DB.sql=INSERT INTO system_log(User_Name, User_Ip, Log_Generate_Class, Log_Create, Log_Method,log_level,Log_Message) VALUES('%X{userId}','%X{userIP}','%c','%d{yyyy-MM-dd hh:mm:ss}','%m','%p','%msg')
# log4j.appender.DB.sql=INSERT INTO logs VALUES('%x', '%d{yyyy-MM-dd HH:mm:ss}', '%C', '%p', '%m')
# Define the layout for file appender
log4j.appender.DB.layout=org.apache.log4j.PatternLayout
# 将日志输出到控制台
log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=[%d{yyyy-MM-dd HH:mm:ss}]-[%t]-[%F:%L]-[%p]-[%c]-%m%n
log4j.appender.console.encoding=UTF-8

第三步

在控制器中加入日志方法

1）引入org.apache.log4j

2）声明方法

 private static Logger log= Logger.getLogger(类名称.class);

3）用户登录加入日志信息

@PostMapping("/login")
@ApiOperation(value = "用户登录")
public Result Login(@RequestParam String username, @RequestParam String password)
{
    //获取用户信息
    SystemUser user=userService.getUserByPass(username, password);
    if(user == null){
        return Result.Failure(ResultCodeEnum.User_Login_Error);
    }
    String token= TokenUtil.sign(user);
    log.info("用户"+user.getName()+"登录系统");
    return Result.Success(token);
}

4）控制台输出结果

5）数据库

五、数据库脚本

DROP TABLE IF EXISTS `system_log`;
CREATE TABLE `system_log`  (
  `Id` int NOT NULL AUTO_INCREMENT COMMENT '主键ID',
  `Log_Message` text CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL COMMENT '日志内容',
  `Log_Level` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '日志级别',
  `Log_Generate_Class` varchar(500) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '日志发生类',
  `Log_Create` datetime NULL DEFAULT NULL COMMENT '日志生成时间',
  `Log_Method` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '日志发生方法',
  `User_Ip` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '用户IP',
  `User_Name` varchar(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '用户名称',
  PRIMARY KEY (`Id`) USING BTREE
) ENGINE = InnoDB AUTO_INCREMENT = 4 CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci COMMENT = '日志表' ROW_FORMAT = Dynamic;

SET FOREIGN_KEY_CHECKS = 1;

六、总结

操作日志可以这样弄，但是建议分表处理不同的级别，因为日志文件后面数据量会非常大，系统级日志建议存log文件即可。

如果本文对你有用的话，麻烦点个赞，分享、收藏支持一下博主呢！