Restful Api 的拦截

最新推荐文章于 2021-11-14 02:06:44 发布
最新推荐文章于 2021-11-14 02:06:44 发布
阅读量464 收藏
点赞数
分类专栏： security 文章标签： Restful API 的拦截
原文链接：https://blog.csdn.net/uotail/article/details/87006979
版权
本文详细探讨了JavaEE提供的过滤器Filter与Spring框架的Interceptor的区别及应用，包括自定义拦截器的实现、配置与测试，以及在异常处理和运行时异常情况下的行为。同时介绍了AOP切片在获取拦截方法参数中的作用。
摘要由CSDN通过智能技术生成

文章目录

过滤器 Filter（javaee提供）

定义时间拦截器

在这里插入图片描述

/**
 * @Package com.whale.web.filter
 * @Description: 时间拦截器
 * @date 2019/2/11 13:18
 */
@Component//使拦截器生效
public class TimeFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("TimeFilter init");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("TimeFilter start");
        long start = new Date().getTime();
        filterChain.doFilter(servletRequest,servletResponse);
        long end = new Date().getTime();
        System.out.println("TimeFilter耗时(毫秒) : " +(end-start));
        System.out.println("TimeFilter finish");
    }

    @Override
    public void destroy() {
        System.out.println("TimeFilter destroy");
    }
}

请求方法

 /**
     * @param idxx
     * @return
     */
    @GetMapping("{id:\\d++}")
    @JsonView(User.UserSimpleView.class)
    public User getInfo4( @PathVariable(name = "id") String idxx){
        System.out.println("=================");

        //throw new UserNotExistException(idxx);
        //System.out.println(idxx);
        System.out.println("进入getInfo服务");
        User u = new User();
        u.setUsername("tom");
        return u;
    }

运行测试

拦截器在运行的时候就已经初始化

访问 http://127.0.0.1:8080/user/1

控制台如下
在这里插入图片描述

第三方拦截器的使用

以前我们使用拦截器时只需要在web.xml里面定义好
在spring boot 中需要再拦截器上加@Component注解

那如何使用第三方注解呢(不能使用注解了)

  • 注释掉TimeFilter的@Component注解
    在这里插入图片描述
  • 创建配置类
    在这里插入图片描述
@Configuration
public class WebConfig implements Serializable {
    @Bean
    public FilterRegistrationBean timeFilter(){
        FilterRegistrationBean registrationBean = new FilterRegistrationBean();

        TimeFilter timeFilter = new TimeFilter();
        registrationBean.setFilter(timeFilter);

        //设置过滤路径
        List<String> urls = new ArrayList<>();
        urls.add("/*");
        registrationBean.setUrlPatterns(urls);

        return registrationBean;

    }
}
  • 测试ok

拦截器 Interceptor(spring 框架本身提供)

自定义拦截器

在这里插入图片描述

@Component
public class TimeInterceptor implements HandlerInterceptor {

    @Override
    public  boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle");
        request.setAttribute("startTime",new Date().getTime());
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
        Long startTime = (Long) request.getAttribute("startTime");
        System.out.println("time interceptor 耗时："+(new Date().getTime()-startTime));
    }


    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,Exception ex) throws Exception {
        System.out.println("afterCompletion");
        Long startTime = (Long) request.getAttribute("startTime");
        System.out.println("time interceptor 耗时："+(new Date().getTime()-startTime));
        System.out.println("ex is" +ex);
    }
}

配置拦截器

在这里插入图片描述

@SuppressWarnings("deprecation")
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

    @Autowired
    private TimeInterceptor timeInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(timeInterceptor);
    }
}

测试1

 /**
     * @param idxx
     * @return
     */
    @GetMapping("{id:\\d++}")
    @JsonView(User.UserSimpleView.class)
    public User getInfo4( @PathVariable(name = "id") String idxx){
        System.out.println("=================");

        //throw new UserNotExistException(idxx);
        //System.out.println(idxx);
        System.out.println("进入getInfo服务");
        User u = new User();
        u.setUsername("tom");
        return u;
    }

访问 http://127.0.0.1:8080/user/1
在这里插入图片描述

测试2 服务抛出异常

    /**
     * @param idxx
     * @return
     */
    @GetMapping("{id:\\d++}")
    @JsonView(User.UserSimpleView.class)
    public User getInfo4( @PathVariable(name = "id") String idxx){
        System.out.println("=================");

        throw new UserNotExistException(idxx);
        //System.out.println(idxx);
        //System.out.println("进入getInfo服务");
        //User u = new User();
        //u.setUsername("tom");
        //return u;
    }

500错误

{"messsage":"user not exists ! ","id":"1"}

控制台
在这里插入图片描述
这次没有打印出postHandle，ex 仍然为空

这是因为异常UserNotExistException被 controller异常处理器吞掉了

在这里插入图片描述

