首页 > 编程语言 >Java 日志系列:JUL 使用和原理分析

Java 日志系列:JUL 使用和原理分析

时间:2023-08-14 21:15:23浏览次数:54  
标签:logger java JUL util logging Java Logger 日志

目录

一、 简介

JUL 全称 Java util Logging 是 java 原生的日志框架,使用时不需要另外引用第三方类库,相对其他日志框架使用方便,学习简单,能够在小型应用中灵活使用。

  • Loggers:被称为记录器,应用程序通过获取 Logger 对象,调用其 API 来来发布日志信息。Logger 通常时应用程序访问日志系统的入口程序。
  • Appenders:也被称为 Handlers,每个 Logger 都会关联一组 Handlers,Logger 会将日志交给关联 Handlers 处理,由 Handlers 负责将日志做记录。Handlers 在此是一个抽象,其具体的实现决定了日志记录的位置可以是控制台、文件、网络上的其他日志服务或操作系统日志等。
  • Layouts:也被称为 Formatters,它负责对日志事件中的数据进行转换和格式化。Layouts 决定了数据在一条日志记录中的最终形式。
  • Level:每条日志消息都有一个关联的日志级别。该级别粗略指导了日志消息的重要性和紧迫,我可以将 Level 和 Loggers,Appenders 做关联以便于我们过滤消息。
  • Filters:过滤器,根据需要定制哪些信息会被记录,哪些信息会被放过。

总结一下就是:
用户使用 Logger 来进行日志记录,Logger 持有若干个 Handler,日志的输出操作是由 Handler 完成的。在 Handler 在输出日志前,会经过 Filter 的过滤,判断哪些日志级别过滤放行哪些拦截,Handler 会将日志内容输出到指定位置(日志文件、控制台等)。Handler 在输出日志时会使用 Layout,将输出内容进行排版。

二、使用

添加 pom 坐标

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.13.2</version>
        </dependency>

注:使用 test 作用域则只能在测试时使用

package com.mcode.logger;

import org.junit.Test;

import java.io.File;
import java.io.InputStream;
import java.util.logging.*;

/**
 * ClassName: JULTest
 * Package: com.mcode.logger
 * Description:
 *
 * @Author robin
 * @Create 2023/8/14 21:38
 * @Version 1.0
 */
public class JULTest {
    /**
     * 入门测试
     * @throws Exception
     */
    @Test
    public void testQuick() throws Exception {
        // 1.创建日志记录器对象
        Logger logger = Logger.getLogger("com.mcode.logger.JULTest");

        // 2.日志记录输出
        logger.info("hello jul");

        logger.log(Level.INFO, "info msg");

        String name = "jack";

        Integer age = 18;

        logger.log(Level.INFO, "用户信息:{0},{1}", new Object[]{name, age});
    }
}

image

三、日志级别

* java.util.logging.Level中定义了日志的级别:
        SEVERE(最高值)
        WARNING
        INFO (默认级别)
        CONFIG
        FINE
        FINER
        FINEST(最低值)

* 还有两个特殊的级别:
OFF,可用来关闭日志记录。
ALL,启用所有消息的日志记录。

虽然我们测试了 7 个日志级别但是默认只实现 info 以上的级别

package com.mcode.logger;

import org.junit.Test;

import java.io.File;
import java.io.InputStream;
import java.util.logging.*;


/**
 * ClassName: JULTest
 * Package: com.mcode.logger
 * Description:
 *
 * @Author robin
 * @Create 2023/8/14 20:38
 * @Version 1.0
 */
public class JULTest {
    /**
     * 日志级别
     * @throws Exception
     */
    @Test
    public void testLogLevel() throws Exception {
        // 1.获取日志对象
        Logger logger = Logger.getLogger("com.mcode.logger.JULTest");
        // 2.日志记录输出
        logger.severe("severe");
        logger.warning("warning");
        logger.info("info"); //默认级别info
        logger.config("cofnig");
        logger.fine("fine");
        logger.finer("finer");
        logger.finest("finest");
    }
}

image

自定义日志级别

    /**
     * 自定义日志级别
     * @throws Exception
     */
    @Test
    public void testLogConfig() throws Exception {
        // 1.创建日志记录器对象
        Logger logger = Logger.getLogger("com.mcode.logger.JULTest");

        // 一、自定义日志级别
        // a.关闭系统默认配置
        logger.setUseParentHandlers(false);
        // b.创建handler对象
        ConsoleHandler consoleHandler = new ConsoleHandler();
        // c.创建formatter对象
        SimpleFormatter simpleFormatter = new SimpleFormatter();
        // d.进行关联
        consoleHandler.setFormatter(simpleFormatter);
        logger.addHandler(consoleHandler);
        // e.设置日志级别
        logger.setLevel(Level.ALL);
        consoleHandler.setLevel(Level.ALL);

        // 二、输出到日志文件
        //获取文件对象
        File file = new File("d:/logs");
        //创建文件夹
        if (!file.exists()) {
            file.mkdir();
        }
        FileHandler fileHandler = new FileHandler("d:/logs/jul.log");

        fileHandler.setFormatter(simpleFormatter);

        logger.addHandler(fileHandler);

        // 2.日志记录输出
        logger.severe("severe");
        logger.warning("warning");
        logger.info("info");
        logger.config("config");
        logger.fine("fine");
        logger.finer("finer");
        logger.finest("finest");

    }

