Java应用常见log框架介绍以及 如何用好Log

news2024/11/15 8:35:13

前言

合理使用日志对于Java应用程序的开发、部署和维护都至关重要。通过采用良好的日志记录实践,可以更好地监控应用程序的运行状况、排查问题并优化性能

日志系统与日志框架

日志系统

直接负责打印输出日志，提供完整的日志输出能力：

JUL

java.util.logging.*，java自带的日志系统简称JUL。目前除了Java自身代码很少被生态系统类库使用。
简介
Java Logging API是Java标准库中内置的日志框架。它提供了基本的日志记录功能,但被认为相对简单和有限。它包括以下主要组件:

Logger对象: 用于记录日志消息。
LogRecord对象: 表示一条日志记录。
Handler对象: 负责处理和发送日志记录到不同的目的地,如文件、控制台等。
Level对象: 定义日志记录的级别(SEVERE、WARNING、INFO、CONFIG、FINE、FINER、FINEST)。
Filter对象: 用于过滤日志记录。

Log4j

https://logging.apache.org/，目前已经发展到2.x版本（2.x版本有超越logback的趋势），早期的1.x版本非常成功。开创日志系统模型（Logger\Appender\Level等概念）并被各种日志框架采用，且一直沿用至今
log4j可直接使用，也可配合日志框架一起使用

简介
Log4j是Apache软件基金会的一个开源日志框架,曾经是Java应用程序中最流行的日志解决方案。它提供了比Java Logging API更丰富的功能,包括:

支持多种日志输出目标,如文件、数据库、控制台、远程套接字等。
支持日志文件滚动和压缩。
支持日志级别的继承和过滤。
支持日志格式化和参数化日志消息。
支持日志上下文(MDC和NDC)。

Logback

http://logback.qos.ch/，Log4j作者的另一个作品，（比Log4j1.x新，Log4j2.x旧）吸取多年经验教训重新设计的一套日志系统，使用更方便、功能更强、性能更好。
logback不能单独使用，需配置日志框架SLF4J一起使用

Logback是Log4j的继任者,由同一个作者开发。它构建在相同的核心代码之上,但修复了Log4j的一些缺陷,并提供了更好的性能和更多功能。Logback完全实现了SLF4J(Simple Logging Facade for Java)API,因此可以无缝地集成到使用SLF4J的应用程序中

日志框架

为了克服各种日志系统标准混乱，诞生了日志框架，日志框架不提供日志输出的功能，它定义标准，提供标准接口API，日志框架+日志系统=输出日志。
写代码过程中使用日志框架的好处：编码的时候调用日志框架API，部署的时候可根据不同的环境在多种日志系统中随意切换。

  • JCL
    https://commons.apache.org/proper/commons-logging/，前几年最流行的日志框架，由Apache社区维护，大量的老牌知名框架版本都在使用，比如Spring（甚至新版本依然在使用）。

Apache Commons Logging是Apache软件基金会的日志抽象层,类似于SLF4J。它提供了一个通用的日志接口,可以绑定到不同的日志实现,如Log4j、java.util.logging等。

  • SLF4J
    https://www.slf4j.org/，Log4j作者推出，这几年最流行的日志框架，特别是配合Logback使用。
    当然也可以配合log4j使用

SLF4J不是一个真正的日志实现,而是一个抽象层,为各种日志框架(如Log4j、Logback、java.util.logging等)提供了一个统一的API接口。这使得应用程序可以在不同的日志框架之间进行切换,而无需修改日志语句。

目前在Java生态趋势主要是使用：SLF4J+Logback组合。

如何正确组合使用日志系统和日志框架

日志系统之间互斥

在这里插入图片描述

  1. 日志框架：JCL和JCL-over-SLF4J桥接包直接互斥
  2. 日志系统：logback和slf4j-log4j12互斥，不能共存

我们大概可枚举出如下几种组合：
在这里插入图片描述

slf4j+logback组合

下面列出一个正确的slf4j+logback依赖，这个环节很重要，很多应用因为依赖搞不清楚经常出现日志丢失问题：

<properties>
  <slf4j.version>${xxxx}</slf4j.version>
  <logback.version>${yyyyy}</logback.version>
