专栏名称: 武哥聊编程
这里有技术，有段子，有生活，也有资源，要不然怎么叫 “私房菜” 呢？
目录
相关文章推荐
偶俚张家港  ·  张家港第一波！开了！开了！🤩 ·  昨天  
偶俚张家港  ·  张家港第一波！开了！开了！🤩 ·  昨天  
甘肃省教育厅  ·  超500000000人次！ ·  昨天  
昆明警方发布  ·  接待游客1464.37万人次 ·  2 天前  
昆明警方发布  ·  接待游客1464.37万人次 ·  2 天前  
掌上铜山  ·  来方特，邂逅甜蜜情人节~ ·  2 天前  
江西文旅发布  ·  梅亦会见中石化江西分公司党委书记仲伟、总经理 ... ·  3 天前  
江西文旅发布  ·  梅亦会见中石化江西分公司党委书记仲伟、总经理 ... ·  3 天前  
51好读  ›  专栏  ›  武哥聊编程

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

武哥聊编程  · 公众号  ·  · 2020-04-09 08:51

正文

作者：最后的轻语_dd43

链接：https://www.jianshu.com/p/978e206ab8fd

该项目源码地址：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相关依赖 

  2.             com.aliyun.oss
  3.             aliyun-sdk-oss
  4.             2.8.3
  5.         

  7.         
  8.             org.projectlombok
  9.             lombok
  10.             1.18.4
  11.             provided
  12.         

  14.         
  15.             joda-time
  16.             




    
joda-time
  17.             2.9.9
  18.         

  20.         
  21.             org.apache.commons
  22.             commons-lang3
  23.             3.8.1
  24.

3.3 安装lombok插件

因为项目中使用了lombok的 @Data 注解，当然你也可以自己写get、set等方法。\ File------>settings------>Plugins

安装lombok插件

安装lombok插件

然后restart IDEA即可。

4. 后端服务编写

项目结构

4.1 阿里云OSS配置

在resource下新建一个application-oss.properties 

  1. aliyun.endpoint=oss-cn-shanghai.aliyuncs.com
  2. aliyun.accessKeyId=你的accessKeyId
  3. aliyun




    
.accessKeySecret=你的accessKeySecret
  4. aliyun.bucketName=gaojun-testbucket
  5. aliyun.urlPrefix=http://gaojun-testbucket.oss-cn-shanghai.aliyuncs.com/
  6. spring.servlet.multipart.max-file-size=100MB
  7. spring.servlet.multipart.max-request-size=1000MB

endpoint、bucketName、urlPrefix在OSS主面板就可以看到

bucketName、endpoint与urlPrefix

accessKeyId、accessKeySecret需要在accesskeys里面查看

accesskeys与accessKeySecret

在java的包下新建一个config包，创建一个AliyunConfig.java 

  1. package com.example.ossdemo.config;

  3. import com.aliyun.oss.OSS;
  4. import com.aliyun.oss.




    
OSSClient;
  5. import lombok.Data;
  6. import org.springframework.boot.context.properties.ConfigurationProperties;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  9. import org.springframework.context.annotation.PropertySource;
  10. /**
  11.  * @desc
  12.  *
  13.  * @author lastwhisper
  14.  * @email [email protected]
  15.  */
  16. @Configuration
  17. @PropertySource(value =




    
 {"classpath:application-oss.properties"})
  18. @ConfigurationProperties(prefix = "aliyun")
  19. @Data
  20. public class AliyunConfig {
  21.     private String endpoint;
  22.     private String accessKeyId;
  23.     private String accessKeySecret;
  24.     private String bucketName;
  25.     private String urlPrefix;

  27.     @Bean
  28.     public OSS oSSClient() {
  29.         return new OSSClient(endpoint, accessKeyId, accessKeySecret);
  30.     




    
}
  31. }

4.2 后端业务

4.2.1 vo

