devbox
weixin_40725706
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

【Spring Boot深度实践】打造高效安全的文件上传服务：从JWT鉴权到持久化存储_spring安全的文件上传

作者：weixin_40725706 | 2024-05-21 09:56:16

赞

踩

spring安全的文件上传


        在当前数字化时代，文件上传功能是各类Web应用中不可或缺的一部分。本文将为您展示如何利用Spring Boot框架及其优秀生态构建一个优雅且安全的文件上传服务——`UploadFileServiceImp`。此服务不仅实现了批量处理上传请求、确保文件安全存储，还通过JWT令牌提取用户ID，并将文件访问地址妥善保存至数据库中。

        首先，我们关注`UploadFileServiceImp`的核心实现逻辑。该类作为服务接口`UploadFileService`的实现，注入了HttpServletRequest对象以捕获客户端请求中的重要信息，如JWT令牌。通过Hutool库解析令牌，获取并转换用户的唯一标识（ID），确保文件上传与用户身份紧密关联，提高了系统安全性。

        代码中使用了 请导包使用此代码

        hutool包
        lombok包

uploadFilesCollectionImp   Collection实现类

  1.  
  2.  
  3. /**
  4.  * @author 青衫烟雨客
  5.  * @description 文件上传控制器实现类，负责处理客户端通过HTTP POST方式发起的多文件上传请求，并将上传的文件持久化保存到服务器指定目录。
  6.  * 使用Spring MVC框架中的`@RequestMapping("/upload")`注解定义了文件上传API的基础路径。
  7.  * @since 2024/02/03
  8.  */
  9. @Slf4j
  10. @RestController
  11. @RequestMapping("/upload")
  12. public class uploadFilesCollectionImp {
  13.  
  14.     @Autowired
  15.     private uploadFileServiceImp uploadFileServiceImp;
  16.  
  17.     /**
  18.      * 处理POST方法的多文件上传请求，接收一个MultipartFile类型的数组参数。
  19.      *
  20.      * @param files 客户端提交的待上传文件集合
  21.      * @return Result 对象封装了上传结果信息。如果所有文件上传成功，则返回包含每个文件完整访问地址的Result.success对象；
  22.      * 若有文件上传失败，则返回Result.error对象并附带错误提示信息。
  23.      */
  24.     @PostMapping
  25.     public R upload(@RequestParam("files") MultipartFile[] files) {
  26.         try {
  27.             List<String> uploadFileUrls = uploadFileServiceImp.uploadFile(files);
  28.             // 如果上传成功，则返回包含文件URL的R.success对象
  29.             if (!CollectionUtils.isEmpty(uploadFileUrls)) {
  30.                 return R.success(uploadFileUrls);
  31.             }
  32.  
  33.             // 如果上传失败且uploadFileUrls为空（假设这代表失败）
  34.             return R.error("文件上传失败");
  35.         } catch (RuntimeException e) {
  36.             // 捕获自定义异常，如文件上传过程中可能出现的问题
  37.             log.error("文件上传时发生错误：{}", e.getMessage());
  38.             return R.error("文件上传失败：" + e.getMessage());
  39.         } catch (Exception e) {
  40.             // 其他未知异常
  41.             log.error("文件上传时发生未知错误：{}", e.getMessage());
  42.             return R.error("文件上传过程中出现未知错误");
  43.         }
  44.     }
  45. }

UploadFileService  Service接口层

  1.  
  2.  
  3. /**
  4.  * @author 青衫烟雨客
  5.  * @description 文件上传服务接口，定义了处理文件批量上传业务逻辑的方法。
  6.  * @date 创建时间: 2024/2/7
  7.  */
  8. public interface UploadFileService {
  9.  
  10.     /**
  11.      * 批量上传文件方法。该方法接收一个MultipartFile数组，代表用户要上传的多个文件，
  12.      * 并返回一个包含所有成功上传文件访问链接地址的字符串列表。
  13.      *
  14.      * @param files MultipartFile[] 用户选择并提交的多个待上传文件对象
  15.      * @return List<String> 成功上传文件的网络访问链接地址列表，每个地址对应一个上传成功的文件
  16.      */
  17.     List<String> uploadFile(MultipartFile[] files);
  18. }

