Spring项目集成Logback【快速上手】

最新推荐文章于 2024-05-12 16:58:59 发布
最新推荐文章于 2024-05-12 16:58:59 发布
阅读量5.5k 收藏 9
点赞数 2
分类专栏： Java 文章标签： logback logback使用外部配置文件 Spring项目集成Logback
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ZhangYuan2HH/article/details/89672847
版权

Spring项目集成Logback

一、logback介绍

官网介绍：【官网：https://logback.qos.ch/index.html介绍翻译过来】Logback旨在作为流行的log4j项目的后续版本，在log4j离开的地方启动。

Logback的架构足够通用，以便在不同情况下应用。目前，logback分为三个模块：logback-core，logback-classic和logback-access。

logback-core模块为其他两个模块奠定了基础。logback-classic模块可以被同化为log4j的显着改进版本。此外，logback-classic本身实现了SLF4J API，因此您可以在logback和其他日志框架（如log4j或java.util.logging（JUL））之间来回切换。

logback-access模块​​与Servlet容器（如Tomcat和Jetty）集成，以提供HTTP访问日志功能。请注意，您可以在logback-core之上轻松构建自己的模块。

看完有点懵那我们自己总结：

  1. Logback是由log4j创始人设计的一个开源日志组件。LogBack被分为3个组件，logback-core, logback-classic 和 logback-access。
  2. logback-core是其它两个模块的基础模块。logback-classic是log4j的一个 改良版本。
  3. 此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging。logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。
  4. 总结：logback比log4j更推荐使用

二、项目集成

 

 1.maven项目 pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>hoperun.pagoda.commandlog</groupId>
  <artifactId>commandlog</artifactId>
  <version>0.0.2-SNAPSHOT</version>
  <name>commandlog</name>
  <url>http://maven.apache.org</url>
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <logback.version>1.2.3</logback.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>test</scope>
    </dependency>
    <!-- log start -->
    <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-api -->
	<dependency>
	    <groupId>org.slf4j</groupId>
	    <artifactId>slf4j-api</artifactId>
	    <version>1.7.26</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-access</artifactId>
	  <version>${logback.version}</version>
	</dependency>
	<dependency>
	  <groupId>ch.qos.logback</groupId>
	  <artifactId>logback-classic</artifactId>
	  <version>${logback.version}</version>
	</dependency>
	<!-- log end -->
  </dependencies>
  <build>
  	<plugins>
  	     <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.0</version>
            <configuration> 
                <source>1.8</source> 
                <target>1.8</target> 
                <compilerVersion>1.8</compilerVersion>
                <encoding>UTF-8</encoding> 
            </configuration> 
          </plugin>
  	</plugins>
  </build>
</project>

 

核心jar依赖如图：

2.logback配置

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--e定义日志文件的存储地址 -->
    <property name="LOG_HOME" value="../logs/diiop"/>
    <!-- e控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--e格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>-->
            <pattern>%msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!--e 按照每天和固定大小(5MB)生成日志文件【最新的日志，是没有日期没有数字的】 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_HOME}/diiop.log</file>
        <append>true</append>
        <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>${LOG_HOME}/diiop_%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!--e日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
            <!--e日志文件最大的大小-->
            <MaxFileSize>5MB</MaxFileSize>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--e格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
       <!-- <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>TRACE</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>-->
    </appender>
    <!--e日志异步到数据库 -->
    <!--<appender name="DB" class="ch.qos.logback.classic.db.DBAppender">-->
    <!--&lt;!&ndash;日志异步到数据库 &ndash;&gt;-->
    <!--<connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">-->
    <!--&lt;!&ndash;连接池 &ndash;&gt;-->
    <!--<dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">-->
    <!--<driverClass>com.mysql.jdbc.Driver</driverClass>-->
    <!--<url>jdbc:mysql://127.0.0.1:3306/databaseName</url>-->
    <!--<user>root</user>-->
    <!--<password>root</password>-->
    <!--</dataSource>-->
    <!--</connectionSource>-->
    <!--</appender>-->
 
    <!-- show parameters for hibernate sql 专为 Hibernate 定制 -->
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder"  level="WARN" />
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor"  level="WARN" />
    <logger name="org.hibernate.SQL" level="WARN" />
    <logger name="org.hibernate.engine.QueryParameters" level="WARN" />
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="WARN" />
 
    <!--myibatis log configure-->
    <logger name="com.apache.ibatis" level="WARN"/>
    <logger name="java.sql.Connection" level="WARN"/>
    <logger name="java.sql.Statement" level="WARN"/>
    <logger name="java.sql.PreparedStatement" level="WARN"/>
 
 
    <!--newcapec-->
    <logger name="com.newcapec" level="INFO"/>
 
    <!-- e 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