image

image

四、Logger 继承关系

JUL 中 Logger 之间存在父子关系,这种父子关系通过树状结构存储,JUL 在初始化时会创建一个顶层 RootLogger 作为所有 Logger 父 Logger,存储上作为树状结构的根节点。并父子关系通过路径来关联。

    /**
     * 日志继承
     * @throws Exception
     */
    @Test
    public void testLogParent() throws Exception {
        Logger logger1 = Logger.getLogger("com.mcode.logger.JULTest");
        Logger logger2 = Logger.getLogger("com.mcode.logger");
        System.out.println(logger1.getParent() == logger2); //true
        //logger2.parent:java.util.logging.LogManager$RootLogger@61e717c2,name:
        System.out.println("logger2.parent:" + logger2.getParent() + ",name:" +
                logger2.getParent().getName());

        // 一、自定义日志级别
        // a.关闭系统默认配置
        logger2.setUseParentHandlers(false);
        // b.创建handler对象
        ConsoleHandler consoleHandler = new ConsoleHandler();
        // c.创建formatter对象
        SimpleFormatter simpleFormatter = new SimpleFormatter();
        // d.进行关联
        consoleHandler.setFormatter(simpleFormatter);
        logger2.addHandler(consoleHandler);
        // e.设置日志级别
        logger2.setLevel(Level.ALL);
        consoleHandler.setLevel(Level.WARNING);
        // 测试日志记录器对象父子关系
        logger1.severe("severe");
        logger1.warning("warning");
        logger1.info("info");
        logger1.config("config");
        logger1.fine("fine");
        logger1.finer("finer");
        logger1.finest("finest");
    }

image

五、配置文件

默认配置文件路径$JAVA_HOME\jre\lib\logging.properties

image

    /**
     * 日志配置文件
     * @throws Exception
     */
    @Test
    public  void testLogProperties() throws Exception {
        InputStream is = JULTest.class.getClassLoader().getResourceAsStream("logging.properties");
        LogManager logManager = LogManager.getLogManager();
        logManager.readConfiguration(is);
        Logger logger = Logger.getLogger("com.mcode.logger.JULTest");
        // 2.日志记录输出
        logger.severe("severe");
        logger.warning("warning");
        logger.info("info");
        logger.config("config");
        logger.fine("fine");
        logger.finer("finer");
        logger.finest("finest");

        Logger logger1 = Logger.getLogger("test");
        logger1.severe("severe");
        logger1.warning("warning");
        logger1.info("info");
        logger1.config("config");
        logger1.fine("fine");
        logger1.finer("finer");
        logger1.finest("finest");
    }
## RootLogger使用的处理器(获取时设置)
handlers= java.util.logging.ConsoleHandler
# RootLogger日志等级
.level= INFO
## 自定义Logger
com.mcode.handlers= java.util.logging.FileHandler
# 自定义Logger日志等级
com.mcode.level= INFO
# 忽略父日志设置
com.mcode.useParentHandlers=false
## 控制台处理器
# 输出日志级别
java.util.logging.ConsoleHandler.level = INFO
# 输出日志格式
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter
## 文件处理器
# 输出日志级别
java.util.logging.FileHandler.level= INFO
# 输出日志格式
java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter
# 输出日志文件限制大小(50000字节)
java.util.logging.FileHandler.limit = 50000
# 输出日志文件限制个数
java.util.logging.FileHandler.count = 10
# 输出日志文件 是否是追加
java.util.logging.FileHandler.append=true
# 输出日志文件路径
java.util.logging.FileHandler.pattern = d:/logs/jul%u.log

image

六、原理解析

  1. 初始化 LogManager
    1. LogManager 加载 logging.properties 配置
    2. 添加 Logger 到 LogManager
  2. 从单例 LogManager 获取 Logger
  3. 设置级别 Level,并指定日志记录 LogRecord
  4. Filter 提供了日志级别之外更细粒度的控制
  5. Handler 是用来处理日志输出位置
  6. Formatter 是用来格式化 LogRecord 的

读取配置文件

LogManger.ensureLogManagerInitialize=>
LogManger.readPrimordialConfiguration=>
LogManger.readConfiguration()=>
LogManger.readConfiguration()

