SpringBoot快速集成Logback日志组件
目录
- 前言
- 引入:
- 配置:
- 开发:
- 结语
前言
在前一节的分享中,慕歌向大家介绍了如何使用spring boot 实现简单的邮寄发送服务,用于验证码服务或者是通知服务。如果大家有兴趣,慕歌还想向大家进一步分享,如何在使用第三方服务,实现手机短信通知服务,就是那个我们每天都会使用到的短信验证码,通知服务。这一节慕歌想带来spring boot日志系统的分享,以及慕歌自己的实现的简易日志记录,慕歌会将日志同时保存在文件和数据库之中。
引入:
如果我们使用 logback 就无需额外引入依赖,在spring boot statrt 中已经默认集成了logback 日志。
<!-- logback--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
如果想要使用log4j2 日志需要排除默认日志,再引入,无需指定版本。
<!-- log4j2--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> <dependency>--> <groupId>org.springframework.boot</groupId>--> <artifactId>spring-boot-starter-log4j2</artifactId>--> </dependency>-->
配置:
引入日志依赖后,我们还需要指定日志的输出格式,需要再resource中新建一个文件 logback.xml 。如果对于日志无特殊要求可直接参考我的日志配置。
<?xml version="1.0" encoding="UTF-8"?> <configuration> <!-- 日志存放路径 --> <property name="log.path" value="/www/wwwroo/logs/"/> <!-- 日志输出格式 --> <property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n"/> <!-- 控制台输出 --> <appender name="console" class="ch.qos.logback.core.ConsoleAppender"> <encoder> <pattern>${log.pattern}</pattern> </encoder> </appender> <!-- 系统日志输出 --> <appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${log.path}/sys-info.log</file> <!-- 循环政策:基于时间创建日志文件 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 日志文件名格式 --> <fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern> <!-- 日志最大的历史 60天 --> <maxHistory>60</maxHistory> </rollingPolicy> <encoder> <pattern>${log.pattern}</pattern> </encoder> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <!-- 过滤的级别 --> <level>INFO</level> <!-- 匹配时的操作:接收(记录) --> <onMatch>ACCEPT</onMatch> <!-- 不匹配时的操作:拒绝(不记录) --> <onMismatch>DENY</onMismatch> </filter> </appender> <appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${log.path}/sys-error.log</file> <!-- 循环政策:基于时间创建日志文件 --> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 日志文件名格式 --> <fileNamePattern>${log.path}/sys-error.%d{yyyy-MM-dd}.log</fileNamePattern> <!-- 日志最大的历史 60天 --> <maxHistory>60</maxHistory> </rollingPolicy> <encoder> <pattern>${log.pattern}</pattern> </encoder> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <!-- 过滤的级别 --> <level>ERROR</level> <!-- 匹配时的操作:接收(记录) --> <onMatch>ACCEPT</onMatch> <!-- 不匹配时的操作:拒绝(不记录) --> <onMismatch>DENY</onMismatch> </filter> </appender> <!-- 用户访问日志输出 --> <appender name="sys-user" class="ch.qos.logback.core.rolling.RollingFileAppender"> <file>${log.path}/sys-user.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- 按天回滚 daily --> <fileNamePattern>${log.path}/sys-user.%d{yyyy-MM-dd}.log</fileNamePattern> <!-- 日志最大的历史 60天 --> <maxHistory>60</maxHistory> </rollingPolicy> <encoder> <pattern>${log.pattern}</pattern> </encoder> </appender> <!-- 系统模块日志级别控制 --> <logger name="com.ewem" level="info"/> <!-- Spring日志级别控制 --> <logger name="org.springframework" level="warn"/> <root level="info"> <appender-ref ref="console"/> </root> <!--系统操作日志--> <root level="info"> <appender-ref ref="file_info"/> <appender-ref ref="file_error"/> </root> <!--系统用户操作日志--> <logger name="sys-user" level="info"> <appender-ref ref="sys-user"/> </logger> </configuration>
这里的日志文件目录由于是使用的linux ,配置格式就是从根目录开始,需要换成你自己的日志输出目录。然后在配置中指定扫描路径,使用我们D定义的日志格式:
# 日志配置 logging: # 日志等级 level: # 更换成你的目录 channel.cert: info org.springframework: warn # 日志路径 config: classpath:logback.xml
完成以下日志配置后,即可在我们开发的时候随时打一个日志,用于错误排查。
开发:
那么在真实的开发中,我们如何在一段代码中引入日志呢。我们不妨可以将日志先看作最初学习的输出语句。可以在如何地方输出一条信息。日志与标准输出的不同在于,日志具有等级:
- 【TRACE】:trace是一种很低的日志级别,一般不会使用。目前,我只有在SpringBoot的启动之中,略微发现一些它的影子,表示的就是默认不打印的日志。
- 【DEBUG】:debug是一种调试程序的日志级别,一般用于程序开发过程中打印一些调试日志、运行信息,可以比较随意的使用。
- 【INFO】:info是用来输出程序的一些关键信息,强调业务逻辑的运行过程信息,不能随便打印。
- 【WARN】:warn是用于输出一些警告提示信息,一般是系统进入到一种可恢复的状态时打印的信息,警告但不是严重错误。
- 【ERROR】:error是系统已经发生错误的事件,比如发生了异常,但是不想影响系统的正常运行。可以打印一些错误信息,提示开发者关注或者定位问题。
日志是打印在日志文件之中的,如果大量的打印会造成日志文件的骤增导致磁盘空间快速增长。但是,排查问题的时候,我们都尽可能希望日志级别可以足够的细致。没有问题的时候,我们希望日志文件可以尽量减少磁盘的占用。所以,如果我们可以做到动态地去控制日志级别,实现动态打印日志,那就可以完美解决上诉的需求。
/** * 管理员 */ @Slf4j @RestController @RequestMapping("/admin") public class AdminUserController { @Autowired AdminUserService adminUserService; @Autowired AdminLogService adminLogService; //用户详情 @SaCheckLogin @RequestMapping("/searchOne") public R searchOne(@RequestBody AdminUser adminUser){ AdminUser user = adminUserService.getById(adminUser.getId()); log.trace("info"+user); log.info("info"+user); log.debug("info"+user); log.info("info"+user); log.warn("info"+user); return R.success(user); } }
在使用日志的时候不直接指定由logback 进行日志记录,而使用slf4j 上层接口,进行日志的写入。这样即使,我们更换了日志系统,并不会导致代码中使用了旧日志系统的日志点报错。
结语
到此这篇关于SpringBoot快速集成Logback日志组件的文章就介绍到这了,更多相关SpringBoot集成Logback日志组件内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!