</configuration>

 

Logback.xml 配置简单介绍：

详细介绍推荐博客文章：https://blog.csdn.net/zzzgd_666/article/details/80458444

  • 日志存储地址：

Logback存储相对位置存储日志：../xxx 则日志存储在项目的同级目录

Logback存储绝对位置存储日志：c:/xxx 或 /xxx（默认在c:下建xxx目录）

  • 输出位置、格式、存储方式 都标注很清楚

  • 日志级别

3.封装utils

package hoperun.pagoda.commandlog;

import java.io.File;
import java.io.IOException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.joran.JoranConfigurator;
import ch.qos.logback.core.joran.spi.JoranException;
import ch.qos.logback.core.util.StatusPrinter;

/**
 * logback工具类.
 * @author Administrator
 */
public class LogUtils {
    /**
     * logger属性.
     */
    private static final Logger LOGGER
    = LoggerFactory.getLogger(LogUtils.class);

    /**
     * info信息.
     * @param message 信息
     */
    public void logInfo(final String message) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.info(builder.toString());
    }
    /**
     * info 异常信息.
     * @param message 信息
     * @param exception 异常信息
     */
    public void logInfo(final String message, final Throwable exception) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.info(builder.toString(), exception);
    }

    /**
     * Warn 信息.
     * @param message 信息
     */
    public void logWarn(final String message) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);

        LOGGER.warn(builder.toString());
    }
    /**
     * Warn 异常信息.
     * @param message 信息
     * @param exception 异常信息
     */
    public void logWarn(final String message, final Throwable exception) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.warn(builder.toString(), exception);
    }
    /**
     * Debug 信息.
     * @param message 信息
     */
    public void logDebug(final String message) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.debug(builder.toString());
    }
    /**
     * Debug 异常信息.
     * @param message 信息
     * @param exception 异常信息
     */
    public void logDebug(final String message, final Throwable exception) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.debug(builder.toString(), exception);
    }
    /**
     * Error 信息.
     * @param message 信息
     */
    public void logError(final String message) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.error(builder.toString());
    }

    /**
     * Error 异常信息.
     * @param message 信息
     * @param exception 异常信息
     */
    public void logError(final String message, final Throwable exception) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.error(builder.toString(), exception);
    }
}

 

 

4.配置文件在项目外的写法

Logback外部配置文件使用

例如配置文件在项目的同目录

下面是代码

package hoperun.pagoda.commandlog;

import java.io.File;
import java.io.IOException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.joran.JoranConfigurator;
import ch.qos.logback.core.joran.spi.JoranException;
import ch.qos.logback.core.util.StatusPrinter;

/**
 * logback工具类.
 * @author Administrator
 */
public class LogUtils {
    /**
     * logger属性.
     */
    private static final Logger LOGGER
    = LoggerFactory.getLogger(LogUtils.class);
    /**
     * logback构造函数.
     */
    public LogUtils() {
        try {
            load("../conf/logback.xml");
        } catch (IOException | JoranException e) {
            logError("Get logback.xml path Error", e);
        }
    }

    /**
     * 加载外部的logback配置文件.
     * @param configFilePath 配置文件路径.
     * @throws IOException IOException
     * @throws JoranException JoranException
     */
    public void load(final String configFilePath)
            throws IOException, JoranException {
        final LoggerContext loggerContext =
                (LoggerContext) LoggerFactory.getILoggerFactory();
        final File configFile = new File(configFilePath);
        final boolean exists = !configFile.exists();
        final boolean isFile = !configFile.isFile();
        final boolean canRead = !configFile.canRead();
        if (exists) {
            throw new IOException("Logback External Config File "
                    + "Parameter does not reference a file that exists");
        } else if (isFile) {
            throw new IOException("Logback External Config File "
                    + "Parameter exists, but does not reference a file");
        } else if (canRead) {
            throw new IOException("Logback External Config File "
                    + "exists and is a file, but cannot be read.");
        } else {
            final JoranConfigurator configurator = new JoranConfigurator();
            configurator.setContext(loggerContext);
            loggerContext.reset();
            configurator.doConfigure(configFilePath);
            StatusPrinter.printInCaseOfErrorsOrWarnings(loggerContext);
        }

    }