</properties>


<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>commons-logging</groupId>
      <artifactId>commons-logging</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>com.alibaba.external</groupId>
      <artifactId>jakarta.commons.logging</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba.external</groupId>
        <artifactId>org.slf4j.slf4j-log4j12</artifactId>
        <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-nop</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-simple</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba.external</groupId>
        <artifactId>org.slf4j.slf4j-simple</artifactId>
        <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <version>999-not-exist</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-ext</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>jcl-over-slf4j</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>jul-to-slf4j</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>log4j-over-slf4j</artifactId>
      <version>${slf4j.version}</version>
    </dependency>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-core</artifactId>
      <version>${logback.version}</version>
    </dependency>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>${logback.version}</version>
    </dependency>
  </dependencies>
</dependencyManagement>



<dependencies>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-ext</artifactId>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jcl-over-slf4j</artifactId>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>jul-to-slf4j</artifactId>
  </dependency>
  <dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>log4j-over-slf4j</artifactId>
  </dependency>
  <dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-core</artifactId>
  </dependency>
  <dependency>
    <groupId>ch.qos.logback</groupId>
    <artifactId>logback-classic</artifactId>
  </dependency>
</dependencies>

  1. 先将依赖全部写在节点中，这样可影响间接依赖，如果只当初的使用dependencies节点，只会应用直接依赖

  2. 使用999-not-exist这样的版本：欺骗maven，直接依赖一个空包占位，这样Maven就不会再去依赖相同坐标的真实依赖，间接起到排包的作用

logback配置

文件名和位置

在这里插入图片描述

配置样例
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <property name="APP_NAME" value="demo1" />
  <property name="LOG_PATH" value="${user.home}/${APP_NAME}/logs" />
  <property name="LOG_FILE" value="${LOG_PATH}/application.log" />
  <property name="LOG.PATTERN" value="%d %-5level %X{EAGLEEYE_TRACE_ID}  %logger{5}[%L] - %msg%n"/>
  <property name="LOG.CHARSET" value="UTF-8"/>

  <appender name="APPLICATION"
    class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${LOG_FILE}</file>
    <encoder>
      <pattern>${LOG.PATTERN}</pattern>
      <charset>${LOG.CHARSET}</charset>
    </encoder>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
      <fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
      <maxHistory>7</maxHistory>
      <maxFileSize>50MB</maxFileSize>
      <totalSizeCap>20GB</totalSizeCap>
    </rollingPolicy>
  </appender>

  <logger name="org.springframework" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="com.ibatis" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="org.mybatis" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="java.sql" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="sqlMonitor" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="com.taobao" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="com.alibaba" additivity="false">
    <level value="error"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <logger name="com.alibaba.example.demo" additivity="false">
    <level value="info"/>
    <appender-ref ref="APPLICATION"/>
  </logger>

  <root level="error">
    <appender-ref ref="APPLICATION" />
  </root>
</configuration>
  1. 使用SizeAndTimeBasedRollingPolicy使日志可以根据大小和日期进行滚动
  2. 日志编码请使用UTF-8
  3. 请正确使用日志级别，不要统统输出error
日志级别根据不同环境可配
  1. 如果是Pandora-boot或spring-boot可以直接在配置里使用property读取application.properties，application.properties在不同环境下使用-Dspring.profiles.active进行切换
  2. 普通应用和WAR应用：请使用autoconfig-maven-plugin插件

一些实用的日志技巧

1. 动态修改日志级别

场景：应用在运行中，默认日志配置的打印级别是error，但是我现在想针对某个包或者某个类输出下info日志。

使用Arthas：https://arthas.aliyun.com/doc/logger.html，该工具提供了动态修改日志的能力。

2. 追加业务信息到日志中，并格式化输出：追加MDC信息，方便排查问题

这是日志系统的一个扩容能力，可以把一些额外的信息输出到日志里，只需要在MDC上下文中写入kv，https://logback.qos.ch/manual/mdc.html

例如：

public static void main(String[] args) {
    //代码里使用MDC.put写入key为traceId的值
    //在logback.xml里就可以使用%X{traceId}进行输出
    MDC.put("traceId", UUID.randomUUID().toString().replace("-", ""));
}