UploadFileService  Service实现类

  1.  
  2.  
  3. /**
  4.  * @author 青衫烟雨客
  5.  * @date 2024/1/2
  6.  * @description 实现文件上传服务接口的类，负责处理文件上传逻辑并存储到服务器，并将文件访问地址存入数据库
  7.  */
  8. @Slf4j
  9. @Service
  10. public class uploadFileServiceImp implements UploadFileService {
  11.  
  12.     // Spring自动注入HttpServletRequest对象以获取请求信息
  13.     @Autowired
  14.     private HttpServletRequest request;
  15.  
  16.     // 注入自定义工具类FileUtils实例，用于进行文件操作
  17.     @Autowired
  18.     private FileUtils fileUtils;
  19.  
  20.     // 注入上传链接地址服务实现类，用于保存上传文件的访问链接
  21.     @Autowired
  22.     private UploadLinkAddressService uploadLinkAddressServiceImp;
  23.  
  24.     // 从配置文件中读取上传服务的基础URL
  25.     @Value("${upload.service-url}")
  26.     private String serviceUrlBase;
  27.  
  28.     // 从配置文件中读取HTTP协议头
  29.     @Value("${upload.http}")
  30.     private String httpProtocol;
  31.  
  32.     //配置中读取上传文件夹路径
  33.     @Value("${upload.path}")
  34.     private String Path;
  35.  
  36.  
  37.     /**
  38.      * 从JWT中提取用户ID
  39.      *
  40.      * @param token JWT令牌
  41.      * @return 用户ID字符串
  42.      */
  43.     private String extractUserIdFromToken(String token) {
  44.         try {
  45.             JWT jwt = JWTUtil.parseToken(token);
  46.             jwt.getHeader(JWTHeader.TYPE);
  47.             return jwt.getPayload("id").toString();
  48.         } catch (Exception e) {
  49.             log.error("解析或获取token中的用户ID时出错: {}", e.getMessage());
  50.             return null;
  51.         }
  52.     }
  53.  
  54.     /**
  55.      * 单个文件上传处理逻辑
  56.      *
  57.      * @param file   MultipartFile对象
  58.      * @param userId 用户ID字符串
  59.      * @return 上传成功后的文件完整访问地址，若失败则返回null
  60.      */
  61.     private String handleSingleFileUpload(MultipartFile file, String userId) {
  62.         try {
  63.             // 检查文件有效性
  64.             if (file.isEmpty()) {
  65.                 return null;
  66.             }
  67.  
  68.             // 获取文件内容字节数组
  69.             byte[] bytes = file.getBytes();
  70.  
  71.             // 获取当前服务器IP地址
  72.             String serverIp = GetServiceIp.getPublicIp();
  73.  
  74.             // 设置目标文件存储路径（基于用户ID）
  75.             Path path = Paths.get(fileUtils.getUploadFolderPath(userId));
  76.  
  77.             // 确保目录存在，如果不存在则创建
  78.             if (!Files.exists(path)) {
  79.                 Files.createDirectories(path);
  80.             }
  81.  
  82.             // 获取上传文件的扩展名
  83.             String extension = FileUtils.getFileExtension(file);
  84.  
  85.             // 生成新的唯一文件名（UUID+扩展名）
  86.             String newFileName = IdUtil.simpleUUID() + extension;
  87.  
  88.             // 将文件保存到指定目录下
  89.             FileUtils.getFileByBytes(bytes, fileUtils.getUploadFolderPath(userId), newFileName);
  90.  
  91.             // 构建文件的内部访问路径
  92.             String fullFilePath = httpProtocol + serverIp + ':' + serviceUrlBase + Path + userId + '/' + newFileName;
  93.  
  94.             // 将文件访问地址保存到数据库或其他持久化存储中
  95.             uploadLinkAddressServiceImp.addLinkAddress(userId, fullFilePath);
  96.  
  97.             return fullFilePath;
  98.         } catch (Exception e) {
  99.             log.error("上传文件[{}]时发生错误: {}", file.getOriginalFilename(), e.getMessage());
  100.             return null;
  101.         }
  102.     }
  103.  
  104.     /**
  105.      * 批量处理文件上传请求，并返回上传成功文件的详细访问地址列表。
  106.      *
  107.      * @param files 用户上传的MultipartFile数组
  108.      * @return List<String> 包含已上传文件完整访问地址的列表
  109.      */
  110.     @Override
  111.     public List<String> uploadFile(MultipartFile[] files) {
  112.         List<String> uploadedFileDetails = new ArrayList<>();
  113.         String userId;
  114.  
  115.         // 获取并验证用户ID
  116.         String token = request.getHeader("token");
  117.         if (token != null) {
  118.             userId = extractUserIdFromToken(token);
  119.             if (userId == null) {
  120.                 uploadedFileDetails.add("上传文件获取token失败");
  121.                 return uploadedFileDetails;
  122.             }
  123.         } else {
  124.             uploadedFileDetails.add("未找到有效的token");
  125.             return uploadedFileDetails;
  126.         }
  127.  
  128.         // 遍历所有待上传的文件
  129.         for (MultipartFile file : files) {
  130.             String fullFilePath = handleSingleFileUpload(file, userId);
  131.  
  132.             if (fullFilePath != null) {
  133.                 uploadedFileDetails.add(fullFilePath);
  134.             } else {
  135.                 uploadedFileDetails.add("部分文件上传失败，请检查后重试");
  136.                 break;
  137.             }
  138.         }
  139.  
  140.         // 检查上传成功的文件数量与原始提交文件总数是否一致
  141.         if (uploadedFileDetails.size() == files.length) {
  142.             log.info("所有文件上传成功");
  143.         } else {
  144.             int failedCount = files.length - uploadedFileDetails.size();
  145.             log.error("{}个文件上传失败", failedCount);
  146.             uploadedFileDetails.add("部分文件上传失败");
  147.         }
  148.  
  149.         return uploadedFileDetails;
  150.     }
  151. }