    /**
     * info信息.
     * @param message 信息
     */
    public void logInfo(final String message) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.info(builder.toString());
    }
    /**
     * info 异常信息.
     * @param message 信息
     * @param exception 异常信息
     */
    public void logInfo(final String message, final Throwable exception) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.info(builder.toString(), exception);
    }

    /**
     * Warn 信息.
     * @param message 信息
     */
    public void logWarn(final String message) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);

        LOGGER.warn(builder.toString());
    }
    /**
     * Warn 异常信息.
     * @param message 信息
     * @param exception 异常信息
     */
    public void logWarn(final String message, final Throwable exception) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.warn(builder.toString(), exception);
    }
    /**
     * Debug 信息.
     * @param message 信息
     */
    public void logDebug(final String message) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.debug(builder.toString());
    }
    /**
     * Debug 异常信息.
     * @param message 信息
     * @param exception 异常信息
     */
    public void logDebug(final String message, final Throwable exception) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.debug(builder.toString(), exception);
    }
    /**
     * Error 信息.
     * @param message 信息
     */
    public void logError(final String message) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.error(builder.toString());
    }

    /**
     * Error 异常信息.
     * @param message 信息
     * @param exception 异常信息
     */
    public void logError(final String message, final Throwable exception) {
        final StringBuilder builder = new StringBuilder();
        builder.append(message);
        LOGGER.error(builder.toString(), exception);
    }
}

 

