天津虚拟现实制作公司,成都seo网站建设,全球十大搜索引擎排名,wordpress和ucenterSpring Boot 使用 slf4j 日志
在开发中经常使用 System.out.println()来打印一些信息#xff0c;但是这样不好#xff0c;因为大量的使用 System.out 会增加资源的消耗。实际项目中使用的是 slf4j 的 logback 来输出日志#xff0c;效率挺高的#xff0c;Spring Boot 提供…Spring Boot 使用 slf4j 日志
在开发中经常使用 System.out.println()来打印一些信息但是这样不好因为大量的使用 System.out 会增加资源的消耗。实际项目中使用的是 slf4j 的 logback 来输出日志效率挺高的Spring Boot 提供了一套日志系统logback 是最优的选择。
控制台打印输出日志
System.out.println(需要输出的内容字符串)
一般在开发阶段需要输出的信息较多作为产品部署后则输出信息较少引入了一种常量的定义方式以控制是否输出日志
RestController
RequestMapping(/users)
public class UserController{PostMapper(/login)public String login(String username,String password){if(Constants.OUT_FLAG)System.out.printf(用户名称%s,用户口令:%s,username,password);return success;}
}可以通过 Constants 接口中的常量定义是否需要输出或者使用 int 型来控制不同的输出等级
外观模式【应用场景、优缺点、编码】
为子系统中的一组接口提供一个一致的界面外观模式定义了一个高层接口这个接口使得这一子系统更加容易使用。可以降低访问复杂系统的内部子系统时的复杂度简化客户端之间的接口。属于 23 种设计模式中的
结构型设计模式
优点 1、减少系统相互依赖。 2、提高灵活性。 3、提高了安全性。
缺点不符合开闭原则如果要改东西很麻烦继承重写都不合适。
编码实现
1、产品接口
public interface Shape{public void draw();
}2、具体实现
class Circle implement Shape{public void draw(){System.out.println(绘制一个圆形);}
}class Square implement Shape{public void draw(){System.out.println(绘制一个正方形);}
}3、定义子系统的外观或者门面。该子系统中包括多个产品组件
class ShapeFacade {private Circle circle;private Square square;public ShapeFacade(){circlenew Circle();squarenew Square();}public void drawCircle(){circle.draw();}public void drawSquare(){square.hashCode();}public void drawCircleAndSqure(){circle.draw();square.draw();}
}感觉电脑的例子更形象电脑整机是 CPU、内存、硬盘的外观。有了外观以后启动电脑和关闭电脑都简化了。直接 new 一个电脑。在 new 电脑的同时把 cpu、内存、硬盘都初始化好并且接好线。对外暴露方法启动电脑关闭电脑。 启动电脑按一下电源键启动 CPU、启动内存、启动硬盘 关闭电脑按一下电源键关闭硬盘、关闭内存、关闭 CPU 1、slf4j 介绍
SLF4J 即简单日志门面不是具体的日志解决方案它只服务于各种各样的日志系统。按照官方的说法SLF4J是一个用于日志系统的简单 Facade允许最终用户在部署其应用时使用其所希望的日志系统。
这里的意思是只需要按统一的方式写记录日志的代码而无需关心日志是通过哪个日志系统以什么风格输出的。因为它们取决于部署项目时绑定的日志系统。例如在项目中使用了 slf4j 记录日志并且绑定了 log4j即导入相应的依赖则日志会以 log4j 的风格输出后期需要改为以 logback 的风格输出日志只需要将 log4j替换成 logback 即可不用修改项目中的代码。这对于第三方组件的引入的不同日志系统来说几乎零学习成本况且它的优点不仅仅这一个而已还有简洁的占位符的使用和日志级别的判断。 slf4j-log4j 通过 slf4j 调用 log4j 的实现
1.1、添加依赖
dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-web/artifactIdexclusions!--排除自带的logback依赖--exclusiongroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-logging/artifactId/exclusionexclusions
/dependency
dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-log4j/artifactIdversion1.3.8.RELEASE/version
/dependency1.2、在 resources 根目录下创建一个 log4j 的配置文件 log4j.properties
og4j.rootLoggerDEBUG, stdout 根日志记录器参数 1 为需要输出的日志等级参数 2 为日志输出的目标地名称 stuout
log4j.appender.stdoutorg.apache.log4j.ConsoleAppender 设置 stdout 是控制台输出
log4j.appender.stdout.layoutorg.apache.log4j.PatternLayout 配置日志输出的格式
log4j.appender.stdout.layout.ConversionPattern%5p [%t] - %m%n
1.3、编程中使用日志记录器输出用户自定义日志信息
RestController
RequestMapping(/tests)
public class TestController{//通过日志工厂类获取日志记录参数是一个标识名称用于区分不同类对象中输出的日志信息一般会使用类名称作为参数private static final Logger LoggerFactory.getLogger(TestController.class);GetMapping(/login)public String logs(){//日志记录器中针对不同的日志输出等级提供了对应的方法例如debug方法表示
//日志输出的等级为debug可以通过配置文件控制那些等级的日志需要输出。只有日志记录器的输出等级大于配置文件的等级才能执行输出操作logger.warn(输出用户自定义日志信息);System.out.printf(logs...);return success;}
}Log4j 输出的目的地
org.apache.log4j.ConsoleAppender控制台
org.apache.log4j.FileAppender文件
org.apache.log4j.DailyRollingFileAppender每天产生一个日志文件
org.apache.log4j.RollingFileAppender文件大小到达指定尺寸的时候产生一个新的文件
org.apache.log4j.WriterAppender将日志信息以流格式发送到任意指定的地方
SpringBoot 输出日志
debug:
true 在 SpringBoot 框架启动时自动输出日志信息同时显示相互之间的依赖关系。仅仅用于开发阶段产品阶段一定关闭或者删除该配置
正因为 sfl4j 有如此多的优点阿里已经将 slf4j 作为他们的日志框架了。在《阿里 Java 开发手册(正式版)》中日志规约一项第一条就强制要求使用 slf4j
1.【强制】应用中不可直接使用日志系统Log4j、Logback中的 API而应依赖使用日志框架 SLF4J 中的 API使用门面模式的日志框架有利于维护和各个类的日志处理方式通一。
强制两个字体现出了 slf4j 的优势所以建议在实际项目中使用 slf4j 作为自己的日志框架。使用 slf4j 记录日志非常简单直接使用 LoggerFactory 创建即可。
目前 SpringBoot 针对日志系统默认采用 logback
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class Test {private static final Logger logger LoggerFactory.getLogger(Test.class);// ……
}application.yml 中对日志的配置
Spring Boot 对 slf4j 支持的很好内部已经集成了 slf4j一般在使用的时候会对 slf4j 做一下配置。
application.yml 文件是 Spring Boot 中唯一需要配置的文件一开始创建工程的时候是 application.properties文件一般推荐使用 yml 文件因为 yml 文件的层次感特别好看起来更直观但是 yml 文件对格式要求比较高比如英文冒号后面必须要有个空格否则项目估计无法启动而且也不报错。用 properties 还是 yml视个人习惯而定实际上都是可以的。
application.yml 文件中对日志的配置
logging: config: logback.xmllevel: 针对不同的包可以设置不同的日志输出等级基本格式为【包名称: 等级】com.ma.dao: tracelogging.config 是用来指定项目启动的时候读取哪个配置文件这里指定的是日志配置文件是根路径下的logback.xml 文件关于日志的相关配置信息都放在 logback.xml 文件中了。logging.level 是用来指定具体的mapper 中日志的输出级别例如配置表示 com.yan.dao 包下的所有 mapper 日志输出级别为 trace会将操作数据库的 sql 打印出来开发时设置成 trace 方便定位问题在生产环境上将这个日志级别再设置成 error级别即可。
常用的日志级别按照从高到低依次为ERROR、WARN、INFO、DEBUG 和 TRACE。可以通过日志输出等级来控制日志输出的详细程度
logback.xml 配置文件解析
在 application.yml 文件中指定了日志配置文件 logback.xmllogback.xml 文件中主要用来做日志的相关配置。
在 logback.xml 中可以定义日志输出的格式、路径、控制台输出格式、文件大小、保存时长等。
3.1 定义日志输出格式和存储路径
configuration property nameLOG_PATTERN value%date{HH:mm:ss.SSS} [%thread]
%-5level%logger{36} - %msg%n /
!--可以理解为定义常量name 就是常量名称value 就是对应的值--property nameFILE_PATH valueD:/logs/demo.%d{yyyy-MM-dd}.%i.log/
/configuration配置文件的含义首先定义一个格式命名为 LOG_PATTERN该格式中%date 表示日期%thread 表示线程名%-5level 表示级别从左显示 5 个字符宽度%logger{36}表示 logger 名字最长 36 个字符%msg 表示日志消息%n 是换行符。
然后再定义一下名为 FILE_PATH 文件路径日志都会存储在该路径下。%i 表示第 i 个文件当日志文件达到指定大小时会将日志生成到新的文件里这里的 i 就是文件索引日志文件允许的大小可以设置。这里需要注意的是不管是 windows 系统还是 Linux 系统日志存储的路径必须要是绝对路径。
3.2 定义控制台输出
configurationappender nameCONSOLE classch.qos.logback.core.ConsoleAppenderencoder!-- 按照上面配置的 LOG_PATTERN 来打印日志 --pattern${LOG_PATTERN}/pattern/encoder/appender
/configuration使用appender节点设置个控制台输出 classch.qos.logback.core.ConsoleAppender的配置定义为CONSOLE。使用上面定义好的输出格式 LOG_PATTERN 来输出使用${}引用进来即可。
3.3 定义日志文件的相关参数
configurationappender nameFILE classch.qos.logback.core.rolling.RollingFileAppenderrollingPolicy classch.qos.logback.core.rolling.TimeBasedRollingPolicy!-- 按照上面配置的 FILE_PATH 路径来保存日志 --fileNamePattern${FILE_PATH}/fileNamePatternmaxHistory15/maxHistory 日志保存 15 天timeBasedFileNamingAndTriggeringPolicy
classch.qos.logback.core.rolling.SizeAndTimeBasedFNATP!--单个日志文件的最大超过则新建日志文件存储--maxFileSize10MB/maxFileSize /timeBasedFileNamingAndTriggeringPolicy/rollingPolicyencoder!-- 按照上面配置的 LOG_PATTERN 来打印日志 --pattern${LOG_PATTERN}/pattern/encoder/appender
/configuration使用appender定义一个名为 FILE 的文件配置主要是配置日志文件保存的时间、单个日志文件存储的大小、以及文件保存的路径和日志的输出格式。
3.4 定义日志输出级别
configurationlogger namecom.ma levelINFO /root levelINFOappender-ref refCONSOLE /appender-ref refFILE //root
/configuration有了上面那些定义后最后使用来定义一下项目中默认的日志输出级别这里定义级别为 INFO然后针对 INFO 级别的日志使用引用上面定义好的控制台日志输出和日志文件的参数。这样 logback.xml文件中的配置就设置完了。
4、使用 Logger 在项目中打印日志
在代码中一般使用 Logger 对象来打印出一些 log 信息可以指定打印出的日志级别也支持占位符很方便。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
RestController
RequestMapping(/test)
public class TestController {private final static Logger logger LoggerFactory.getLogger(TestController.class);RequestMapping(/log)public String testLog() {logger.debug(测试日志 debug 级别打印);logger.info(测试日志 info 级别打印);logger.error(测试日志 error 级别打印);logger.warn(测试日志 warn 级别打印);// 可以使用占位符打印出一些参数信息String str1 blog.yang.com;String str2 blog.csdn.net/yangyang;// 输出日志内容时允许使用{}表示一个占位符后续参数按照位置对应进行赋值logger.info(羊羊的个人博客{}羊羊的 CSDN 博客{}, str1, str2);return success;}
}启动该项目在浏览器中输入 localhost:8080/test/log 后可以看到控制台的日志记录 测试日志 info 级别打印 测试日志 error 级别打印 测试日志 warn 级别打印 羊羊的个人博客blog.yang.com羊羊的 CSDN 博客blog.csdn.net/yangyang 因为 INFO 级别比 DEBUG 级别高所以 debug 这条没有打印出来如果将 logback.xml 中的日志级别设置成DEBUG那么四条语句都会打印出来可以测试。同时可以打开 D:\logs\demo\目录里面有刚刚项目启动以后后面生成的所有日志记录。在项目部署后大部分都是通过查看日志文件来定位问题。
5、总结
主要了解 slf4j 的使用并且对 Spring Boot 中使用 slf4j 输出日志有详细的说明着重分析 logback.xml 文件中对日志相关信息的配置包括日志的不同级别。最后针对这些配置在代码中使用 Logger 打印出一些进行测试。在实际项目中这些日志都是排查问题的过程中非常重要的资料。
