分类: JAVA 发表时间: 2019年09月07日

标题: 在tomcat中使用SpringBoot进行文件上传总结

摘要: 在tomcat中创建文件需要修改默认的UMASK,否则无法为指定0640以上的权限。Spring Boot对文件上传提供了包装方法便于我们获得上传的文件内容,通过使用java的nio可以对上传的文件进行保存以及设置权限。本文对整个上传流程进行了总结

Spring Boot上传与生产环境部署总结

本文假定你的项目符合Spring Boot的默认架构(可以通过start.spring.io来初始化项目,下文中的所有配置相关文件均以此结构为标准,如application.properties文件应该存在于项目根目录/src/main/resources中。文中示例均没有对异常进行捕获,实际使用时请根据实际情况捕获异常并处理

Spring Boot文件上传与保存

Spring Boot框架默认提供了对文件上传的支持,由于Spring Boot框架的开箱即用,一些默认配置未必符合我们项目的预期,此时我们可以在application.properties文件中更改默认配置,示例:

  1. spring.servlet.multipart.enabled=true //是否开启文件上传,默认开启
  2. spring.servlet.multipart.location=/tmp //服务器临时保存文件的位置,默认未配置,视具体系统与服务器而定
  3. spring.servlet.multipart.max-request-size=12MB //配置上传表单的最大上限,默认为10MB
  4. spring.servlet.multipart.max-file-size=10MB //配置单个上传文件的最大上限,默认为1MB

一、Spring Boot文件上传

Spring Boot对文件上传表单multipart/form-data提供了一个MultipartFile对象来支持文件上传,该对象可以用来声明RequestParam注解的参数类型,示例:

  1. import org.springframework.web.bind.annotation.RequestMapping;
  2. import org.springframework.web.bind.annotation.RequestMethod;
  3. import org.springframework.web.bind.annotation.RequestParam;
  4. import org.springframework.web.bind.annotation.ResponseBody;
  5. import org.springframework.web.multipart.MultipartFile;
  6. // ...
  7. @ResponseBody
  8. @RequestMapping(value = "upload/img", method = RequestMethod.POST)
  9. public String uploadImg(@RequestParam(value = "upload-image-file") MultipartFile up) {
  10. // 这里可以通过up对象提供的方法来对其进行访问
  11. }

示例中RequestParam注解的value属性设置为表单中file的name属性值。此时我们在方法中得到上传文件的对象,可以对其进行验证后保存到其他位置

二、Java文件操作

java的nio包提供了与系统无关的Path与Files接口,通过它们我们可以来完成目录的创建工作

我们将上传的文件保存在src/main/resources/static中,首先我们应该在Spring Boot中获取到该目录的绝对路径,Spring Boot提供了ResourceUtils对象来帮助我们解析一些相关资源目录,示例:

  1. import org.springframework.util.ResourceUtils;
  2. // ...
  3. String classPath = ResourceUtils.getURL("classpath:static").getPath(); // 获取到部署时static目录的绝对路径

然后我们通过Path接口来拼装我们的文件保存目录并使用Files接口创建,示例:

  1. import java.nio.file.Files;
  2. import java.nio.file.Path;
  3. // ...
  4. Path path = Path.of(classPath, "uploads", "images"); // src/main/resources/static/uploads/images,Path.of()方法会根据系统选择使用/还是\分隔符
  5. if (!Files.exists(path)) {
  6. Files.createDirectories(path); // 创建images目录,如果中间的部分目录不存在则一同创建出来,创建时使用环境默认权限(这里不是系统的,因为部署在tomcat上时,tomcat可能会更改默认权限)
  7. }

在保存文件之前,我们先生成一个文件名称,代码:

  1. import project.packages.FileUtil; // 这个工具类我们只用来对文件进行签名计算,计算可以用MD5,具体实现方法可以查阅其他相关文档,这里不做展开
  2. // ...
  3. String hashSign = FileUtil.md5(up.getBytes()); // 计算文件签名来作为文件名,这样如果存在相同签名的文件时我们便不需要再次上传了直接返回结果即可
  4. // 获取文件后缀
  5. String contentType = up.getContentType(); // 获取到的Content Type为image/png或image/jpeg这种格式,我们要自己转换为文件后缀,可以写一个switch来获取,这里不做展开
  6. String ext = getExtension(contentType); // 假设我们有一个方法getExtension来获取相应类型的文件后桌,此方法返回内容如.jpg/.gif/.png,实现此方法可以通过switch来检查contentType
  7. String filename = String.format("%s%s", hashSign, ext); // 用来保存文件的文件名称

之后便可以保存我们上传过来的文件,示例:

  1. Path file =Path.of(path.toString(), filename);
  2. up.transferTo(file.toFile()); // 通过transferTo方法将上传文件的内容写入到file中即可完成上传,此时可以通过file对象来获取上传后文件的相关信息

到此我们应该就可以在src/main/resources/static/uploads/images目录下看到我们上传过来的文件了

我们可以通过如下代码来获取到上传文件以uploads为根目录的路径:

  1. Path.of(classPath).relativize(file).normalize().toString(); // 获取的路径为:uploads/images/xxxxxx.jpg样式,注意这里在路径开头没有/

Tomcat部署

在tomcat下部署时,我们上传文件时使用的是tomcat的默认权限,在tomcat8以上版本中,tomcat的默认文件权限掩码为0027,即你创建的文件或目录权限不能大于750(此时非文件所有者以及所属组的其他用户和用户组不能获取读取权限),如果我们要将上传的文件对nginx这种服务开放访问就需要修改tomcat的默认文件掩码,此配置在tomcat根目录/bin/catelina.sh启动文件中,搜索UMASK可以看到如下代码:

  1. if [ -z "$UMASK" ]; then
  2. UMASK="0027"
  3. fi
  4. umask $UMASK

我们将0027改为0022即可,除此之外,我们也可以在启动tomcat之前,设置环境变量UMASK来覆盖此启动配置,不过这样在每次启动tomcat之前都需要设置

更改权限掩码后,我们创建的目录默认权限为0755,创建的文件默认权限为0644