UploadLinkAddressCollection Collection接口

  1.  
  2.  
  3. /**
  4.  * @author 青衫烟雨客
  5.  * @description 上传链接地址服务接口，定义了与文件链接地址管理相关的业务逻辑方法。
  6.  * @date 创建时间: 2024/2/7
  7.  */
  8. public interface UploadLinkAddressService {
  9.  
  10.     /**
  11.      * 添加新的文件链接地址到数据库中。这个方法会将指定的用户（通过name字段标识）和其上传文件的访问链接关联起来。
  12.      *
  13.      * @param name        用户名或用户ID，用于标识文件所属的用户
  14.      * @param addressLink 文件的网络访问链接地址
  15.      */
  16.     void addLinkAddress(String name, String addressLink);
  17.  
  18.     /**
  19.      * 根据用户ID查询该用户的所有已上传文件链接地址列表。
  20.      *
  21.      * @return List<FileLinkAddress> 包含所有与给定用户ID相关联的文件链接地址信息的对象列表
  22.      */
  23.     List<FileLinkAddress> listByID();
  24.  
  25.     int deleteById(Integer id);
  26. }

UploadLinkAddressCollection   Collection实现类

  1.  
  2.  
  3. /**
  4.  * @author 青衫烟雨客
  5.  * @date 2024/1/23
  6.  * @description 控制器实现类，处理上传链接地址相关接口请求
  7.  */
  8. // 设置该类下所有方法的统一基础路径
  9. @Slf4j
  10. @RestController
  11. public class uploadLinkAddressCollectionImp implements UploadLinkAddressCollection {
  12.     // 上传链接地址业务服务实例
  13.     @Autowired
  14.     private uploadLinkAddressServiceImp uploadLinkAddressServiceImp;
  15.  
  16.     /**
  17.      * 处理查询所有上传链接地址的POST请求
  18.      *
  19.      * @return R 对象，包含查询结果信息
  20.      */
  21.     @PostMapping("/uploadList")
  22.     @Log // 使用自定义的日志注解记录该方法调用
  23.     public R linAddressAll() {
  24.         // 调用业务层方法获取所有文件链接地址信息
  25.         List<FileLinkAddress> fileLinkAddresses = uploadLinkAddressServiceImp.listByID();
  26.  
  27.         // 判断查询结果是否为空
  28.         if (!CollectionUtils.isEmpty(fileLinkAddresses)) {
  29.             // 如果查询到数据，则返回成功状态并携带查询结果
  30.             log.info("查询当前用户照片成功");
  31.             return R.success(fileLinkAddresses);
  32.         }
  33.  
  34.         // 若查询不到数据，则返回失败状态及提示信息
  35.         log.info("查询不到当前用户照片");
  36.         return R.error("查询不到当前用户的照片");
  37.  
  38.     }
  39.  
  40.     @DeleteMapping("/deleteId/{id}")
  41.     public R deleteById(@PathVariable Integer id) {
  42.         int i = uploadLinkAddressServiceImp.deleteById(id);
  43.         if (i != 0) {
  44.             return R.success();
  45.         }
  46.         return R.error("删除失败，没有此图片");
  47.     }
  48. }

 UploadLinkAddressService  service接口

  1.  
  2.  
  3. public interface UploadLinkAddressService {
  4.  
  5.     /**
  6.      * 添加新的文件链接地址到数据库中。这个方法会将指定的用户（通过name字段标识）和其上传文件的访问链接关联起来。
  7.      *
  8.      * @param name        用户名或用户ID，用于标识文件所属的用户
  9.      * @param addressLink 文件的网络访问链接地址
  10.      */
  11.     void addLinkAddress(String name, String addressLink);
  12.  
  13.     /**
  14.      * 根据用户ID查询该用户的所有已上传文件链接地址列表。
  15.      *
  16.      * @return List<FileLinkAddress> 包含所有与给定用户ID相关联的文件链接地址信息的对象列表
  17.      */
  18.     List<FileLinkAddress> listByID();
  19.  
  20.     int deleteById(Integer id);
  21. }

