基于SpringBoot实现文件的上传下载

最新推荐文章于 2024-10-07 16:01:13 发布
最新推荐文章于 2024-10-07 16:01:13 发布
阅读量1.2k 收藏 12
点赞数
原文链接：https://juejin.cn/post/6917586720309379079
版权

SpringBoot 文件上传 文件下载 MultipartFile 数据库操作
关键词由CSDN通过智能技术生成

（一）概述

文件上传下载一直都是一个系统最常用也是最基本的功能点，刚好最近公司的项目上有用到这个功能，于是自己就用SpringBoot也写了一个简化的版本，已实现文件的上传和下载功能。

（二）创建项目

首先创建一个SpringBoot的项目，接着引入相关的依赖，因为涉及到数据库的操作，所以依赖会比较多一些。

2.1 依赖引入

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.3</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.9</version>
</dependency>

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
复制代码

2.2 接口通用返回类编写

编写一个接口的通用返回体，这个在之前的博客中我专门写过，现在就直接拿来用了:

public enum ResponseCode {
    // 系统模块
    SUCCESS(0, "操作成功"),
    ERROR(1, "操作失败"),
    SERVER_ERROR(500, "服务器异常"),

    // 通用模块 1xxxx
    ILLEGAL_ARGUMENT(10000, "参数不合法"),
    REPETITIVE_OPERATION(10001, "请勿重复操作"),
    ACCESS_LIMIT(10002, "请求太频繁, 请稍后再试"),
    MAIL_SEND_SUCCESS(10003, "邮件发送成功"),

    // 用户模块 2xxxx
    NEED_LOGIN(20001, "登录失效"),
    USERNAME_OR_PASSWORD_EMPTY(20002, "用户名或密码不能为空"),
    USERNAME_OR_PASSWORD_WRONG(20003, "用户名或密码错误"),
    USER_NOT_EXISTS(20004, "用户不存在"),
    WRONG_PASSWORD(20005, "密码错误"),

    // 文件模块 3xxxx
    FILE_EMPTY(30001,"文件不能空"),
    FILE_NAME_EMPTY(30002,"文件名称不能为空"),
    FILE_MAX_SIZE(30003,"文件大小超出"),
    ;

    ResponseCode(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
    private Integer code;
    private String msg;
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}
复制代码

返回体：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Result {
    private int code;
    private String message;
    private Object data;
}
复制代码

2.3 配置一下解决跨域问题的配置类

在SpringBoot中有多种解决跨域的方法，这里选择其中一种

public class WebMvcConfig implements WebMvcConfigurer {
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("*")
                .allowedMethods("POST", "GET", "PUT", "OPTIONS", "DELETE")
                .maxAge(3600)
                .allowCredentials(true);
    }
}
复制代码

到这里为止，基本的项目配置就算结束了，接下来就是功能的实现了。

（三）实现文件上传下载

3.1 创建表

首先创建一张表来记录文件的路径、名称、后缀等信息：

CREATE TABLE `file` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `filePath` varchar(255) DEFAULT NULL,
  `fileName` varchar(255) DEFAULT NULL,
  `fileSuffix` varchar(255) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;
复制代码

3.2 编写实体类

写一个文件对象，和数据库中的字段相对应：

@Data
@AllArgsConstructor
@NoArgsConstructor
@Getter
@Setter
@EqualsAndHashCode
public class Files implements Serializable {

    private static final long serialVersionUID=1L;
    /**
     * 文件存储路径
     */
    private String filePath;
    /**
     * 文件名称
     */
    private String fileName;
    /**
     * 文件后缀名
     */
    private String fileSuffix;

}
复制代码

3.3 配置application.properties

在配置文件中将服务端口，数据库连接方式以及文件的保存路径配置一下：

server.port=8080

spring.datasource.url=jdbc:mysql://localhost:3306/test7?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

