springboot实现将自定义日志格式存储到mongodb中

下面是关于“Spring Boot实现将自定义日志格式存储到MongoDB中”的完整攻略：

1. 准备工作

在开始操作之前，需要先安装相关软件和工具：

• JDK：Java开发环境，需要安装1.8及以上版本；
• MongoDB：一个NoSQL数据库，用于存储日志数据；
• Maven：Java项目管理工具，用于构建项目。

2. 创建Spring Boot项目

使用Spring Initializr快速构建Spring Boot项目，选择需要的依赖项，点击生成按钮后导入IDE，等待项目构建完成。

3. 添加依赖项

在pom.xml文件中添加以下依赖项：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>6.6</version>
</dependency>

其中，第一个依赖项是Spring Data MongoDB的依赖，用于在Spring应用程序中使用MongoDB。第二个依赖项是logstash-logback-encoder，它是一个用于logback库的Logstash编码器，用于将日志编码为JSON格式。

4. 配置日志格式

在application.yml文件中配置日志格式，例如：

logging:
  pattern:
    console: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"

其中，logging.pattern.console配置控制台输出的日志格式，上面的配置将输出时间、线程、日志级别、类名和日志消息。

5. 配置应用程序属性

在application.yml文件中配置应用程序属性，例如：

spring:
  data:
    mongodb:
      uri: mongodb://localhost:27017/test
      database: logs
      auto-index-creation: true
logging:
  file:
    name: logs/app.log
    pattern: "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"
  level:
    root: INFO

其中，spring.data.mongodb.uri是MongoDB的连接字符串，用于连接MongoDB数据库；spring.data.mongodb.database是指数据库名称，这里设置为“logs”；spring.data.mongodb.auto-index-creation设置为true，允许自动创建索引。

logging.file.name配置日志文件的路径和名称，logging.file.pattern配置日志文件的格式，logging.level.root设置日志的输出级别。

6. 编写日志处理程序

编写一个名为“AppLoggingAspect”的Java类作为日志处理程序，将日志记录到MongoDB中。

package com.example.demo;

import java.util.Date;
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.stereotype.Component;

@Component
@Aspect
public class AppLoggingAspect {

  private static final Logger LOGGER = LoggerFactory.getLogger(AppLoggingAspect.class);

  @Autowired
  private MongoTemplate mongoTemplate;

  @Pointcut("within(@org.springframework.stereotype.Controller *) || within(@org.springframework.web.bind.annotation.RestController *)")
  public void controller() {
  }

  @AfterReturning(pointcut = "controller()", returning = "result")
  public void log(final JoinPoint joinPoint, final Object result) throws Throwable {
    LOGGER.info("Method:[{}], Result:[{}], Time:[{}]", joinPoint.getSignature().getName(),
        result, new Date());
    Log log = new Log(joinPoint.getSignature().getName(), result.toString(), new Date());
    mongoTemplate.save(log);
  }

}

在这个类中，使用了AOP编程，该程序会在Spring应用程序中所有注解了@Controller和@RestController类的方法执行后记录日志。作为日志记录的实例，创建了一个名为“Log”的数据模型，如下所示：

package com.example.demo;

import java.util.Date;
import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;

@Document(collection = "logs")
public class Log {

  @Id
  private String id;

  private String method;

  private String result;

  private Date date;

  public Log() {
  }

  public Log(final String method, final String result, final Date date) {
    this.method = method;
    this.result = result;
    this.date = date;
  }

  public String getId() {
    return id;
  }

  public void setId(final String id) {
    this.id = id;
  }

  public String getMethod() {
    return method;
  }

  public void setMethod(final String method) {
    this.method = method;
  }

  public String getResult() {
    return result;
  }

  public void setResult(final String result) {
    this.result = result;
  }

  public Date getDate() {
    return date;
  }

  public void setDate(final Date date) {
    this.date = date;
  }

  @Override
  public String toString() {
    return "Log{" +
        "id='" + id + '\'' +
        ", method='" + method + '\'' +
        ", result='" + result + '\'' +
        ", date=" + date +
        '}';
  }

}

该数据模型包含了一些基本属性，如方法名称、方法返回结果、时间等。

7. 运行项目

在命令行中输入“mvn spring-boot:run”命令运行Spring Boot项目，在控制台上可以看到实时输出的日志信息，同时该信息也会存储到MongoDB中。

示例说明

示例一：

首先，访问网站的主页，浏览器上会出现如下内容：

Hello, world!

此时，在项目的控制台上会输出下面的日志信息：

2021-11-05 14:42:07.245 [http-nio-8080-exec-1] INFO  com.example.demo.AppLoggingAspect - Method:[index], Result:[Hello, world!], Time:[Fri Nov 05 14:42:07 CST 2021]

此时，MongoDB中会保存一条日志记录，包含了方法名称、方法返回结果和时间信息。

示例二：

在浏览器上访问以下URL：

http://localhost:8080/hello/world

此时，项目会返回一个字符串：

Hello, world!

同时，在控制台和MongoDB中都会保存日志信息。