FileHandler 中配置

    private void configure() {
        LogManager manager = LogManager.getLogManager();

        String cname = getClass().getName();

        pattern = manager.getStringProperty(cname + ".pattern", "%h/java%u.log");
        limit = manager.getIntProperty(cname + ".limit", 0);
        if (limit < 0) {
            limit = 0;
        }
        count = manager.getIntProperty(cname + ".count", 1);
        if (count <= 0) {
            count = 1;
        }
        append = manager.getBooleanProperty(cname + ".append", false);
        setLevel(manager.getLevelProperty(cname + ".level", Level.ALL));
        setFilter(manager.getFilterProperty(cname + ".filter", null));
        setFormatter(manager.getFormatterProperty(cname + ".formatter", new XMLFormatter()));
        try {
            setEncoding(manager.getStringProperty(cname +".encoding", null));
        } catch (Exception ex) {
            try {
                setEncoding(null);
            } catch (Exception ex2) {
                // doing a setEncoding with null should always work.
                // assert false;
            }
        }
    }

ConsoleHandler 中配置

    private void configure() {
        LogManager manager = LogManager.getLogManager();
        String cname = getClass().getName();

        setLevel(manager.getLevelProperty(cname +".level", Level.INFO));
        setFilter(manager.getFilterProperty(cname +".filter", null));
        setFormatter(manager.getFormatterProperty(cname +".formatter", new SimpleFormatter()));
        try {
            setEncoding(manager.getStringProperty(cname +".encoding", null));
        } catch (Exception ex) {
            try {
                setEncoding(null);
            } catch (Exception ex2) {
                // doing a setEncoding with null should always work.
                // assert false;
            }
        }
    }

标签:logger,java,JUL,util,logging,Java,Logger,日志
From: https://www.cnblogs.com/vic-tory/p/17629722.html

相关文章

  • java高级之多线程
    1.什么是多线程首先引入程序与进程概念:程序(program)程序是为完成特定任务、用某种语言编写的一组指令的集合。即指一段静态的代码(还没有运行起来),静态对象。进程(process)进程是程序的一次执行过程,也就是说程序运行起来了,加载到了内存中,并占用了cpu的资源。这是一个动态的过......
  • java中语法糖
    概念   语法糖(SyntacticSugar),也称糖衣语法。指的是在计算机语言中添加的某种语法,这种语法对语言的编译结果和功能并没有实际影响,但是却能更方便程序员使用该语言。用处   通常来说使用语法糖能够减少代码量、增加程序的可读性,从而减少程序代码出错的机会。举例  ......
  • Java中常用的设计模式
    Java中常用的设计模式有以下几种:单例模式(SingletonPattern):确保一个类只有一个实例,并提供全局访问点。工厂模式(FactoryPattern):通过工厂类创建对象,隐藏对象的实例化过程。抽象工厂模式(AbstractFactoryPattern):提供一个创建一系列相关或相互依赖对象的接口,而无需指定具体类。建造者......
  • java_零钱通_面向过程版本
    packagechange;importjava.text.SimpleDateFormat;importjava.util.Date;importjava.util.Scanner;publicclassChange{publicstaticvoidmain(String[]args){booleanloop=true;Scannerscanner=newScanner(System.in);......
  • java_零钱通_面向对象版本
    功能packagechange2;importjava.text.SimpleDateFormat;importjava.util.Date;importjava.util.Scanner;publicclassChangeOOPFunction{//状态booleanloop=true;Scannerscanner=newScanner(System.in);Stringkey="";......
  • Java入门学习——二进制、八进制、十六进制
    一、十进制转二进制的算法十进制数转二进制数:除二取余法。  二、十进制转十进制的算法三、二进制转十进制的算法    四、八进制、十六进制介绍为了便于观察和表示二进制,推出八进制和十六进制。每3位二进制作为一个单元,最小数是0(000),最大数是7(111),共8个数字,这就是......
  • Java基础之--内部类
    1、局部内部类比如: 2、匿名内部类 packagecom.lwx.inner;publicclassAnonymousInnerClass{publicstaticvoidmain(String[]args){Outer02outer02=newOuter02();outer02.m1();}}classOuter02{privateintn1=20;......
  • JavaScript建造者模式:构建复杂对象的利器
    JavaScript建造者模式JavaScript建造者模式是一种创建对象的设计模式,它可以帮助我们构建复杂的对象,同时保持代码的可读性和可维护性。在本文中,我们将介绍JavaScript建造者模式的基本概念和使用方法,并通过一个实际的例子来说明它的应用。什么是JavaScript建造者模式?JavaScript建......
  • CF793F Julia the snail 题解
    题意有一个长为\(n\)的杆,上面有\(m\)条绳子,每条绳子可以让蜗牛从\(l_i\)爬到\(r_i\)(中途不能离开),保证\(r_i\)各不相同。蜗牛也可以自然下落。现在有\(q\)次询问,询问\(x\)出发,途中高度不能低于\(x\)或高于\(y\),问最高能爬到的位置。\(n,m,q\leq10^5\)。题解......
  • JavaSE基础知识
    1.JavaSE基础知识1.数据类型1.1.基本类型1子节=8位1byte=8bit整数型类型占用字节范围byte1-128(-2^7)~127(2^7-1)short2-2^15~2^15-1int4-2^31~2^31-1long8-2^63~2^63-1浮点型类型占用字节float4double8......