使用 Spring Boot 实现文件上传:从配置文件中动态读取上传路径

news2025/1/5 9:14:24

使用 Spring Boot 实现文件上传:从配置文件中动态读取上传路径

      • 一、前言
      • 二、文件上传的基本概念
      • 三、环境准备
        • 1. 引入依赖
        • 2. 配置文件设置
          • `application.yml` 配置示例:
          • `application.properties` 配置示例:
      • 四、编写文件上传功能代码
        • 1. 控制器类
        • 2. 代码解析
        • 3. 配置实体类与服务层操作(可选)
      • 五、异常处理与文件上传安全
      • 六、小结


一、前言

在现代 Web 开发中,文件上传是一个常见的需求。Spring Boot 提供了强大的文件上传支持,但如何动态地根据配置文件来读取上传路径,并保证上传的安全性与灵活性呢?在本文中,我们将通过一个实际示例,详细介绍如何在 Spring Boot 中实现文件上传,且上传路径可从配置文件中读取。

二、文件上传的基本概念

文件上传指的是用户将文件通过 HTTP 请求上传到服务器的过程。通常,文件上传的功能包括:

  • 接收客户端发送的文件数据。
  • 保存上传的文件到服务器的指定目录。
  • 返回操作结果(如上传成功或失败)。

在 Java 中,Spring Boot 提供了 MultipartFile 类型来处理文件上传,常配合 @RequestParam 注解使用。

三、环境准备

在开始代码之前,我们先进行一些必要的环境准备工作。

1. 引入依赖

首先,我们需要在 Spring Boot 项目中引入相关依赖。通常,文件上传功能的实现需要 spring-boot-starter-webspring-boot-starter-thymeleaf(如果你使用 Thymeleaf 模板渲染)等基础组件。确保在 pom.xml 中包含以下依赖:

<dependencies>
    <!-- Spring Boot Web Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- 文件上传支持 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>

    <!-- Spring Boot DevTools (可选, 用于开发时热重载) -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-devtools</artifactId>
        <scope>runtime</scope>
    </dependency>
</dependencies>
2. 配置文件设置

在 Spring Boot 中,配置文件(如 application.ymlapplication.properties)是管理应用程序配置的标准方式。我们需要在配置文件中设置上传文件的目录路径,以便从配置中动态读取。

application.ymlapplication.properties 中设置文件上传目录:

application.yml 配置示例:
file:
  upload-dir: C:/serve/upload
application.properties 配置示例:
file.upload-dir=C:/serve/upload

通过这些配置,我们可以在应用程序中读取文件上传目录,而不需要硬编码路径,增强了程序的灵活性。

四、编写文件上传功能代码

1. 控制器类

在 Spring Boot 中,我们通过 @RestController@Controller 注解来创建控制器类。在文件上传的实现中,我们需要处理 MultipartFile 类型的参数,并将文件保存到指定目录。以下是一个文件上传的控制器实现示例:

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.util.StringUtils;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletRequest;
import java.io.File;
import java.io.IOException;
import java.util.Date;

@RestController
public class FileUploadController {

    // 从配置文件中读取文件上传目录路径
    @Value("${file.upload-dir}")
    private String uploadDir;

    /**
     * 上传文件
     */
    @RequestMapping(value = "/upload", method = RequestMethod.POST)
    public R upload(@RequestParam("file") MultipartFile file, String type, HttpServletRequest request) throws Exception {
        // 检查文件是否为空
        if (file.isEmpty()) {
            throw new EIException("上传文件不能为空");
        }

        // 获取文件扩展名
        String fileExt = file.getOriginalFilename().substring(file.getOriginalFilename().lastIndexOf(".") + 1);
        // 生成文件名:当前时间戳 + 文件扩展名
        String fileName = new Date().getTime() + "." + fileExt;

        // 获取配置文件中的上传目录路径,并确保目录存在
        File uploadDirFile = new File(uploadDir);
        if (!uploadDirFile.exists()) {
            uploadDirFile.mkdirs();  // 创建目录
        }

        // 创建目标文件
        File dest = new File(uploadDirFile, fileName);
        // 将文件保存到目标路径
        file.transferTo(dest);

        // 如果上传的类型是 "1",则更新配置项 "faceFile"
        if (StringUtils.hasText(type) && "1".equals(type)) {
            ConfigEntity configEntity = configService.selectOne(new EntityWrapper<ConfigEntity>().eq("name", "faceFile"));
            if (configEntity == null) {
                configEntity = new ConfigEntity();
                configEntity.setName("faceFile");
                configEntity.setValue(fileName);
            } else {
                configEntity.setValue(fileName);
            }
            configService.insertOrUpdate(configEntity);
        }

        // 返回成功的响应,包含文件名
        return R.ok().put("file", fileName);
    }
}
2. 代码解析
  • 读取配置文件路径:通过 @Value("${file.upload-dir}") 注解,我们可以将配置文件中的 file.upload-dir 属性注入到 uploadDir 变量中。这使得我们能够动态读取文件上传路径,而不需要在代码中硬编码路径。
  • 检查文件是否为空:在上传文件前,先检查文件是否为空,防止空文件上传。
  • 生成文件名:为了避免文件名重复,我们通过当前的时间戳来生成唯一的文件名。
  • 创建目录:在保存文件之前,检查指定的上传目录是否存在。如果目录不存在,我们会自动创建它。
  • 保存文件:通过 file.transferTo(dest) 将文件保存到服务器指定路径。
  • 返回响应:文件上传成功后,返回一个包含文件名的响应。
