欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

详解Spring Boot中使用AOP统一处理Web请求日志

程序员文章站 2024-02-21 09:18:34
在spring boot中,简单几步,使用spring aop实现一个拦截器: 1、引入依赖:

在spring boot中,简单几步,使用spring aop实现一个拦截器:

1、引入依赖

<dependency> 
  <groupid>org.springframework.boot</groupid> 
  <artifactid>spring-boot-starter-aop</artifactid> 
</dependency>
<dependency> 
   <groupid>org.springframework.boot</groupid> 
   <artifactid>spring-boot-starter-aop</artifactid> 
 </dependency> 

 2、创建拦截器类(在该类中,定义了拦截规则:拦截com.xjj.web.controller包下面的所有类中,有@requestmapping注解的方法。):

/** 
 * 拦截器:记录用户操作日志,检查用户是否登录…… 
 * @author xujijun 
 */ 
@aspect 
@component 
public class controllerinterceptor { 
  private static final logger logger = loggerfactory.getlogger(controllerinterceptor.class); 
   
  @value(“${spring.profiles}”) 
  private string env; 
   
  /** 
   * 定义拦截规则:拦截com.xjj.web.controller包下面的所有类中,有@requestmapping注解的方法。 
   */ 
  @pointcut(“execution(* com.xjj.web.controller..*(..)) and @annotation(org.springframework.web.bind.annotation.requestmapping)”) 
  public void controllermethodpointcut(){} 
   
  /** 
   * 拦截器具体实现 
   * @param pjp 
   * @return jsonresult(被拦截方法的执行结果,或需要登录的错误提示。) 
   */ 
  @around(“controllermethodpointcut()”) //指定拦截器规则;也可以直接把“execution(* com.xjj………)”写进这里 
  public object interceptor(proceedingjoinpoint pjp){ 
    long begintime = system.currenttimemillis(); 
    methodsignature signature = (methodsignature) pjp.getsignature(); 
    method method = signature.getmethod(); //获取被拦截的方法 
    string methodname = method.getname(); //获取被拦截的方法名 
     
    set<object> allparams = new linkedhashset<>(); //保存所有请求参数,用于输出到日志中 
     
    logger.info(”请求开始,方法:{}”, methodname); 
     
    object result = null; 
 
    object[] args = pjp.getargs(); 
    for(object arg : args){ 
      //logger.debug(“arg: {}”, arg); 
      if (arg instanceof map<?, ?>) { 
        //提取方法中的map参数,用于记录进日志中 
        @suppresswarnings(“unchecked”) 
        map<string, object> map = (map<string, object>) arg; 
 
        allparams.add(map); 
      }else if(arg instanceof httpservletrequest){ 
        httpservletrequest request = (httpservletrequest) arg; 
        if(isloginrequired(method)){ 
          if(!islogin(request)){ 
            result = new jsonresult(resultcode.not_login, “该操作需要登录!去登录吗?\n\n(不知道登录账号?请联系老许。)”, null); 
          } 
        } 
         
        //获取query string 或 posted form data参数 
        map<string, string[]> parammap = request.getparametermap(); 
        if(parammap!=null && parammap.size()>0){ 
          allparams.add(parammap); 
        } 
      }else if(arg instanceof httpservletresponse){ 
        //do nothing… 
      }else{ 
        //allparams.add(arg); 
      } 
    } 
     
    try { 
      if(result == null){ 
        // 一切正常的情况下,继续执行被拦截的方法 
        result = pjp.proceed(); 
      } 
    } catch (throwable e) { 
      logger.info(”exception: ”, e); 
      result = new jsonresult(resultcode.exception, “发生异常:”+e.getmessage()); 
    } 
     
    if(result instanceof jsonresult){ 
      long costms = system.currenttimemillis() - begintime; 
      logger.info(”{}请求结束,耗时:{}ms”, methodname, costms); 
    } 
     
    return result; 
  } 
   
  /** 
   * 判断一个方法是否需要登录 
   * @param method 
   * @return 
   */ 
  private boolean isloginrequired(method method){ 
    if(!env.equals(“prod”)){ //只有生产环境才需要登录 
      return false; 
    } 
     
    boolean result = true; 
    if(method.isannotationpresent(permission.class)){ 
      result = method.getannotation(permission.class).loginreqired(); 
    } 
     
    return result; 
  } 
   
  //判断是否已经登录 
  private boolean islogin(httpservletrequest request) { 
    return true; 
    /*string token = xwebutils.getcookiebyname(request, webconstants.cookiename.admintoken); 
    if(“1”.equals(redisoperator.get(redisconstants.prefix.admin_token+token))){ 
      return true; 
    }else { 
      return false; 
    }*/ 
  } 
} 