测试三 服务抛出运行时异常

  /**
     * @param idxx
     * @return
     */
    @GetMapping("{id:\\d++}")
    @JsonView(User.UserSimpleView.class)
    public User getInfo4( @PathVariable(name = "id") String idxx){
        System.out.println("=================");

        //throw new UserNotExistException(idxx);
        throw  new RuntimeException("user is not exists");
        //System.out.println(idxx);
        //System.out.println("进入getInfo服务");
        //User u = new User();
        //u.setUsername("tom");
        //return u;
    }

在这里插入图片描述
在这里插入图片描述
拦截器会拦截所有控制器

切片 Aspect

拦截器不能拿到拦截方法参数中的值

如果需要知道拦截方法中的参数，就需要切片

aop介绍

在这里插入图片描述

加入aop依赖

    <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-aop -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
            <!--<version>2.1.2.RELEASE</version>-->
        </dependency>

自定义切片

在这里插入图片描述

@Aspect
@Component
public class TimeAspect{

    //@Before() 相当于 拦截器的 preHandle
    //@After()
    //@AfterThrowing 抛出异常时调用

    //@Around()      切入点 覆盖了上面三种 我们一般用这个

    //第一个*  可以是任何返回值
    //第二个*  类中的任何一个方法
    //(..)    方法中的任意参数

    //参考aop表达式语法
    // https://docs.spring.io/spring/docs/4.3.22.RELEASE/spring-framework-reference/htmlsingle/#aop-pointcuts-examples
    @Around("execution(* com.whale.web.controller.UserController.*(..))")
    public Object handleControllerMethod(ProceedingJoinPoint pjp) throws Throwable {
        System.out.println("time aspect start ");

        Object[] args = pjp.getArgs();
        for (Object arg : args) {
            System.out.println("arg is " + arg);
        }
        long start = new Date().getTime();

        Object object = pjp.proceed(); //切入点方法的返回值

        System.out.println("time aspect 耗时： "+ (new Date().getTime()-start));

        System.out.println("time aspect end ");


        return object;
    }
}

测试

 /**
     * @param idxx
     * @return
     */
    @GetMapping("{id:\\d++}")
    @JsonView(User.UserSimpleView.class)
    public User getInfo4( @PathVariable(name = "id") String idxx){
        System.out.println("=================");

        //throw new UserNotExistException(idxx);
        //throw  new RuntimeException("user is not exists");
        System.out.println(idxx);
        System.out.println("进入getInfo服务");
        User u = new User();
        u.setUsername("tom");
        return u;
    }

访问 http://127.0.0.1:8080/user/1
控制台如下
在这里插入图片描述

总结

在这里插入图片描述