日志配置中使用：
在这里插入图片描述

3. 配置定时日志磁盘占用清理

一定要配置合理的日志清理策略，避免磁盘被打爆，可借助日志框架自身能力，或借助可用的日志清理系统（如果有）

在logback.xml配置中，可通过配置带有清理作用的rollingPolicy来完成日志定时清理和滚动，例如：SizeAndTimeBasedRollingPolicy

<rollingPolicy class="ch.gos. logback.core. rolling. SizeAndTimeBasedRollingPolicy">
	<fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i.log</fileNamePattern>
	<maxHistory>7</maxHistory>
	<maxFileSize>50MB</maxFileSize>
	<totalSizeCap>20GB</totalSizeCap>
</rollingPolicy>

这段配置的含义是：最多保留7天，单个文件最大50MB，该日志（包括滚动的）最大只能保存20GB。

4. 不要封装一个日志Util，而应该直接使用日志框架进行输出

反例：LogUtil.log(“通过封装的日志工具打印日志”);

正例：log.info(“直接使用日志框架的api进行日志输出”);

理由：在日志输出的时候，日志系统会打印日志产生的原始位置：比如哪个包的哪个类，以及第几行（如果配置了[%L]），如果你使用LogUtil等自己封装的工具，所有的日志输出打印的位置都是LogUtil的，这样不便于做日志问题定位

5. 高效使用日志输出 前提是日志框架 日志系统配置正常

集成lombok 通过使用 注解来进行日志输出

@Slf4j
public class TestLog {
    public void test(){
        log.info("日志输出......");
    }
}

日志问题排查思路

目前没有现成的工具帮你一键做好这个事情，下面给出一个排查思路

  • 先明确该系统到底使用的是什么日志框架+日志系统组合，这个很重要，必须搞清是何种组合才可有针对性的处理后续步骤

  • 如果是slf4j+logback组合，则可根据上述列出的maven依赖进行排包处理，优先保证依赖的包没有错误，90%的情况下都是包依赖混乱导致的日志丢失

  • 排查自己的logback配置文件是否放在正确的路径下、文件名是否正确，配置文件位置不对也会导致日志输出的不对甚至丢失

  • 检查logback配置文件内部每个logger及其level配置是否正确，避免自己期望打印info，却配置了error

原文 ：https://mp.weixin.qq.com/s/Qdi5kDq6vLqcRsFD5_vnnw

the end ！！！
good day ！！！

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1539381.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

栅格地图路径规划：4种最新算法（小龙虾优化算法COA、螳螂搜索算法MSA、红尾鹰算法RTH、霸王龙优化算法TROA）求解机器人路径规划（提供MATLAB代码）

栅格地图路径规划：4种最新算法（小龙虾优化算法COA、螳螂搜索算法MSA、红尾鹰算法RTH、霸王龙优化算法TROA）求解机器人路径规划（提供MATLAB代码）

一、机器人路径规划介绍 移动机器人&#xff08;Mobile robot&#xff0c;MR&#xff09;的路径规划是 移动机器人研究的重要分支之&#xff0c;是对其进行控制的基础。根据环境信息的已知程度不同&#xff0c;路径规划分为基于环境信息已知的全局路径规划和基于环境信息未知或…
阅读更多...
RIPGeo代码理解（七）test.py（加载检查点，然后测试）

RIPGeo代码理解（七）test.py（加载检查点，然后测试）

​代码链接：RIPGeo代码实现 ├── preprocess.py # 预处理数据集并为模型运行执行IP聚类 ├── main.py # 运行模型进行训练和测试 ├── test.py #加载检查点，然后测试 一、导入各种模块和数据库 import torch.nnfrom lib.utils import * import argparse import…
阅读更多...
paddlepaddle框架构建数据集进行分类问题的时候，会发现数据集在构建的过程中不会构建标签（花分类）

paddlepaddle框架构建数据集进行分类问题的时候，会发现数据集在构建的过程中不会构建标签（花分类）