mybatis.mapper-locations=classpath:mapper/*.xml
file.save-path=E:/temp/files
复制代码

3.4 编写Controller

新建一个类叫FileController，用来写接口，文件上传下载接口的代码已经给了注释，Spring中提供了一个MultipartFile类，用来接收前台传过来的文件，这里直接使用即可。

@RestController
@RequestMapping("/api")
public class FileController {
    @Autowired
    private FileService fileService;

    @RequestMapping(value = "/upload",method = RequestMethod.POST)
    public Result upLoadFiles(MultipartFile multipartFile){
        if (multipartFile.isEmpty()){
            return new Result(ResponseCode.FILE_EMPTY.getCode(),ResponseCode.FILE_EMPTY.getMsg(),null);
        }
        return fileService.upLoadFiles(multipartFile);
    }

    @RequestMapping(value = "/download/{id}",method = RequestMethod.GET)
    public void downloadFiles(@PathVariable("id") String id, HttpServletRequest request, HttpServletResponse response){
        OutputStream outputStream=null;
        InputStream inputStream=null;
        BufferedInputStream bufferedInputStream=null;
        byte[] bytes=new byte[1024];
        Files files = fileService.getFileById(id);
        String fileName = files.getFileName();
        // 获取输出流
        try {
            response.setHeader("Content-Disposition", "attachment;filename=" +  new String(fileName.getBytes(StandardCharsets.UTF_8), StandardCharsets.ISO_8859_1));
            response.setContentType("application/force-download");
            inputStream=fileService.getFileInputStream(files);
            bufferedInputStream=new BufferedInputStream(inputStream);
            outputStream = response.getOutputStream();
            int i=bufferedInputStream.read(bytes);
            while (i!=-1){
                outputStream.write(bytes,0,i);
                i=bufferedInputStream.read(bytes);
            }
        } catch (IOException e) {
            e.printStackTrace();
        }finally {
            try {
                if (inputStream!=null){
                    inputStream.close();
                }
                if (outputStream!=null){
                    outputStream.close();
                }
                if (bufferedInputStream!=null){
                    bufferedInputStream.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }

        }
    }

}


复制代码

所有的业务都写在service中，因此需要有fileService接口以及fileServiceImpl实现类：

public interface FileService {
    /**
     * 文件上传接口
     * @param file
     * @return
     */
    Result upLoadFiles(MultipartFile file);

    /**
     * 根据id获取文件
     * @param id
     * @return
     */
    Files getFileById(String id);

    /**
     * 根据id获取数据流
     * @param files
     * @return
     */
    InputStream getFileInputStream(Files files);
}
复制代码

fileServiceImpl实现类：

@Service
public class FileServiceImpl implements FileService {

    @Value("${file.save-path}")
    private String savePath;
    @Autowired
    private FileMapper fileMapper;

    @Override
    public Result upLoadFiles(MultipartFile file) {
        //设置支持最大上传的文件，这里是1024*1024*2=2M
        long MAX_SIZE=2097152L;
        //获取要上传文件的名称
        String fileName=file.getOriginalFilename();
        //如果名称为空，返回一个文件名为空的错误
        if (StringUtils.isEmpty(fileName)){
            return new Result(ResponseCode.FILE_NAME_EMPTY.getCode(),ResponseCode.FILE_NAME_EMPTY.getMsg(),null);
        }
        //如果文件超过最大值，返回超出可上传最大值的错误
        if (file.getSize()>MAX_SIZE){
            return new Result(ResponseCode.FILE_MAX_SIZE.getCode(),ResponseCode.FILE_MAX_SIZE.getMsg(),null);
        }
        //获取到后缀名
        String suffixName = fileName.contains(".") ? fileName.substring(fileName.lastIndexOf(".")) : null;
        //文件的保存重新按照时间戳命名
        String newName = System.currentTimeMillis() + suffixName;
        File newFile=new File(savePath,newName);
        if (!newFile.getParentFile().exists()){
            newFile.getParentFile().mkdirs();
        }
        try {
            //文件写入
            file.transferTo(newFile);
        } catch (IOException e) {
            e.printStackTrace();
        }
        //将这些文件的信息写入到数据库中
        Files files=new Files(newFile.getPath(),fileName,suffixName);
        fileMapper.insertFile(files);
        return new Result(ResponseCode.SUCCESS.getCode(),ResponseCode.SUCCESS.getMsg(),"数据上传成功");
    }

