目录
一. 打印日志的常见三种方法?
1.1 手动创建 Logger 对象(基于SLF4J API)
1.2 使用 Lombok 插件的 @Slf4j 注解
1.3 使用 Spring 的 Log 接口(使用频率较低)
二. 常见的 Logger,logger,log是有什么关系吗?
三. 日志的级别和推荐级别
一. 打印日志的常见三种方法?
1.1 手动创建 Logger 对象(基于SLF4J API)
第一种方法就是手动创建 logger 日志对象,直接通过 LoggerFactory 日志工厂创建即可,使用 Logger 类型来接收,这里实例对象就叫 "logger"。
SLF4J 是日志门面(Facade),它提供统一的日志接口,不直接实现日志功能。
核心类:org.slf4j.Logger
是 SLF4J 的核心接口,通过 LoggerFactory.getLogger()
创建实例。
打印日志也可以单个或多个参数,具体实例如下图,
注意每个"{}"对应一个参数即可,并且参数顺序要对的上。
import com.markerhub.entity.User;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;import java.time.LocalDateTime;public class MyClass {// 通过 LoggerFactory 日志工厂创建日志对象private static final Logger logger = LoggerFactory.getLogger(MyClass.class);public static void main(String[] args) {// 用法一:单个参数 logger 日志打印String message = "abcde";logger.info("这是手动创建的 logger 对象打出的日志:打印单个参数{}", message);// 用法二:多个参数 logger 日志打印int number = 100;String message2 = "abcdefg";long time = 1000000000000000000L;logger.info("这是手动创建的 logger 对象打出的日志:打印多个参数{},{},{}", number, message2, time);// 用法三:对象参数 logger 日志打印User user1 = new User();user1.setUsername("zhangsna");user1.setPassword("123456");user1.setCreated(LocalDateTime.now());user1.setEmail("123456@qq.com");user1.setStatus(1);logger.info("这是手动创建的 logger 对象打出的日志:打印对象参数{}", user1);logger.debug("debug 日志");logger.error("error 日志");}
}
运行程序,如下控制台打印所示,可以看出 info 就是普通的日志,debug 是调试日志,error 是错误日志。
这里之所以有颜色区分是因为小编使用了插件,插件名称:"Grep Console",有需要的小伙伴可以搜索看下使用教程。
1.2 使用 Lombok 插件的 @Slf4j 注解
第二种方法最简单,直接使用 @Slf4j 注解,但需要注意IDEA中需要安装了 Lombok 插件并且你的 spring boot 项目中引用了 lombok 依赖。
@Slf4j 是
lombok插件提供的一个注解,用于自动生成 SLF4J 的 Logger
实例,减少样板代码。其底层还是通过第一种方式去新建的 logger 对象。
<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId>
</dependency>
如下代码
注解在类的头上添加 @Slf4j 注解即可,然后就可以在本类的任意位置直接显式调用 log 对象,不需要再自行创建,非常方便。
import com.markerhub.entity.User;
import lombok.extern.slf4j.Slf4j;import java.time.LocalDateTime;@Slf4j
public class MyClass {public static void main(String[] args) {// 用法一:单个参数 logger 日志打印String message = "abcde";log.info("这是 @Slf4j 注解的 log 对象打出的日志:打印单个参数{}", message);// 用法二:多个参数 logger 日志打印int number = 100;String message2 = "abcdefg";long time = 1000000000000000000L;log.info("这是 @Slf4j 注解的 log 对象打出的日志:打印多个参数{},{},{}", number, message2, time);// 用法三:对象参数 logger 日志打印User user1 = new User();user1.setUsername("zhangsna");user1.setPassword("123456");user1.setCreated(LocalDateTime.now());user1.setEmail("123456@qq.com");user1.setStatus(1);log.info("这是 @Slf4j 注解的 log 对象打出的日志:打印对象参数{}", user1);log.debug("debug 日志");log.error("error 日志");}
}
运行程序,如下图,和上面的 logger 对象效果是完全一样的。
1.3 使用 Spring 的 Log 接口(使用频率较低)
如下代码所示,Spring 自身提供了 Log
接口也可以创建日志对象。
import com.markerhub.entity.User;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.time.LocalDateTime;public class MyClass {private static final Log logger = LogFactory.getLog(MyClass.class);public static void main(String[] args) {// 用法一:单个参数 logger 日志打印String message = "abcde";logger.info("这是 @Slf4j 注解的 log 对象打出的日志:打印单个参数{}",message);// 用法二:多个参数 logger 日志打印int number = 100;String message2 = "abcdefg";long time = 1000000000000000000L;logger.info("这是 @Slf4j 注解的 log 对象打出的日志:打印多个参数{},{},{}", number, message2, time);// 用法三:对象参数 logger 日志打印User user1 = new User();user1.setUsername("zhangsna");user1.setPassword("123456");user1.setCreated(LocalDateTime.now());user1.setEmail("123456@qq.com");user1.setStatus(1);logger.info("这是 @Slf4j 注解的 log 对象打出的日志:打印对象参数{}", user1);logger.debug("debug 日志");logger.error("error 日志");}
}
但是, Spring 提供的 logger 对象,无法像前两种一样输出参数值,这一点其实是不太友好的,不过 Spring 提供的这种日志输出方式基本也没人使用,同学们作为了解即可,主要还是前两种用的比较多。
二. 常见的 Logger,logger,log是有什么关系吗?
(1)Logger 是SLF4J提供的日志接口,用于创建日志对象(如 LoggerFactory.getLogger()
)。需要手动实例化。
(2)log 是通过 @Slf4j
注解生成的变量名,本质还是一个 Logger
实例。
(3)logger ,没有特殊含义,只是采用SLF4J提供的日志接口创建对象时,常常见对象命名为 logger 而已。
三. 日志的级别和推荐级别
如以下表格所示,日志的详细程度由高到低。一般情况下,日志输出的详细,越耗费系统性能,所以不建议将日志输出特别详细,适中即可,大部分都是选择 INFO 级别,也推荐大家尽量选择 INFO 或 DEBUG 。
级别 | 严重性 | 适用场景 | 生产环境建议 | 开发环境建议 |
---|---|---|---|---|
TRACE | 最低 | 详细追踪程序执行流程 | 关闭 | 按需开启 |
DEBUG | 低 | 调试代码逻辑和变量状态 | 关闭 | 开启 |
INFO | 中 | 监控应用运行状态和关键操作 | 开启 | 开启 |
WARN | 较高 | 潜在问题,不影响程序运行 | 开启 | 开启 |
ERROR | 高 | 功能错误,需人工干预 | 开启 | 开启 |
FATAL | 最高 | 致命错误,程序无法继续运行 | 开启 | 开启 |
日志级别的设置,基本在配置文件中设置的,方式如下
# 设置全局日志级别
logging.level.root=info# 设置特定包的日志级别
logging.level.com.example.myapp=debug# 自定义日志输出格式和文件路径
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n
logging.file.name=app.log