Java EE 突击 9 - Spring Boot 日志文件

Spring Boot 日志文件

  • 学习目标
  • 一 . 日志有什么用
    • 1.1 日志格式说明
  • 二 . 自定义日志打印
    • 2.1 得到日志对象
    • 2.2 使用日志对象提供的方法 , 输出自定义的日志内容
    • 2.3 日志的级别
  • 三 . 日志持久化
    • 3.1 在配置文件里面设置日志名称
    • 3.2 设置日志的保存目录
  • 四 . 日志级别的设置
  • 五 . 简化日志的小技巧 - lombok
    • 5.1 lombok 的使用
    • 5.2 lombok 的原理
    • 5.3 lombok 更多注解说明
  • 总结

这个专栏给大家介绍一下 Java 家族的核心产品 - SSM 框架
JavaEE 进阶专栏

Java 语言能走到现在 , 仍然屹立不衰的原因 , 有一部分就是因为 SSM 框架的存在

接下来 , 博主会带大家了解一下 Spring、Spring Boot、Spring MVC、MyBatis 相关知识点

并且带领大家进行环境的配置 , 让大家真正用好框架、学懂框架

来上一篇文章复习一下吧
点击即可跳转到我的小秘密
在这里插入图片描述

学习目标

  1. 输出自定义日志信息
  2. 将日志持久化
  3. 通过设置日志的级别来筛选和控制日志的内容

一 . 日志有什么用

日志只有一个作用 : 发现问题 定位问题
我们之前已经使用了很多次的日志
image.png
除了发现和定位问题之外,我们还可以通过日志实现以下功能:

  • 记录用户登录日志,方便分析用户是正常登录还是恶意破解用户。
  • 记录系统的操作 , 方便数据恢复和定位操作。
  • 记录程序的执行时间 , 方便为以后优化程序提供数据支持。

1.1 日志格式说明

image.png
日志打印级别 : 用来筛选有效信息

在日常调试和开发过程中 , 我们需要看的日志通常会比较多 , 在生产环境的时候 , 我们并不需要看调试日志以及开发日志 , 我们就可以把他屏蔽掉 , 也可以把 Spring Boot 展示给我们的日志(INFO) 也关闭掉 , 只展示报错以及警告信息 , 那么我们就可以通过日志的级别来进行筛选关键信息 . 而且打印日志也是会消耗一定资源的 , 所以在线上环境就尽量别弄出什么幺蛾子了 .

通过目前我们了解到的日志 , 我们发现三个问题 :

  1. 这是 Spring Boot 默认的日志格式 , 目前我们打印出的都是系统自己的日志 , 那么我们怎么样能让控制台打印我们自己的日志 ?
  2. 我们的日志是保存在我们的内存上的 , 那么假如我们的线上环境出现了问题 , 我们也不能说让人一直去看着 , 出现问题赶紧把开发人员叫过来查看日志 , 所以日志的持久化保存也是非常有必要的
  3. 我们需要通过日志的级别来筛选我们需要的信息

二 . 自定义日志打印

自定义日止的实现步骤 :

  1. 在程序中得到日志对象
  2. 使用日志对象的相关语法输出要打印的内容

我们思考一个问题 : 使用 sout 语句能否替代日志呢 ?
TestController.java

package com.example.demo.aa.bb;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

// 这个注解什么意思先不用管
@RestController
public class TestController {

    // 这个注解什么意思先不用管
    @RequestMapping("/sayhi")
    public String sayHi() {
        System.out.println("这里正在测试日志");
        return "日志";
    }
}

我们这不也打印出相关信息了吗 ?
image.png
但是感觉跟正常的日志差得有点多 , 感觉不太靠谱

  1. 只有打印的内容 , 没有其他的相关信息 , 比如打印的时间、打印的类(出处)
  2. 不能实现不同环境下的行为控制