FileUtils 类

  1.  
  2.  
  3. /**
  4.  * 此类提供文件操作相关的工具方法，包括：
  5.  * 1. 将本地文件转换成字节数组
  6.  * 2. 根据字节数组创建并保存文件
  7.  * 3. 获取MultipartFile对象的文件后缀名
  8.  */
  9. @Getter
  10. @Slf4j
  11. @Component
  12. public class FileUtils {
  13.  
  14.     @Value("${upload.folder}")
  15.     private String UPLOAD_FOLDER;
  16.  
  17.     /**
  18.      * 将指定路径下的文件读取并转换成Byte数组
  19.      *
  20.      * @param path 文件在本地的完整路径
  21.      * @return 文件内容的字节数组，若出现异常则返回null
  22.      */
  23.     public static byte[] getBytesByFile(String path) {
  24.         try (FileInputStream fis = new FileInputStream(path);
  25.              ByteArrayOutputStream bos = new ByteArrayOutputStream()) {
  26.             byte[] buffer = new byte[4096];
  27.             int n;
  28.             while ((n = fis.read(buffer)) != -1) {
  29.                 bos.write(buffer, 0, n);
  30.             }
  31.             return bos.toByteArray();
  32.         } catch (IOException e) {
  33.             log.error("读取文件转换成字节数组时出错: {}", e.getMessage());
  34.             return null;
  35.         }
  36.     }
  37.  
  38.     /**
  39.      * 将字节数组写入到指定目录下，并以给定的文件名创建新文件
  40.      *
  41.      * @param bytes      要写入文件的字节数组数据
  42.      * @param targetPath 目标文件所在目录的路径
  43.      * @param fileName   新建文件的名称（含扩展名）
  44.      * @throws IOException 当创建目录或写入文件时发生异常
  45.      */
  46.     public static void getFileByBytes(byte[] bytes, String targetPath, String fileName) throws IOException {
  47.         Path targetDir = Paths.get(targetPath);
  48.         if (!Files.exists(targetDir)) {
  49.             Files.createDirectories(targetDir);
  50.         }
  51.         Path targetFile = targetDir.resolve(fileName);
  52.  
  53.         try (FileOutputStream fos = new FileOutputStream(targetFile.toFile());
  54.              BufferedOutputStream bos = new BufferedOutputStream(fos)) {
  55.             bos.write(bytes);
  56.         }
  57.     }
  58.  
  59.     /**
  60.      * 从MultipartFile对象中获取原始文件的扩展名（包含点）
  61.      *
  62.      * @param file Spring框架提供的用于处理上传文件的对象
  63.      * @return 原始文件的扩展名（包含点），例如 ".jpg" 或 ".txt"
  64.      */
  65.     public static String getFileExtension(MultipartFile file) {
  66.         return Objects.requireNonNull(file.getOriginalFilename()).substring(file.getOriginalFilename().lastIndexOf('.'));
  67.     }
  68.  
  69.     /**
  70.      * 获取上传文件夹路径（根据用户ID）
  71.      *
  72.      * @param id 用户ID
  73.      * @return 完整的上传文件夹路径（包含系统分隔符）
  74.      */
  75.     public String getUploadFolderPath(String id) {
  76.         // 使用常量 UPLOAD_FOLDER 与系统分隔符拼接用户ID，生成上传文件夹路径
  77.         return UPLOAD_FOLDER + File.separator + id;
  78.     }
  79. }

  UploadLinkAddressService  service实现类

  1.  
  2.  
  3. /**
  4.  * @author 青衫烟雨客
  5.  * @date 2024/1/22
  6.  * @description 实现上传链接地址服务接口的类，负责将上传文件的访问链接与用户ID关联并存入数据库，
  7.  * 以及根据用户ID查询已上传文件的链接地址列表。
  8.  */
  9. @Service
  10. @Slf4j
  11. public class uploadLinkAddressServiceImp implements UploadLinkAddressService {
  12.  
  13.     // Spring自动注入HttpServletRequest对象以获取请求信息
  14.     @Autowired
  15.     private HttpServletRequest request;
  16.     // 注入UploadAddressLinkMapper实例，用于操作数据库
  17.     @Autowired
  18.     private UploadAddressLinkMapper uploadLinkAddressMapper;
  19.  
  20.  
  21.     /**
  22.      * 添加新的文件访问链接到数据库，并关联给定的用户名（或用户ID）。
  23.      *
  24.      * @param name        用户名或用户ID标识符
  25.      * @param addressLink 上传文件的访问链接
  26.      */
  27.     @Override
  28.     @Log
  29.     public void addLinkAddress(String name, String addressLink) {
  30.         // 将链接、名称和当前时间戳保存到数据库
  31.         uploadLinkAddressMapper.addressLink(name, addressLink, LocalDateTime.now());
  32.     }
  33.  
  34.     /**
  35.      * 根据用户ID查询该用户所有已上传文件的链接地址列表。
  36.      *
  37.      * @return List<FileLinkAddress> 包含用户上传文件链接地址信息的对象列表
  38.      */
  39.     @Override
  40.     public List<FileLinkAddress> listByID() {
  41.  
  42.         // 获取用户ID
  43.         Object userID = JwtUtils.getUserID(request);
  44.  
  45.         // 查询并返回该用户的所有文件链接地址记录
  46.         return uploadLinkAddressMapper.listById((String) userID);
  47.     }
  48.  
  49.     /**
  50.      * 根据id删除数据
  51.      *
  52.      * @param id 要删除的数据的id
  53.      * @return 删除的行数
  54.      */
  55.     @Override
  56.     public int deleteById(Integer id) {
  57.         return uploadLinkAddressMapper.deleteById(id);
  58.  
  59.     }
  60. }

