学习教程框架

SpringMVC入门-03

sinarcsinx2023-03-082023-03-11

SpringMVC入门-03

拦截器

应用场景

如果我们想在多个Handler方法执行之前或者之后都进行一些处理，甚至某些情况下需要拦截掉，不让Handler方法执行，那么可以使用SpringMVC为我们提供的拦截器

拦截器和过滤器的区别

过滤器是在Servlet执行之前或者之后进行处理，而拦截器是对Handler（处理器）执行前后进行处理

如图：

创建并配置拦截器

创建类实现HandlerInterceptor接口

1 2	public class MyInterceptor implements HandlerInterceptor { }

实现方法

public class MyInterceptor implements HandlerInterceptor {
    
    //在handler方法执行之前会被调用
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle");
        //返回值代表是否放行，如果为true则放行，如果为fasle则拦截，目标方法执行不到
        return true;
    }

    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
    }

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion");
    }
}

配置拦截器

<!--配置拦截器-->
<mvc:interceptors>
    <mvc:interceptor>
        <!--
                配置拦截器要拦截的路径
                /*    代表当前一级路径，不包含子路径
                /**   代表当前一级路径和多级路径，使用的更多

                例如：
                    /test/*   这种会拦截下面这种路径/test/add  /test/delete
                              但是拦截不了多级路径的情况例如  /test/add/abc  /test/add/abc/bcd
                    /test/**  这种可以拦截多级目录的情况，无论    /test/add还是/test/add/abc/bcd 都可以拦截
        -->
        <mvc:mapping path="/**"/>
        <!--配置排除拦截的路径-->
        <!--<mvc:exclude-mapping path="/"/>-->
        <!--配置拦截器对象注入容器-->
        <bean class="com.sinarcsinx.interceptor.MyInterceptor"></bean>
    </mvc:interceptor>
</mvc:interceptors>

拦截器方法及参数详解

preHandle方法会在Handler方法执行之前执行，我们可以在其中进行一些前置的判断或者处理
postHandle方法会在Handler方法执行之后执行，我们可以在其中对域中的数据进行修改，也可以修改要跳转的页面
afterCompletion方法会在最后执行，这个时候已经没有办法对域中的数据进行修改，也没有办法修改要跳转的页面。我们在这个方法中一般进行一些资源的释放

/**
 * 在handler方法执行之前会被调用
 * @param request 当前请求对象
 * @param response 响应对象
 * @param handler 相当于是真正能够处理请求的handler方法封装成的对象，对象中有这方法的相关信息
 * @return 返回值代表是否放行，如果为true则放行，如果为fasle则拦截，目标方法执行不到
 * @throws Exception
 */
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    System.out.println("preHandle");
    //返回值代表是否放行，如果为true则放行，如果为fasle则拦截，目标方法执行不到
    return true;
}

/**
 * postHandle方法会在Handler方法执行之后执行
 * @param request 当前请求对象
 * @param response 响应对象
 * @param handler 相当于是真正能够处理请求的handler方法封装成的对象，对象中有这方法的相关信息
 * @param modelAndView handler方法执行后的modelAndView对象，我们可以修改其中要跳转的路径或者是域中的数据
 * @throws Exception
 */
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    System.out.println("postHandle");
}

/**
 * afterCompletion方法会在最后执行
 * @param request 当前请求对象
 * @param response 响应对象
 * @param handler 相当于是真正能够处理请求的handler方法封装成的对象，对象中有这方法的相关信息
 * @param ex 异常对象
 * @throws Exception
 */
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    System.out.println("afterCompletion");
}

案例-登录状态拦截器

需求

我们的接口需要做用户登录状态的校验，如果用户没有登录则跳转到登录页面，登录的情况下则可以正常访问我们的接口

分析

怎么判断是否登录？

登录时往session写入用户相关信息，然后在其他请求中从session中获取这些信息，如果获取不到说明不是登录状态

很多接口都要去写判断的代码，难道在每个Handler中写判断逻辑？

用拦截器，在拦截器中进行登录状态的判断

登录接口是否应该进行拦截？

不能拦截

静态资源是否要进行拦截？

不能拦截

步骤分析

①登录页面，请求发送给登录接口

②登录接口中，校验用户名密码是否正确（模拟校验即可，先不查询数据库）

如果用户名密码正确，登录成功。把用户名写入session中

③定义其他请求的Handler方法

④定义拦截器来进行登录状态判断

         如果能从session中获取用户名则说明是登录的状态，则放行

