com.relaxed.common.log.biz.annotation

注释类型 BizLog

@Target(value={ANNOTATION_TYPE,METHOD})
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
public @interface BizLog

业务操作日志注解，用于标记需要记录业务操作日志的方法。 支持记录操作的系统、模块、操作类型、操作人、业务编号等信息， 并可以通过模板定义成功和失败时的日志内容。 该注解支持继承，可以被子类继承使用。

从以下版本开始:

1.0.0

作者:

Yakir

可选元素概要

可选元素

限定符和类型	可选元素和说明
String	bizNo 业务标识，用于关联具体的业务对象。
String	condition 日志记录条件，用于控制是否记录日志。
String	detail 操作详情，用于记录更详细的操作信息。
String	fail 操作失败时的日志文本模板。
String	moduleName 模块名称，用于标识操作所属的功能模块。
String	operator 操作执行人标识。
boolean	recordReturnValue 是否记录方法返回值。
String	success 操作成功时的日志文本模板。
String	systemName 系统名称，用于标识操作所属的系统。
String	type 操作类型，用于标识具体的操作行为。

元素详细资料

systemName

public abstract String systemName

系统名称，用于标识操作所属的系统。 当一个应用服务多个系统时，可以用来区分不同系统的日志。

返回:

系统名称，默认为空字符串

默认值:

""

moduleName

public abstract String moduleName

模块名称，用于标识操作所属的功能模块。 可以帮助更细粒度地分类和查询日志。

返回:

模块名称，默认为空字符串

默认值:

""

success

public abstract String success

操作成功时的日志文本模板。 支持 SpEL 表达式，可以引用方法参数、返回值等信息。 例如："用户 #{#operator} 成功创建了订单 #{#bizNo}"

返回:

成功日志模板，默认为空字符串

默认值:

""

fail

public abstract String fail

操作失败时的日志文本模板。 支持 SpEL 表达式，可以引用方法参数、异常信息等。 例如："用户 #{#operator} 创建订单 #{#bizNo} 失败，原因：#{#error.message}"

返回:

失败日志模板，默认为空字符串

默认值:

""

operator

public abstract String operator

操作执行人标识。 支持 SpEL 表达式，可以从上下文中获取当前操作人信息。

返回:

操作执行人标识，默认为空字符串

默认值:

""

type

public abstract String type

操作类型，用于标识具体的操作行为。 建议使用统一的操作类型常量，如：CREATE、UPDATE、DELETE、QUERY等。

返回:

操作类型，默认为空字符串

默认值:

""

bizNo

public abstract String bizNo

业务标识，用于关联具体的业务对象。 支持 SpEL 表达式，通常使用业务对象的唯一标识。 例如："#{#order.orderId}" 或 "#{#user.userId}"

返回:

业务标识，默认为空字符串

默认值:

""

detail

public abstract String detail

操作详情，用于记录更详细的操作信息。 支持 SpEL 表达式，可以记录修改前后的数据对比等信息。

返回:

操作详情，默认为空字符串

默认值:

""

condition

public abstract String condition

日志记录条件，用于控制是否记录日志。 支持 SpEL 表达式，可以根据运行时条件决定是否记录日志。 例如："#{#result != null}" 或 "#{#user.type == 'ADMIN'}"

返回:

条件表达式，默认为 "true"，表示始终记录日志

默认值:

"true"

recordReturnValue

public abstract boolean recordReturnValue

是否记录方法返回值。 当设置为 true 时，会将方法的返回值记录到日志中。 注意：对于返回值较大的方法，建议设置为 false 以避免日志数据过大。

返回:

true 表示记录返回值，false 表示不记录

默认值:

true