Spring MVC（二）拦截器

程序员云笔记

已于 2022-07-03 22:25:23 修改

阅读量421

点赞数

分类专栏： Java 文章标签： spring mvc interceptor exception

于 2022-06-25 23:13:16 首次发布

本文链接：https://blog.csdn.net/weixin_44152160/article/details/125464834

版权

Java 专栏收录该内容

18 篇文章 1 订阅

订阅专栏

本文详细介绍了Spring MVC中的拦截器（Interceptor）使用，包括与监听器、过滤器的对比，执行流程以及多个拦截器的执行顺序。还讲解了如何处理multipart形式的数据，控制器中异常的处理策略，以及基于Flash属性的跨重定向请求数据传递。示例代码展示了自定义拦截器的实现和注册，以及文件上传和异常处理的控制器方法。

摘要由CSDN通过智能技术生成

1 拦截器（Inteceptor）使用

1.1 监听器、过滤器和拦截器对比

Servlet：处理Request请求和Response响应
过滤器（Filter）：对Request请求起到过滤的作⽤，作⽤在Servlet之前，如果配置为/*可以对所有的资源访问（servlet、js/css静态资源等）进行过滤处理
监听器（Listener）：实现了javax.servlet.ServletContextListener 接⼝的服务器端组件，它随Web应⽤的启动而启动，只初始化⼀次，然后会⼀直运⾏监视，随Web应⽤的停止而销毁
作用⼀：做⼀些初始化工作，web应⽤中spring容器启动ContextLoaderListener
作用二：监听web中的特定事件，比如HttpSession,ServletRequest的创建和销毁；变量的创建、销毁和修改等。可以在某些动作前后增加处理，实现监控，比如统计在线⼈数，利⽤HttpSessionLisener等。
拦截器（Interceptor）：是SpringMVC、Struts等表现层框架自己的，不会拦截
jsp/html/css/image的访问等，只会拦截访问的控制器方法（Handler）。
从配置的⻆度也能够总结发现：serlvet、ﬁlter、listener是配置在web.xml中的，而interceptor是配置在表现层框架自己的配置⽂件中的

拦截顺序

在Handler业务逻辑执行之前拦截⼀次

在Handler逻辑执⾏完毕但未跳转页面之前拦截⼀次

在跳转页面之后拦截⼀次

1.2 拦截器的执行流程

在运⾏程序时，拦截器的执⾏是有⼀定顺序的，该顺序与配置⽂件中所定义的拦截器的顺序相关。单个拦截器，在程序中的执⾏流程如下图所示：

1）程序先执行preHandle()方法，如果该⽅法的返回值为true，则程序会继续向下执⾏处理器中的⽅法，否则将不再向下执行。
2）在业务处理器（即控制器Controller类）处理完请求后，会执行postHandle()方法，然后会通过DispatcherServlet向客户端返回响应。
3）在DispatcherServlet处理完请求后，才会执行afterCompletion()方法。

1.3 多个拦截器的执行流程

多个拦截器（假设有两个拦截器Interceptor1和Interceptor2，并且在配置⽂件中， Interceptor1拦截器配置在前），在程序中的执⾏流程如下图所示：

从上图可以看出，当有多个拦截器同时⼯作时，它们的preHandle()方法会按照配置⽂件中拦截器的配置顺序执⾏，而它们的postHandle()方法和afterCompletion()方法则会按照配置顺序的反序执行。

示例代码

自定义SpringMVC拦截器

import org.springframework.web.servlet.HandlerInterceptor; 
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
 * 自定义springmvc拦截器
 */
