logback 日志输出格式

已于 2023-06-07 23:25:28 修改
阅读量5.5k 收藏 31
点赞数 15
分类专栏： ● 编程语言 # 【Java】 文章标签： logback 日志输出格式
于 2019-09-24 11:17:20 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhanghan18333611647/article/details/101269545
版权

强烈推荐一个大神的人工智能的教程：http://www.captainai.net/zhanghan​

【前言】

         日志对一个系统的重要性不言而喻；日志通常是在排查问题时给人看，一个友好的输出样式让人看到后赏心悦目，排查效率通常也会随之提高；下面为大家共享一下通过设置logback日志输出格式，打印出令人欣喜的日志样式。

【搞一下日志格式】

        一、未指定日志格式，日志输出

              1、代码实现

                  （1）演示日志输出控制器

/*
 * Copyright (c) 2019. zhanghan_java@163.com All Rights Reserved.
 * 项目名称：实战SpringBoot
 * 类名称：CheckMobileController.java
 * 创建人：张晗
 * 联系方式：zhanghan_java@163.com
 * 开源地址: https://github.com/dangnianchuntian/springboot
 * 博客地址: https://zhanghan.blog.csdn.net
 */

package com.zhanghan.zhboot.controller;

import com.mysql.jdbc.StringUtils;
import com.zhanghan.zhboot.controller.request.MobileCheckRequest;
import com.zhanghan.zhboot.properties.MobilePreFixProperties;
import com.zhanghan.zhboot.util.wrapper.WrapMapper;
import com.zhanghan.zhboot.util.wrapper.Wrapper;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import java.util.HashMap;
import java.util.Map;

@RestController
@Api(value = "校验手机号控制器", tags = {"校验手机号控制器"})
public class CheckMobileController {

    private static Logger logger = LoggerFactory.getLogger(CheckMobileController.class);

    @Autowired
    private MobilePreFixProperties mobilePreFixProperties;

    @ApiOperation(value = "优雅校验手机号格式方式", tags = {"校验手机号控制器"})
    @RequestMapping(value = "/good/check/mobile", method = RequestMethod.POST)
    public Wrapper goodCheckMobile(@RequestBody @Validated MobileCheckRequest mobileCheckRequest) {

        logger.info("good check mobile param {}", mobileCheckRequest.toString());

        String countryCode = mobileCheckRequest.getCountryCode();
        String proFix = mobilePreFixProperties.getPrefixs().get(countryCode);

        if (StringUtils.isNullOrEmpty(proFix)) {
            logger.error("good check mobile param is error; param is {}, profix is {}", mobileCheckRequest.toString(), proFix);
            return WrapMapper.error("参数错误");
        }

        String mobile = mobileCheckRequest.getMobile();

        Boolean isLegal = false;
        if (mobile.startsWith(proFix)) {
            isLegal = true;
        }


        Map map = new HashMap();
        map.put("mobile", mobile);
        map.put("isLegal", isLegal);
        map.put("proFix", proFix);
        return WrapMapper.ok(map);
    }