R 实现类

  1.  
  2.  
  3. @Data
  4. @NoArgsConstructor
  5. @AllArgsConstructor
  6. public class R {
  7.     private Integer code;//响应码，1 代表成功; 0 代表失败
  8.     private String msg;  //响应信息 描述字符串
  9.     private Object data; //返回的数据
  10.  
  11.     //增删改 成功响应
  12.  
  13.  
  14.     public static @NotNull R success() {
  15.         return new R(1, "success" , null);
  16.     }
  17.  
  18.     //查询 成功响应
  19.  
  20.     public static @NotNull R success(Object data) {
  21.         return new R(1, "success" , data);
  22.     }
  23.  
  24.     //失败响应
  25.  
  26.     public static @NotNull R error(String msg) {
  27.         return new R(0, msg, null);
  28.     }
  29. }

UploadAddressLinkMapper  Mapper层

  1.  
  2.  
  3. @Mapper
  4. public interface UploadAddressLinkMapper {
  5.     @Insert("insert into fileLink (name, address, create_time)values  (#{name},#{address},#{createTime})")
  6.     void addressLink(String name, String address, LocalDateTime createTime);
  7.  
  8.     @Select("select * from fileLink where  name=#{id};")
  9.     List<FileLinkAddress> listById(String id);
  10.  
  11.     @Delete("delete from filelink where id =#{id};")
  12.     int deleteById(Integer id);
  13. }

        注意：在数据库建一个 fileLink  表来存储上传文件的路经用户姓名（用户名是JWT中的token获取到的），地址，上传时间

  1.  
  2. -- 上传照片表
  3. create table if not exists fileLink
  4. (
  5.     id          int auto_increment
  6.         primary key,
  7.     name        varchar(1000) not null,
  8.     address     varchar(500)  not null,
  9.     create_time datetime      null
  10. );

在批量处理文件上传的过程中，服务采取了细致入微的错误处理策略。当接收到MultipartFile数组时，会逐一检查每个文件的有效性。若发现空文件，则立即停止上传流程并反馈给调用方。对于每一个待上传的文件，服务执行以下关键步骤：

1. 获取文件内容字节数组。
2. 根据用户ID生成并确保目标存储路径存在，创建必要的目录结构。
3. 为文件生成一个独特的名称，结合UUID和文件扩展名。
4. 使用自定义工具类`FileUtils`将文件内容写入服务器指定位置。
5. 构建内部访问路径，添加至已上传文件的详细访问地址列表。
6. 将生成的文件访问地址持久化存储至数据库中，便于后续检索和管理。

        在完成所有文件上传后，服务会对上传成功的文件数量进行校验，如果与原始提交文件总数一致，则输出成功消息；反之则记录失败次数并提醒用户部分文件上传失败。

        总结来说，本篇所探讨的`UploadFileServiceImp`实现在提供高效稳定的文件上传功能的同时，兼顾了安全性与数据一致性，展示了Spring Boot在实际开发场景下的强大威力。通过巧妙地整合JWT令牌验证、自定义工具类以及数据库操作，这一服务组件无疑为您的项目增添了独特魅力与实用价值。

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/weixin_40725706/article/detail/601966
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号