SpringMVC拦截器和文件的上传下载

Fiercezm

已于 2023-04-09 19:56:26 修改

阅读量280

点赞数

文章标签： spring java

于 2023-04-09 19:54:03 首次发布

本文链接：https://blog.csdn.net/qq_63754844/article/details/130031608

版权

文章详细介绍了SpringMVC中的拦截器机制，如何创建自定义拦截器以及在配置文件中注册。同时，对比了拦截器与过滤器在处理请求时的不同点。此外，还展示了登录验证的实现，包括在首页展示和登录页面的跳转。最后，讨论了SpringMVC中文件上传的功能，包括配置和前端表单设置，以及CommonsMultipartFile的使用。

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

1、概述

Spring MVC的拦截器是一种在请求处理过程中拦截请求的机制。它可以在请求到达控制器之前或之后执行一些操作，例如身份验证、日志记录、性能监视等。拦截器可以用于实现各种功能，例如检查用户是否已登录、检查请求参数是否有效等。

在Spring MVC中，拦截器是通过实现HandlerInterceptor接口来创建的。这个接口定义了三个方法，分别是preHandle()、postHandle()和afterCompletion()。preHandle()方法在请求到达控制器之前执行，可以用于执行身份验证等操作。postHandle()方法在控制器处理请求后执行，可以用于修改模型或视图。afterCompletion()方法在视图呈现后执行，可以用于清理资源等操作。

例如：自定义一个拦截器

public class MyInterceptor implements HandlerInterceptor {
    //return true;执行下一个拦截器
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("---------处理前--------");
        return true;
    }
    //相当于一个日志
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
        System.out.println("---------处理后--------");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
        System.out.println("---------清理--------");
    }
}