比如我们的日志能够通过日志级别筛选 , 让线上环境或者开发环境展示出不同的信息 , 而 sout 语句不行 , 他会在哪里都打印的

所以使用 sout 语句是不能替代日志的 , 还是需要专业的人干专业的事的

2.1 得到日志对象

导入 Logger 对象
注意 : 一定要选择 org.slf4j (飒楼否四节)
然后使用 Logger 的 LoggerFactory 里面的 getLogger 方法, 参数填写当前类.class
image.png
image.png
image.png

2.2 使用日志对象提供的方法 , 输出自定义的日志内容

使用 log. 的方式 , 接下来我们就可以打印日志了

package com.example.demo.aa.bb;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    // 1. 得到日志对象
    private static Logger log = LoggerFactory.getLogger(TestController.class);

    @RequestMapping("/sayhi")
    public String sayHi() {
        // 2. 打印日志
        log.info("Hi,Spring Boot Log.");//使用日志对象的方法输出日志
        return "日志";
    }
}

image.png
那么我们上面告诉大家一定要用 slf4j , 那么 slf4j 是个什么东西 ?
我们的 slf4j 与 Spring Boot 是密切相关的 , slf4j 也是目前行业中的日志标杆了 , 他的日志以我们目前对于 Spring Boot 的理解来说 , 还算是比较复杂的 . 但看似很简单的日志 , 其实是由两部分实现的
image.png
我们可以这样理解 : 日志门面就是前端 , 日志实现就是后端
为什么一个简简单单的日志还要分解为日志门面还有日志实现呢 ?
最刚开始 , 其实日志是不分类的 , 后来发现了一个问题 : 我们的代码通用性问题 , 假如我们最开始用 log4j 1/2 , 但是后来他就出现漏洞了 , 所以大家又转战到了 logback , 但是使用 logback 就出现了问题 : 我们之前所有调用日志代码的地方就需要去更改 , 这样日志就没有通用性了 , 所以我们就再抽象一层 , 我们是从 slf4j 使用的 , slf4j 会自己帮我们解决好适配性问题 , 提高代码的移植性
其实和我们 JDBC 的问题是一样的 , 大家都是为了能够提高代码的通用性

2.3 日志的级别

我们不光可以打印普通日志 , 还可以打印其他等级的日志

package com.example.demo.aa.bb;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
    // 1. 得到日志对象
    private static Logger log = LoggerFactory.getLogger(TestController.class);

    @RequestMapping("/sayhi")
    public String sayHi() {
        // 2. 打印日志
        // 级别从上到下逐个提升的
        log.trace("Hi,I am trace.");//痕迹日志
        log.debug("Hi,I am debug.");//调试日志
        log.info("Hi,I am info.");//普通日志
        log.warn("Hi,I am warn.");//警告日志
        log.error("Hi,I am error");//报错
        return "日志";
    }
}

image.png
那为什么剩下两个没被打印呢 ?
这是因为默认情况下日志级别是 info , 所以就把 trace debug 筛选下去了
那么我们都有哪些级别的日志呢 ?
image.png

  • trace:微量,少许的意思,级别最低;
  • debug:需要调试时候的关键信息打印;
  • info:普通的打印信息;
  • warn:警告,不影响使用,但需要注意的问题;
  • error:错误信息,级别较高的错误日志信息;
  • fatal:致命的,因为代码异常导致程序退出执行的事件。

那么我们上面只打印出来五种啊 , 咋没打印第六种 .
image.png
可以看到 , 我们是调用不出来 fatal 的 . 这种致命的错误不是你说调就调出来的 , 当发生异常情况导致终止的时候才能看到 fatal , 甚至说严重点 , 还没有多少人见过他的芳容 .

三 . 日志持久化

3.1 在配置文件里面设置日志名称

我们在 application.yml 里面添加这句配置项

# 设置日志文件的文件名
logging:
  file:
    name: springboot.log

