日志、异常文件记录保存工具类文档

March 16, 2025 · View on GitHub

使用演示类 FileRecordUse 介绍了配置参数及使用

项目类结构

文件记录分析工具类（FileRecordUtils）：用于记录信息方便分析，支持存储目录、时间段保存

API 文档

文件记录分析工具类 -> FileRecordUtils.java

方法	注释
isSuccessful	校验记录方法返回字符串是否成功
isHandler	是否处理记录
setHandler	设置是否处理记录
getRecordInsert	获取日志记录插入信息
setRecordInsert	设置日志记录插入信息
setCallback	设置文件记录回调
getLogContent	获取日志内容
record	记录方法

日志记录配置信息 -> RecordConfig.java

方法	注释
get	获取配置信息
getStoragePath	获取存储路径
getFileName	获取文件名 ( 固定 )
getFolderName	获取文件夹名 ( 模块名 )
getFileIntervalTime	获取文件记录间隔时间
isHandler	是否处理记录
setHandler	设置是否处理记录
getRecordInsert	获取日志记录插入信息
setRecordInsert	设置日志记录插入信息
getFinalPath	获取文件地址

日志记录插入信息 -> RecordInsert.java

方法	注释
getFileInfo	getFileInfo
setFileInfo	setFileInfo
getLogHeader	getLogHeader
setLogHeader	setLogHeader
getLogTail	getLogTail
setLogTail	setLogTail

日志、异常文件记录保存使用方法

String storagePath = PathUtils.getAppExternal().getAppCachePath();

// 创建文件夹 ( 以秒为存储单位 ) 创建如: HH_23/MM_13/SS_01 对应文件夹, 并存储到该目录下
RecordConfig config = RecordConfig.get(storagePath, "Main_Module", RecordConfig.TIME.HH);

// 创建文件夹 ( 以小时为存储单位 ) 创建如: HH_23 对应文件夹, 并存储到该目录下
RecordConfig config2 = RecordConfig.get(storagePath, "User_Module", RecordConfig.TIME.HH);

// 存储到 storagePath/FileRecord/yyyy_MM_dd/FolderName/HH_number/MM_number/SS_number/ 内
FileRecordUtils.record(config, "日志内容");

// 保存错误信息
NullPointerException nullPointerException = new NullPointerException("报错啦, null 异常啊");

// 单独异常
FileRecordUtils.record(config2, nullPointerException);

// 异常 + 日志
FileRecordUtils.record(config2, "第一个日志内容", nullPointerException, "其他日志内容");