JSP 自定义注解及记录操作日志

下面是详细讲解“JSP 自定义注解及记录操作日志”的完整攻略：

什么是JSP自定义注解

注解是一种可插入到 Java 代码中的标记，这些标记可以在编译、运行时被读取，并执行特定的处理。在 JSP 中，可以使用注解添加自定义标记，可以让 JSP 页面更灵活、更易读、更易维护。

JSP自定义注解的使用方法

在 JSP 类中使用注解，需要先定义注解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogRecord {
    String value() default "";
}

注解的定义与普通类的定义很像，只是在开头加了一个公共注解“@interface”。@Retention 用于声明注解的保留策略，RUNTIME 表示注解会在运行期也保留，方便运行时获取。@Target 用于声明注解的作用目标，这里定义为方法。

在 JSP 中引用注解：

public class TestController {
    @LogRecord("测试方法")
    public void test() {
        // do something...
    }
}

在方法上用 @LogRecord 注解标识，参数 "测试方法" 表示这是一个名为“测试方法”的操作。这样当方法执行完毕后，就可以根据这个注解来获取执行日志信息了。

另外，可以使用 AOP 技术实现自动记录方法执行日志。

下面提供两条使用示例：

示例1：使用注解记录请求日志

在实现 Web 应用时，我们很容易需要记录用户的请求日志。可以使用以下方法：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface RequestLog {
    String value();
}

public class RequestLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(RequestLogAspect.class);

    @Around("@annotation(requestLog)")
    public Object logAround(ProceedingJoinPoint joinPoint, RequestLog requestLog) throws Throwable {
        Object result = null;
        long startTime = System.currentTimeMillis();
        try {
            result = joinPoint.proceed();
            return result;
        } finally {
            long endTime = System.currentTimeMillis();
            HttpServletRequest request = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest();
            String remoteAddr = request.getRemoteAddr();
            String method = request.getMethod();
            String requestURI = request.getRequestURI();
            String queryString = request.getQueryString();
            String userAgent = request.getHeader("User-Agent");
            String referer = request.getHeader("Referer");
            int responseStatus = ((ServletWebRequest) RequestContextHolder.getRequestAttributes()).getResponse().getStatus();
            String message = String.format("%s %s %s?%s %d %dms %s %s", method, requestURI, queryString, remoteAddr, responseStatus, endTime - startTime, userAgent, referer);
            logger.info("{} {}", requestLog.value(), message);
        }
    }
}

上面是一个记录请求日志的切面类，首先定义了一个 @RequestLog 注解，然后使用 AOP 在被 @RequestLog 标记的方法执行前后记录请求日志。

示例2：使用注解记录异步任务日志

在实现异步任务时，也需要记录异步任务的执行情况，可以使用以下方法：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AsyncLog {
    String value();
}

@Component
public class AsyncLogAspect {
    private static final Logger logger = LoggerFactory.getLogger(AsyncLogAspect.class);

    @AfterReturning("@annotation(asyncLog)")
    public void logAsyncTask(JoinPoint joinPoint, AsyncLog asyncLog) {
        Object[] args = joinPoint.getArgs();
        String message = String.format("%s 成功执行。params: %s", asyncLog.value(), Arrays.toString(args));
        logger.info(message);
    }

    @AfterThrowing(pointcut = "@annotation(asyncLog)", throwing = "ex")
    public void logAsyncError(Throwable ex, AsyncLog asyncLog) {
        String message = String.format("%s 执行失败。error: %s", asyncLog.value(), ex.getMessage());
        logger.error(message, ex);
    }
}

上面是一个记录异步任务的执行日志的切面类，定义了两个方法：logAsyncTask 和 logAsyncError，分别在异步任务执行成功或失败后记录日志。

总结

自定义注解可以提高 JSP 程序的灵活性，使代码更加简单易读。同时，注解结合 AOP 可以实现自动记录操作日志的功能，大大节省了开发人员的工作量。