该实体类用于后台返回给前台。 

  1. package com.example.ossdemo.vo;

  3. import lombok.Data;

  5. /**
  6.  * @author lastwhisper
  7.  * @desc 用于前后端交互的返回值
  8.  * @email [email protected]
  9.  */
  10. @Data
  11. public class FileUploadResult {
  12.     // 文件唯一标识
  13.     private String uid;
  14.     // 文件名
  15.     private 




    
String name;
  16.     // 状态有：uploading done error removed
  17.     private String status;
  18.     // 服务端响应内容，如：'{"status": "success"}'
  19.     private String response;
  20. }

4.2.2 service

在service使用ossClient操作阿里云OSS，进行上传、下载、删除、查看所有文件等操作，同时可以将图片的url进行入库操作。 

  1. package com.example.ossdemo.service;

  3. import com.aliyun.oss.OSS;
  4. import com.aliyun.oss.model.*;
  5. import com.example.ossdemo.config.AliyunConfig;
  6. import com.example.ossdemo.vo.FileUploadResult




    
;
  7. import org.apache.commons.lang3.RandomUtils;
  8. import org.apache.commons.lang3.StringUtils;
  9. import org.joda.time.DateTime;
  10. import org.springframework.beans.factory.annotation.Autowired;
  11. import org.springframework.stereotype.Service;
  12. import org.springframework.web.multipart.MultipartFile;

  14. import java.io.*;
  15. import java.util.List;

  17. /**
  18.  * @author lastwhisper




    

  19.  * @desc
  20.  * @email [email protected]
  21.  */
  22. @Service
  23. public class FileUploadService {
  24.     // 允许上传的格式
  25.     private static final String[] IMAGE_TYPE = new String[]{".bmp", ".jpg",
  26.             ".jpeg", ".gif", ".png"};
  27.     @Autowired
  28.     private OSS ossClient;
  29.     @Autowired
  30.     private AliyunConfig aliyunConfig;

  32.     




    
/**
  33.      * @author lastwhisper
  34.      * @desc 文件上传
  35.      * 文档链接 https://help.aliyun.com/document_detail/84781.html?spm=a2c4g.11186623.6.749.11987a7dRYVSzn
  36.      * @email [email protected]
  37.      */
  38.     public FileUploadResult upload(MultipartFile uploadFile) {
  39.         // 校验图片格式
  40.         boolean isLegal = false;
  41.         for (String type : IMAGE_TYPE) {
  42.             if (StringUtils.endsWithIgnoreCase(uploadFile.getOriginalFilename(),
  43.                     type)) {
  44.                 isLegal = true;
  45.                 break;
  46.             




    
}
  47.         }
  48.         //封装Result对象，并且将文件的byte数组放置到result对象中
  49.         FileUploadResult fileUploadResult = new FileUploadResult();
  50.         if (!isLegal) {
  51.             fileUploadResult.setStatus("error");
  52.             return fileUploadResult;
  53.         }
  54.         //文件新路径
  55.         String fileName = uploadFile.getOriginalFilename();
  56.         String filePath = getFilePath(fileName);
  57.         // 上传到阿里云
  58.         try {
  59.             ossClient




    
.putObject(aliyunConfig.getBucketName(), filePath, new
  60.                     ByteArrayInputStream(uploadFile.getBytes()));
  61.         } catch (Exception e) {
  62.             e.printStackTrace();
  63.             //上传失败
  64.             fileUploadResult.setStatus("error");
  65.             return fileUploadResult;
  66.         }
  67.         fileUploadResult.setStatus("done");
  68.         fileUploadResult.setResponse("success");
  69.         //this.aliyunConfig.getUrlPrefix() + filePath 文件路径需要保存到数据库
  70.         fileUploadResult.setName(this.aliyunConfig.getUrlPrefix




    
() + filePath);
  71.         fileUploadResult.setUid(String.valueOf(System.currentTimeMillis()));
  72.         return fileUploadResult;
  73.     }

  75.     /**
  76.      * @author lastwhisper
  77.      * @desc 生成路径以及文件名 例如：//images/2019/04/28/15564277465972939.jpg
  78.      * @email [email protected]
  79.      */
  80.     private String getFilePath(String sourceFileName) {
  81.         DateTime dateTime = new DateTime();
  82.         return "images/" + dateTime.toString("yyyy")
  83.                 + "/" +




    
 dateTime.toString("MM") + "/"
  84.                 + dateTime.toString("dd") + "/" + System.currentTimeMillis() +
  85.                 RandomUtils.nextInt(100, 9999) + "." +
  86.                 StringUtils.substringAfterLast(sourceFileName, ".");
  87.     }

  89.     /**
  90.      * @author lastwhisper
  91.      * @desc 查看文件列表
  92.      * 文档链接 https://help.aliyun.com/document_detail/84841.html?spm=a2c4g.11186623.2.13.3ad5b5ddqxWWRu#concept-84841-zh
  93.      * @email [email protected]
  94.      */
  95.     public List




    
<OSSObjectSummary> list() {
  96.         // 设置最大个数。
  97.         final int maxKeys = 200;
  98.         // 列举文件。
  99.         ObjectListing objectListing = ossClient.listObjects(new ListObjectsRequest(aliyunConfig.getBucketName()).withMaxKeys(maxKeys));
  100.         List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
  101.         return sums;
  102.     }

  104.     /**
  105.      * @author lastwhisper
  106.      * @desc 删除文件
  107.      * 文档链接 https://help.aliyun.com/document_detail/84842.html?spm=a2c4g.11186623.6.770.4f9474b4UYlCtr
  108.      * @email [email protected]
  109.      */




    

  110.     public FileUploadResult delete(String objectName) {
  111.         // 根据BucketName,objectName删除文件
  112.         ossClient.deleteObject(aliyunConfig.getBucketName(), objectName);
  113.         FileUploadResult fileUploadResult = new FileUploadResult();
  114.         fileUploadResult.setName(objectName);
  115.         fileUploadResult.setStatus("removed");
  116.         fileUploadResult.setResponse("success");
  117.         return fileUploadResult;
  118.     }

  120.     /**
  121.      * @author lastwhisper
  122.      * @desc 下载文件
  123.      * 文档链接 https://help.aliyun.com/document_detail/84823.html?spm=a2c4g.11186623.2.7.37836e84ZIuZaC#concept-84823-zh




    

  124.      * @email [email protected]
  125.      */
  126.     public void exportOssFile(OutputStream os, String objectName) throws IOException {
  127.         // ossObject包含文件所在的存储空间名称、文件名称、文件元信息以及一个输入流。
  128.         OSSObject ossObject = ossClient.getObject(aliyunConfig.getBucketName(), objectName);
  129.         // 读取文件内容。
  130.         BufferedInputStream in = new BufferedInputStream(ossObject.getObjectContent());
  131.         BufferedOutputStream out = new BufferedOutputStream(os);
  132.         byte[] buffer = new byte




    
[1024];
  133.         int lenght = 0;
  134.         while ((lenght = in.read(buffer)) != -1) {
  135.             out.write(buffer, 0, lenght);
  136.         }
  137.         if (out != null) {
  138.             out.flush();
  139.             out.close();
  140.         }
  141.         if (in != null) {
  142.             




    
in.close();
  143.         }
  144.     }
  145. }