如果获取不到，则说明未登录，要跳转到登录页面

代码实现

登录功能代码实现

编写登录页面

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <form method="post" action="/login">
        用户名：<input type="text" name="username">
        密码：<input type="password" name="password">
        <input type="submit">
    </form>
</body>
</html>

编写登录接口

接口中，校验用户名密码是否正确（模拟校验即可，先不查询数据库）。如果用户名密码正确，登录成功。把用户名写入session中

@Controller
public class LoginController {

    @PostMapping("/login")
    public String longin(String username, String password, HttpSession session){
        //往session域中写入用户名用来代表登录成功
        session.setAttribute("username",username);
        return "/WEB-INF/page/success.jsp";
    }
}

登录状态校验代码实现

定义拦截器

1 2	public class LoginInterceptor implements HandlerInterceptor { }

重写方法，在preHandle方法中实现状态校验

public class LoginInterceptor implements HandlerInterceptor {

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //从session中获取用户名，判断是否存在
        HttpSession session = request.getSession();
        String username = (String) session.getAttribute("username");
        if(StringUtils.isEmpty(username)){
            //如果获取不到说明未登录 ，重定向跳转到登录页面
            String contextPath = request.getServletContext().getContextPath();
            response.sendRedirect(contextPath+"/static/login.html");
        }else{
            //如果获取到了，说明之前登录过。放行。
            return true;
        }
        return false;
    }
}

配置拦截器

登录相关接口不应该拦截
静态资源不拦截

<mvc:interceptors>
    <mvc:interceptor>
        <!--要拦截的路径-->
        <mvc:mapping path="/**"/>
        <!--排除不拦截的路径-->
        <mvc:exclude-mapping path="/static/**"></mvc:exclude-mapping>
        <mvc:exclude-mapping path="/WEB-INF/page/**"></mvc:exclude-mapping>
        <mvc:exclude-mapping path="/login"></mvc:exclude-mapping>
        <bean class="com.sinarcsinx.interceptor.LoginInterceptor"></bean>
    </mvc:interceptor>
</mvc:interceptors>

多拦截器执行顺序

如果我们配置了多个拦截器，拦截器的顺序是按照配置的先后顺序的

这些拦截器中方法的执行顺序如图（preHandler都返回true的情况下）

多拦截器执行顺序

如果拦截器3的preHandle方法返回值为false。执行顺序如图

多拦截器执行顺序2

只有所有拦截器都放行了，postHandle方法才会被执行
只有当前拦截器放行了，当前拦截器的afterCompletion方法才会执行

统一异常处理

我们在实际项目中Dao层和Service层的异常都会被抛到Controller层，但是如果我们在Controller的方法中都加上异常的try…catch处理也会显的非常的繁琐

所以SpringMVC为我们提供了统一异常处理方案。可以把Controller层的异常进行统一处理，这样既提高了代码的复用性也让异常处理代码和我们的业务代码解耦

一种是实现HandlerExceptionResolver接口的方式，一种是使用@ControllerAdvice注解的方式

HandlerExceptionResolver

实现接口

1 2	public class MyHandlerExceptionResolver implements HandlerExceptionResolver { }

重写方法

public class MyHandlerExceptionResolver implements HandlerExceptionResolver {
    //如果handler中出现了异常，就会调用到该方法，我们可以在本方法中进行统一的异常处理。
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        //获取异常信息，把异常信息放入域对象中
        String msg = ex.getMessage();
        ModelAndView modelAndView = new ModelAndView();
        modelAndView.addObject("msg",msg);
        //跳转到error.jsp
        modelAndView.setViewName("/WEB-INF/page/error.jsp");
        return modelAndView;
    }
}

注入容器

可以使用注解注入也可以使用xml配置注入，这里使用注解注入的方式

在类上加**@Component**注解，注意要保证类能被组件扫描扫描到

@Component
public class MyHandlerExceptionResolver implements HandlerExceptionResolver {
	//....省略无关代码
}

@ControllerAdvice（重要）

创建类加上@ControllerAdvice注解进行标识

1
2
3

@ControllerAdvice
public class MyControllerAdvice {
}

定义异常处理方法

定义异常处理方法，使用**@ExceptionHandler**标识可以处理的异常

@ControllerAdvice
public class MyControllerAdvice {

