spring boot如何使用spring AOP实现拦截器

 更新时间:2017年04月08日 14:51:21   作者:Clement-Xu  
本篇文章主要介绍了spring boot如何使用spring AOP实现拦截器,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧

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

1、引入依赖:

<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; 
    }*/ 
  } 
} 

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 

证明拦截器已经生效。

源代码参考:https://github.com/xujijun/my-spring-boot

源码下载:my-spring-boot_jb51.rar

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

相关文章

  • springboot整合mybatis实现多表查询的实战记录

    springboot整合mybatis实现多表查询的实战记录

    SpringBoot对数据库操作有多种方式,下面这篇文章主要给大家介绍了关于springboot整合mybatis实现多表查询的相关资料,文中通过示例代码以及图文介绍的非常详细,需要的朋友可以参考下
    2021-08-08
  • SpringBoot开发中的数据源详解

    SpringBoot开发中的数据源详解

    这篇文章主要介绍了SpringBoot开发中的数据源详解,数据源(Data Source)顾名思义,数据的来源,是提供某种所需要数据的器件或原始媒体,在数据源中存储了所有建立数据库连接的信息,需要的朋友可以参考下
    2023-09-09
  • Spring中使用AOP进行事务管理实例

    Spring中使用AOP进行事务管理实例

    这篇文章主要介绍了Spring中使用AOP进行事务管理实例,当在Spring项目中涉及数据库操作时,事务管理是非常重要的,它可以确保数据库操作的一致性和完整性,Spring提供了强大的事务管理功能,可以通过声明式或编程式两种方式进行配置,需要的朋友可以参考下
    2023-09-09
  • Spring-Retry(重试机制)解读

    Spring-Retry(重试机制)解读

    这篇文章主要介绍了Spring-Retry(重试机制),具有很好的价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-08-08
  • spring集成redis cluster详解

    spring集成redis cluster详解

    这篇文章主要介绍了spring集成redis cluster详解,分享了maven依赖,Spring配置,增加connect-redis.properties 配置文件等相关内容,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • 深入理解Java new String()方法

    深入理解Java new String()方法

    今天给大家带来的是关于Java的相关知识,文章围绕着Java new String()展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • IDEA使用Lombok简化POJO代码的示例

    IDEA使用Lombok简化POJO代码的示例

    今天小编就为大家分享一篇关于IDEA使用Lombok简化POJO代码的示例,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • SpringBoot中注解实现定时任务的两种方式

    SpringBoot中注解实现定时任务的两种方式

    这篇文章主要介绍了SpringBoot中注解实现定时任务的两种方式,SpringBoot 定时任务是一种在SpringBoot应用中自动执行任务的机制,通过使用Spring框架提供的@Scheduled注解,我们可以轻松地创建定时任务,需要的朋友可以参考下
    2023-10-10
  • IntelliJIDEA中实现SpringBoot多实例运行的两种方式

    IntelliJIDEA中实现SpringBoot多实例运行的两种方式

    在微服务开发中,经常需要同时启动多个服务实例进行测试或模拟集群环境,‌IntelliJ IDEA‌作为Java开发者常用工具,提供了灵活的多实例启动支持,本文将详细介绍如何通过修改配置‌和批量启动‌两种方式实现SpringBoot多实例运行,并解决常见问题,需要的朋友可以参考下
    2025-03-03
  • SpringBoot 分模块开发的操作方法

    SpringBoot 分模块开发的操作方法

    这篇文章主要介绍了SpringBoot 分模块开发的操作方法,通过在原项目新增一个maven模块,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-04-04

最新评论