SpringBoot（拦截器+文件上传）

文章目录

- 1.拦截器
- - - 1.基本介绍
    - 2.应用实例
    - - 1.去掉Thymeleaf案例中使用session进行权限验证的部分
      - 2.编写自定义拦截器 LoginInterceptor.java 实现HandlerInterceptor接口的三个方法
      - 3.注册拦截器
      - 1.第一种方式配置类直接实现WebMvcConfigurer接口，重写addInterceptors方法
        2.第二种方式注入一个WebMvcConfigurer接口类型的bean，使用匿名内部类实现接口的方法
        3.注册拦截器方式小结
    - 3.注意事项和细节
    - - 1.关于图片资源
      - 2.uri和url的区别
- 2.文件上传
- - - 1.需求分析
    - 2.具体实现
    - - 1.编写upload.html
      - 2.编写UploadController.java 可以请求转发到upload.html
      - 3.编写Controller来将上传的文件保存到D:\temp_upload
      - 4.升级版，将上传的文件保存到动态创建的目录（常用）
      - 5.测试
    - 3.注意事项和细节
    - - 1.文件上传的限制
      - 1.MultipartProperties
        2.修改文件上传的限制大小 application.yml
      - 2.同名文件覆盖问题
      - 3.分目录存放
      - 1.WebUtils.java
        2.修改代码

1.拦截器

1.基本介绍

2.应用实例

1.去掉Thymeleaf案例中使用session进行权限验证的部分

2.编写自定义拦截器 LoginInterceptor.java 实现HandlerInterceptor接口的三个方法

package com.sun.springboot.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

/**
 * @author 孙显圣
 * @version 1.0
 */
public class LoginInterceptor implements HandlerInterceptor {
    @Override
    //在Controller之前调用
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("uri=" + request.getRequestURI());
        //对登录的校验
        HttpSession session = request.getSession();
        //如果session中有LoginAdmin则登录成功
        if (session.getAttribute("LoginAdmin") != null) {
            return true;
        } else {
            //如果登录失败则将信息请求转发到首页面
            request.setAttribute("msg", "登录失败，请重新登录");
            request.getRequestDispatcher("/").forward(request, response);
            return false;
        }
    }

    @Override
    //在Controller之后调用
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle被调用");
    }

    @Override
    //视图解析器将信息请求转发到某个页面，然后将那个页面相应给浏览器时调用
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion被调用");
    }
}

3.注册拦截器

1.第一种方式配置类直接实现WebMvcConfigurer接口，重写addInterceptors方法

package com.sun.springboot.config;

import com.sun.springboot.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * @author 孙显圣
 * @version 1.0
 */

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
        public void addInterceptors(InterceptorRegistry registry) {
        //注册拦截器并且设置拦截路径和排除路径，这里的/是根路径
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**").excludePathPatterns("/", "/login", "/images");
    }
}

2.第二种方式注入一个WebMvcConfigurer接口类型的bean，使用匿名内部类实现接口的方法

package com.sun.springboot.config;

import com.sun.springboot.interceptor.LoginInterceptor;
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.WebMvcConfigurer;

/**
 * @author 孙显圣
 * @version 1.0
 */
@Configuration
public class WebConfig02 {
    //注册拦截器
    @Bean //注入一个WebMvcConfigurer接口类型的bean，使用匿名内部类实现接口的方法
    public WebMvcConfigurer webMvcConfigurer() {
        return new WebMvcConfigurer() {
            @Override
            public void addInterceptors(InterceptorRegistry registry) {

                registry.addInterceptor(new LoginInterceptor()).
                        addPathPatterns("/**").excludePathPatterns("/", "/login", "/images");
            }
        };
    }
}

3.注册拦截器方式小结

第一种方式是配置类实现WebMvcConfigurer接口，利用配置类的特性来注入bean
第二种方式是在配置类中注入一个bean，是WebMvcConfigurer接口类型的
他们的共通点就是：都向容器中注入了一个实现了WebMvcConfigurer接口的bean

3.注意事项和细节

1.关于图片资源

如果不放行，则在第一次进入登录界面时，还会向服务器申请图片资源，此时会被拦截
图片资源路径的设置是按照设置的访问路径，默认是http://localhost:8080/下的资源

2.uri和url的区别

uri就是服务器内部的路径/代表的是服务器根路径
url是浏览器地址栏的路径

2.文件上传

1.需求分析

2.具体实现

1.编写upload.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>upload</title>
</head>
<body bgcolor="#CED3FE">
<img src="images/1.GIF"/>
<hr/>
<div style="text-align: center">
    <h1>注册用户~</h1>
    <form action="#" method="post" th:action="@{/upload}" enctype="multipart/form-data">
        用户名:<input type="text" style="width:150px" name="name"/><br/><br/>
        电 邮:<input type="text" style="width:150px" name="email"/><br/><br/>
        年 龄:<input type="text" style="width:150px" name="age"/><br/><br/>
        职 位:<input type="text" style="width:150px" name="job"/><br/><br/>
        头 像:<input type="file" style="width:150px" name="header"><br/><br/>
        <!--这里使用的multiple表示可以一次上传多个文件-->
        宠 物:<input type="file" style="width:150px" name="photos" multiple><br/><br/>
        <input type="submit" value="注册"/>
        <input type="reset" value="重新填写"/>
    </form>
