如何使用Spring Boot和MinIO实现文件上传、读取、下载和删除的功能？

刺骨的言语ヽ痛彻心扉 2023-10-13 13:57 67阅读 0赞

#### 引言 ####

在现代Web应用程序开发中，文件的上传、读取、下载和删除是非常常见的功能。Spring Boot 是一个流行的Java框架，而MinIO则是一个高性能的对象存储服务。本文将详细介绍如何使用Spring Boot和MinIO实现文件上传、读取、下载和删除的功能。

![f171209c1b1c8ecaa4007789a76da028.png][]

#### 准备工作 ####

在开始之前，需要进行一些准备工作：

1.  安装Java JDK并配置好环境变量。
2.  安装Maven构建工具。
3.  创建一个新的Spring Boot项目。

#### 步骤一：添加所需依赖 ####

首先，在项目的pom.xml文件中添加以下依赖：

<dependencies>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        
        
        <dependency>
            <groupId>io.minio</groupId>
            <artifactId>minio</artifactId>
            <version>8.4.0</version>
        </dependency>
    </dependencies>

这里我们添加了Spring Boot Web依赖以及MinIO Java SDK依赖。

#### 步骤二：配置MinIO连接信息 ####

在application.properties（或application.yml）文件中添加MinIO连接信息：

# MinIO连接信息
    minio.url=http://localhost:9000
    minio.accessKey=minio_access_key
    minio.secretKey=minio_secret_key

这里需要将`minio.url`、`minio.accessKey`和`minio.secretKey`替换为你实际使用的MinIO连接信息。

#### 步骤三：编写文件上传接口 ####

创建一个新的REST Controller类，用于处理文件上传：

@RestController
    public class FileController {
        
        
        @Value("${minio.url}")
        private String minioUrl;
        
        @Value("${minio.accessKey}")
        private String minioAccessKey;
        
        @Value("${minio.secretKey}")
        private String minioSecretKey;
        
        // 文件上传接口
        @PostMapping("/upload")
        public String uploadFile(@RequestParam("file") MultipartFile file) {
        
            try {
        
                // 创建MinIO客户端
                MinioClient minioClient = MinioClient.builder()
                        .endpoint(minioUrl)
                        .credentials(minioAccessKey, minioSecretKey)
                        .build();
                
                // 生成随机文件名
                String filename = UUID.randomUUID().toString() + "-" + file.getOriginalFilename();
                
                // 使用putObject方法上传文件
                minioClient.putObject(PutObjectArgs.builder()
                        .bucket("my-bucket") // 替换为你实际的存储桶名称
                        .object(filename)
                        .stream(file.getInputStream(), file.getSize(), -1)
                        .contentType(file.getContentType())
                        .build());
                
                return "文件上传成功";
            } catch (Exception e) {
        
                e.printStackTrace();
                return "文件上传失败：" + e.getMessage();
            }
        }
    }

这个接口使用`@PostMapping`注解定义了一个文件上传的POST请求接口。在方法内部，我们首先获取MinIO连接信息，并创建MinioClient实例。然后，生成一个随机文件名，使用`putObject`方法将文件上传到指定的存储桶中。

请注意，这里的存储桶名称需要根据你实际的需求进行替换。

#### 步骤四：编写文件读取接口 ####

继续在FileController类中添加一个文件读取的接口：

@GetMapping("/read/{filename}")
    public ResponseEntity<InputStreamResource> readFile(@PathVariable String filename) {
        
        try {
        
            // 创建MinIO客户端
            MinioClient minioClient = MinioClient.builder()
                    .endpoint(minioUrl)
                    .credentials(minioAccessKey, minioSecretKey)
                    .build();
            
            // 获取文件流
            GetObjectResponse objectResponse = minioClient.getObject(GetObjectArgs.builder()
                    .bucket("my-bucket") // 替换为你实际的存储桶名称
                    .object(filename)
                    .build());
            
            InputStream inputStream = objectResponse;
            
            // 设置响应头
            HttpHeaders headers = new HttpHeaders();
            headers.add(HttpHeaders.CONTENT_TYPE, objectResponse.contentType());
            
            return ResponseEntity.ok()
                    .headers(headers)
                    .body(new InputStreamResource(inputStream));
        } catch (Exception e) {
        
            e.printStackTrace();
            return ResponseEntity.notFound().build();
        }
    }