    @ApiOperation(value = "扩展性差校验手机号格式方式", tags = {"校验手机号控制器"})
    @RequestMapping(value = "/bad/check/mobile", method = RequestMethod.POST)
    public Wrapper badCheckMobile(@RequestBody MobileCheckRequest mobileCheckRequest) {

        logger.info("bad check mobile param {}", mobileCheckRequest.toString());

        String countryCode = mobileCheckRequest.getCountryCode();

        String proFix = "";
        if (countryCode.equals("CN")) {
            proFix = "86";
        } else if (countryCode.equals("US")) {
            proFix = "1";
        } else {
            logger.error("bad check mobile param is error; param is {}, profix is {}", mobileCheckRequest.toString(), proFix);
            return WrapMapper.error("参数错误");
        }

        String mobile = mobileCheckRequest.getMobile();

        Boolean isLegal = false;
        if (mobile.startsWith(proFix)) {
            isLegal = true;
        }

        Map map = new HashMap();
        map.put("mobile", mobile);
        map.put("isLegal", isLegal);
        map.put("proFix", proFix);
        return WrapMapper.ok(map);
    }

}

              2、项目部署服务器后访问打印日志的效果

        二、指定日志格式，日志输出

              1、代码实现

                  （1）演示日志输出控制器（同上）

                  （2）在项目的resources目录下增加logback.xml设置打印格式，logback.xml内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<!-- 说明： 1、日志级别及文件 日志记录采用分级记录，级别与日志文件名相对应，不同级别的日志信息记录到不同的日志文件中 例如：error级别记录到log_error_xxx.log或log_error.log（该文件为当前记录的日志文件），而log_error_xxx.log为归档日志，
	日志文件按日期记录，同一天内，若日志文件大小等于或大于2M，则按0、1、2...顺序分别命名 例如log-level-2013-12-21.0.log
	其它级别的日志也是如此。 2、文件路径 若开发、测试用，在Eclipse中运行项目，则到Eclipse的安装路径查找logs文件夹，以相对路径../logs。
	若部署到Tomcat下，则在Tomcat下的logs文件中 3、Appender FILEERROR对应error级别，文件名以log-error-xxx.log形式命名
	FILEWARN对应warn级别，文件名以log-warn-xxx.log形式命名 FILEINFO对应info级别，文件名以log-info-xxx.log形式命名
	FILEDEBUG对应debug级别，文件名以log-debug-xxx.log形式命名 stdout将日志信息输出到控制上，为方便开发测试使用 -->
