SpringBoot整合阿里云OSS文件上传、下载、查看、删除

本文档介绍了如何使用SpringBoot整合阿里云OSS进行文件上传、下载、查看和删除。从开发前的环境准备,如Java基础和SpringBoot知识,到阿里云OSS的使用,包括Bucket创建和文件管理。接着详细阐述了项目初始化、后端服务编写,如配置文件和业务代码,以及前端页面的编写和测试,利用AJAX实现文件异步上传。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

该项目源码地址:https://github.com/ggb2312/JavaNotes/tree/master/springboot-integration-examples (其中包含SpringBoot和其他常用技术的整合,配套源码以及笔记。基于最新的 SpringBoot2.1+,欢迎各位 Star)

1. 开发前准备

1.1 前置知识

  • java基础
  • SpringBoot简单基础知识

1.2 环境参数

  • 开发工具:IDEA
  • 基础环境:Maven+JDK8
  • 所用技术:SpringBoot、lombok、阿里云OSS存储服务
  • SpringBoot版本:2.1.4

1.3 涉及知识点

  • OSS简介,以及阿里云OSS控制台快速入门使用
  • SpringBoot 整合 阿里云OSS 存储服务,进行文件上传、下载、查看、删除
  • 阿里云OSS文档介绍,以及快速入门使用
  • lombok入门使用以及IDEA lombok插件安装
  • SpringMVC与AJAX前后端分离交互
  • AJAX文件异步上传

2. 使用阿里云OSS

对象存储OSS的多重冗余架构设计,为数据持久存储提供可靠保障。

2.1 创建Bucket

使用OSS,首先需要创建Bucket,Bucket翻译成中文是水桶的意思,把存储的图片资源看做是水,想要盛水必须得
有桶。
进入控制台,https://oss.console.aliyun.com/overview

新建Bucket

新建 Bucket

创建完成后,在左侧可以看到已经创建好的Bucket:

Bucket

选择Bucket后,即可看到对应的信息,如:url、消耗流量等

Bucket相关信息

2.2 管理文件

可以通过在线的方式进行管理文件

管理文件

2.3 阿里云OSS文档

阿里云OSS文档

阿里云OSS文档

右侧的开发指南说的更加详细
开发指南

阿里云虽然提供了完整的文档,但是做一个完整的前后端交互的文件上传、下载、查看、删除等操作,对于小白来说还是有点难度的,所以我把自己学习OSS的步骤以及代码分享了出来,共有需要的人使用。

3. 项目初始化

3.1 创建SpringBoot项目

在Idea中File——>New——>Project
创建SpringBoot项目 步骤一

创建SpringBoot项目 步骤二

创建SpringBoot项目 步骤三

创建SpringBoot项目 步骤四

3.2 Maven依赖

导入Maven相关依赖

<dependency>
            <groupId>com.aliyun.oss</groupId>
            <artifactId>aliyun-sdk-oss</artifactId>
            <version>2.8.3</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.4</version>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
            <version>2.9.9</version>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</ar
