利用spring AOP实现每个请求的日志输出

前提条件:

除了spring相关jar包外,还需要引入aspectj包。

<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.7.2</version>
  </dependency>

要实现此功能,必须完成以下几步:

1.在springmvc-servlet.xml中实现对AOP的支持

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" 
    xmlns:aop="http://www.springframework.org/schema/aop" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"
  xmlns:context="http://www.springframework.org/schema/context"
  xmlns:mvc="http://www.springframework.org/schema/mvc"
  xsi:schemaLocation="   
  http://www.springframework.org/schema/beans   
  http://www.springframework.org/schema/beans/spring-beans-4.0.xsd   
  http://www.springframework.org/schema/context   
  http://www.springframework.org/schema/context/spring-context-4.0.xsd  
  http://www.springframework.org/schema/mvc   
  http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd
  http://www.springframework.org/schema/aop 
         http://www.springframework.org/schema/aop/spring-aop-4.0.xsd">
         
  <aop:aspectj-autoproxy proxy-target-class="true"/>
  <bean class="com.yusj.interceptor.LogAspect" />
.
.
.
.
</beans>

2.注解的方法实现Aspect

package com.yusj.core.interceptor;

import java.text.SimpleDateFormat;
import java.util.HashMap;
import java.util.Map;

import javax.servlet.http.HttpServletRequest;

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import com.google.gson.Gson;

/**
 * 
* @ClassName: LogAspect 
* @Description: 日志记录AOP实现 
* @author shaojian.yu
* @date 2014年11月3日 下午1:51:59 
*
 */
@Aspect
public class LogAspect {
  private final Logger logger = LoggerFactory.getLogger(this.getClass());

  private String requestPath = null ; // 请求地址
  private String userName = null ; // 用户名
  private Map<?,?> inputParamMap = null ; // 传入参数
  private Map<String, Object> outputParamMap = null; // 存放输出结果
  private long startTimeMillis = 0; // 开始时间
  private long endTimeMillis = 0; // 结束时间

  /**
   * 
   * @Title:doBeforeInServiceLayer
   * @Description: 方法调用前触发 
   *  记录开始时间 
   * @author shaojian.yu 
   * @date 2014年11月2日 下午4:45:53
   * @param joinPoint
   */
  @Before("execution(* com.yusj.controller..*.*(..))")
  public void doBeforeInServiceLayer(JoinPoint joinPoint) {
    startTimeMillis = System.currentTimeMillis(); // 记录方法开始执行的时间
  }

  /**
   * 
   * @Title:doAfterInServiceLayer
   * @Description: 方法调用后触发 
   *  记录结束时间
   * @author shaojian.yu 
   * @date 2014年11月2日 下午4:46:21
   * @param joinPoint
   */
  @After("execution(* com.yusj.controller..*.*(..))")
  public void doAfterInServiceLayer(JoinPoint joinPoint) {
    endTimeMillis = System.currentTimeMillis(); // 记录方法执行完成的时间
    this.printOptLog();
  }

  /**
   * 
   * @Title:doAround
   * @Description: 环绕触发 
   * @author shaojian.yu 
   * @date 2014年11月3日 下午1:58:45
   * @param pjp
   * @return
   * @throws Throwable
   */
  @Around("execution(* com.yusj.controller..*.*(..))")
  public Object doAround(ProceedingJoinPoint pjp) throws Throwable {
    /**
     * 1.获取request信息
     * 2.根据request获取session
     * 3.从session中取出登录用户信息
     */
    RequestAttributes ra = RequestContextHolder.getRequestAttributes();
    ServletRequestAttributes sra = (ServletRequestAttributes)ra;
    HttpServletRequest request = sra.getRequest();
    // 从session中获取用户信息
    String loginInfo = (String) session.getAttribute("username");
    if(loginInfo != null && !"".equals(loginInfo)){
      userName = operLoginModel.getLogin_Name();
    }else{
      userName = "用户未登录" ;
    }
    // 获取输入参数
    inputParamMap = request.getParameterMap();
    // 获取请求地址
    requestPath = request.getRequestURI();
    
    // 执行完方法的返回值:调用proceed()方法,就会触发切入点方法执行
    outputParamMap = new HashMap<String, Object>();
    Object result = pjp.proceed();// result的值就是被拦截方法的返回值
    outputParamMap.put("result", result);
    
    return result;
  }

  /**
   * 
   * @Title:printOptLog
   * @Description: 输出日志 
   * @author shaojian.yu 
   * @date 2014年11月2日 下午4:47:09
   */
  private void printOptLog() {
    Gson gson = new Gson(); // 需要用到google的gson解析包
    String optTime = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(startTimeMillis);
    logger.info("\n user:"+userName
        +"  url:"+requestPath+"; op_time:" + optTime + " pro_time:" + (endTimeMillis - startTimeMillis) + "ms ;"
        +" param:"+gson.toJson(inputParamMap)+";"+"\n result:"+gson.toJson(outputParamMap));
  }
}


你可能感兴趣的:(利用spring AOP实现每个请求的日志输出)