public class MyIntercepter01 implements HandlerInterceptor {
	/**
	 * 会在handler⽅法业务逻辑执⾏之前执⾏ 
	 * 往往在这⾥完成权限校验⼯作
	 * @param request
	 * @param response
	 * @param handler
	 * @return  返回值boolean代表是否放⾏，true代表放⾏，false代表中⽌
	 * @throws Exception
	 */
	@Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    	System.out.println("MyIntercepter01 preHandle......");
    	return true;
    }
    /**
     *	会在handler⽅法业务逻辑执⾏之后尚未跳转⻚⾯时执⾏
     *	@param request
     *	@param response
     *	@param handler
     *	@param modelAndView  封装了视图和数据，此时尚未跳转⻚⾯呢，你可以在这⾥针对返回的数据和视图信息进⾏修改
     *	@throws Exception 
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    	System.out.println("MyIntercepter01 postHandle......");
    }
    /**
     *	⻚⾯已经跳转渲染完毕之后执⾏
     *	@param request
     *	@param response
     *	@param handler
     *	@param ex  可以在这⾥捕获异常
     *	@throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    	System.out.println("MyIntercepter01 afterCompletion......");
    }
}

注册SpringMVC拦截器

<mvc:interceptors>
	<!--拦截所有handler-->
	<!--<bean class="com.lxsh.interceptor.MyIntercepter01"/>-->
	<mvc:interceptor>
		<!--配置当前拦截器的url拦截规则，**代表当前⽬录下及其⼦⽬录下的所有url--> 
		<mvc:mapping path="/**"/>
		<!--exclude-mapping可以在mapping的基础上排除⼀些url拦截-->
		<!--<mvc:exclude-mapping path="/demo/**"/>-->
		<bean class="com.lxsh.interceptor.MyIntercepter01"/>
	</mvc:interceptor>
	<mvc:interceptor>
		<mvc:mapping path="/**"/>
		<bean class="com.lxsh.interceptor.MyIntercepter02"/> 
	</mvc:interceptor>
</mvc:interceptors>

2 处理multipart形式的数据

文件上传：原生servlet处理上传的文件数据，SpringMvc又是对servlet的封装

pom文件

<!--⽂件上传所需jar包坐标-->
<dependency>
	<groupId>commons-fileupload</groupId>
	<artifactId>commons-fileupload</artifactId>
	<version>1.3.1</version>
</dependency>

配置文件上传解析器

<!--配置⽂件上传解析器，id是固定的multipartResolver-->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
    <!--设置上传⼤⼩，单位字节-->
    <property name="maxUploadSize" value="1000000000"/>
</bean>

前端表单

<form method="post" enctype="multipart/form-data" action="/demo/upload">
  <input type="file" name="uploadFile"/>
  <input type="submit" value="上传"/>
</form>

后台处理

@RequestMapping("upload")
public String upload(MultipartFile uploadFile, HttpServletRequest request) throws IOException {
	// ⽂件原名，如xxx.jpg
    String originalFilename = uploadFile.getOriginalFilename();     
    // 获取⽂件的扩展名,如jpg
    String extendName = originalFilename.substring(originalFilename.lastIndexOf(".") + 1, originalFilename.length());
    String uuid = UUID.randomUUID().toString();     
    // 新的⽂件名字
    String newName = uuid + "." + extendName;     
    String realPath = request.getSession().getServletContext().getRealPath("/uploads");
    // 解决⽂件夹存放⽂件数量限制，按⽇期存放
    String datePath = new SimpleDateFormat("yyyy-MM-dd").format(new Date());     File floder = new File(realPath + "/" + datePath);
    if(!floder.exists()) {
    	floder.mkdirs();
    }
    uploadFile.transferTo(new File(floder,newName));     
    return "success";
}

3 在控制器中处理异常

import org.springframework.web.bind.annotation.ControllerAdvice; 
import org.springframework.web.bind.annotation.ExceptionHandler; 
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

// 可以让我们优雅的捕获所有Controller对象handler⽅法抛出的异常
@ControllerAdvice
public class GlobalExceptionResolver {
	
    @ExceptionHandler(ArithmeticException.class)
    public ModelAndView handleException(ArithmeticException exception, HttpServletResponse response) {
    ModelAndView modelAndView = new ModelAndView();
    modelAndView.addObject("msg",exception.getMessage()); 
    modelAndView.setViewName("error");
	return modelAndView;
	}
}

4 基于Flash属性的跨重定向请求数据传递

重定向时请求参数会丢失，我们往往需要重新携带请求参数，我们可以进⾏⼿动参数拼接如下：
return "redirect:handle01?name=" + name;
但是上述拼接参数的⽅法属于get请求，携带参数⻓度有限制，参数安全性也不⾼，此时，我们可以使⽤SpringMVC提供的ﬂash属性机制，向上下⽂中添加ﬂash属性，框架会在session中记录该属性值，当跳转到⻚⾯之后框架会⾃动删除ﬂash属性，不需要我们⼿动删除，通过这种⽅式进⾏重定向参数传递，参数⻓度和安全性都得到了保障，如下：

/**
 *	SpringMVC 重定向时参数传递的问题
 *	转发：A 找 B 借钱400，B没有钱但是悄悄的找到C借了400块钱给A 
 *	     url不会变,参数也不会丢失,⼀个请求
 *	重定向：A 找 B 借钱400，B 说我没有钱，你找别⼈借去，那么A ⼜带着400块的借钱需求找到 
 *	       url会变,参数会丢失需要重新携带参数,两个请求
 */
@RequestMapping("/handleRedirect")
public String handleRedirect(String name,RedirectAttributes redirectAttributes) {
	//return "redirect:handle01?name=" + name;  // 拼接参数安全性、参数⻓度都有
	// addFlashAttribute⽅法设置了⼀个flash类型属性，该属性会被暂存到session中，在跳转到⻚⾯之后该属性销毁
	redirectAttributes.addFlashAttribute("name",name); 
	return "redirect:handle01";
}