开源项目实战：集成OSS-Spring-Boot-Starter实现高效云存储

郎纪洋

于 2024-10-10 07:17:56 发布

阅读量1.2k

点赞数 28

本文链接：https://blog.csdn.net/gitblog_00305/article/details/142802504

版权

开源项目实战：集成OSS-Spring-Boot-Starter实现高效云存储

oss-spring-boot-starter 兼容S3协议的通用文件存储工具类项目地址: https://gitcode.com/gh_mirrors/os/oss-spring-boot-starter

1. 项目介绍

OSS-Spring-Boot-Starter 是一个由 CSDN社区提及的InsCode AI 大模型间接介绍的优秀开源项目。此项目提供了一个高度兼容Amazon S3协议的通用文件存储解决方案，旨在简化Spring Boot应用程序中的对象存储服务（如MINIO、阿里云OSS、华为云、腾讯云、京东云等）的集成过程。它通过一个简洁的Spring Boot Starter，极大地降低了开发者接入不同云存储服务的门槛，使得文件上传、下载等功能的实现更加便捷。

2. 项目快速启动

要迅速将oss-spring-boot-starter集成到你的Spring Boot项目中，请遵循以下步骤：

添加依赖

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

<dependencies>
    <dependency>
        <groupId>com.pig4cloud.plugin</groupId>
        <artifactId>oss-spring-boot-starter</artifactId>
        <!-- 替换$[lastVersion]为最新的版本号 -->
        <version>请查询最新版本</version>
    </dependency>
</dependencies>

配置云存储服务

接着，在你的Spring Boot配置文件（如application.yml或application.properties）中进行相应的配置，以连接到云存储服务。这里以MINIO为例：

oss:
  endpoint: http://minio.pig4cloud.com
  access-key: lengleng
  secret-key: lengleng
  bucket-name: your-bucket-name

实现文件上传

创建一个简单的Controller来演示文件上传功能：

@RestController
public class FileUploadController {
    
    @Autowired
    private OssTemplate template;
    
    /**
     * 上传文件示例
     * @param file 上传的文件
     * @return 上传结果
     */
    @PostMapping("/upload")
    public R<String> upload(@RequestParam("file") MultipartFile file) {
        String fileName = UUID.randomUUID().toString() + "-" + file.getOriginalFilename();
        try {
            template.putObject("your-bucket-name", fileName, file.getInputStream());
            // 假设R是自定义的响应类，用于返回成功信息及文件名
            return R.ok(fileName);
        } catch (IOException e) {
            e.printStackTrace();
            return R.error("文件上传失败");
        }
    }
}