--- theme: channing-cyan highlight: atom-one-light --- 「回顾2022，展望2023，我正在参与[2022年终总结征文大赛活动](https://juejin.cn/post/7172462429929111559)」 ### 前言 > 背景：日志对于我们维护项目、寻找bug都是至关重要的。很多时候我们的项目都是运行在服务器中，因此查看日志其实也不是很方便，每次都得去打开服务器控制台，而且不是所有的成员都拥有查看服务器的权限，所以我们将解决的是如何不通过服务器直接快捷的查看日志信息。通常我们会把日志输出到外部文件中进行保存归档和查看，为了解决上述问题，让所有人都可以快速查看相关日志，我们可以在项目中直接读取这些日志文件，用接口进行查看，这样所有人只要访问相应项目的接口就可以查看相关日志 ### 一、引入相关依赖 ``` org.springframework.boot spring-boot-starter-web org.projectlombok lombok 1.18.4 commons-io commons-io 2.8.0 ``` ### 二、编写logback-spring.xml文件，放置在resources目录下 > 注：想要使用Spring扩展profile支持，要以logback-spring.xml命名，其他如property需要改为springProperty，对以下注解不了解的自行搜索，网上有很多资料对这些注解进行了详细的解释 ``` ${LOG_HOME}${APP_NAME}-%d{yyyy-MM-dd}-%i.log 7 10240KB %d %p (%file:%line)- %m%n UTF-8

``` ### 三、创建 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 "

" + logStringBuilder + "";
    }
}
```

### 六、总结

通常我们会创建一个父工程用于管理子工程，将该项目作为一个日志模块，即子工程，其他子工程只需在pom文件中引入该模块即可，如果不想每个项目都创建该日志模块，也可将该项目放到公共仓库中，这样就不需要项目中创建该日志模块，只需要直接在pom中像引入lombok等依赖一样直接引入该模块即可。

**存在的问题：** 目前输出的日志文件的大小默认是10M，超过10M将会被分割成多个文件，可自行调整为1k查看效果，我们当前的代码只能查看当天最新的日志文件，比如日志文件为11M,那我们只能看到那1M的日志。

**解决方案：** 我们可以在GetLogDTO中新增一个参数，用于控制查看当前文件的前N个文件，还可设置多一个参数，用于查看前N天的日志文件，这样就可以更方便我们查看这些文件，后续有时间我会把改良后的代码补充上来。