问题描述 在做一个paddlepaddle项目的时候&#xff0c;需要使用神经网络对他进行分类&#xff0c;数据集的结构如下图&#xff0c;这时候我们可以使用常用dataset方法对数据集进行构建。 这时候我们就会发现一个问题&#xff0c;就是这个矿建不是构建标签&#xff0c;也就是说…
阅读更多...
IM系统设计之websocket消息转发

IM系统设计之websocket消息转发

Websocket消息转发 项目地址&#xff1a;gitgithub.com:muyixiaoxi/Link.git 上周面试被面试官问到&#xff1a;“在分布式IM系统中&#xff0c;如何实现多个websocket集群之间的通信”。 我在思考了良久后回答&#xff1a;“不会”。 随着我的回答&#xff0c;我和面试官的…
阅读更多...
【C++航海王：追寻罗杰的编程之路】stack

【C++航海王：追寻罗杰的编程之路】stack

目录 1 -> stack的介绍和使用 1.1 -> stack的介绍 1.2 -> stack的使用 1.3 -> stack的模拟实现 1 -> stack的介绍和使用 1.1 -> stack的介绍 stack的文档介绍 1. stack是一种容器适配器&#xff0c;专门用在具有后进先出操作的上下文环境中&#xff0c…
阅读更多...
React【Day1】

React【Day1】

B站视频链接 一、React介绍 React由Meta公司开发&#xff0c;是一个用于 构建Web和原生交互界面的库 React的优势 相较于传统基于DOM开发的优势 组件化的开发方式不错的性能 相较于其它前端框架的优势 丰富的生态跨平台支持 React的市场情况 全球最流行&#xff0c;大…
阅读更多...
案例实践 | 基于长安链的煤质检测智慧实验室

案例实践 | 基于长安链的煤质检测智慧实验室

案例名称-煤质检测智慧实验室 ■ 建设单位 国能数智科技开发&#xff08;北京&#xff09;有限公司 ■ 用户群体 煤炭生产单位、电力单位、化工单位等产业链上下游单位 ■ 应用成效 化验效率提升50%&#xff0c;出验时间缩短40%&#xff0c;提高化验数据市场公信力 案例…
阅读更多...
数据结构-＞手把手教入门栈与列队（基础）

数据结构-＞手把手教入门栈与列队（基础）

✅作者简介&#xff1a;大家好&#xff0c;我是橘橙黄又青&#xff0c;一个想要与大家共同进步的男人&#x1f609;&#x1f609; &#x1f34e;个人主页&#xff1a;橘橙黄又青-CSDN博客 1.什么是栈 1.1栈的概念及结构 栈&#xff1a;一种特殊的线性表&#xff0c;其只允许…
阅读更多...
利用Scala与Apache HttpClient实现网络音频流的抓取

利用Scala与Apache HttpClient实现网络音频流的抓取

概述 在当今数字化时代&#xff0c;网络数据的抓取和处理已成为许多应用程序和服务的重要组成部分。本文将介绍如何利用Scala编程语言结合Apache HttpClient工具库实现网络音频流的抓取。通过本文&#xff0c;读者将学习如何利用强大的Scala语言和Apache HttpClient库来抓取网…
阅读更多...
IS210BPPCH1AEC的数据分析

IS210BPPCH1AEC的数据分析

GE IS210BPPCH1AEC 是一款专为石油和天然气行业设计的压力传感器。 该传感器可以监测油井、气井以及管道系统中的压力&#xff0c;并且具备数据分析和远程监控的能力。这使得它在确保油气生产过程安全和效率方面发挥关键作用。具体来看&#xff0c;以下是一些特点和应用&#x…
阅读更多...
Webman全局异常捕获处理

Webman全局异常捕获处理

最近在使用webman这个框架做项目开发&#xff0c;涉及到需要统一处理异常捕获。由于官网给的并不详细&#xff0c;于是自己实现了一下全局异常处理类。 一、配置效果 例如&#xff1a;我要在项目中统一返回json 格式数据&#xff0c;并不想在业务层写try,catch逻辑。 或者在业务…
阅读更多...
校招应聘流程讲解

校招应聘流程讲解