接下来运行查看一下效果
image.png
还可以这样去看
image.png
image.png
image.png
如果有的同学没看见日志在哪里 , 可以把 target 文件夹删除 , 重新运行再来看
image.png
接下来 , 我们就可以把项目停掉 , 来看一下咱们的日志
image.png
那么我们重新运行 , 新的日志是追加在后面还是覆盖掉 ?
肯定是追加在后面 , 不然还是有日志丢失的风险 .
重新运行后的日志就变多了
image.png
那么日志一直追加 , 越来越大 , 打开的速度就会变得非常慢 , 寻找日志就比较麻烦 , 那怎么办呢 ?
当日志比较大的时候 , 会自动分割成多个文件 , 所以不用去担心

3.2 设置日志的保存目录

# 设置日志文件的目录
logging:
  file:
    path: D:\study\JavaCode

我们打开这个目录看一下是否真的生成了 ?
image.png
那么我们把程序停止 , 看看日志里面有什么 ?
image.png
那么这种方式能不能追加日志呢 ?
也是可以追加的
image.png

四 . 日志级别的设置

日志级别的设置非常的精细化 , 可以针对于某个目录设置日志级别 , 还可以设置一个全局的日志级别
日志级别配置只需要在配置文件中设置 “logging level” 配置项即可

logging:
  level:
    root: debug

image.png
注意 : 我们之前写过 logging , 要是再写一个 logging 的话就会报错
image.png
所以我们可以在一个 logging 标签底下写多个配置项

logging:
  file:
    path: D:\study\JavaCode
  level:
    root: warn # 根路径

那么有的人只想看到自己的 DEBUG 日志 , 不想看到 Spring 的 DEBUG 日志 , 因为 Spring 的 DEBUG 日志实在是太多了 , 那么我们就可以把系统日志设置的级别高一些 , 可以让 Spring 的日志级别设置成 warn , 我们自己的代码的日志级别设置成 debug

logging:
  file:
    path: D:\study\JavaCode
  level:
    root: warn # 根路径
    com:
      example:
        demo: debug # com.example.demo 下面的所有类,日志级别都是 debug

image.png
那么我们想要自己的日志级别为 trace , 系统日志为 warn 怎么处理呢 , 同样很简单

logging:
  file:
    path: D:\study\JavaCode
  level:
    root: warn # 根路径
    com:
      example:
        demo: trace

image.png


接下来 , 我们模拟一下真实的开发环境
上节课我们学过多平台的配置文件设置 , 那么我们就可以根据不同的环境打印出不同等级的日志了
首先 , 我们创建出三个不同的环境的配置文件

开发环境的配置文件 : application-dev.yml
测试环境的配置文件 : application-test.yml
生产环境的配置文件 : application-prod.yml

然后我们分别在每个配置文件中设置不一样的端口 , 方便我们后续测试效果
image.png
然后接下来设置每个环境的日志等级
开发环境设置成系统日志为 warn , 自己的日志为 debug
测试环境设置成系统日志为 warn , 自己的日志为 info
生产环境设置成系统日志为 warn , 自己的日志为 warn
image.png
接下来在我们总的配置文件中调用每个单独的配置文件

# 运行环境设置
spring:
  profiles:
    active: dev

记得这里要去浏览器访问 127.0.0.1:8888/sayhi, 因为我们的开发环境配置文件端口号是 8888
image.png
这次访问 127.0.0.1:9999/sayhi

# 运行环境设置
spring:
  profiles:
    active: test

image.png
这次访问 127.0.0.1:11111/sayhi

# 运行环境设置
spring:
  profiles:
    active: prod

image.png

五 . 简化日志的小技巧 - lombok

我们在 com.example.demo 包底下新建一个 StudentController 类
然后编写代码

