com.biz.operation.log.OperationLog Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biz-all Show documentation

BizX 是一个灵活而高效的业务开发框架, 其中也有很多为业务开发所需要的工具类的提供。

The newest version!

package com.biz.operation.log;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * {@code OperationLog}注解用于标记需要记录操作日志的方法或类。
 *
 * 此注解支持在方法或类级别使用，提供对日志分类、子分类以及内容的自定义。
 *
 * 示例用法：
 * {@code
 * @OperationLog(category = "USER_OPERATION", subcategory = "LOGIN", content = "用户登录操作")
 * public void loginUser() {
 *     // 用户登录逻辑
 * }
 * }
 *
 * 此注解支持使用Spring Expression Language (SpEL) 来动态获取日志内容。例如：
 * {@code
 * @OperationLog(category = "ORDER_OPERATION", content = "#order.id + '号订单创建'")
 * public void createOrder(Order order) {
 *     // 创建订单逻辑
 * }
 * }
 *
 * 以下是关于该注解的各个属性的详细说明：
 *
 * 此注解的目标为方法和类型（类、接口等），并且其保留策略为运行时。
 *
 * @see ElementType
 * @see RetentionPolicy
 * @see Target
 * @author francis
 * @since 1.0.1
 * @version 1.0.1
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface OperationLog {

    /**
     * 获取日志分类。
     *
     * 该属性用于标识日志的主要分类。通常用于区分不同的业务模块或操作类别。
     *
     * @return 日志的分类
     */
    String category();

    /**
     * 获取日志子分类。
     *
     * 该属性用于进一步细化日志的分类，默认值为空字符串。
     *
     * @return 日志的子分类
     */
    String subcategory() default "";

    /**
     * 获取日志内容。
     *
     * 日志的具体内容。可以使用Spring Expression Language (SpEL) 表达式来动态获取。
     *
     * @return 日志内容
     */
    String content();

}