3. 配置实体类与服务层操作(可选)

在上传过程中,我们可能需要在数据库中保存一些文件信息,例如用户头像等。如果需要将文件信息保存到数据库中,我们可以定义一个 ConfigEntity 类,并通过 configService 操作数据库。

五、异常处理与文件上传安全

在文件上传过程中,我们应当注意以下几点安全问题:

  • 文件大小限制:应限制上传文件的大小,防止过大的文件消耗过多的服务器资源。Spring Boot 提供了相关配置项,如 spring.servlet.multipart.max-file-sizespring.servlet.multipart.max-request-size,可以设置上传文件的最大尺寸。

    spring:
      servlet:
        multipart:
          max-file-size: 10MB
          max-request-size: 10MB
    
  • 文件类型限制:为了防止恶意文件上传,我们可以根据文件扩展名或 MIME 类型限制上传文件的类型。

  • 异常处理:为了提高代码的健壮性,我们可以通过 @ControllerAdvice@ExceptionHandler 统一处理文件上传中的异常,返回友好的错误信息。

六、小结

在这篇文章中,我们学习了如何在 Spring Boot 项目中实现文件上传,并从配置文件中动态读取上传路径。通过使用 Spring Boot 的 MultipartFile 和配置注入,我们可以灵活地管理文件上传功能,同时增强程序的可维护性与安全性。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2269837.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

【AIGC篇】AIGC 引擎:点燃创作自动化的未来之火

&#xff1a;羑悻的小杀马特.-CSDN博客 未来都是惊喜。你生来本应为高山。并非草芥。 引言&#xff1a; 在当今数字化的时代&#xff0c;人工智能生成内容&#xff08;AIGC&#xff09;正以一种前所未有的力量改变着我们的创作领域。它就像一个神秘而强大的魔法师&#xff0c;…

UnityRenderStreaming使用记录(三)

测试UnityRenderStreaming在Ubuntu24.04.1LTS上的表现 先放上运行图操作系统 Ubuntu24.04.1LTSUnity测试工程环境相关修改遇到的问题 先放上运行图 操作系统 Ubuntu24.04.1LTS 系统下载地址 https://cn.ubuntu.com/download/desktop安装UnityHub https://blog.csdn.net/AWNUXC…

从0开始的docker镜像制作-ubuntu22.04

从0开始的docker镜像制作-ubuntu22.04 一、拉取基础ubuntu22.04镜像二、进入拉取的docker镜像中&#xff0c;下载自己需要的安装包三、安装需要的系统软件四、打包现有镜像为一个新的镜像五、推送打包的镜像到私有docker服务器1.编辑docker文件&#xff0c;使其允许http传输和对…

多模态论文笔记——CogVLM和CogVLM2(副)

大家好&#xff0c;这里是好评笔记&#xff0c;公主号&#xff1a;Goodnote&#xff0c;专栏文章私信限时Free。本文详细介绍多模态模型的LoRA版本——CogVLM和CogVLM2。在SD 3中使用其作为captioner基准模型的原因和优势。 文章目录 CogVLM论文背景VLMs 的任务与挑战现有方法及…

gitlab-runner的卸载与安装

如果你使用rpm方式安装gitlab-runner&#xff0c;则可以参考本教程。 卸载 停止和卸载gitlab-runner 停止 gitlab-runner stopchkconfig gitlab-runner off卸载 gitlab-runner uninstall删除rpm包 查询出rpm包名&#xff0c;根据包名删除rpm。 [rootEuler02 ~]# rpm -qa …

Nacos配置中心总结

Nacos配置中心总结 Nacos配置文件的加载顺序和优先级 加载顺序 nacos作为配置中心时&#xff0c;需要在bootstrap.yml文件中添加nacos config相关的配置&#xff0c;这样系统启动时就能先去拉取nacos server上的配置了。拉取过来后会和本地配置文件进行合并。 bootstrap.ym…

赛博周刊·2024年度工具精选(图片资源类)

1、EmojiSpark emoji表情包查找工具。 2、fluentui-emoji 微软开源的Fluent Emoji表情包。 3、开源Emoji库 一个开源的emoji库&#xff0c;目前拥有4000个emoji表情。 4、中国表情包大合集博物馆 一个专门收集中国表情包的项目&#xff0c;已收录5712张表情包&#xff0c;并…

Goland:专为Go语言设计的高效IDE

本文还有配套的精品资源&#xff0c;点击获取 简介&#xff1a;Goland是JetBrains公司开发的集成开发环境&#xff08;IDE&#xff09;&#xff0c;专为Go语言设计&#xff0c;提供了高效的代码编辑、强大的调试工具和丰富的项目管理功能。其智能代码补全、强大的调试与测试支…

