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

步骤如下

首先定义封装所需要的日志信息的实体类

public class MyLog {
       //根据需要定义字段
        @Id
        private String id;
        private Date ts;
        private String level;
        private String msg;
        private String thread;
       
       //属性的get/set方法（略）
}

定义操作mongodb的接口

@Repository
   public interface LogRepository extends MongoRepository<MyLog, String>{
}

定义一个MongoDBAppender继承UnsynchronizedAppenderBase

@Component
Public class MongoDBAppender extends UnsynchronizedAppenderBase<LoggingEvent> implements ApplicationContextAware{
private static LogRepository logRepository;
protected void append(LoggingEvent e){
       MyLog myLog = new MyLog();
       myLog.setLevel(e.getLevel().toString());
       myLog.setMsg(e.getFormattedMessage());
       myLog.setThread(e.getThreadName());
       myLog.setTs(new Date(e.getTimeStamp()));
       logRepository.save(myLog);
}
 
Public void setApplicationContext(ApplicationContext applicationContext) {
        if (applicationContext.getAutowireCapableBeanFactory()
                .getBean(LogRepository.class) != null) {
            logRepository = (LogRepository) applicationContext
                 .getAutowireCapableBeanFactory()
                 .getBean(LogRepository.class);
        }
}
}

以上是java代码部分

下面就是自定义日志文件logback.xml的配置了

<?xml version="1.0" encoding="UTF-8"?>
<configuration >
   <contextName>logback</contextName>
   <!—设置变量：输出格式 -->
   <property name="log.format" value="%d [%thread] %-5level %logger{68} %line - logId[[%X{client}][%X{request_id}]] - %msg%n"/>
   <!-- 输出到控制台 -->
   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <charset>UTF-8</charset>
            <pattern>${log.format}</pattern>
        </encoder>
    </appender>
  <!--输出到mongodb中-->  
    <appender name="MONGODB" class="cn.mis.mongo.appender.MongoDBAppender">
  </appender>  
    
 <root level="INFO">
         <appender-ref ref="STDOUT" />
         <appender-ref ref="MONGODB" />
     </root>
<logger name="com.mis.mongo.controller.DemoController"
level="WARN" additivity="false">
        <appender-ref ref=" MONGODB "/>
         </logger>  
</configuration>

下面简要的介绍一下自定义日志配置文件中的内容

首先介绍一下日志选型的原因

Spring Boot在所有内部日志中使用Commons Logging，但是默认配置也提供了对常用日志的支持，如：Java Util Logging，Log4J, Log4J2和Logback。每种Logger都可以通过配置使用控制台或者文件输出日志内容。

Logback是log4j框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持SLF4J。SpringBoot默认使用Logback。

自定义日志配置

由于日志服务一般都在ApplicationContext创建前就初始化了，它并不是必须通过Spring的配置文件控制。因此通过系统属性和传统的Spring Boot外部配置文件依然可以很好的支持日志控制和管理。

根据不同的日志系统，你可以按如下规则组织配置文件名，就能被正确加载：

Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项（下面会提到）。

根节点<configuration>包含的属性

scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。

scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。

debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。

根节点<configuration>的子节点：

<configuration>下面一共有2个属性，3个子节点，分别是：

属性一：设置上下文名称<contextName>

每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改,可以通过%contextName来打印日志上下文名称。

属性二：设置变量<property>

用来定义变量值的标签，有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量

子节点一<appender>

appender用来格式化日志输出节点，有俩个属性name和class，class用来指定哪种输出策略，常用就是控制台输出策略和文件输出策略。

控制台输出ConsoleAppender

<encoder>表示对日志进行编码：

• %d{HH: mm:ss.SSS}——日志输出时间
• %thread——输出日志的进程名字，这在Web应用以及异步任务处理中很有用
• %-5level——日志级别，并且使用5个字符靠左对齐
• %logger{36}——日志输出者的名字
• %msg——日志消息
• %n——平台的换行符

子节点二<root>

root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性。

level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。

默认是DEBUG。

可以包含零个或多个元素，标识这个appender将会添加到这个loger。

子节点三<logger>

<logger>用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<logger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。

name:用来指定受此loger约束的某一个包或者具体的某一个类。

level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。

addtivity:是否向上级loger传递打印信息。默认是true。

logger在实际使用的时候有两种情况

第一种：带有loger的配置，不指定级别，不指定appender

第二种：带有多个loger的配置，指定级别，指定appender

先来看一看代码中如何使用

我们可以通过logger对象输出不同级别的日志信息

以下两种方式均可实现对具体方法进行不同级别的日志管理

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

最新评论