package com.example.demo;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class StudentController {
    // 1. 得到日志对象
    private static Logger logger = LoggerFactory.getLogger(StudentController.class);

    @RequestMapping("/hi")
    public String sayHi() {
        // 2. 使用日志对象提供的方法进行日志打印
        logger.trace("Hi,I am trace.");
        logger.debug("Hi,I am debug.");
        return "Hi,Spring Boot.";
    }
}

image.png
但是每次这样写 , 我们还觉得怪麻烦的
那我们的 Spring Boot 还是可以解决这个问题的
这就需要我们使用额外的库 - lombok
我们之前不想写 Getter Setter 方法 , 只要在上面加上 @Getter @Setter 注解 , 甚至直接加一个 @Data 注解即可
等到日志这里 , 我们发现唯一不同的 ,就是图片里圈出来那部分 , lombok 发现了 , 只有类型不同 , 那么我们只需要拿到当前类的类型呗 , 那我就通过一个注解帮你完成 , 注解内部就是我们图片里的这句代码 , lombok 自动帮我们获取类型了
那怎么使用 lombok 来更简单的输出呢 ?

5.1 lombok 的使用

  1. 添加 lombok 框架支持。
  2. 使用 @slf4j 注解输出日志。
package com.example.demo;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

// 1. 引入 lombok 依赖
@Slf4j
@RestController
public class StudentController {

    @RequestMapping("/hi")
    public String sayHi() {
        // 2. 使用日志对象提供的方法进行日志打印
        log.debug("Hi,I am debug.");
        return "Hi,Spring Boot.";
    }
}

image.png


有的同学可能调用不出来 lombok , 比如这样
image.png
只需要添加 lombok 的依赖即可
右键 -> Generate
image.png
选择 Dependency
image.png
搜索 lombok , 选择第二个
image.png
这样 lombok 依赖就自己添加进去了
前提是 IDEA 版本是 2021.3.2+ , 其他版本我们也可以选择装一个插件 : EditStarters 实现依赖引入
image.png
image.png
image.png
这个页面似曾相识
image.png
这样依赖就添加进去了 , 记得手动刷新一下

5.2 lombok 的原理

image.png
image.png
image.png
image.png
image.png
image.png
image.png
实际上 , 原理就是这样
image.png
lombok 在编译期间就开始干活了 , 这样对于 JVM 来说是感知不到的 , 他就知道我们传过来的代码里面已经有日志对象了

5.3 lombok 更多注解说明

基本注解 :

注解作用
@Getter自动添加 getter 方法
@Setter自动添加 setter 方法
@ToString自动添加 toString 方法
@EqualsAndHashCode自动添加 equals 和 hashCode 方法
@NoArgsConstructor自动添加 无参构造 方法
@AllArgsConstructor自动添加 全属性的构造方法 方法 , 顺序按照属性的定义顺序
@NonNull属性设置成不能为 null
@RequiredArgsConstructor⾃动添加必需属性的构造方法 , final + @NonNull 的属性为必需

组合注解 :

注解作用
@Data@Getter + @Setter + @ToString +
@EqualsAndHashCode +
@RequiredArgsConstructor +
@NoArgsConstructor

日志注解 :

注解作用
@Slf4j添加⼀个名为 log 的日志,使用 slf4j

总结

日志是程序中的重要组成部分,试用日志可以快速的发现和定位问题,Spring Boot 提供了日志框架 , 默认情况下使用的是 info 日志级别将日志输出到控制台的,我们可以通过 lombok 提供的 @Slf4j 注解和 log 对象快速的打印自定义日志,⽇日志包含 6 个级别:

  • trace:微量,少许的意思,级别最低;
  • info:普通的打印信息;
  • debug:需要调试时候的关键信息打印;
  • warn:警告,不影响使用,但需要注意的问题;
  • error:错误信息,级别较高的错误日志信息;
  • fatal:致命的,因为代码异常导致程序退出执行的事件。

日志级别依次提升 , 而日志级别越高,收到的日志信息也就越少,我们可以通过配置日志的保存名称或保存目录来将日志永久地保存下来。