在整个应聘流程中&#xff0c;记得保持积极的态度、认真准备面试&#xff0c;同时也要对自己的能力和经验有清晰的认识&#xff0c;这样才能在竞争激烈的校园招聘中脱颖而出&#xff0c;成功获得心仪的工作机会. 1. 校招资源获取 想要参加校招&#xff0c;首先需要获取校招资…
阅读更多...
操作系统内功篇:硬件结构之CPU是如何执行任务的？

操作系统内功篇:硬件结构之CPU是如何执行任务的？

一 CPU是如何读写数据的&#xff1f; 1.1 CPU架构(组成) 当代CPU一般是多核心的&#xff0c;每个核心都有自己的一个L1和L2Cache&#xff0c;L3Cache是一个CPU所有核心共享的&#xff0c;一个CPU只有一个。L1Cache分为数据缓存和指令缓存。 CPU有三层高速缓存的目的就是将Cac…
阅读更多...
基于SSM+Jsp+Mysql的记账管理系统

基于SSM+Jsp+Mysql的记账管理系统

开发语言&#xff1a;Java框架&#xff1a;ssm技术&#xff1a;JSPJDK版本&#xff1a;JDK1.8服务器&#xff1a;tomcat7数据库&#xff1a;mysql 5.7&#xff08;一定要5.7版本&#xff09;数据库工具&#xff1a;Navicat11开发软件&#xff1a;eclipse/myeclipse/ideaMaven包…
阅读更多...
C# Solidworks二次开发：获取主窗口API和创建新活动窗口API详解

C# Solidworks二次开发：获取主窗口API和创建新活动窗口API详解

今天要讲的是Solidworks中的两个API。 &#xff08;1&#xff09;Frame Method (ISldWorks)&#xff1a;获取SOLIDWORKS主框架。 下面是API中给出的例子&#xff1a; public void Main(){ModelDoc2 swModelDoc default(ModelDoc2);Frame swFrame default(Frame);ModelWindow…
阅读更多...
jmeter之接口功能自动化

jmeter之接口功能自动化

一、接口测试简述 接口&#xff1a;用来连接前端&#xff0c;后端还有移动端的程序模块。由于不同端的工作进度不一样&#xff0c;需要对最开始出来的接口进行接口测试。 接口分类&#xff1a;POST&#xff0c;GET&#xff0c;PUT&#xff0c;DELETE。 POST请求的数据是放在…
阅读更多...
战略精进·第1篇：市场洞察的操作要点分享

战略精进·第1篇：市场洞察的操作要点分享

首发&#xff1a;麦子禾咨询 作者&#xff1a;石头 近期本来没有计划写战略相关主题的&#xff0c;毕竟在3月初&#xff0c;石头定下来的方向是「大客户经营」&#xff0c;也在围绕大客户主题做些积累。 为什么要打乱现有的节奏&#xff0c;原因很简单&#xff0c;近期正在接…
阅读更多...
NIO简介以及用NIO实现一个群聊系统

NIO简介以及用NIO实现一个群聊系统

一、BIO的工作原理 传统Io(BIO)的本质就是面向字节流来进行数据传输的 ①:当两个进程之间进行相互通信&#xff0c;我们需要建立一个用于传输数据的管道(输入流、输出流)&#xff0c;原来我们传输数据面对的直接就是管道里面一个个字节数据的流动&#xff08;我们弄了一个 by…
阅读更多...
利用Base64加密算法将数据加密解密

利用Base64加密算法将数据加密解密

1. Base64加密算法 Base64准确来说并不像是一种加密算法&#xff0c;而更像是一种编码标准。 我们知道现在最为流行的编码标准就是ASCLL&#xff0c;它用八个二进制位&#xff08;一个char的大小&#xff09;表示了127个字符&#xff0c;任何二进制序列都可以用这127个字符表…
阅读更多...
实用工具推荐：适用于 TypeScript 网络爬取的常用爬虫框架与库

实用工具推荐：适用于 TypeScript 网络爬取的常用爬虫框架与库

随着互联网的迅猛发展&#xff0c;网络爬虫在信息收集、数据分析等领域扮演着重要角色。而在当前的技术环境下&#xff0c;使用TypeScript编写网络爬虫程序成为越来越流行的选择。TypeScript作为JavaScript的超集&#xff0c;通过类型检查和面向对象的特性&#xff0c;提高了代…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023