REST Api中Filter、Interceptor、AOP的使用

filter过滤器:过滤器始于servlet,依赖servlet,主要应用于用户访问权限、记录访问轨迹日志。
Interceptor拦截器:拦截器是基于java的反射机制,可以知晓要访问的contoller和方法。
AOP:Spring两大核心之一,可以获取访问的controller、方法和参数,但是获取不到请求头中的信息,主要应用于系统日志的记录。

三者同时存在于项目中,执行顺序为:filter、Interceptor、ControllerAdvice、Aspect、controller


基于spring boot框架REST拦截使用

Filter

之前提到过过滤器依赖于servlet容器,其运行原理与servlet类似,若想使用过滤器必须实现Filter接口,重写doFilter方法。Filter提供的方法有三个init、doFilter、destroy。

创建的TimeFilter主要是重写doFilter规定TimeFilter需要干哪些事情!

package com.per.web.filter;

import java.io.IOException;
import java.util.Date;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;


//@Component 
public class TimeFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化filter");

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        Long strat = new Date().getTime();
        System.out.println("start filter");
        chain.doFilter(request, response);
        Long finish = new Date().getTime();
        System.out.println("finish filter"+(finish-strat));
    }

    @Override
    public void destroy() {
        System.out.println("销毁filter");
    }

}

WebConfig文件调用TimeFilter,并设定对哪些url的那种格式做过滤!

package com.per.web.config;

import java.util.ArrayList;
import java.util.List;

//import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
//import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

//import com.per.web.Interceptor.TimeInterceptor;
import com.per.web.filter.TimeFilter;

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter{
//  @Autowired
//  TimeInterceptor timeInterceptor;
//
//  @Override
//  public void addInterceptors(InterceptorRegistry registry) {
//      registry.addInterceptor(timeInterceptor);
//  }
    
    @Bean
    public FilterRegistrationBean timeFilter() {
        FilterRegistrationBean filterRegistrationBean =new FilterRegistrationBean();
        TimeFilter timeFilter =new TimeFilter();
        filterRegistrationBean.setFilter(timeFilter);
        
        List<String> urList =new ArrayList<String>();
        urList.add("/*");
        filterRegistrationBean.setUrlPatterns(urList);
        return filterRegistrationBean;
    }
}

Interceptor

拦截器需要实现HandlerInterceptor接口,重写里面的三种方法,preHandle、postHandle、afterCompletion。
preHandle:在拦截某个controller之前执行。
postHandle:在执行完controller之后不抛出异常的情况下执行。
afterCompletion:在执行完controller之后无论是否发生异常都会执行。

TimeInterceptor实现HandlerInterceptor接口。

/**
 * 
 */
package com.per.web.Interceptor;

import java.util.Date;

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

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

/**
 * @author Administrator
 *
 */
@Component
public class TimeInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        // 在调用某个controller之前执行
        System.out.println("preHandle");
        
        System.out.println(((HandlerMethod)handler).getBean().getClass().getName());
        
        System.out.println(((HandlerMethod)handler).getMethod().getName());
        
        request.setAttribute("stratTime", new Date().getTime());
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        // 在调用某个controller之后执行,且在不抛出异常的情况下
        System.out.println("postHandle");
        Long stratTime=  (Long)request.getAttribute("stratTime");
        request.setAttribute("控制层执行耗时:",(new Date()).getTime()-stratTime);
        System.out.println("=================拦截器耗时:"+(Long)request.getAttribute("控制层执行耗时:"));

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        // 执行controller之后执行,无论是否抛出异常
        System.out.println("afterCompletion");
        Long stratTime=  (Long)request.getAttribute("stratTime");
        request.setAttribute("控制层执行耗时:",(new Date()).getTime()-stratTime);
        System.out.println("ex============"+ex);

    }

}

配置文件注入TimeInterceptor,使用WebMvcConfigurerAdapter中的拦截器适配器添加该拦截器。

package com.per.web.config;

//import java.util.ArrayList;
//import java.util.List;

import org.springframework.beans.factory.annotation.Autowired;
//import org.springframework.boot.web.servlet.FilterRegistrationBean;
//import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

import com.per.web.Interceptor.TimeInterceptor;
//import com.per.web.filter.TimeFilter;

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter{
    @Autowired
    TimeInterceptor timeInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(timeInterceptor);
    }
    
//  @Bean
//  public FilterRegistrationBean timeFilter() {
//      FilterRegistrationBean filterRegistrationBean =new FilterRegistrationBean();
//      TimeFilter timeFilter =new TimeFilter();
//      filterRegistrationBean.setFilter(timeFilter);
//      
//      List<String> urList =new ArrayList<String>();
//      urList.add("/*");
//      filterRegistrationBean.setUrlPatterns(urList);
//      return filterRegistrationBean;
//  }
}

拦截器会拦截所有controller层,无论是自己写的还是spring提供的!!!


AOP

设置切点,前置、后置、增强

package com.per.web.aspect;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class TimeAspect {
    @Around("execution(* com.per.web.controller.UserController.*(..))")
    public Object handleControllerMethod(ProceedingJoinPoint pjp) throws Throwable {
        System.out.println("切面编程开始!");
        Object[] listObject=pjp.getArgs();
        for(Object obj:listObject){
            System.out.println("obj is============================"+obj);//遍历出执行的方法所有参数
        }
        
        Object obj=pjp.proceed();//执行切片
        System.out.println(obj);//获取执行的方法
        System.out.println("切面编程结束!");
        return obj;
    }
}

注意三个注解缺一不可,@Aspect、@Component、@Around(或@Before或After)

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,099评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,828评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,540评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,848评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,971评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,132评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,193评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,934评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,376评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,687评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,846评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,537评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,175评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,887评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,134评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,674评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,741评论 2 351

推荐阅读更多精彩内容