至此 , Spring Boot 的日志文件就分享完毕 , 给个三连来救救小猫
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/67268.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

Dockerfile定制Tomcat镜像

Dockerfile中的打包命令 FROM : 以某个基础镜像作为此镜像的基础 RUN : RUN后面跟着linux常用命令,如RUN echo xxx >> xxx,注意,RUN 不能用于执行命令,因为每个RUN都是独立运行的,RUN 的cd对镜像中的…

【玩转pandas系列】pandas加载数据,分箱操作和时间序列,绘制图形

知识目录 前言一、加载数据1 - 加载CSV文件2 - 加载Excel文件3 - 加载数据库数据 二、分箱1 - 等宽分箱2 - 等频分箱 三、时间序列1 - Timestamp和Period的创建2 - 索引和切片3 - 属性和移动4 - 频率转换5 - 数据聚合 四、pandas绘制图形1 - 折线图2 - 柱状图3 - 直方图4 - 饼图…

uniapp微信小程序 401时重复弹出登录弹框问题

APP.vue 登陆成功后,保存登陆信息 if (res.code 200) {uni.setStorageSync(loginResult, res)uni.setStorageSync(token, res.token);uni.setStorageSync(login,false);uni.navigateTo({url: "/pages/learning/learning"}) }退出登录 toLogout: func…

基于微信小程序的传染病酒店隔离平台设计与实现(Java+spring boot+MySQL+微信小程序)

获取源码或者论文请私信博主 演示视频: 基于微信小程序的传染病酒店隔离平台设计与实现(Javaspring bootMySQL微信小程序) 使用技术: 前端:html css javascript jQuery ajax thymeleaf 微信小程序 后端:…

Vue3 表单输入绑定简单应用

去官网学习→表单输入绑定 | Vue.js 运行示例&#xff1a; 代码&#xff1a;HelloWorld.vue <template><div class"hello"><h1>Vue 表单输入绑定</h1><input type"text" placeholder"输入框" v-model"msg"…

github pages 用法详解 发布自己的网站

github pages 基础用法 URL 规则 假设你的 github 帐号为 mygithub&#xff0c;需要发布的仓库名为 myrepo&#xff0c;那么 pages 的 URL 为&#xff1a; https://mygithub.github.io/myrepo 添加内容 用任意编辑器写好&#xff08;或者生成&#xff09;标准的网页内容&a…

/proc directory in linux

Its zero-length files are neither binary nor text, yet you can examine and display themUnder Linux, everything is managed as a file; even devices are accessed as files (in the /dev directory). Although you might think that “normal” files are either text …

由于目标计算机积极拒绝,无法连接。 Could not connect to Redis at 127.0.0.1:6379

项目在启动时候报出redis连接异常 然后查看是redis 连接被计算机拒绝 解决方法 打开redis安装文件夹 先打开redis-servce.exe挂着&#xff0c;再打开redis-cli.exe 也不会弹出被拒接的问题了。而且此方法不用每次都去cmd里输入命令。

nginx负载均衡(反向代理)

nginx负载均衡 负载均衡&#xff1a;由反向代理来实现。 nginx的七层代理和四层代理&#xff1a; 七层是最常用的反向代理方式&#xff0c;只能配置在nginx配置文件的http模块当中&#xff0c;而且配置方法名称&#xff1a;upstream模块&#xff0c;不能写在server模块中&#…

如何搭建个人的GPT网页服务

写在前面 在创建个人的 GPT网页之前&#xff0c;我登录了 Git 并尝试了一些开源项目&#xff0c;但是没有找到满足我个性化需求的设计。虽然许多收费的 GPT网页提供了一些免费额度&#xff0c;足够我使用&#xff0c;但是公司的安全策略会屏蔽这些网页。因此&#xff0c;我决定…

volatile,解决内存可见性引起的问题,wait和notify

