net.sohelp.boot.admin.core.service.log

类 OperatorLogService

java.lang.Object

net.sohelp.boot.admin.core.service.log.OperatorLogService

@Service
public class OperatorLogService
extends Object

操作日志记录服务类，用于记录系统中的操作行为（如错误或普通信息）到数据库中。

从以下版本开始:

2024/3/24 12:12

作者:

AaronFung

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	OperatorLogService.LogTypeEnum 日志类型枚举：ERROR 表示错误日志，INFO 表示普通信息日志。

构造器概要

构造器

构造器和说明
OperatorLogService()

方法概要

限定符和类型	方法和说明
void	error(String message) 记录一条错误类型的日志。
void	info(String message) 记录一条普通信息类型的日志。
boolean	isErrorPrint() 判断是否允许向客户端输出详细的错误信息。
void	log(OperatorLogService.LogTypeEnum logTypeEnum, String message) 根据指定的日志类型和消息内容记录操作日志，并将相关信息存入数据库表 pb_operation_record 中。
void	log(String message) 默认调用 error 方法记录日志。

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

OperatorLogService

public OperatorLogService()

方法详细资料

error

public void error(String message)

记录一条错误类型的日志。

参数:

message - 错误描述信息

抛出:

SQLException - 数据库插入异常时抛出

info

public void info(String message)

记录一条普通信息类型的日志。

参数:

message - 描述信息

抛出:

SQLException - 数据库插入异常时抛出

log

public void log(String message)
         throws SQLException

默认调用 error 方法记录日志。

参数:

message - 日志消息内容

抛出:

SQLException - 数据库插入异常时抛出

log

@Comment(value="\u8bb0\u5f55\u64cd\u4f5c\u65e5\u5fd7")
public void log(OperatorLogService.LogTypeEnum logTypeEnum,
                                                                        String message)

根据指定的日志类型和消息内容记录操作日志，并将相关信息存入数据库表 pb_operation_record 中。

参数:

logTypeEnum - 日志类型（INFO 或 ERROR）

message - 日志详细信息

抛出:

RuntimeException - 当数据库操作失败时抛出运行时异常

isErrorPrint

@Comment(value="\u662f\u5426\u5411\u524d\u7aef\u51fa\u9519\u8bef\u4fe1\u606f")
public boolean isErrorPrint()

判断是否允许向客户端输出详细的错误信息。

返回:

true 表示可以输出错误详情；false 表示不应暴露敏感错误信息给前端