spring拦截器和注解处理日志操作

整体思想：通过拦截器拦截所有的请求，处理含有自定义注解的方法，通过request得到需要的参数。

拦截器代码：

package com.zktx.platform.log2;

import java.lang.reflect.Method;
import java.text.MessageFormat;
import java.util.List;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import com.zktx.platform.log.LogLevel;
import com.zktx.platform.shiro.SecurityConstants;

public class LogInterceptor implements HandlerInterceptor {

    /**
     * preHandle方法是进行处理器拦截用的，顾名思义，该方法将在Controller处理之前进行调用，
     * SpringMVC中的Interceptor拦截器是链式的，可以同时存在
     * 多个Interceptor，然后SpringMVC会根据声明的前后顺序一个接一个的执行
     * ，而且所有的Interceptor中的preHandle方法都会在
     * Controller方法调用之前调用。SpringMVC的这种Interceptor链式结构也是可以进行中断的
     * ，这种中断方式是令preHandle的返 回值为false，当preHandle的返回值为false的时候整个请求就结束了。
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // LogUtil.putRequest(request);
        return true;
    }

    /**
     * 这个方法只会在当前这个Interceptor的preHandle方法返回值为true的时候才会执行。postHandle是进行处理器拦截用的，
     * 它的执行时间是在处理器进行处理之
     * 后，也就是在Controller的方法调用之后执行，但是它会在DispatcherServlet进行视图的渲染之前执行
     * ，也就是说在这个方法中你可以对ModelAndView进行操
     * 作。这个方法的链式结构跟正常访问的方向是相反的，也就是说先声明的Interceptor拦截器该方法反而会后调用
     * ，这跟Struts2里面的拦截器的执行过程有点像，
     * 只是Struts2里面的intercept方法中要手动的调用ActionInvocation的invoke方法
     * ，Struts2中调用ActionInvocation的invoke方法就是调用下一个Interceptor
     * 或者是调用action，然后要在Interceptor之前调用的内容都写在调用invoke之前
     * ，要在Interceptor之后调用的内容都写在调用invoke方法之后。
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        if (!(handler instanceof HandlerMethod)) {
            return;
        }
        final HandlerMethod handlerMethod = (HandlerMethod) handler;
        // 通过handler获取请求的方法
        Method method = handlerMethod.getMethod();
        // 放回自定义注解
        final SystemControllerLog log = method.getAnnotation(SystemControllerLog.class);
        // 如果方法包含此注解，处理数据
        if (log != null) {
            String description = log.description();
            LogLevel level = log.level();
            // SecurityConstants.LOG_ARGUMENTS为常量字符串
            List<String> list = (List<String>) request.getAttribute(SecurityConstants.LOG_ARGUMENTS);
            // MessageFormat为一个字符串格式化类：字符串中的{0}{1}{2} 与数组的[1,2,3]对应
            MessageFormat mFormat = new MessageFormat(description);
            String result = mFormat.format(list.toArray());
            System.out.println("result：" + result + ",level:" + level);
        }

    }

    /**
     * 该方法也是需要当前对应的Interceptor的preHandle方法的返回值为true时才会执行。该方法将在整个请求完成之后，
     * 也就是DispatcherServlet渲染了视图执行，
     * 这个方法的主要作用是用于清理资源的，当然这个方法也只能在当前这个Interceptor的preHandle方法的返回值为true时才会执行。
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // LogUtil.removeRequest();

    }

}

 

自定义注解：

package com.zktx.platform.log2;

/**
 * 自定义注解，拦截Controller
 */
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.zktx.platform.log.LogLevel;

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.METHOD, ElementType.PARAMETER })
@Documented
public @interface SystemControllerLog {
    /**
     * 日志信息
     * 
     * @return
     */
    String description() default "";

    /**
     * 
     * 日志记录等级
     * 
     * @return
     */
    LogLevel level() default LogLevel.TRACE;
}

日志级别等级：

package com.zktx.platform.log;

/**
 * 值越大，等级越高。
 * 
 */
public enum LogLevel {

    TRACE("TRACE"),

    DEBUG("DEBUG"),

    INFO("INFO"),

    WARN("WARN"),

    ERROR("ERROR");

    private String value;

    LogLevel(String value) {
        this.value = value;
    }

    public String value() {
        return this.value;
    }
}

 

 

调用方式：

    // 删除
    @RequestMapping("/delete")
    @SystemControllerLog(description = "删除了{0}用户")
    // 定义的字符串
    public @ResponseBody String deleteByPrimaryKey(Integer id, HttpServletRequest request) {
        try {
            userService.deleteByPrimaryKey(id);
            List<String> list = new ArrayList<String>();
            // 添加需要的参数
            list.add(id + "");
            request.setAttribute(SecurityConstants.LOG_ARGUMENTS, list);
        } catch (Exception e) {
            e.printStackTrace();
            return "error";
        }

        return "success";
    }

最后，spring配置文件中注册拦截器

<!-- 自定义拦截器 -->
    <mvc:interceptors>
        
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.zktx.platform.log2.LogInterceptor"></bean>
        </mvc:interceptor>
    </mvc:interceptors>