Kevin-Zeng
关注
专栏目录
SpringCloud Alibaba二十五 | 网关Restful接口拦截
飘渺Jam的博客
01-14 1361
前言之前在 集成RBAC授权 的文章中提到了SpringCloud可以「基于路径匹配器授权」在网关层进行用户权限校验，这种方式的实现原理是Springcloud Gateway接受到请求...
SpringBoot整合Mybatis+CXF实现Restful api 与 WebService api
最新发布
u011938827的博客
05-11 315
可以看到，没有使用/cxf/ 就依然是由springmvc来处理的。浏览器输入http://localhost:8082/cxf/ 就可以查看到多了 Available RESTful services:Endpoint address: http://localhost:8082/cxf/students。CXFServlet()是返回一个cxf Servlet，用来拦截cxf，这里传入拦截路径/cxf/* 也就是访问路径是： ip:port/cxf/这里填@path的值。最后测试restful请求。
RESTful API的拦截
hongcaixia的博客
04-28 992
RESTful API的拦截 场景：对RESTfulAPI作统一的处理，比如希望对所有的RESTfulAPI记录服务处理的时间。 一、过滤器Filter 可以拿到原始的http请求和响应的信息， 但是拿不到真正处理请求的那个方法的信息。 自定义TimeFilter： @Component public class TimeFilter implements Filter{ ...
Restful 拦截
寂寞日记本
01-30 230
过滤器 1. 实现 javax.servlet.Filter 2. 声明为@Component 3. 添加第三方过滤器配置到上下文环境中 @Configuration 定义一个配置类 @Configuration public class WebConfig{ FilterRegistrationBean registrationBean = new FilterRegistration...
Spring Boot RESTful API拦截（过滤器，拦截器，切片）
superbeyone
11-26 2327
文章目录RESTful API拦截1. 过滤器（Filter）1.1 添加方式一1.2 添加方式二2. 拦截器（Interceptor）3. 切片（Aspect） RESTful API拦截 1. 过滤器（Filter） 1.1 添加方式一 添加Filterimport javax.servlet.*; import java.io.IOException; /** * @Project:...
spring boot RESTFul API拦截 以及Filter和interceptor 、Aspect区别
weixin_33963189的博客
06-27 2366
       今天学习一下RESTFul api拦截           大概有三种方式 一、通过Filter这个大家很熟悉了吧,这是java规范的一个过滤器，他会拦截请求。在springboot中一般有两种配置方式。         这种过滤器拦截并不知道你用的是哪一个Controller处理也不知道你用哪一个方法处理。   （1）第一种直接写类实现这个接口。代码如下这个要使用C...
SpringBoot使用拦截器实现Restful URL权限拦截
小码农的博客
11-14 3153
前言 RBAC 是基于角色的访问控制（Role-Based Access Control ）。RBAC是在任何一个系统里无法绕过的问题。没有权限控制管理的系统是非常不安全的。 在Spring框架体系中。有非常多的RBAC框架，如Spring Shiro、Spring Security。 而本文介绍的是使用SpringMVC自带的拦截器来实现RBAC权限控制。功能虽然不够全面，但胜在够轻量，能够实现最基本的权限拦截。 实现的关键点： 1.拦截器的使用 2.正则表达式的使用 3.建立正确的RBAC权限模型 权
【SpringBoot】RESTful API拦截-过滤器、拦截器、切片
好学若饥，谦卑若愚
05-02 5317
前言 这里了解一下restful api的拦截，文本主要介绍三种方式来对api进行拦截，参考本文可实现拦截api，进行一些附加操作，比如打印拦截到的方法所在类名，获取原始的request，拦截到api的调用的方法名，还可以根据需要实现打印出方法的参数。当然，下面介绍的拦截器、过滤器、切片功能不全一样，侧重点不同。希望可以给大家带来帮助。 应用 过滤器方式实现拦截 1、自定义过滤器：...
java restful api开发_SpringBoot快速开发Restful Api
weixin_39759060的博客
02-22 923
Spring-Boot Restful Api1、Restful API开发1.1 Restful简介springMVC对编写Restful Api提供了很好的支持。Restful Api有三个主要的特性：是基于Http协议的，是无状态的。是以资源为导向的人性化的，返回体内部包含相关必要的指导和链接面向资源?传统的Api接口以动作为导向，并且请求方法单一。例如/user/query?id=1 GE...
采用Spring框架构建你的RestfulAPI
03-04
在构建基于Spring框架的RESTful API时，开发者可以利用Spring的强大功能来实现高效、安全且易于维护的后端服务。以下是一些关键知识点的详细解释： 1. **Spring Boot初始化Web应用** - **Maven依赖**：使用Spring ...
RESTful风格实现拦截登录
Byron's blogs
07-25 4966
1.1 什么是RESTfulRESTful架构，是目前最流行的一种互联网软件架构之一。它结构清晰、符合标准、易于理解、扩展方便。
RESTful API拦截的三种方式
李白的博客
07-16 2172
目录1 过滤器1.1 使用1.2 特点2 拦截器2.1 使用2.2 特点3 切片3.1 使用3.2 特点4 三种方式起作用的顺序 1 过滤器 1.1 使用 定义bean @Component public class TimeFilter implements Filter { //过滤器销毁的方法 @Override public void destroy() { Syste...
restful风格和自定义拦截器
melody875649004的博客
10-21 1496
Restful:约定俗成的一种风格，便于规范开发 使用POST、DELETE、PUT、GET，使用不同方法对资源进行操作 分别对应 添加、 删除、修改、查询 传统方式操作资源                             使用RESTful操作资源  http://127.0.0.1/item/queryItem.action?id=1 查询,GET             http...
拦截Restful服务的三种方式
fansanjian的博客
11-03 1611
一、使用 Filter进行服务过滤 1、本地开发的过滤器：直接将过滤类置于Spring-Boot可扫描的路径下，加@Component注解即可，代码示例： 服务： 过滤器： 运行效果：（进入过滤器两次，有浏览器对静态资源的访问） 2、集成第三方的过滤器： 需要进行配置，代码示例： 服务不变，第三方类 用上图的 TimeFilter 类代替，取消其上的 @Component ...
restful url 设计规范_Restful概述以及规范
weixin_42529544的博客
01-14 605
一 什么是Restful?随着互联网的发展，前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)，这些(客户端)设备都需要访问后端进行通信，因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信,于是RESTful诞生了，它可以通过一套统一的接口为 Web，iOS和Android提供服务二 Restful 设计规范1.协议API与用户的通信协议，总是使用https协议。2.域...
shiro拦截restful的api
04-29
要使用Shiro拦截RESTful API，可以使用Shiro的Filter机制来实现。以下是基本的步骤： 1. 创建一个类，继承Shiro的AuthenticatingFilter或AuthorizationFilter类，用于拦截RESTful API请求。 2. 在该类中实现doFilterInternal方法，该方法会在请求被拦截后被调用。在该方法中可以实现用户认证、权限验证等逻辑。 3. 在Shiro的配置文件中配置该Filter，并配置该Filter拦截的URL路径。例如： ``` [filters] authc = com.example.MyAuthenticatingFilter [urls] /api/** = authc ``` 以上代码表示使用MyAuthenticatingFilter拦截/api/路径下的所有请求。 4. 在RESTful API的Controller中，可以通过Shiro的SecurityUtils.getSubject()方法获取当前用户的Subject对象，从而获取用户信息、角色、权限等。 需要注意的是，Shiro的Filter机制只会拦截HTTP请求，而不会拦截Java方法调用。如果需要在Java方法中使用Shiro进行权限验证，可以使用注解方式来实现。具体可以参考Shiro的注解支持文档。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值