/** 
 * 拦截器:记录用户操作日志,检查用户是否登录…… 
 * @author xujijun 
 */ 
@aspect 
@component 
public class controllerinterceptor { 
  private static final logger logger = loggerfactory.getlogger(controllerinterceptor.class); 
 
  @value("${spring.profiles}") 
  private string env; 
 
  /** 
   * 定义拦截规则:拦截com.xjj.web.controller包下面的所有类中,有@requestmapping注解的方法。 
   */ 
  @pointcut("execution(* com.xjj.web.controller..*(..)) and @annotation(org.springframework.web.bind.annotation.requestmapping)") 
  public void controllermethodpointcut(){} 
 
  /** 
   * 拦截器具体实现 
   * @param pjp 
   * @return jsonresult(被拦截方法的执行结果,或需要登录的错误提示。) 
   */ 
  @around("controllermethodpointcut()") //指定拦截器规则;也可以直接把“execution(* com.xjj.........)”写进这里 
  public object interceptor(proceedingjoinpoint pjp){ 
    long begintime = system.currenttimemillis(); 
    methodsignature signature = (methodsignature) pjp.getsignature(); 
    method method = signature.getmethod(); //获取被拦截的方法 
    string methodname = method.getname(); //获取被拦截的方法名 
 
    set<object> allparams = new linkedhashset<>(); //保存所有请求参数,用于输出到日志中 
 
    logger.info("请求开始,方法:{}", methodname); 
 
    object result = null; 
 
    object[] args = pjp.getargs(); 
    for(object arg : args){ 
      //logger.debug("arg: {}", arg); 
      if (arg instanceof map<?, ?>) { 
        //提取方法中的map参数,用于记录进日志中 
        @suppresswarnings("unchecked") 
        map<string, object> map = (map<string, object>) arg; 
 
        allparams.add(map); 
      }else if(arg instanceof httpservletrequest){ 
        httpservletrequest request = (httpservletrequest) arg; 
        if(isloginrequired(method)){ 
          if(!islogin(request)){ 
            result = new jsonresult(resultcode.not_login, "该操作需要登录!去登录吗?\n\n(不知道登录账号?请联系老许。)", null); 
          } 
        } 
 
        //获取query string 或 posted form data参数 
        map<string, string[]> parammap = request.getparametermap(); 
        if(parammap!=null && parammap.size()>0){ 
          allparams.add(parammap); 
        } 
      }else if(arg instanceof httpservletresponse){ 
        //do nothing... 
      }else{ 
        //allparams.add(arg); 
      } 
    } 
 
    try { 
      if(result == null){ 
        // 一切正常的情况下,继续执行被拦截的方法 
        result = pjp.proceed(); 
      } 
    } catch (throwable e) { 
      logger.info("exception: ", e); 
      result = new jsonresult(resultcode.exception, "发生异常:"+e.getmessage()); 
    } 
 
    if(result instanceof jsonresult){ 
      long costms = system.currenttimemillis() - begintime; 
      logger.info("{}请求结束,耗时:{}ms", methodname, costms); 
    } 
 
    return result; 
  } 
 
  /** 
   * 判断一个方法是否需要登录 
   * @param method 
   * @return 
   */ 
  private boolean isloginrequired(method method){ 
    if(!env.equals("prod")){ //只有生产环境才需要登录 
      return false; 
    } 
 
    boolean result = true; 
    if(method.isannotationpresent(permission.class)){ 
      result = method.getannotation(permission.class).loginreqired(); 
    } 
 
    return result; 
  } 
 
  //判断是否已经登录 
  private boolean islogin(httpservletrequest request) { 
    return true; 
    /*string token = xwebutils.getcookiebyname(request, webconstants.cookiename.admintoken); 
    if("1".equals(redisoperator.get(redisconstants.prefix.admin_token+token))){ 
      return true; 
    }else { 
      return false; 
    }*/ 
  } 
} 

3、测试

浏览器中输入:http://localhost:8082/api/admin/login

测试结果:

2016-07-26 11:58:12,057:info http-nio-8082-exec-1 (controllerinterceptor.java:58) - 请求开始,方法:login 
2016-07-26 11:58:12,061:info http-nio-8082-exec-1 (controllerinterceptor.java:103) - login请求结束,耗时:8ms 

2016-07-26 11:58:12,057:info http-nio-8082-exec-1 (controllerinterceptor.java:58) - 请求开始,方法:login 
2016-07-26 11:58:12,061:info http-nio-8082-exec-1 (controllerinterceptor.java:103) - login请求结束,耗时:8ms 

证明拦截器已经生效。

源代码参考:

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。