这个接口使用`@GetMapping`注解定义了一个文件读取的GET请求接口。在方法内部，我们首先获取MinIO连接信息，并创建MinioClient实例。然后，使用`getObject`方法获取文件流，并将其封装为`InputStreamResource`对象。

#### 步骤五：编写文件下载接口 ####

在FileController类中继续添加一个文件下载的接口：

@GetMapping("/download/{filename}")
    public ResponseEntity<InputStreamResource> downloadFile(@PathVariable String filename) {
        
        try {
        
            // 创建MinIO客户端
            MinioClient minioClient = MinioClient.builder()
                    .endpoint(minioUrl)
                    .credentials(minioAccessKey, minioSecretKey)
                    .build();
            
            // 获取文件流
            GetObjectResponse objectResponse = minioClient.getObject(GetObjectArgs.builder()
                    .bucket("my-bucket") // 替换为你实际的存储桶名称
                    .object(filename)
                    .build());
            
            InputStream inputStream = objectResponse;
            
            // 设置响应头
            HttpHeaders headers = new HttpHeaders();
            headers.add(HttpHeaders.CONTENT_TYPE, objectResponse.contentType());
            headers.add(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=\"" + filename + "\"");
            
            return ResponseEntity.ok()
                    .headers(headers)
                    .body(new InputStreamResource(inputStream));
        } catch (Exception e) {
        
            e.printStackTrace();
            return ResponseEntity.notFound().build();
        }
    }

这个接口也使用`@GetMapping`注解定义了一个文件下载的GET请求接口。与文件读取接口类似，我们首先获取MinIO连接信息，并创建MinioClient实例。然后，使用`getObject`方法获取文件流，并将其封装为`InputStreamResource`对象。

不同之处在于，我们设置了`Content-Disposition`响应头，指定文件的下载方式。

#### 步骤六：编写文件删除接口 ####

最后，在FileController类中添加文件删除的接口：

@DeleteMapping("/delete/{filename}")
    public String deleteFile(@PathVariable String filename) {
        
        try {
        
            // 创建MinIO客户端
            MinioClient minioClient = MinioClient.builder()
                    .endpoint(minioUrl)
                    .credentials(minioAccessKey, minioSecretKey)
                    .build();
            
            // 删除文件
            minioClient.removeObject(RemoveObjectArgs.builder()
                    .bucket("my-bucket") // 替换为你实际的存储桶名称
                    .object(filename)
                    .build());
            
            return "文件删除成功";
        } catch (Exception e) {
        
            e.printStackTrace();
            return "文件删除失败：" + e.getMessage();
        }
    }

这个接口使用`@DeleteMapping`注解定义了一个文件删除的DELETE请求接口。在方法内部，我们首先获取MinIO连接信息，并创建MinioClient实例。然后，使用`removeObject`方法从指定的存储桶中删除文件。

#### 测试 ####

完成以上步骤后，你可以启动Spring Boot应用程序，并使用任何HTTP客户端（如Postman）来测试文件上传、读取、下载和删除的功能。

例如，使用POST方法请求`http://localhost:8080/upload`接口来上传文件，使用GET方法请求`http://localhost:8080/read/{filename}`接口来读取文件，使用GET方法请求`http://localhost:8080/download/{filename}`接口来下载文件，使用DELETE方法请求`http://localhost:8080/delete/{filename}`接口来删除文件。

请记得根据实际情况替换URL中的`{filename}`和存储桶名称。

#### 结论 ####

通过使用Spring Boot和MinIO，我们可以方便地实现文件上传、读取、下载和删除的功能。在实际应用中，你可能还需要添加更多的功能，如文件列表、权限控制等。希望本文对你有所帮助，祝你在使用Spring Boot和MinIO开发文件管理功能时取得成功！

[f171209c1b1c8ecaa4007789a76da028.png]: https://img-blog.csdnimg.cn/img_convert/f171209c1b1c8ecaa4007789a76da028.png