</div>
<hr/>
<img src="images/logo.png"/>
</body>
</html>

2.编写UploadController.java 可以请求转发到upload.html

package com.sun.springboot.controller;

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

/**
 * @author 孙显圣
 * @version 1.0
 */
@Controller
@Slf4j
public class UploadController {
    @GetMapping("/upload.html")
    public String uploadPage() {
        //请求转发到upload.html
        return "upload";

    }
}

3.编写Controller来将上传的文件保存到D:\temp_upload

   //处理有文件的表单
    @ResponseBody
    @PostMapping("/upload")
    //获取上传的表单信息
    public String upload(@RequestParam("name") String name,
                         @RequestParam("email") String email,
                         @RequestParam("age") Integer age,
                         @RequestParam("job") String job,
                         @RequestParam("header") MultipartFile header,
                         @RequestParam("photos") MultipartFile[] photos) throws IOException {
        //显示获取到的信息
        log.info("name={} email={} age={} job={} header={} photos={}",
                name, email, age, job, header, photos);
        //首先处理单个文件
        if (!header.isEmpty()) {
            //文件不为空则获取文件的名字
            String originalFilename = header.getOriginalFilename();
            //将文件转存在磁盘的指定位置D:\temp_upload
            header.transferTo(new File("D:\\temp_upload\\" + originalFilename));
        }
        //处理文件数组
        if (photos.length > 0) {
            //只要长度大于0,就遍历
            for (MultipartFile photo : photos) {
                //获取当前文件的名字
                String originalFilename = photo.getOriginalFilename();
                if (!photo.isEmpty()) {
                    //只要文件不为空就转存
                    photo.transferTo(new File("D:\\temp_upload\\" + originalFilename));
                }
            }
        }
        return "文件上传成功！";
    }

4.升级版，将上传的文件保存到动态创建的目录（常用）

    //处理有文件的表单
    @ResponseBody
    @PostMapping("/upload")
    //获取上传的表单信息
    public String upload(@RequestParam("name") String name,
                         @RequestParam("email") String email,
                         @RequestParam("age") Integer age,
                         @RequestParam("job") String job,
                         @RequestParam("header") MultipartFile header,
                         @RequestParam("photos") MultipartFile[] photos) throws IOException {
        //处理单个文件，存到动态创建的文件夹下
        if (!header.isEmpty()) {
            //1.文件不为空则获取文件的名字
            String originalFilename = header.getOriginalFilename();

            //2.动态创建一个类路径下的自定义目录
            //2.1 获取类路径的绝对路径
            // /D:/Intelij_IDEA_Project/springboot/springboot-usersys/target/classes/
            String classPath = ResourceUtils.getURL("classpath:").getPath();
            //2.2 拼接目录，得到想要创建的目录的文件对象
            File targetFile = new File(classPath + "static\\upload\\");
            //2.3 只要目录不存在就动态创建目录
            if (!targetFile.exists()) {
                targetFile.mkdirs(); //注意这里是多级目录必须加s
            }

            //3.将文件转存到这个自定义目录下
            //3.1 获取这个目录的绝对路径
            String targetAbsolutePath = targetFile.getAbsolutePath();
            //3.2 将文件转存到这个路径下
            // D:\Intelij_IDEA_Project\springboot\springboot-usersys\target\classes\static\(注意upload没有\)upload
            header.transferTo(new File(targetAbsolutePath + "\\" + originalFilename));
        }

        //处理文件数组，存到磁盘指定位置
        if (photos.length > 0) {
            //只要长度大于0,就遍历
            for (MultipartFile photo : photos) {
                //获取当前文件的名字
                String originalFilename = photo.getOriginalFilename();
                if (!photo.isEmpty()) {
                    //只要文件不为空就转存
                    photo.transferTo(new File("D:\\temp_upload\\" + originalFilename));
                }
            }
        }
        return "文件上传成功！";
    }

5.测试

3.注意事项和细节

1.文件上传的限制

1.MultipartProperties

2.修改文件上传的限制大小 application.yml

spring:
  servlet:
    multipart:
      max-file-size: 10MB #单个文件大小上限
      max-request-size: 50MB #一次请求的文件大小上限

2.同名文件覆盖问题

3.分目录存放

1.WebUtils.java

package com.sun.springboot.utils;

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Stack;

/**
 * @author 孙显圣
 * @version 1.0
 */
public class WebUtils {
    //上传文件的前缀
    public static String UPLOAD_FILE_DIRECTORY = "static\\upload\\";

    //编写方法，根据当前日期生成一个目录
    public static String getUploadFileDirectory() {
        return UPLOAD_FILE_DIRECTORY +
                new SimpleDateFormat("yyyy\\MM\\dd").format(new Date()) + "\\";
    }

}