<configuration>
    <springProperty scope="context" name="LOG_HOME" source="spring.application.name"/>

    <springProfile name="local">
        <property name="LOG_PATH" value="D:/www/logs/common"/> <!-- 日志保存目录 -->
    </springProfile>
    <springProfile name="dev">
        <property name="LOG_PATH" value="/data/logs/common" /> <!-- 日志保存目录 -->
    </springProfile>

    <property name="appName" value="common"/>
    <property name="maxSaveDays" value="365"/><!-- 日志最大保存天数 -->
    <property name="maxFileSize" value="200MB"/><!-- 单个文件最大大小 -->
    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %highlight(%-5level) %green([${LOG_HOME},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}]) %magenta(${PID:-}) %white(---) %-20(%yellow([%20.20thread])) %-55(%cyan(%.32logger{30}:%L)) %highlight(- %msg%n)</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <appender name="rollingFileConsole" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/${appName}-log-console-%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern>
            <maxHistory>${maxSaveDays}</maxHistory> <!--max save days -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %highlight(%-5level) %green([${LOG_HOME},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}]) %magenta(${PID:-}) %white(---) %-20(%yellow([%20.20thread])) %-55(%cyan(%.32logger{30}:%L)) %highlight(- %msg%n)</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <appender name="rollingFileInfo" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/${appName}-log-info-%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern>
            <maxHistory>${maxSaveDays}</maxHistory> <!--max save days -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>%d{"yyyy-MM-dd HH:mm:ss,SSS"}[%X{userId}|%X{sessionId}][%p][%c{0}-%M]-%m%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>DENY</onMatch>
            <onMismatch>ACCEPT</onMismatch>
        </filter>
    </appender>

    <appender name="rollingFileError" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/${appName}-log-error-%d{yyyy-MM-dd}.%i.log.zip</fileNamePattern>
            <maxHistory>${maxSaveDays}</maxHistory> <!--max save days -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>${maxFileSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <encoder>
            <pattern>%d{"yyyy-MM-dd HH:mm:ss,SSS"}[%X{userId}|%X{sessionId}][%p][%c{0}-%M]-%m%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>    

    <!-- 为单独的包配置日志级别，若root的级别大于此级别， 此处级别也会输出 应用场景：生产环境一般不会将日志级别设置为trace或debug，但是为详细的记录SQL语句的情况，
        可将hibernate的级别设置为debug，如此一来，日志文件中就会出现hibernate的debug级别日志， 而其它包则会按root的级别输出日志 -->
    <!-- <logger name="org.springframework" level="DEBUG" /> -->
    <logger name="com.ibatis" level="DEBUG"/>
    <logger name="com.ibatis.common.jdbc.SimpleDataSource" level="DEBUG"/>
    <logger name="com.ibatis.common.jdbc.ScriptRunner" level="DEBUG"/>
    <logger name="com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate"
            level="INFO"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>
    <logger name="com.netflix.discovery" additivity="true" level="ERROR"/>
    <!-- 生产环境，将此级别配置为适合的级别，以名日志文件太多或影响程序性能 -->
    <root level="INFO">
        <appender-ref ref="rollingFileConsole"/>
        <appender-ref ref="rollingFileInfo"/>
        <appender-ref ref="rollingFileError"/>
        <appender-ref ref="stdout"/>
    </root>
</configuration>

              3、项目部署服务器后访问打印日志的效果

              4、查看日志记录文件，效果也一样，效果图：

        三、项目地址

                 1、地址：https://github.com/dangnianchuntian/springboot

                 2、代码版本：1.5.0-Release

【总结】

        1、通过设定日志格式，输出的样式更加人性化，错误也更加明显；

        2、这个小小的改变，使得在排查程序时更加的赏心悦目，心情上的开心将在无形中增加排错的效率；

当年的春天
关注
  • 15
    点赞
  • 踩
  • 31
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
将Logback日志输出到websocket
04-13
1、无需读取日志文件。 2、对代码无侵入，实时输出，0延时。 3、可定制日志格式等
扩展logback将日志输出到Kafka实例源码
01-23
扩展logback将日志输出到Kafka实例源码，详情请参见博文：http://blog.csdn.net/l1028386804/article/details/79135948
logback日志输出设置模板
最新发布
Amelia_Liu的博客
03-05 398
【代码】logback日志输出设置模板。
springboot+logback输出日志文件1
08-08
springboot+logback输出日志文件1
SpringBoot Logback日志记录到数据库的实现方法
08-25
主要介绍了SpringBoot Logback日志记录到数据库的实现方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
springboot日志框架logback异步输出配置
03-11
目前所有的日志记录方式采用的都是同步的方式，即直接将日志写入文件。每次日志输出到文件都会进行一次磁盘IO，在多应用的时候这种效果会导致一定的线程运行延迟，所以可以采用异步的方式处理。 采用异步写日志的方式，通过不让主线程去写日志文件而减少磁盘IO，避免并发下造成线程阻塞，从而减少不必要的性能损耗。
springboot学习之:logback配置,输出log到控制台和文件
dh_2017的博客
10-28 2083
pom springboot已经整合了logback如果引了spring-boot-starter-web或者spring-boot-starter,那么就不需要再引logback了 yml 通过配置xml文件的方式加载logback配置 如果再resource下创建logback-spring.xml就不需要在yml中指定xml配置 logging: config: classpath:logback.xml logback.xml <?xml version="1.0" encoding="
SpringBoot项目新增和修改讲师接口开发day2-3
我就是我 ，我会让自己活得更好！
09-16 592
一: 新增功能自动填充封装 1、 创建包service_base项目下com.atguigu.servicebase新建handler，创建自动填充类 MyMetaObjectHandler类: package com.atguigu.servicebase.handler; import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler; import lombok.extern.slf4j.Slf4j; import org.apach
logback日志，不同级别输出到不同文件中+传递变量控制日志级别+输出格式自定义
jfqqqqq的博客
05-11 1123
传递变量：在前三个<property>属性中 控制日志级别：在第三个变量传入级别，然后结合末尾处的<root>实现控制，传入info时，只有info、warn、error会有内容，传入warn则只有warn、error会有内容，以此类推。 输出格式自定义：在<appender name="FILE_DEBUG"> ====》 <encoder> =====》<pattern>中指定。 <?xml version="1.0...
Logback日志配置
sssxlxwbwz的博客
08-24 8898
Logback配置文件解析
log4j2 pattern 行号_Log4j2配置及与Logback对比
weixin_42361764的博客
12-28 475
Log4j2 使用和配置一、Maven配置1、与SpringBoot集成<dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-starterartifactId><exclusions><exclusion><groupI...
Spring Boot异步输出Logback日志方法详解
08-25
主要给大家介绍了关于Spring Boot异步输出Logback日志的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Spring Boot具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
logback日志配置详解
jcc4261的博客
03-23 2608
这里对 logback 的日志配置文件做了一下总结。logback 整体的运行机制是非常复杂而庞大的，这里只对 配置文件的一些节点，做简单的介绍，希望能对大家 ，有所帮助！
说说在 logback中如何配置日志的控制台输出与文件输出
读万卷书，行万里路
06-19 1941
通常情况下，日志是由一个抽象层 + 实现层的组合来搭建[i]。 spring-boot-starter 其中包含了 spring-boot-starter-logging ，该依赖内容就是 Spring Boot 默认的日志框架 logback，所以实际开发中我们不需要直接添加该依赖[ii]。 因为我们需要对日志进行更多控制，所以需要增加 logback配置。 在项目的 resources 文件夹内新建一个名为 logback-spring.xml 文件。logback-spring.xml 只有在Spr
logback日志框架的使用
zaq775253417的博客
07-13 396
目录 Spring Boot集成slf4j+logback 导入依赖 配置文件 结合使用 日志追踪MDC使用 日志框架 Logback的架构 logback三大核心模块 logback三个主要类 Logger context 有效等级 方法打印的规则 Logger获取 Appender 与 Layout appender的层级叠加性 Layout Logback的过滤器 Logback底层实现 Spring Boot集成slf4j+logback 导入依赖
logback详解与错误
热门推荐
jdk java api 中文 下载
03-30 4万+
logback 配置与踩坑 ** logback.xml示例（内容包括info、error、RocketMQ）** 官方文档推荐使用logback-spring.xml命名而不是logback.xml <?xml version="1.0" encoding="UTF-8"?> <!-- scan 配置文件如果发生改变，将会被重新加载 scanPeriod 检测间隔时间--> <configuration scan="true" scanPeriod="60 seconds"
Java日志框架：logback详解
yuhui666666的博客
08-16 676
举一反三，上面的name="java"这个可以把additivity设置为true试试看是什么结果，如果对前面的分析理解的朋友应该很容易想到，有两部分日志输出，一部分是日志级别大于等于warn的、一部分是日志级别大于等于debug的。目前PatternLayoutEncoder是唯一有用的且默认的encoder，有一个节点，就像上面演示的，用来设置日志的输入格式，使用“%+转换符"的方式，如果要输出"%"则必须使用"\%"对"%"进行转义。...
logback 日志输出格式设置
_WanG
01-11 1万+
logback 日志输出格式设置部分标签解释内置转换器部分特殊字符串解释更多内置特殊字符如何自定义输出样式字符颜色定义内置的一些样式代码示例使用内置模板使用自定义模板 部分标签解释 withJansi: 是否配合jansi使用 filter: 日志过滤器 layout: 布局, 配合内置模板使用 pattern: 日志模板, 有内置的日志模板可以直接使用, 例如: ${FILE_LOG_PATT...
logback编码设置
gogcc的专栏
03-10 6588
直接上代码:        %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n true UTF-8 logback 1.1  为什么charset要指明实现类呢!? UTF-8 logback 读取xml文件实现是java反射   调用 Enco
logback 文件输出格式
09-13
Logback文件输出格式可以通过配置文件进行设置。在logback的配置文件中，可以使用PatternLayout模式来定义日志的输出格式。 PatternLayout模式中使用的占位符可以指定输出的内容。下面是一些常用的占位符： - %d{格式}：输出时间，格式可以是yyyy-MM-dd HH:mm:ss.SSS等。 - %p：输出日志级别。 - %t：输出线程名。 - %c：输出Logger的名称。 - %m：输出日志消息。 - %n：输出换行符。 - %r：输出自应用启动以来的时间，单位为毫秒。 可以根据需要自定义输出格式，例如： ``` <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%p [%t %c - %m%n</pattern> </encoder> </appender> ``` 上面的配置将日志输出格式设置为"[时间] [日志级别] [线程名] Logger的名称 - 日志消息"的格式。 通过修改PatternLayout的配置，可以实现自定义的日志输出格式。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

当年的春天

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值