补充&#xff1a;synchronized&#xff08;务必会读&#xff08;辛可肉耐子&#xff09;会写&#xff09;&#xff0c;要搭配一个对象的时候&#xff0c;不一定非要是访问的this成员 synchronized(锁对象&#xff09;{ 代码块} public synchronized static void func(){} 静态方…

木马免杀(篇一)基础知识学习

木马免杀&#xff08;篇一&#xff09;基础知识学习 ———— 简单的木马就是一个 exe 文件&#xff0c;比如今年hw流传的一张图&#xff1a;某可疑 exe 文件正在加载。当然木马还可能伪造成各式各样的文件&#xff0c;dll动态链接库文件、lnk快捷方式文件等&#xff0c;也可能…

.net core的Knife4jUI,让swagger更精致

要在 .NET Core 中使用 IGeekFan.AspNetCore.Knife4jUI&#xff0c;您可以按照以下步骤进行配置&#xff1a; 首先&#xff0c;安装 IGeekFan.AspNetCore.Knife4jUI NuGet 包。可以通过 Visual Studio 的 NuGet 包管理器或者 .NET CLI 进行安装。 在 Startup.cs 文件的 Config…

电脑数据怎么加密?电脑数据加密软件有哪些?

在生活和工作中&#xff0c;我们总离不开电脑&#xff0c;而电脑中那些重要的数据&#xff0c;需要我们加密保护。那么电脑数据该怎么加密呢&#xff1f;电脑数据加密软件又有哪些呢&#xff1f;下面我们就来了解一下吧。 电脑数据加密软件 一般来说&#xff0c;常见的电脑加密…

【从零学习python 】10.Python条件语句和if嵌套详解

文章目录 elif一、 elif的功能二、注意点if嵌套想一想&#xff1a; 一、if嵌套的格式二、if嵌套的应用为什么结果3和结果4相同&#xff1f;&#xff1f;&#xff1f; 猜拳游戏运行效果:参考代码: if补充内容三、自动类型转换进阶案例 elif 如果有这样一种情况&#xff1a;当条件…

Electron学习1 安装环境与第一个程序

Electron学习1 安装环境与第一个程序 一、 Electron 简介二、安装 nvm三、安装nodejs四、安装nrm五、安装electron1. npm 初始化2. 创建 package.json3. 安装electron4. 创建一个页面5. 创建文件main.js6. 创建预加载器文件 preload.js7. 启动程序 六、打包 一、 Electron 简介…

TS学习笔记

一、变量与常量 //1、类型 2、面向对象 //输出语句、 //变量 //声明变量 字母数字下划线 驼峰命名 let personname "李逍遥001"; var personname1 "李逍遥002"; personname "李逍遥003" document.write(personname " " pe…

希尔排序——C语言andPython

前言 步骤 代码 C语言 Python 总结 前言 希尔排序&#xff08;Shell Sort&#xff09;是一种改进的插入排序算法&#xff0c;它通过将数组分成多个子序列进行排序&#xff0c;逐步减小子序列的长度&#xff0c;最终完成整个数组的排序。希尔排序的核心思想是通过排序较远距…

【ChatGPT 指令大全】销售怎么借力ChatGPT提高效率

目录 销售演说 电话销售 产出潜在客户清单 销售领域计划 销售培训计划 总结 随着人工智能技术的不断进步&#xff0c;我们现在有机会利用ChatGPT这样的智能助手来改进我们的销售工作。在接下来的时间里&#xff0c;我将为大家介绍如何运用ChatGPT提高销售效率并取得更好的…

苹果电脑图像元数据编辑器:MetaImage for Mac

MetaImage for Mac是一款功能强大的照片元数据编辑器&#xff0c;它可以帮助用户编辑并管理照片的元数据信息&#xff0c;包括基本信息和扩展信息。用户可以根据需要进行批量处理&#xff0c;方便快捷地管理大量照片。 MetaImage for Mac还提供了多种导入和导出格式&#xff0…