要使用拦截器，需要在Spring MVC配置文件中注册它们。这可以通过在配置文件applicationContext.xml中添加<mvc:interceptors>元素来实现。

    <mvc:interceptors>
        <mvc:interceptor>
            <!--/**代表包括这个请求下的所有请求-->
            <mvc:mapping path="/**"/>
            <!--拦截器路径-->
            <bean class="com.zhang.config.MyInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

效果：

过滤器与拦截器的区别：拦截器是AOP思想的具体应用。

拦截器和过滤器都是用于拦截和修改请求和响应的机制，但它们在拦截请求的阶段和范围上有所不同。

过滤器用于在Web应用程序堆栈的较低级别拦截请求和响应，通常在请求到达Servlet容器之前。过滤器在web.xml文件中定义，可以用于执行身份验证、日志记录和压缩等任务。过滤器可以拦截所有请求，包括静态资源的请求。
拦截器用于在Web应用程序堆栈的较高级别拦截请求和响应，通常在Spring MVC框架内部。拦截器在Spring配置文件中定义为bean，可以用于执行身份验证、日志记录和修改模型或视图等任务。拦截器只能拦截由Spring MVC处理的请求，不能拦截静态资源的请求。

总之，过滤器用于在Web应用程序堆栈的较低级别拦截请求和响应，而拦截器用于在Spring MVC框架内部的较高级别拦截请求和响应。过滤器可以拦截所有请求，而拦截器只能拦截由Spring MVC处理的请求。

2、登录判断验证

需求：在进入首页之前不登录的话进不去，在index.jsp上放上首页和前往登录界面的请求地址，点首页会转发到登录，点登录就是跳转到登录页面。

index.jsp:


<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>$Title$</title>
  </head>
  <body>
    <h1>
      <a href="${pageContext.request.contextPath}/user/main">首页</a>
      <a href="${pageContext.request.contextPath}/user/tologin">登录</a>

    </h1>
  </body>
</html>

controller：登录的时候需要把用户的信息存到session中，然后再返回给首页用户名字作为提示信息

    @RequestMapping("/main")
    public String main() {
        return "main";
    }
    @RequestMapping("/tologin")
    public String tologin() {
        return "login";
    }

    @RequestMapping("/login")
    public String login(String username, String passwd, HttpSession session, Model model){
        //将用户信息存到session中
        System.out.println("登录信息---》"+username);
        session.setAttribute("userLoginInfo",username);
        model.addAttribute("usermasg",username+passwd);
        return "main";
    }

1、在WEB-INF/jsp/下写一个login.jsp


<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>登录</title>
</head>
<body>
    <%--在WEB-INF下面的所有页面或者资源，只能通过controller或者servlet访问--%>
    <h1>登录页面</h1>
    <form action="${pageContext.request.contextPath}/user/login" method="post">
        用户名：<input type="text" name="username">
        密码：<input type="text" name="passwd">
        <input type="submit" value="提交">
    </form>

</body>
</html>

2、再写一个首页，主页面main.jsp。


<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>首页</title>
</head>
<body>
<h1>首页</h1>
<span style="background: red">${usermasg}</span>
</body>
</html>

3、写拦截器，LoginInterceptor。

要想知道用户是否登录，需要判断session是否为空，为空，则不放行直接跳转到登陆页面，不为空就放行返回true。

由于preHandle方法最后的返回设成false，需要将登录页面也放行，登录时有登录页面跳转的请求，所以，请求中只要包含了“login”字符的都放行。

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //根据session判断有没有登录
        HttpSession session = request.getSession();

        //登录页面也放行
        if (request.getRequestURI().contains("login")){
            return true;
        }
        if (session.getAttribute("userLoginInfo") != null){
            System.out.println("用户session------"+session);
            request.setAttribute("usermasg",session.getAttribute("username"));
            return true;
        }
        //没登录就直接转发到登录页面去
        request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request,response);
        return false;
    }
}

到applicationContext.xml配置文件注册拦截器：

 <mvc:interceptor>
            <mvc:mapping path="/user/**"/>
            <bean class="com.zhang.config.LoginInterceptor"/>
 </mvc:interceptor>

文件的上传和下载

文件上传是开发中比较常见的功能了，springmvc也支持文件上传与下载，但需要在配置文件中配置MulitipartResolver。

当然，前提是先导依赖：

<!--文件上传-->
<dependency>
   <groupId>commons-fileupload</groupId>
   <artifactId>commons-fileupload</artifactId>
   <version>1.3.3</version>
</dependency>

applicationContext.xml：这个bena的id必须是multipartResolver

 <!--文件上传配置-->
    <bean id="multipartResolver"  class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
        <!-- 请求的编码格式，必须和jSP的pageEncoding属性一致，以便正确读取表单的内容，默认为ISO-8859-1 -->
        <property name="defaultEncoding" value="utf-8"/>
        <!-- 上传文件大小上限，单位为字节（10485760=10M） 可以不配这个-->
        <!--<property name="maxUploadSize" value="10485760"/>
        <property name="maxInMemorySize" value="40960"/>-->
 </bean>

前端的表单也需要将from表单的method设置成post，将enctype设置为multipart/form-data。此时，浏览器才会把用户选择的文件以二进制数据发送，

 <form action="${pageContext.request.contextPath}/upload" enctype="multipart/form-data" method="post">
      <input type="file" name="file">
      <input type="submit" value="提交文件">
    </form>

表单中的enctype属性各个值的说明：

- application/x-www-form-urlencoded：默认值。在提交表单时，将表单数据编码为URL编码格式。
- multipart/form-data：用于上传文件或二进制数据。在提交表单时，表单数据将被编码为多部分消息。
- text/plain：在提交表单时，将表单数据编码为纯文本格式。

在上述代码片段中，我们使用了multipart/form-data来上传文件。这个值告诉浏览器在提交表单时使用多部分消息编码。这是因为文件数据不能像普通表单数据那样简单地编码为URL编码格式。相反，它们需要使用二进制编码。因此，我们需要使用multipart/form-data来告诉浏览器使用多部分消息编码。

注意：当使用multipart/form-data时，表单数据将被编码为多部分消息，这意味着它们将被分成多个部分。每个部分都有自己的头和正文，用于描述和传输数据。这些部分中的一个将包含上传的文件数据。在服务器端，需要使用相应的库来解析这些多部分消息并提取文件数据。

CommonsMultipartFile 的一些常用方法：

getBytes()：获取文件内容的字节数组。
getContentType()：获取文件的MIME类型。
getInputStream()：获取一个InputStream对象，用于读取文件内容，文件流。
getName()：获取文件的原始名称。
getOriginalFilename()：获取文件的原始名称。
getSize()：获取文件的大小，以字节为单位。
isEmpty()：检查文件是否为空。
transferTo(File dest)：将上传的文件保存到指定的目标文件中。

Controller：

  //批量上传CommonsMultipartFile则为数组即可
    @RequestMapping("/upload")
    public String fileUpload(@RequestParam("file") CommonsMultipartFile file , HttpServletRequest request) throws IOException {

        //获取文件名 : file.getOriginalFilename();
        String uploadFileName = file.getOriginalFilename();

        //如果文件名为空，直接回到首页！
        if ("".equals(uploadFileName)){
            return "redirect:/index.jsp";
        }
        System.out.println("上传文件名 : "+uploadFileName);

        //上传路径保存设置
        String path = request.getServletContext().getRealPath("/upload");
        //如果路径不存在，创建一个
        File realPath = new File(path);
        if (!realPath.exists()){
            realPath.mkdir();
        }
        System.out.println("上传文件保存地址："+realPath);

        InputStream is = file.getInputStream(); //文件输入流
        OutputStream os = new FileOutputStream(new File(realPath,uploadFileName)); //文件输出流

        //读取写出
        int len=0;
        byte[] buffer = new byte[1024];
        while ((len=is.read(buffer))!=-1){
            os.write(buffer,0,len);
            os.flush();
        }
        os.close();
        is.close();
        return "redirect:/index.jsp";
    }

第二种方式：采用file.Transto 来保存上传的文件

/*
* 采用file.Transto 来保存上传的文件
*/
@RequestMapping("/upload2")
public String  fileUpload2(@RequestParam("file") CommonsMultipartFile file, HttpServletRequest request) throws IOException {

   //上传路径保存设置
   String path = request.getServletContext().getRealPath("/upload");
   File realPath = new File(path);
   if (!realPath.exists()){
       realPath.mkdir();
  }
   //上传文件地址
   System.out.println("上传文件保存地址："+realPath);

   //通过CommonsMultipartFile的方法直接写文件（注意这个时候）
   file.transferTo(new File(realPath +"/"+ file.getOriginalFilename()));

   return "redirect:/index.jsp";
}