    @ExceptionHandler({NullPointerException.class,ArithmeticException.class})
    public ModelAndView handlerException(Exception ex){
        //如果出现了相关的异常，就会调用该方法
        String msg = ex.getMessage();
        ModelAndView modelAndView = new ModelAndView();
        //把异常信息存入域中
        modelAndView.addObject("msg",msg);
        //跳转到error.jsp
        modelAndView.setViewName("/WEB-INF/page/error.jsp");
        return modelAndView;
    }
}

注入容器

可以使用注解注入也可以使用xml配置注入，这里使用注解注入的方式

在类上加**@Component**注解，注意要保证类能被组件扫描扫描到

@ControllerAdvice
@Component
public class MyControllerAdvice {
	//省略无关代码
}

总结

我们在实际项目中一般会选择使用@ControllerAdvice 来进行异常的统一处理

因为如果在前后端不分离的项目中，异常处理一般是跳转到错误页面，让用户有个更好的体验，而前后端分离的项目中，异常处理一般是把异常信息封装到Json中写入响应体，无论是哪种情况，使用@ControllerAdvice的写法都能比较方便的实现

例如下面这种方式就是前后端分离的异常处理方案，把异常信息封装到对象中，转换成json写入响应体

@ControllerAdvice
@Component
public class MyControllerAdvice {

    @ExceptionHandler({NullPointerException.class,ArithmeticException.class})
    @ResponseBody
    public Result handlerException(Exception ex){
        Result result = new Result();
        result.setMsg(ex.getMessage());
        result.setCode(500);
        return result;
    }
}

文件上传

文件上传要求

Http协议规定了我们在进行文件上传时的请求格式要求，所以在进行文件上传时，除了在表单中增加一个用于上传文件的表单项（input标签，type=file）外必须要满足以下的条件才能进行上传

请求方式为POST请求

如果是使用表单进行提交的话，可以把form标签的method属性设置为POST。例如:

1 2	<form action="/upload" method="post"> </form>

请求头Content-Type必须为multipart/form-data

如果是使用表单的话可以把表单的entype属性设置成multipart/form-data。例如：

1 2	<form action="/upload" method="post" enctype="multipart/form-data"> </form>

SpringMVC接收上传过来的文件

SpringMVC使用commons-fileupload的包对文件上传进行了封装，我们只需要引入相关依赖和进行相应配置就可以很轻松的实现文件上传的功能

依赖

<!--commons文件上传，如果需要文件上传功能，需要添加本依赖-->
<dependency>
    <groupId>commons-fileupload</groupId>
    <artifactId>commons-fileupload</artifactId>
    <version>1.4</version>
</dependency>

配置

<!--
    文件上传解析器
    注意：id 必须为 multipartResolver
-->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
    <!-- 设置默认字符编码 -->
    <property name="defaultEncoding" value="utf-8"/>
    <!-- 一次请求上传的文件的总大小的最大值，单位是字节-->
    <property name="maxUploadSize" value="#{1024*1024*100}"/>
    <!-- 每个上传文件大小的最大值，单位是字节-->
    <property name="maxUploadSizePerFile" value="#{1024*1024*50}"/>
</bean>

接收上传的文件数据并处理

上传表单

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    <form action="/upload" method="post" enctype="multipart/form-data">
        <input type="file" name="uploadFile">
        <input type="submit">
    </form>
</body>
</html>

@Controller
public class UploadController {

    @RequestMapping("/upload")
    public String upload(MultipartFile uploadFile) throws IOException {
        //文件存储 把上传上来的文件存储下来
        uploadFile.transferTo(new File("test.sql"));
        return "/success.jsp";
    }
}

注意：方法参数名要和提交上来的参数名一致

MultipartFile常见用法

获取上传文件的原名
1
uploadFile.getOriginalFilename()
获取文件类型的MIME类型
1
uploadFile.getContentType()
获取上传文件的大小
1
uploadFile.getSize()
获取对应上传文件的输入流
1
uploadFile.getInputStream()

文件下载

文件下载要求

如果我们想提供文件下载的功能，HTTP协议要求我们的必须满足如下规则

设置响应头Content-Type

要求把提供下载文件的MIME类型作为响应头Content-Type的值

设置响应头Content-disposition

要求把文件名经过URL编码后的值写入响应头Content-disposition，但是要求符合以下格式，因为这样可以解决不同浏览器中文文件名乱码问题

