在项目开发中的Logback日志框架技术

学习目录

  • 前言
    • 一、日志的引入
    • 二、日志技术体系
    • 三、logBack快速入门
    • 四、配置文件编写
    • 五、实战演练

前言

日志框架技术和异常处理比较类似,它通过将信息记录到系统文件中来帮助开发者检查程序运行情况,这也是在做小项目过程中偶然听到的一个概念,想着很陌生,抱着查缺补漏的心态完善一下对日志框架技术的认知了解

一、日志的引入

在生活中,日记是对一天中点点滴滴的记录,在程序中日志可以用来记录程序运行过程中的信息,并可以永久保存在内存文件中
我们都知道try-catch存在的目的是为了捕获异常,输出异常保持程序的健壮性,但是信息只能展示在控制台,不可以把程序的运行情况记录到内存文件,或者保存到数据库中。而且想要取消控制台输出的信息我得去改源代码才能完成
上述的弊端就孕育出了程序中的日志技术:
可以将系统执行的信息通过人为操作,选择性的记录到指定位置(可以是控制台、文件、数据库)
可以通过更改配置文件的方式控制是否记录日志,无需修改源代码,又是一类规范化的技术操作

二、日志技术体系

在项目开发中的Logback日志框架技术_第1张图片
日志的规范是通过一些接口来实现,是开发者提供给日志的实现框架设计的标准
日志框架则是牛人或者第三方公司已经做好的日志记录实现代码,后来者直接可以拿去使用,Logback则是目前的主流框架,是其他版本的升级改造

三、logBack快速入门

Logback是由log4j创始人设计的另一个开源日志组件,性能优于log4j
下载网址:https://logback.qos.ch/index.html
Logback是基于slf4j的日志规范实现的框架

①在项目下新建文件夹lib,导入logback的相关jar包到该文件夹下
在项目开发中的Logback日志框架技术_第2张图片

②添加到项目依赖库中
在项目开发中的Logback日志框架技术_第3张图片

③将核心配置文件logback.xml拷贝到src目录下
在项目开发中的Logback日志框架技术_第4张图片
④在代码中获取日志对象
public static final Logger LOGGER= LoggerFactory.getLogger("类对象");
在这里插入图片描述

四、配置文件编写

通过logback.xml 中的<append>标签可以设置输出位置和日志信息的详细格式
设置日志的输出位置可以是控制台、文件,在编写配置文件时可以两者都写上
1.输出到控制台,以out的形式输出:
CONSOLE表示控制台

    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <target>System.out</target>

2.格式化输出:
%d表示日期,%thread表示线程名,%-5level表示级别从左显示5个字符宽度,%msg表示日志消息,%n表示换行符

 <encoder>
   <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level]  %c [%thread] : %msg%n</pattern>
 </encoder>

3.设置以内容输出到文件,FILE表示通向文件:

<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">

4.拆分压缩规则:
随着程序在不断运行,日志会一直记录,为了以后高效的查询日志,在配置文件中引入了按大小拆分的功能,以下是按照1MB拆分的模式

 <!--日志输出路径-->
        <file>D:/Daily/test1.log</file>
 <rollingPolicy
       class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
       <!--通过指定压缩文件名称,来确定分割文件方式-->
       <fileNamePattern>D:/Daily/test2-%d{yyyy-MM-dd}.log%i.gz</fileNamePattern>
       <!--文件拆分大小为1MB-->
       <maxFileSize>1MB</maxFileSize>
</rollingPolicy>

5.日志级别设置:

级别程度依次是:TRACE ERROR:错误级别,优先输出
WARN:警告级别,二级优先
INFO:关键信息级别,三级优先
DEBUG:调试信息级别,四级优先
TRACE:路径跟踪级别,最后输出

作用:用于控制系统中哪些日志级别是可以输出的,只输出级别不低于设定级别的日志信息
通俗易懂的讲,我把日志级别设置成WARN那就只会输出WARN,REEOR级别的信息,低级别的信息不会输出
特例:ALL 和OFF分别是打开全部日志信息,及关闭全部日志信息
6.关联输出形式:
注意:如果这里不配置关联打印位置,该位置将不会记录日志

    <root level="ALL">
        <appender-ref ref="FILE" />
        <appender-ref ref="CONSOLE" />
    </root>

五、实战演练

按照上述要求编写配置文件,导入jar包,得到日志对象后,在代码中打上日志,运行程序后自动记录到文件中

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Test {
    public static final Logger LOGGER = LoggerFactory.getLogger("Test.class");//得到日志对象
    public static void main(String[] args) {
        try {
            LOGGER.debug("开始记日志了");
            LOGGER.info("这是第一行~");
            LOGGER.info("这是第二行~");
            int a = 7;
            int b = 3;
            LOGGER.trace("a=" + a);
            LOGGER.trace("b=" + b);
            System.out.println("结果是:" + (a / b));
        } catch (Exception e) {
            e.printStackTrace();
            System.out.println("出现异常"+e.getClass());
        }
    }
}

运行程序后的记录情况:
在系统文件中的情况
在项目开发中的Logback日志框架技术_第5张图片
在控制台的情况:
在项目开发中的Logback日志框架技术_第6张图片
完整配置文件如下:
不写可以直接拿去用,更改一下文件输出目录即可

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <!--这里表示输出流对象 默认 System.out 改为 System.err-->
        <target>System.out</target>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%-5level]  %c [%thread] : %msg%n</pattern>
        </encoder>
    </appender>
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
            <charset>utf-8</charset>
        </encoder>
        <!--日志文件输出路径-->
        <file>D:/Daily/test1.log</file>
        <rollingPolicy>
                class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>D:/Daily/test2-%d{yyyy-MM-dd}.log%i.gz</fileNamePattern>
            <maxFileSize>1MB</maxFileSize>
        </rollingPolicy>
    </appender>
    <root level="ALL">
        <appender-ref ref="FILE" />
        <appender-ref ref="CONSOLE" />
    </root>
</configuration>

你可能感兴趣的:(JavaSE,需求设计,java,开发语言,后端)