小程序发版后,用户使用时,强制更新为最新版本

为什么要强制更新为最新版本&#xff1f; 在小程序的开发和运营过程中&#xff0c;强制用户更新到最新版本是一项重要的策略&#xff0c;能够有效提升用户体验并保障系统的稳定性与安全性。以下是一些主要原因&#xff1a; 1. 功能兼容 新功能或服务通常需要最新版本的支持&…

EasyExcel(环境搭建以及常用写入操作)

文章目录 EasyExcel环境搭建1.创建模块 easyexcel-demo2.引入依赖3.启动类创建 EasyExcel写1.最简单的写入1.模板2.方法3.结果 Write01.xlsx 2.指定字段不写入Excel1.模板2.方法3.结果 Write02.xlsx 3.指定字段写入excel1.模板2.方法3.结果 Write03.xlsx 4.按照index顺序写入ex…

典型常见的基于知识蒸馏的目标检测方法总结三

来源&#xff1a;Google学术2023-2024的顶会顶刊论文 NeurIPS 2022&#xff1a;Towards Efficient 3D Object Detection with Knowledge Distillation 为3D目标检测提出了一种知识蒸馏的Benchmark范式&#xff0c;包含feature的KD&#xff0c;Logit的cls和reg的KD&#xff0c…

通过Dockerfile来实现项目可以指定读取不同环境的yml包

通过Dockerfile来实现项目可以指定读取不同环境的yml包 1. 挂载目录2. DockerFile3. 运行脚本deploy.sh4. 运行查看日志进入容器 5. 接口测试修改application-dev.yml 6. 优化Dockerfile7. 部分参数解释8. 优化不同环境下的日志也不同调整 Dockerfile修改部署脚本 deploy.sh重新…

开源的go语言统一配置中心 - nacos + nacos go sdk

配置文件实时更新机制的场景需求 配置文件热更新主要应用于需要在不停机的情况下动态调整系统行为的场景&#xff0c;例如修改服务参数、切换数据源等。其原理在于通过一个中心化的管理平台来存储和分发最新的配置信息。当配置文件发生变化时&#xff0c;该平台会主动或被动地…

对45家“AI+安全”产品/方案的分析

一. 关键洞察 “AI+安全”创新非常活跃,一片百家争鸣之势,赛道选择上,以事件分诊Incident Triage、 安全辅助Security Copilots、自动化Automation三者为主为主,这充分反映了当前安全运营的主要需求,在产品理念选择上以 AI 和 自动化为主,这确实又切合上了在关键…

GESP202412 三级【数字替换】题解(AC)

》》》点我查看「视频」详解》》》 [GESP202412 三级] 数字替换 题目描述 小杨有一个包含 n n n 个数字的序列 A A A&#xff0c;即 A [ a 1 , a 2 , … , a n ] A[a_1,a_2,\ldots,a_n] A[a1​,a2​,…,an​]&#xff0c;他想将其中大于 k k k 的数字都替换为序列的最大…

springboot集成websokcet+H5开发聊天原型(二)

本文没有写完~~~~ 聊天相关数据结构&#xff1a; 我们初步设计了如下几个数据结构。 //存放 sessionId 与 userId 的map private Map<String,String> sessionId_userId new HashMap<>(); // 用于存储用户与群组的关联关系&#xff0c;键为用户ID&#xff0c;值…

List接口(源码阅读)

文章目录 1.List接口常用方法1.代码2.结果 2.ArrayList底层机制1.结论2.ArrayList底层源码1.代码2.debug添加第一个元素1.进入2.elementData数组存储ArrayList的数据3.初始化为空数组4.首先确保使用size1来计算最小容量5.如果elementData为空&#xff0c;最小容量就是106.modCo…

Python爬虫(一)- Requests 安装与基本使用教程

文章目录 前言一、简介及安装1. 简介2. 安装 Requests2.1 安装2.2 检查安装是否成功 二、使用 Requests 发送 HTTP 请求1. 发送 GET 请求2. 发送 POST 请求3. 发送 PUT 请求4. 发送 DELETE 请求5. 发送 HEAD 请求6. 发送 OPTIONS 请求 三、传递参数1. GET 请求传递 URL 参数1.1…

风力涡轮机缺陷检测数据集,86.6%准确识别率,11921张图片,支持yolo,PASICAL VOC XML,COCO JSON格式的标注

风力涡轮机缺陷检测数据集&#xff0c;86.6&#xff05;准确识别率&#xff0c;11921张图片&#xff0c;支持yolo&#xff0c;PASICAL VOC XML&#xff0c;COCO JSON格式的标注 数据集下载 yolov11&#xff1a; https://download.csdn.net/download/pbymw8iwm/90206849 yolov…

简易屏幕共享工具-基于WebSocket

前面写了两个简单的屏幕共享工具&#xff0c;不过那只是为了验证通过截屏的方式是否可行&#xff0c;因为通常手动截屏的频率很低&#xff0c;而对于视频来说它的帧率要求就很高了&#xff0c;至少要一秒30帧率左右。所以&#xff0c;经过实际的截屏工具验证&#xff0c;我了解…