### Spring Boot集成阿里云OSS实现文件上传下载 #### 创建启动类 为了使Spring Boot应用程序能够运行并管理依赖组件,创建`OssApplication.java`作为项目的入口点[^1]。 ```java package com.sun.oss; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.annotation.ComponentScan; @SpringBootApplication @ComponentScan({"com.sun"}) public class OssApplication { public static void main(String[] args) { SpringApplication.run(OssApplication.class, args); } } ``` #### 添加Maven依赖项 为了让项目支持与阿里云OSS交互的功能,在`pom.xml`中加入必要的库来处理对象存储服务的操作[^2]。 ```xml <dependency> <groupId>com.aliyun</groupId> <artifactId>aliyun-java-sdk-oss</artifactId> <version>LATEST_VERSION_HERE</version> </dependency> ``` 注意替换`LATEST_VERSION_HERE`为实际版本号。 #### OSS配置属性设置 定义用于连接到阿里云OSS的服务端点、访问密钥和其他必要参数的应用程序属性。这些通常放在`application.properties`或`application.yml`文件内。 对于`.properties`格式: ```properties # application.properties spring.cloud.alicloud.access-key=your-access-key-id spring.cloud.alicloud.secret-key=your-secret-access-key spring.cloud.alicloud.endpoint=http://oss-cn-hangzhou.aliyuncs.com spring.cloud.alicloud.bucketName=test-bucket-name ``` 对于`.yaml`格式: ```yaml # application.yml spring: cloud: alicloud: access-key: your-access-key-id secret-key: your-secret-access-key endpoint: http://oss-cn-hangzhou.aliyuncs.com bucketName: test-bucket-name ``` #### 编写控制器方法以执行上传操作 通过编写RESTful API接口允许客户端发送POST请求来进行文件上载至指定位置,并返回成功与否的信息给调用者。 ```java @RestController @RequestMapping("/api/file") public class FileController { private final String BUCKET_NAME = "test-bucket-name"; @Autowired private AliyunOSSClient aliyunOSSClient; /** * 实现文件上传逻辑 */ @PostMapping("/upload") public ResponseEntity<String> uploadFile(@RequestParam("file") MultipartFile file){ try{ // 调用工具类完成具体上传过程 boolean result = aliyunOSSClient.upload(BUCKET_NAME,file.getInputStream(),file.getOriginalFilename()); if(result){ return new ResponseEntity<>("Upload Success", HttpStatus.OK); }else{ return new ResponseEntity<>("Upload Failed",HttpStatus.INTERNAL_SERVER_ERROR); } }catch(Exception e){ e.printStackTrace(); return new ResponseEntity<>(e.getMessage(),HttpStatus.BAD_REQUEST); } } } ``` #### 定义服务层负责具体的业务逻辑 这里假设存在名为`AliyunOSSClient`的一个辅助类用来封装同阿里云SDK之间的通信细节以及提供简单的API供外部调用。 ```java @Service public class AliyunOSSClient { @Value("${spring.cloud.alicloud.endpoint}") private String ENDPOINT; @Value("${spring.cloud.alicloud.access-key}") private String ACCESS_KEY_ID; @Value("${spring.cloud.alicloud.secret-key}") private String SECRET_ACCESS_KEY; @Value("${spring.cloud.alicloud.bucketName}") private String BUCKET_NAME; private OSS client; @PostConstruct public void init(){ this.client=new OSSClientBuilder().build(ENDPOINT,ACCESS_KEY_ID,SECRET_ACCESS_KEY); } /** * 将输入流中的数据保存到目标bucket下的object名称所指代的对象处 * *@param bucket 存储空间名 *@param inputStream 输入的数据源 *@param objectName 对象的名字(即路径加文件名) *@return 是否上传成功的标志位 */ public Boolean upload(String bucket, InputStream inputStream,String objectName){ ObjectMetadata metadata = new ObjectMetadata(); PutObjectRequest request = new PutObjectRequest(bucket, objectName, inputStream,metadata); try{ PutObjectResult putRes =client.putObject(request); return true; }finally { IOUtils.closeQuietly(inputStream); } } } ``` #### 处理文件下载请求 同样地,可以构建另一个HTTP GET类型的API端点让用户可以从远程仓库获取所需资源。 ```java @GetMapping("/download/{fileName:.+}") public ResponseEntity<Resource> downloadFile(@PathVariable String fileName){ Resource resource=null; try{ byte[] bytes=this.aliyunOSSClient.download(fileName).readAllBytes(); ByteArrayInputStream bis=new ByteArrayInputStream(bytes); resource=new InputStreamResource(bis); HttpHeaders headers=new HttpHeaders(); headers.add(HttpHeaders.CONTENT_DISPOSITION,"attachment; filename="+URLEncoder.encode(fileName,"UTF-8")); return ResponseEntity.ok() .headers(headers) .contentLength(resource.contentLength()) .contentType(MediaType.APPLICATION_OCTET_STREAM) .body(resource); } catch (IOException ex) { throw new RuntimeException(ex.getMessage()); } } /** * 获取对应名字的文件字节数组 */ private ByteArrayOutputStream download(String keyName)throws IOException{ OSSObject ossObj = null; try{ ossObj = client.getObject(new GetObjectRequest(BUCKET_NAME,keyName)); ByteArrayOutputStream byteArrayOutputStream =new ByteArrayOutputStream(); IOUtils.copy(ossObj.getObjectContent(),byteArrayOutputStream ); return byteArrayOutputStream ; } finally { if(null != ossObj){ ossObj.close(); } } } ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值