「回顾2022，展望2023，我正在参与2022年终总结征文大赛活动」
前言
背景：日志对于我们维护项目、寻找bug都是至关重要的。很多时候我们的项目都是运行在服务器中，因此查看日志其实也不是很方便，每次都得去打开服务器控制台，而且不是所有的成员都拥有查看服务器的权限，所以我们将解决的是如何不通过服务器直接快捷的查看日志信息。通常我们会把日志输出到外部文件中进行保存归档和查看，为了解决上述问题，让所有人都可以快速查看相关日志，我们可以在项目中直接读取这些日志文件，用接口进行查看，这样所有人只要访问相应项目的接口就可以查看相关日志
一、引入相关依赖
<!-- spring-boot-starter-web中包含了spring-boot-starter-logging -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 方便Setter、Getter 以及简化日志的使用：@Slf4j -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.4</version>
</dependency>
<!-- 读取日志文件需要用到 -->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.8.0</version>
</dependency>
二、编写logback-spring.xml文件，放置在resources目录下
注：想要使用Spring扩展profile支持，要以logback-spring.xml命名，其他如property需要改为springProperty，对以下注解不了解的自行搜索，网上有很多资料对这些注解进行了详细的解释
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!--应用名称-->
<springProperty scope="context" name="APP_NAME" source="spring.application.name" defaultValue="springBoot"/>
<!--日志文件保存路径-->
<property name="LOG_HOME" value="target/"/>
<springProfile name="prod">
<property name="LOG_HOME" value="/home/log/server/${APP_NAME}/"/>
</springProfile>
<springProfile name="test">
<property name="LOG_HOME" value="/home/log/test/server/${APP_NAME}/"/>
</springProfile>
<!-- %m输出的信息,%p日志级别,%t线程名,%d日期,%c类的全名,%i索引【从数字0开始递增】,,, -->
<!-- appender是configuration的子节点，是负责写日志的组件。 -->
<!-- ConsoleAppender：把日志输出到控制台 -->
<!-- <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">-->
<!-- <encoder>-->
<!-- <pattern>%d %p (%file:%line)- %m%n</pattern>-->
<!-- <!– 控制台也要使用UTF-8，不要使用GBK，否则会中文乱码 –>-->
<!-- <charset>UTF-8</charset>-->
<!-- </encoder>-->
<!-- </appender>-->
<!--引用默认日志配置-->
<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
<!--使用默认的控制台日志输出实现-->
<include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
<!-- RollingFileAppender：滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->
<!-- 以下的大概意思是：1.先按日期存日志，日期变了，将前一天的日志文件名重命名为XXX%日期%索引，新的日志仍然是demo.log -->
<!-- 2.如果日期没有发生变化，但是当前日志的文件大小超过1KB时，对当前日志进行分割 重命名-->
<springProfile name="prod,test">
<!-- 将日志输出到外部文件中 -->
<appender name="M33_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--<File>/data/log/tech.log</File>-->
<!-- rollingPolicy:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。 -->
<!-- TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!-- 活动文件的名字会根据fileNamePattern的值，每隔一段时间改变一次 -->
<!-- 文件名-->
<fileNamePattern>${LOG_HOME}${APP_NAME}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
<!-- 每产生一个日志文件，该日志文件的保存期限为7天 -->
<maxHistory>7</maxHistory>
<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!-- maxFileSize:这是活动文件的大小，默认值是10MB，测试时可改成1KB看效果 -->
<maxFileSize>10240KB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>
<encoder>
<!-- pattern节点，用来设置日志的输入格式 -->
<pattern>
%d %p (%file:%line)- %m%n
</pattern>
<!-- 记录日志的编码:此处设置字符集 - -->
<charset>UTF-8</charset>
</encoder>
</appender>
</springProfile>
<!-- 控制台输出日志级别 -->
<!-- 指定项目中某个包，当有日志操作行为时的日志记录级别 -->
<!-- com.liyan为根包，也就是只要是发生在这个根包下面的所有日志操作行为的权限都是DEBUG -->
<!-- 级别依次为【从高到低】：FATAL > ERROR > WARN > INFO > DEBUG > TRACE -->
<logger name="com.test" level="info"/>
<!-- 以下配置可根据需要自行调整 -->
<!-- 在 dev 环境下，日志只输出到控制台，日志级别为info -->
<springProfile name="dev">
<root level="info">
<appender-ref ref="CONSOLE"/>
</root>
</springProfile>
<!-- 在 prod,test 环境下，日志输出到控制台以及外部文件中，M33_LOG 用于配置输入日志的文件路径以及格式等，日志级别为info -->
<springProfile name="prod,test">
<root level="info">
<appender-ref ref="CONSOLE"/>
<appender-ref ref="M33_LOG"/>
</root>
</springProfile>
</configuration>
三、创建 GetLogDTO 文件，用于控制查看的日志条数等
import lombok.Data;
@Data
public class GetLogDTO {
private Integer count = 500;
private Boolean error = false;
}
四、创建 LogController 文件，用于定义日志接口
@RestController
@RequestMapping("/log")
public class LogController {
@ApiIgnore
@GetMapping("/get")
public String get(GetLogDTO getLogDTO) {
return LogFileUtil.getLog(getLogDTO);
}
}
五、创建 LogFileUtil 工具类，用于读取日志文件并打印
import ch.qos.logback.classic.Logger;
import ch.qos.logback.core.rolling.RollingFileAppender;
import org.apache.commons.io.input.ReversedLinesFileReader;
import org.slf4j.LoggerFactory;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
public class LogFileUtil {
public static String getLog(GetLogDTO getLogDTO) {
StringBuilder logStringBuilder = new StringBuilder("");
Logger logger = (Logger) LoggerFactory.getLogger("ROOT");
// logTag 与 logback-spring.xml 中定义的用于输入日志文件的appender命名要一致，否则无法获取 // 到日志文件
String logTag = "M33_LOG";
RollingFileAppender rollingFileAppender = (RollingFileAppender) logger.getAppender(logTag);
String logFilePath = rollingFileAppender.getFile();
File logFile = new File(logFilePath);
InputStreamReader inputStreamReader = null;
BufferedReader bufferedReader = null;
ReversedLinesFileReader reversedLinesFileReader = null;
String enterString = "\n";
try {
if (getLogDTO.getCount() > 0) {
reversedLinesFileReader = new ReversedLinesFileReader(logFile, 4096, Charset.defaultCharset());
String lineText = null;
int lineCount = 0;
while (lineCount++ < getLogDTO.getCount() && (lineText = reversedLinesFileReader.readLine()) != null) {
logStringBuilder.insert(0, lineText).insert(0, enterString);
}
logStringBuilder.deleteCharAt(0);
} else {
inputStreamReader = new InputStreamReader(
new FileInputStream(logFile), "utf-8");
bufferedReader = new BufferedReader(inputStreamReader);
String lineText = "";
while ((lineText = bufferedReader.readLine()) != null) {
logStringBuilder.append(enterString).append(lineText);
}
}
} catch (Exception e) {
e.printStackTrace();
return "读取日志出错：" + e.getMessage();
} finally {
if (inputStreamReader != null) {
try {
inputStreamReader.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (bufferedReader != null) {
try {
bufferedReader.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (reversedLinesFileReader != null) {
try {
reversedLinesFileReader.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
return "<pre>" + logStringBuilder + "<pre></pre>";
}
}
六、总结
通常我们会创建一个父工程用于管理子工程，将该项目作为一个日志模块，即子工程，其他子工程只需在pom文件中引入该模块即可，如果不想每个项目都创建该日志模块，也可将该项目放到公共仓库中，这样就不需要项目中创建该日志模块，只需要直接在pom中像引入lombok等依赖一样直接引入该模块即可。
存在的问题： 目前输出的日志文件的大小默认是10M，超过10M将会被分割成多个文件，可自行调整为1k查看效果，我们当前的代码只能查看当天最新的日志文件，比如日志文件为11M,那我们只能看到那1M的日志。
解决方案： 我们可以在GetLogDTO中新增一个参数，用于控制查看当前文件的前N个文件，还可设置多一个参数，用于查看前N天的日志文件，这样就可以更方便我们查看这些文件，后续有时间我会把改良后的代码补充上来。