远方-zhangyuan
关注
  • 2
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring Boot logback 日志配置
zombres的博客
02-05 8612
spring-boot 项目中默认的日志已经是 logback 了，大型项目中，日志的管理也是很重要的，需要合理规划配置，本文对常用功能做了总结。
spring整合logBack日志框架：
qq_52963857的博客
07-05 1452
spring整合logBack日志框架： SLF4J简介logback和log4j logback的使用 引入logback.xml日志配置文件 logback.xml日志配置文件的配置逻辑：理解正确的日志输出级别
spring boot- 日志打印logback（logback-spring.xml获取properties配置文件配置项）
西京刀客
11-30 5364
文章目录一、Spring中使用Logback（Spring/Spring MVC）1. spring 如何在Logback自动加载logback.xml之前加载变量PropertyDefiner方式LoggerContextListener方式二、参考 一、Spring中使用Logback（Spring/Spring MVC） [推荐]spring如何自定义加载logback.xml 参考URL:...
最新在项目开发中的Logback日志框架技术_在项目中使用logback(2)，2024年最新高级大数据开发开发面试解答之线程篇
最新发布
2401_84181501的博客
05-12 663
作用：用于控制系统中哪些日志级别是可以输出的，只输出级别不低于设定级别的日志信息通俗易懂的讲，我把日志级别设置成WARN那就只会输出WARN，REEOR级别的信息，低级别的信息不会输出。
Spring Boot日志配置logback
夏壹分享
11-16 3228
logback在Spring Boot项目中使用特别注意异步打印队列大小、丢弃大小、是否阻塞。此外log节点注意additivity属性值
SpringBoot整合Logback日志框架配置全解析
m0_71777195的博客
07-07 3946
SpringBoot使用 Commons Logging 进行所有内部日志的记录，但默认配置也提供了对常用日志的支持，如 Java Util Logging，Log4J2，和Logback. 每种logger都可以通过配置使用控制台或文件输出日志内容。Logback是log4j框架的作者开发的新一代日志框架，它效率更高、能够适应诸多的运行环境，同时天然支持SLF4J。由于日志服务一般都在ApplicationContext创建前就初始化了，它并不是必须通过Spring的配置文件控制。
springboot使用logback日志框架超详细教程
程序员阿红的博客
06-08 2万+
现在很多项目都基于springBoot框架来进行开发，但是日志框架繁而杂乱，本文为你介绍一下Logback的日志框架详细作用，看完必会。首先我们要在application.xml设置开发环境，因为针对开发环境和生产环境有不同的日志策略通过日志查看程序的运行过程，运行信息，异常信息等日志记录器（Logger）的行为是分等级的。如下表所示：分为：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF默认情况下，spring boot从控制台打印出来的日志级别只有INFO及以上级别，
spring-quickstart:Spring Boot 快速入门项目
07-07
标题“spring-quickstart:Spring Boot 快速入门项目”表明这是一个帮助开发者快速了解并上手 Spring Boot 的教程或示例项目。这通常包含一系列的代码样例和指导，旨在解释如何创建、配置和运行一个基本的 Spring ...
Spring Boot 教程、技术栈示例代码，快速简单上手教程。
11-03
Spring Boot 默认使用 Logback 作为日志系统，同时支持 Log4j2。Actuator 提供了监控应用的端点，如 `/health`、`/metrics` 等。 总之，Spring Boot 以其简洁的配置、快速的开发体验，成为了现代 Java 开发中的热门...
spring boot 使用国产化 tongweb资源
10-13
它集成了大量的默认配置，使得开发者能够快速上手并构建应用。TongWeb是一款由东软集团开发的企业级应用服务器，它支持Java EE标准，且在国产化方面具有较好的兼容性，适用于国内对自主可控技术的需求。 在"spring ...
spring-mybatis-spring-2.1.0.zip
04-19
通过以上介绍，我们可以看到，"spring-mybatis-spring-2.1.0.zip"这个资源包为开发者提供了一套完整的Spring与MyBatis整合解决方案，无论是新手还是经验丰富的开发者，都可以快速上手，构建高效的企业级应用。...
springboot纯净版项目模板
02-23
综上所述，“springboot纯净版项目模板”是一个基础的、可快速上手的开发环境，它整合了SpringBoot、MyBatis和Redis，适用于日常实验和开发工作。开发者可以在此基础上根据具体需求添加更多的功能和配置，以满足实际...
SpringBoot集成logback
Wdoing的博客
10-27 4622
springboot集成logback,以及logback的介绍
SpringBoot系列 Logback日志配置
yygr的博客
04-09 8177
https://blog.csdn.net/u012834750/article/details/78806167?utm_medium=distribute.pc_relevant.none-task-blog-2~default~baidujs_baidulandingword~default-1.pc_relevant_aa&spm=1001.2101.3001.4242.2&utm_relevant_index=4 前言 Logback是SpringBoot内置的日志处理框
SpringBoot集成Logback
囚徒之困
03-14 2246
SpringBoot集成Logback
logback配置---Spring集成logback
D的博客
09-04 1万+
项目中重新采用了logback日志组件,替换log4j,由于以前使用log4j时,spring有结合log4j启动的类,但是logback现在还没有,可以自己写代码完成,官方已经写了一个扩展,用于解决与spring的结合——logback-ext-spring。 具体配置如下: １、　pom.xml文件中添加配置：                    org.slf4
日志之旅：深入Spring整合Logback的高效日志管理
学而时习之，不亦说乎？温故而知新，可以为师矣！
01-11 507
Spring与Logback的整合为Java应用提供了强大的日志管理能力，本文将深入研究如何实现这一整合。我们将详细介绍Logback的基本概念、配置文件的编写方式，以及如何在Spring项目中集成Logback。
logback-spring.xml配置文件标签（超详解）
热门推荐
皮卡丘的情绪
04-26 2万+
1、SpringBoot日志框架 市面上的日志框架； JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j… 日志门面 （日志的抽象层） 日志实现 JCL（Jakarta Commons Logging） SLF4j（Simple Logging Facade for Java） jboss-logging Log4j JUL（java.util.logging） Log4j2 Logback SpringBoot选用
springboot2 集成log4 mybatis 日志_Spring Boot 2 集成log4j2日志框架
weixin_28717411的博客
01-22 153
前言Log4j2是Log4j的进化版本，并提供了许多Logback可用的改进，同时解决了Logback体系结构中的一些固有问题。而且日志处理中我们会用到kafka作为日志管道。而kafka客户端依赖与Logback的兼容不是很完美，你可以选择排除依赖冲突或者使用Log4j2。排除Logback依赖Spring Boot 2.x默认使用Logback日志框架，要使用Log4...
SpringCloud项目中添加logback的MDC
04-20
很好的问题，我可以为您提供解答。在SpringCloud项目中，想要添加logback的MDC，可以采用如下步骤： 1. 添加logback的MDC依赖包： 在pom文件中添加如下依赖： ```xml <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> </dependency> ``` 2. 添加logback.xml文件： 在resources目录下添加logback.xml文件，文件内容如下： ```xml <configuration> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %mdc{traceId} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <root level="INFO"> <appender-ref ref="STDOUT"/> </root> </configuration> ``` 注意：其中的%mdc{traceId}表示MDC变量名，可以根据自己的需要修改。 3. 配置MDC： 在代码中添加如下配置： ```java MDC.put("traceId", UUID.randomUUID().toString()); ``` 注意：这里的traceId可以根据自己的需要改成其他的MDC变量名。 在以上三个步骤完成后，logback的MDC就可以成功添加到SpringCloud项目中了。希望我的回答对您有所帮助。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值