4.2.3 controller

controller进行接收用户请求 

  1. package com.example.ossdemo.controller;

  3. import com.aliyun.oss.model.OSSObjectSummary;
  4. import com.example.ossdemo.service.FileUploadService;
  5. import com.example.ossdemo.vo.FileUploadResult;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.http.HttpHeaders




    
;
  8. import org.springframework.http.HttpStatus;
  9. import org.springframework.http.MediaType;
  10. import org.springframework.http.ResponseEntity;
  11. import org.springframework.stereotype.Controller;
  12. import org.springframework.web.bind.annotation.RequestMapping;
  13. import org.springframework.web.bind.annotation.RequestParam;
  14. import org.springframework.web.bind.annotation.ResponseBody;
  15. import org.springframework.web.multipart.MultipartFile;




    


  17. import javax.servlet.http.HttpServletResponse;
  18. import java.io.IOException;
  19. import java.io.InputStream;
  20. import java.net.URLEncoder;
  21. import java.util.List;

  23. /**
  24.  * @author lastwhisper
  25.  * @desc
  26.  * @email [email protected]
  27.  */
  28. @Controller
  29. public class FileUploadController {
  30.     @Autowired
  31.     private FileUploadService




    
 fileUploadService;

  33.     /**
  34.      * @author lastwhisper
  35.      * @desc 文件上传到oss
  36.      * @return FileUploadResult
  37.      * @Param uploadFile
  38.      */
  39.     @RequestMapping("file/upload")
  40.     @ResponseBody
  41.     public FileUploadResult upload(@RequestParam("file") MultipartFile uploadFile)
  42.             throws Exception {
  43.         return this.fileUploadService.upload(uploadFile);
  44.     }

  46.     /**
  47.      * @return FileUploadResult
  48.      * @desc 根据文件名删除oss上的文件




    

  49.      * http://localhost:8080/file/delete?fileName=images/2019/04/28/1556429167175766.jpg
  50.      * @author lastwhisper
  51.      * @Param objectName
  52.      */
  53.     @RequestMapping("file/delete")
  54.     @ResponseBody
  55.     public FileUploadResult delete(@RequestParam("fileName") String objectName)
  56.             throws Exception {
  57.         return this.fileUploadService.delete(objectName);
  58.     }

  60.     /**
  61.      * @author lastwhisper
  62.      * @desc 查询oss上的所有文件
  63.      * http://localhost:8080/file/list
  64.      * @return List




    

  65.      * @Param
  66.      */
  67.     @RequestMapping("file/list")
  68.     @ResponseBody
  69.     public List<OSSObjectSummary> list()
  70.             throws Exception {
  71.         return this.fileUploadService.list();
  72.     }

  74.     /**
  75.      * @author lastwhisper
  76.      * @desc 根据文件名下载oss上的文件
  77.      * @return
  78.      * @Param objectName
  79.      */
  80.     @RequestMapping("file/download")




    

  81.     @ResponseBody
  82.     public void download(@RequestParam("fileName") String objectName, HttpServletResponse response) throws IOException {
  83.         //通知浏览器以附件形式下载
  84.         response.setHeader("Content-Disposition",
  85.                 "attachment;filename=" + new String(objectName.getBytes(), "ISO-8859-1"));
  86.         this.fileUploadService.exportOssFile(response.getOutputStream(),objectName);
  87.     }
  88. }