    //根据id获取文件信息
    @Override
    public Files getFileById(String id) {
        Files files = fileMapper.selectFileById(id);
        return files;
    }
    
    //将文件转化为InputStream
    @Override
    public InputStream getFileInputStream(Files files) {
        File file=new File(files.getFilePath());
        try {
            return new FileInputStream(file);
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        }
        return null;
    }
}
复制代码

3.5 对数据库的操作

需要将数据写入到数据库中，这里用到的是mybatis，新建一个FileMapper接口：

@Mapper
@Repository
public interface FileMapper {
    /**
     * 将数据信息插入到数据库
     * @param files
     */
    void insertFile(Files files);

    /**
     * 根据id获取文件
     * @param id
     * @return
     */
    Files selectFileById(String id);
}
复制代码

编写对应的xml文件

<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.javayz.fileuploadanddownload.mapper.FileMapper">
    <insert id="insertFile" parameterType="com.javayz.fileuploadanddownload.entity.Files">
        insert into file(filepath,filename,filesuffix) values(#{filePath},#{fileName},#{fileSuffix});
    </insert>

    <select id="selectFileById" parameterType="string" resultType="com.javayz.fileuploadanddownload.entity.Files">
        select * from file where id=#{id};
    </select>
</mapper>
复制代码

代码已上传至github，欢迎自取：github

（四）测试

将项目运行起来，首先测试文件上传，通过postman直接上传一个文件

点击send后得到操作成功的返回值，我们可以在自己设置的路径下看到这个文件，同时在数据库中也存在该文件的信息：

接下来测试文件下载，因为是get请求，直接在浏览器中访问： http://localhost:8080/api/download/4 即可调用下载。


作者：Java鱼仔
链接：https://juejin.cn/post/6917586720309379079
来源：稀土掘金
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

栗少
关注
java基于springboot实现文件上传下载
王小坏
09-13 286
创建springboot项目，生成springboot依赖； 添加文件上传、下载所需工具类 import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.http.ResponseEntity; import org.springframework.web.multipart.MultipartFile; import javax.servlet.http.HttpServletRespon
基于springboot实现的文件下载上传
05-08
利用springboot实现用户注册登录，完善个人资料，文件上传和文件下载，查看自己上传的文件，还有后台管理功能。数据库文件在压缩包中。
SpringBoot文件上传下载
weixin_33717117的博客
04-10 176
项目中经常会有上传和下载的需求，这篇文章简述一下springboot项目中实现简单的上传和下载。 新建springboot项目，前台页面使用的thymeleaf模板，其余的没有特别的配置，pom代码如下： <?xml version="1.0" encoding="UTF-8"?> <pro...
SpringBoot下载文件的几种方式
最新发布
小哇
10-07 522
【代码】SpringBoot下载文件的几种方式。
SpringBoot 上传下载文件
一个95后开发者，热爱编程，喜欢玩游戏. 希望可以结识更多的小伙伴...
12-11 1723
【SpringBoot】SpringBoot：实现文件上传和下载功能
Easonmax的博客
06-15 1716
在现代应用中，用户需要上传各种类型的文件，如图片、文档、视频等，或者下载生成的报告和数据文件。SpringBoot通过其强大的生态系统和简化的配置，能够高效地实现文件上传和下载功能。在完成文件上传和下载功能的开发后，应该进行充分的测试，确保所有功能都能正常工作。通过这种方式，可以确保应用的各个部分在开发过程中得到充分的测试，减少上线后的问题。通过本文的介绍，我们了解了如何使用SpringBoot实现文件上传和下载。为了方便管理上传的文件，我们需要在项目中配置文件存储的位置。这将文件上传目录设置为。
springboot文件的上传与下载
weixin_34116110的博客
01-03 69
【转载】http://blog.csdn.net/coding13/article/details/54577076 一下代码为自己改进的代码 1、工程结构图 2、pom.xml文件依赖项 4.0.0 <groupId>com.example</groupId> <artifactId>demo</artifactId> <version...
基于SpringBoot实现图片上传与显示
08-27
基于SpringBoot实现图片上传与显示 基于SpringBoot实现图片上传与显示是指使用SpringBoot框架来实现图片上传和显示的功能。这种实现方式可以使开发者快速构建基于Web的图片上传和显示应用程序。 在实现图片上传和...
springboot+vue实现文件上传下载
01-18
本文实例为大家分享了springboot+vue实现文件上传下载的具体代码，供大家参考，具体内容如下 一、文件上传（基于axios的简单上传） 所使用的技术：axios、springboot、vue; 实现思路：通过h5 ：input元素标签进行...
基于springboot实现的文件下载上传.rar
05-12
本项目“基于SpringBoot实现的文件下载上传”旨在教你如何利用Spring Boot来实现文件的上传和下载功能，这对于许多Web应用来说是至关重要的。下面我们将详细探讨相关的知识点。 1. **Spring Boot基础知识**： - ...
SpringBoot实现文件上传下载功能
呆萌小新@渊洁的博客
01-02 823
实现文件下载,上传功能 文件的上传和下载都是基于io复制,只不过 文件上传是浏览器向服务器发送报文 文件下载是服务器向浏览器发送报文 提示：以下是本篇文章正文内容，下面案例可供参考 一、通用配置 pom.xml <dependencies> <!-- SpringMVC --> <dependency> <
SpringBoot上传文件实例下载
03-11
SpringBoot 单文件上传、批量文件上传。SpringMVC 也可以用。
SpringBoot实现文件上传下载功能小结
08-29
最近做的一个项目涉及到文件上传与下载功能。SpringBoot后台如何实现文件上传下载呢？下面有单文件上传和多文件上传功能，感兴趣的朋友一起看看吧
springboot实现文件上传下载功能
weixin_51504215的博客
04-04 203
logger.info("上传的文件：" + multipartFiles[i].getName()+","+multipartFiles[i].getContentType()+","return ResultUtil.error("下载附件失败，请检查文件“" + fileName + "”是否存在");logger.error("下载文件失败，请检查文件“"+ fileName +"”是否存在");//在文件中，不用/或者\最好，推荐使用File.separator。//检查到文件不存在则创建。
Spring Boot实现文件上传与下载功能
勤劳的小琪
04-19 977
本文介绍了如何使用Spring Boot实现文件上传与下载功能，并提供了相应的代码片段。通过配置Spring Boot的相关属性和创建相应的Controller，我们可以方便地实现文件上传和下载的需求。在实际应用中，还需要根据具体需求进行进一步的优化和扩展，比如添加文件验证、处理大文件上传、实现断点续传等功能。
SpringBoot实现文件上传和下载
qq_58860773的博客
11-15 1412
SpringBoot+Vue实现简单的单文件上传和下载，可供学习参考使用。
springboot实现文件上传与下载
热门推荐
李白的博客
12-05 1万+
文件传 jsp &amp;lt;form action=&quot;upload&quot; method=&quot;post&quot; enctype=&quot;multipart/form-data&quot;&amp;gt; &amp;lt;input type=&quot;file&quot; name=&quot;file&quot; placeholder=&quot;&
springboot文件上传下载
Ccong的博客
07-17 155
1 文件上传 html <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> <form action="/upload" method="post" enctype="multipart/form-data"> <input t
springboot 文件上传下载
laow的博客
09-18 123
配置文件配置文件存储路径 application: #版本 version: 1.0.0 #文件存储路径 profile: /usr/local/tempfile/tempfile/ spring: #设置文件上限大小 servlet: multipart: enabled: true max-file-size: 200MB max-request-size: 200MB 注册读取配置文件类 @Component @Config
springboot实现文件上传下载
09-06
以下是基于Spring Boot的文件上传和下载的实现步骤： 文件上传： 1. 创建Spring Boot项目并添加所需的依赖项，例如spring-boot-starter-web和spring-boot-starter-data-jpa。 2. 创建一个Controller类来处理文件...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值