1	Content-disposition: attachment; filename=%E4%B8%8B%E6%B5%B7%E5%81%9Aup%E4%B8%BB%E9%82%A3%E4%BA%9B%E5%B9%B4.txt;filename*=utf-8''%E4%B8%8B%E6%B5%B7%E5%81%9Aup%E4%B8%BB%E9%82%A3%E4%BA%9B%E5%B9%B4.txt

文件数据写入响应体中

代码实现

我们可以使用之前封装的下载工具类实现文件下载

工具类代码：

import javax.servlet.ServletContext;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.FileInputStream;
import java.net.URLEncoder;

public class DownLoadUtils {
    /**
     * 该方法可以快速实现设置两个下载需要的响应头和把文件数据写入响应体
     * @param filePath 该文件的相对路径
     * @param context  ServletContext对象
     * @param response
     * @throws Exception
     */
    public static void downloadFile(String filePath, ServletContext context, HttpServletResponse response) throws Exception {
        String realPath = context.getRealPath(filePath);
        File file = new File(realPath);
        String filename = file.getName();
        FileInputStream fis = new FileInputStream(realPath);
        String mimeType = context.getMimeType(filename);//获取文件的mime类型
        response.setHeader("content-type",mimeType);
        String fname= URLEncoder.encode(filename,"UTF-8");
        response.setHeader("Content-disposition","attachment; filename="+fname+";"+"filename*=utf-8''"+fname);
        ServletOutputStream sos = response.getOutputStream();
        byte[] buff = new byte[1024 * 8];
        int len = 0;
        while((len = fis.read(buff)) != -1){
            sos.write(buff,0,len);
        }
        sos.close();
        fis.close();
    }
}

Handler方法定义

@Controller
public class DownLoadController {

    @RequestMapping("/download")
    public void download(HttpServletRequest request, HttpServletResponse response) throws Exception {
        //文件下载
        DownLoadUtils.downloadFile("/WEB-INF/file/下海做UP主那些年.txt",request.getServletContext(),response);
    }
}

SpringMVC执行流程

因为我们有两种开发模式，我们分别来讲解两种模式在SpringMVC中的执行流程

一种是类似JSP的开发流程:

把数据放入域对象中，然后进行页面跳转

另外一种是前后端分离的开发模式，这也是目前市场上主流的模式：

把数据转化为json放入响应体中

完整流程图如下：

SpringMVC执行流程

类JSP开发模式执行流程

用户发起请求被DispatchServlet所处理
DispatchServlet通过HandlerMapping根据具体的请求查找能处理这个请求的Handler（HandlerMapping主要是处理请求和Handler方法的映射关系的）
HandlerMapping返回一个能够处理请求的执行链给DispatchServlet，这个链中除了包含Handler方法也包含拦截器
DispatchServlet拿着执行链去找HandlerAdater执行链中的方法
HandlerAdater会去执行对应的Handler方法，把数据处理转换成合适的类型然后作为方法参数传入
Handler方法执行完后的返回值会被HandlerAdapter转换成ModelAndView类型（HandlerAdater主要进行Handler方法参数和返回值的处理）
返回ModelAndView给DispatchServlet
如果对于的ModelAndView对象不为null，则DispatchServlet把ModelAndView交给 ViewResolver 也就是视图解析器解析
ViewResolver 也就是视图解析器把ModelAndView中的viewName转换成对应的View对象返回给DispatchServlet（ViewResolver 主要负责把String类型的viewName转换成对应的View对象）
DispatchServlet使用View对象进行页面的展示

前后端分离开发模式执行流程

前后端分离的开发模式中我们会使用@ResponseBody来把数据写入到响应体中，所以不需要进行页面的跳转

故流程如下：

用户发起请求被DispatchServlet所处理
DispatchServlet通过HandlerMapping根据具体的请求查找能处理这个请求的Handler（HandlerMapping主要是处理请求和Handler方法的映射关系的）
HandlerMapping返回一个能够处理请求的执行链给DispatchServlet，这个链中除了包含Handler方法也包含拦截器
DispatchServlet拿着执行链去找HandlerAdater执行链中的方法
HandlerAdater会去执行对应的Handler方法，把数据处理转换成合适的类型然后作为方法参数传入
Handler方法执行完后的返回值会被HandlerAdapter转换成ModelAndView类型。由于使用了@ResponseBody注解，返回的ModelAndView会为null ，并且HandlerAdapter会把方法返回值放到响应体中（HandlerAdater主要进行Handler方法参数和返回值的处理）
返回ModelAndView给DispatchServlet
因为返回的ModelAndView为null，所以不用去解析视图解析和其后面的操作