5. 前端页面编写与测试

5.1 文件上传页面

使用ajax异步文件上传到后端对接的OSS上。 

  2.  lang="en">
  4.      charset="UTF-8">






请到「今天看啥」查看全文


推荐文章
偶俚张家港  ·  张家港第一波！开了！开了！🤩
昨天
偶俚张家港  ·  张家港第一波！开了！开了！🤩
昨天
甘肃省教育厅  ·  超500000000人次！
昨天
昆明警方发布  ·  接待游客1464.37万人次
2 天前
昆明警方发布  ·  接待游客1464.37万人次
2 天前
掌上铜山  ·  来方特，邂逅甜蜜情人节~
2 天前
江西文旅发布  ·  梅亦会见中石化江西分公司党委书记仲伟、总经理施尚强一行
3 天前
江西文旅发布  ·  梅亦会见中石化江西分公司党委书记仲伟、总经理施尚强一行
3 天前
两个质子  ·  iPhone点燃手机新接口千亿市场
8 年前
古文观止  ·  《二十四史》经典佳句30则，掌握了它，受益终生！
7 年前
科睿唯安生命科学与制药  ·  【科睿唯安大会快报-2】药物创新与临床研究|精彩观点回顾
7 年前
招商研究  ·  招商化工·周铮/姚鑫/孙维容：中泰化学（002092）—PVC行业仍处景气，三季度业绩值得期待
7 年前
酱子工厂  ·  今天我差点和哈登握了手？
7 年前
Sov5搜索   ·   小百科   ·   今天看啥   ·   移动版
51好读 - 好文章就要读起来!