JAVA集成阿里云OSS对象存储

超、凢脫俗 2023-09-23 19:43 160阅读 0赞

JAVA集成阿里云OSS对象存储

  • 1 : 配置集成
    • 1.1、对象存储OSS
  • 2 : 代码配置
    • 2.1、说明
    • 2.2、配置文件
    • 2.3、加载配置文件代码
    • 2.4、封装统一的DTO
    • 2.5、OSS上传Controller
    • 2.6、OSS上传Service
    • 2.7、OSS上传ServiceImpl
  • 3 : 测试
    • 3.1、文件上传
    • 3.2、文件迁移
  • 4 : 总结
    • 4.1、参考资料
    • 4.2、注意事项
    • 4.3、源码链接

1 : 配置集成

1.1、对象存储OSS

这就不用说了，从阿里云平台花钱买OSS对象存储就行了。
然后在bucket列表中创建自己使用的bucket即可。
比如创建：oss-test
然后从概览中找到 Access Key
在这里插入图片描述
在这里插入图片描述
然后就可以看到对应的id和key了。
在这里插入图片描述

这个时候，就有了四个参数
1、access-key：就是刚才的 AccessKey ID
2、secret-key：页面点击‘查看 Secret’就能看的到了
3、bucket：新建的桶的名称oss-test
4、endpoint：页面截图，选择自己的桶就能看到对应的endpoint

2 : 代码配置

2.1、说明

本篇代码，主要做的两件事：
1、文件上传至OSS
2、对服务器磁盘文件转存至OSS

2.2、配置文件

在application.yml中增加配置

  1. #阿里云oss
  2. alibaba:
  3.   cloud:
  4.     access-key: **********
  5.     secret-key: **********
  6.     oss:
  7.       endpoint: oss********.aliyuncs.com
  8.       bucket: *******
  9.   config:
  10.     # oss开关 0：关  1：开
  11.     oss-switch: 1
  12.     # oss 开始使用时间
  13.     oss-date: 2022-01-01
  14.     # oss 文件夹目录
  15.     oss-directory: image,attach,video,audio,template
  16.     # oss title
  17.     oss-title: https://
  18.     # oss business directory
  19.     business-directory: user,org

非常非常重要：在配置的时候上面4个重要参数的位置，以及名称一定不能修改，否则会报找不到endPoint的错

2.3、加载配置文件代码

新建 YmlConfigBean.java

  1. package com.upload.bean;
  3. import org.springframework.stereotype.Component;
  4. import java.util.List;
  6. /**
  7.  * 配置文件参数读取
  8.  */
  9. @Component
  10. public class YmlConfigBean {
  13.     // 阿里云OSS 申请的 key id
  14.     public volatile static String OSS_KEY_ID;
  15.     // 阿里云OSS 申请的 key secret
  16.     public volatile static String OSS_KEY_SECRET;
  17.     // 阿里云OSS endpoint
  18.     public volatile static String OSS_ENDPOINT;
  19.     // 阿里云OSS bucket
  20.     public volatile static String OSS_BUCKET;
  21.     // 阿里云OSS 开关 0 关 1 开
  22.     public volatile static String OSS_SWITCH;
  23.     // 阿里云OSS 开始使用时间
  24.     public volatile static String OSS_DATE;
  25.     // 阿里云OSS 文件夹目录
  26.     public volatile static List<String> OSS_DIRECTORY;
  27.     // 阿里云OSS 开始使用时间
  28.     public volatile static String OSS_TITLE;
  29.     //业务文件类别
  30.     public volatile static List<String> BUSINESS_DIRECTORY;
  31. }

新建 YmlConfigBeanMethod.java

  1. package com.upload.bean;
  3. import org.springframework.beans.factory.annotation.Value;
  4. import org.springframework.stereotype.Component;
  5. import java.util.List;
  7. @Component
  8. public class YmlConfigBeanMethod {
  11.     @Value("#{'${alibaba.cloud.access-key}'}")
  12.     private void setOssKeyId(String key) {
  14.         YmlConfigBean.OSS_KEY_ID = key;
  15.     }
  16.     @Value("#{'${alibaba.cloud.secret-key}'}")
  17.     private void setOssKeySecret(String key) {
  19.         YmlConfigBean.OSS_KEY_SECRET = key;
  20.     }
  21.     @Value("#{'${alibaba.cloud.oss.endpoint}'}")
  22.     private void setOssEndpoint(String key) {
  24.         YmlConfigBean.OSS_ENDPOINT = key;
  25.     }
  26.     @Value("#{'${alibaba.cloud.oss.bucket}'}")
  27.     private void setOssBucket(String key) {
  29.         YmlConfigBean.OSS_BUCKET = key;
  30.     }
  31.     @Value("#{'${alibaba.config.oss-switch}'}")
  32.     private void setOssSwitch(String key) {
  34.         YmlConfigBean.OSS_SWITCH = key;
  35.     }
  36.     @Value("#{'${alibaba.config.oss-date}'}")
  37.     private void setOssDate(String key) {
  39.         YmlConfigBean.OSS_DATE = key;
  40.     }
  41.     @Value("#{'${alibaba.config.oss-directory}'.split(',')}")
  42.     public void setOssDirectory(List<String> key){
  44.         YmlConfigBean.OSS_DIRECTORY = key;
  45.     }
  46.     @Value("#{'${alibaba.config.oss-title}'}")
  47.     private void setOssTitle(String key) {
  49.         YmlConfigBean.OSS_TITLE = key;
  50.     }
  52.     @Value("#{'${alibaba.config.business-directory}'.split(',')}")
  53.     public void setBusinessDirectory(List<String> key){
  55.         YmlConfigBean.BUSINESS_DIRECTORY= key;
  56.     }
  58. }

2.4、封装统一的DTO

建一个统一的DTO Result.java

  1. package com.upload.bean;
  3. /**
  4.  * 统一的DTO
  5.  */
  6. public class Result<T> {
  8.     private boolean success = true;
  9.     private Integer code = 0;
  10.     private String msg;
  11.     private T data;
  13.     public boolean isSuccess() {
  15.         return this.code == 0;
  16.     }
  17.     public void setSuccess(boolean success) {
  19.         this.success = success;
  20.     }
  21.     public Integer getCode() {
  23.         return code;
  24.     }
  25.     public void setCode(Integer code) {
  27.         this.code = code;
  28.         if(code != 0){
  30.             success = false;
  31.         }
  32.     }
  33.     public String getMsg() {
  35.         return msg;
  36.     }
  37.     public void setMsg(String msg) {
  39.         this.msg = msg;
  40.     }
  41.     public T getData() {
  43.         return data;
  44.     }
  45.     public void setData(T data) {
  47.         this.data = data;
  48.     }
  50.     public Result() {
  52.         super();
  53.     }
  54.     public Result(boolean success) {
  56.         this.success = success;
  57.         if(success){
  59.             code = 0;
  60.         }
  61.     }
  62.     public Result(int code) {
  64.         super();
  65.         success = false;
  66.         this.code = code;
  67.     }
  68.     public Result(String msg) {
  70.         success = false;
  71.         this.msg = msg;
  72.     }
  73.     public Result(boolean success, String msg) {
  75.         super();
  76.         this.success = success;
  77.         this.msg = msg;
  78.     }
  79.     public Result(int code, String msg) {
  81.         super();
  82.         success = false;
  83.         this.code = code;
  84.         this.msg = msg;
  85.     }
  87.     /*设置返回为成功*/
  88.     public static Result ok() {
  90.         return new Result();
  91.     }
  92.     /*设置返回为成功,同时设置返回数据*/
  93.     public Result<T> ok(T data) {
  95.         Result<T> result = new Result<T>();
  96.         result.setData(data);
  97.         return result;
  98.     }
  99.     /*设置返回为失败,默认未知异常*/
  100.     public static Result error() {
  102.         return error(500, "未知异常，请联系管理员!");
  103.     }
  104.     /*设置返回为失败,同时设置异常信息*/
  105.     public static Result error(String msg) {
  107.         return error(500, msg);
  108.     }
  109.     /*设置返回为失败,同时设置code,msg*/
  110.     public static Result error(Integer code,String msg) {
  112.         Result result = new Result();
  113.         result.setCode(code);
  114.         result.setMsg(msg);
  115.         return result;
  116.     }
  117.     public static Result<Object> error(Integer code,String msg,Object data) {
  119.         Result<Object> result = new Result<Object>();
  120.         result.setData(data);
  121.         result.setCode(code);
  122.         result.setMsg(msg);
  123.         return result;
  124.     }
  125.     public static Result success(Object data) {
  127.         Result<Object> result = new Result<Object>();
  128.         result.setData(data);
  129.         return result;
  130.     }
  131.     public static Result success(String msg) {
  133.         Result result = new Result();
  134.         result.setMsg(msg);
  135.         return result;
  136.     }
  138. }

常量配置好之后，方便后续直接使用配置文件的中内容。

2.5、OSS上传Controller

新建 OssUploadController.java

  1. package com.upload;
  3. import com.upload.service.IOssUploadService;
  4. import com.upload.bean.Result;
  5. import org.springframework.stereotype.Controller;
  6. import org.springframework.web.bind.annotation.RequestMapping;
  7. import org.springframework.web.bind.annotation.RequestParam;
  8. import org.springframework.web.bind.annotation.ResponseBody;
  9. import org.springframework.web.multipart.MultipartFile;
  10. import javax.annotation.Resource;
  11. import javax.servlet.http.HttpServletRequest;
  13. /**
  14.  * <p>
  15.  * 阿里云OSS 前端控制器
  16.  * </p>
  17.  */
  18. @Controller
  19. public class OssUploadController {
  22.     @Resource
  23.     private IOssUploadService ossUploadService;
  25.     /**
  26.      * OSS文件上传
  27.      */
  28.     @RequestMapping("/uploadOss")
  29.     @ResponseBody
  30.     public Result upload(@RequestParam String ossDirectory, @RequestParam String businessDirectory,
  31.                          @RequestParam MultipartFile file, HttpServletRequest request) {
  33.         return ossUploadService.upload(ossDirectory, businessDirectory, file, request);
  34.     }
  36.     /**
  37.      * OSS文件迁移
  38.      */
  39.     @RequestMapping("/migrationOss")
  40.     @ResponseBody
  41.     public Result doDataMigration(@RequestParam String ossDirectory, @RequestParam String businessDirectory) {
  43.         return ossUploadService.doDataMigration(ossDirectory, businessDirectory, true);
  44.     }
  46. }

2.6、OSS上传Service

新建 IOssUploadService.java

  1. package com.upload.service;
  3. import com.upload.bean.Result;
  4. import org.springframework.web.multipart.MultipartFile;
  5. import javax.servlet.http.HttpServletRequest;
  7. /**
  8.  * <p>
  9.  * 阿里云OSS 服务类
  10.  */
  11. public interface IOssUploadService {
  14.     Result upload(String ossDirectory, String businessDirectory, MultipartFile file, HttpServletRequest request);
  16.     Result doDataMigration(String ossDirectory, String businessDirectory, boolean threadFlag);
  18. }

2.7、OSS上传ServiceImpl

新建 OssUploadServiceImpl.java

  1. package com.upload.service.impl;
  3. import com.aliyun.oss.OSS;
  4. import com.aliyun.oss.OSSClientBuilder;
  5. import com.aliyun.oss.model.CannedAccessControlList;
  6. import com.upload.bean.Result;
  7. import com.upload.bean.YmlConfigBean;
  8. import com.upload.entity.FileUpload;
  9. import com.upload.service.IOssUploadService;
  10. import lombok.extern.slf4j.Slf4j;
  11. import org.apache.commons.codec.digest.DigestUtils;
  12. import org.apache.commons.lang.time.DateFormatUtils;
  13. import org.apache.logging.log4j.util.Strings;
  14. import org.springframework.stereotype.Service;
  15. import org.springframework.web.multipart.MultipartFile;
  16. import javax.servlet.http.HttpServletRequest;
  17. import java.io.File;
  18. import java.io.FileInputStream;
  19. import java.io.IOException;
  20. import java.io.InputStream;
  21. import java.security.SecureRandom;
  22. import java.util.ArrayList;
  23. import java.util.Date;
  24. import java.util.List;
  26. @Slf4j
  27. @Service
  28. public class OssUploadServiceImpl implements IOssUploadService {
  31. //    @Resource
  32. //    private UploadMapper uploadMapper;
  33.     private final static String ROOT_PATH = "/data/file/";
  35.     /**
  36.      * 对外提供的文件上传
  37.      * @param ossDirectory OSS所属模块
  38.      * @param fileDir 文件所属模块
  39.      * @param file 文件
  40.      * @param request 请求
  41.      */
  42.     @Override
  43.     public Result upload(String ossDirectory, String fileDir, MultipartFile file, HttpServletRequest request) {
  45.         if (file.isEmpty()) {
  47.             return Result.error("不能上传空文件");
  48.         }
  49.         String originalFilename = file.getOriginalFilename();
  50.         Long fileBytes = file.getSize();
  51.         if (Strings.isBlank(originalFilename) || 0L == fileBytes) {
  53.             return Result.error("不能上传空文件");
  54.         }
  55.         if(Strings.isBlank(ossDirectory)){
  57.             ossDirectory = "image";
  58.         } else {
  60.             if (!YmlConfigBean.OSS_DIRECTORY.contains(ossDirectory.startsWith("/") ? ossDirectory.substring(1) : ossDirectory)) {
  62.                 log.info("文件上传目录非法，非法目录："+ ossDirectory);
  63.                 return Result.error("文件上传目录非法，请更改文件上传目录");
  64.             }
  65.         }
  66.         if (!YmlConfigBean.BUSINESS_DIRECTORY.contains(fileDir.startsWith("/") ? fileDir.substring(1) : fileDir)) {
  68.             log.info("文件上传目录非法，非法目录："+ fileDir);
  69.             return Result.error("文件上传目录非法，请更改文件上传目录");
  70.         }
  71.         String fileMd5;
  72.         try {
  74.             fileMd5 = DigestUtils.sha256Hex(file.getInputStream());
  75.         } catch (Exception e) {
  77.             log.error(file.getOriginalFilename() + "验证文件md5失败",e);
  78.             return Result.error("当前验证文件md5失败");
  79.         }
  80.         Result<String> result = new Result<>();
  81.         String uploadUrl = null;
  82.         String newName = null;
  83.         OSS ossClient = getOSSClient();
  84.         try {
  86.             //获取上传文件流
  87.             InputStream inputStream = file.getInputStream();
  88.             //构建日期路径：/2019/02/26/文件名
  89.             String fileType = originalFilename.split("\\.")[originalFilename.split("\\.").length - 1];
  90.             newName = DateFormatUtils.format(new Date(), "yyMMddHHmmss") +
  91.                     (new SecureRandom().nextInt(100) + 100) + "." + fileType;
  92.             String newFileDir = (fileDir.startsWith("/") ? fileDir.substring(1) : fileDir).trim().replace(" ","") +
  93.                     getDatePath();
  94.             String fileUrl = ossDirectory + "/" + newFileDir + newName;
  95.             // 上传文件 (上传文件流的形式)
  96.             ossClient.putObject(YmlConfigBean.OSS_BUCKET, fileUrl, inputStream);
  97.             //获取url地址
  98.             uploadUrl = YmlConfigBean.OSS_TITLE + YmlConfigBean.OSS_BUCKET + "." + YmlConfigBean.OSS_ENDPOINT + "/" + fileUrl;
  99.         } catch (IOException e) {
  101.             log.error("上传OSS失败，文件名：" + originalFilename);
  102.             throw new RuntimeException("上传OSS失败");
  103.         } finally {
  105.             // 关闭OSSClient。
  106.             if (ossClient != null) {
  108.                 ossClient.shutdown();
  109.             }
  110.         }
  111.         //文件上传实体属性赋值,数据入库
  112.         try {
  114.             log.info("原文件名称：" + originalFilename + "\n" + "文件MD5码：" + fileMd5 + "\n" + "新文件名称：" + newName + "\n" +
  115.             "文件路径：" + uploadUrl + "\n" + "文件大小：" + fileBytes);
  116. //            uploadMapper.doUploadInsert(null);
  117.         } catch (Exception e) {
  119.             log.error("上传文件，数据库记录失败", e);
  120.         }
  121.         result.setData(uploadUrl);
  122.         return result;
  123.     }
  125.     /**
  126.      * 文件迁移
  127.      * @param ossDirectory 需要同步的OSS文件夹
  128.      * @param businessDirectory 业务文件路径，以此查询表中数据
  129.      * @param threadFlag 是否开启异步线程
  130.      * @return Result
  131.      */
  132.     @Override
  133.     public Result doDataMigration(String ossDirectory, String businessDirectory, boolean threadFlag){
  135.         if(Strings.isBlank(businessDirectory)) return Result.error("路径不能为空");
  136. //        List<FileUpload> fileUploads = uploadMapper.selectList();
  137.         List<FileUpload> fileUploads = new ArrayList<>();
  138.         if(null == fileUploads || fileUploads.size() == 0) return Result.error("暂无数据");
  139.         if(threadFlag){
  141.             Thread thread = new Thread(()->{
  143.                 doSonThread(fileUploads, ossDirectory);
  144.             });
  145.             thread.start();
  146.         } else {
  148.             doSonThread(fileUploads, ossDirectory);
  149.         }
  150.         return Result.success("文件迁移中，请稍后查看！");
  151.     }
  153.     private void doSonThread(List<FileUpload> fileUploads, String ossDirectory){
  155.         if(Strings.isBlank(ossDirectory)) {
  157.             ossDirectory = "image";
  158.         }
  159.         String filePath = null;
  160.         for(FileUpload fileUpload : fileUploads){
  162.             if(Strings.isBlank(fileUpload.getFilePath()) || Strings.isBlank(fileUpload.getFileName())){
  164.                 continue;
  165.             }
  166.             filePath = uploadFileAndDeleteByPath(ROOT_PATH + fileUpload.getFilePath(), fileUpload.getFileName(), ossDirectory);
  167.             //更新新的路径入库
  168.             fileUpload.setFilePathNew(filePath);
  169. //            uploadMapper.doUploadUpdate(fileUpload);
  170.         }
  171.     }
  173.     public static String uploadFileAndDeleteByPath(String path, String fileName, String ossDirectory) {
  175.         File file = new File(path + File.separator + fileName);
  176.         return uploadFileAndDeleteByFile(file, ossDirectory);
  177.     }
  179.     public static String uploadFileAndDeleteByFile(File file, String ossDirectory) {
  181.         if (file.isDirectory()) return null;
  182.         String filePath = null;
  183.         Boolean deleteFlag = false;
  184.         try {
  186.             filePath = uploadHistory(ossDirectory, file.getPath(), file);
  187.             deleteFlag = checkExists(filePath.substring(filePath.indexOf(YmlConfigBean.OSS_ENDPOINT) + 1 + YmlConfigBean.OSS_ENDPOINT.length(), filePath.length()));
  188.         } catch (IOException e) {
  190.             log.error("上传OSS失败，文件名：" + file.getName());
  191.             throw new RuntimeException("上传OSS失败");
  192.         }
  193.         if(deleteFlag){
  195.             file.delete();
  196.         }
  197.         return filePath;
  198.     }
  200.     public static String uploadHistory(String ossDirectory, String businessDirectory, File file) throws IOException{
  202.         String filename = file.getName();
  203.         OSS ossClient = getOSSClient();
  204.         //获取上传文件流
  205.         InputStream inputStream = new FileInputStream(file);
  206.         //构建日期路径：/2019/02/26/文件名
  207.         String fileType = filename.split("\\.")[filename.split("\\.").length - 1];
  208.         String newName = filename.substring(0, filename.indexOf(".")) + "_" + (new SecureRandom().nextInt(1000) + 1000) + "." + fileType;
  209.         String newFileDir = (businessDirectory.startsWith("/") ? businessDirectory.substring(1) : businessDirectory).trim().replace(" ","");
  210.         String fileUrl = ossDirectory + "/" + newFileDir + newName;
  211.         // 上传文件 (上传文件流的形式)
  212.         ossClient.putObject(YmlConfigBean.OSS_BUCKET, fileUrl, inputStream);
  213.         ossClient.shutdown();
  214.         //获取url地址
  215.         return YmlConfigBean.OSS_TITLE + YmlConfigBean.OSS_BUCKET + "." + YmlConfigBean.OSS_ENDPOINT + "/" + fileUrl;
  216.     }
  218.     public static boolean checkExists(String objectName) throws IOException{
  220.         OSS ossClient = getOSSClient();
  221.         Boolean flag = ossClient.doesObjectExist(YmlConfigBean.OSS_BUCKET, objectName);
  222.         ossClient.shutdown();
  223.         return flag;
  224.     }
  226.     public static OSS getOSSClient() {
  228.         OSS ossClient = new OSSClientBuilder().build(YmlConfigBean.OSS_ENDPOINT, YmlConfigBean.OSS_KEY_ID, YmlConfigBean.OSS_KEY_SECRET);
  229.         //判断oss实例是否存在：如果不存在则创建，如果存在则获取
  230.         if (!ossClient.doesBucketExist(YmlConfigBean.OSS_BUCKET)) {
  232.             //创建bucket
  233.             ossClient.createBucket(YmlConfigBean.OSS_BUCKET);
  234.             //设置oss实例的访问权限：公共读
  235.             ossClient.setBucketAcl(YmlConfigBean.OSS_BUCKET, CannedAccessControlList.PublicRead);
  236.         }
  237.         return ossClient;
  238.     }
  240.     /*public static void uploadFileAndDelete(File file) {
  241.         if (file.isDirectory()) {
  242.             String[] fileList = file.list();
  243.             if(null != fileList && fileList.length > 0){
  244.                 //递归删除目录中的子目录下
  245.                 File subFile = null;
  246.                 for(String str : fileList){
  247.                     subFile = new File(file, str);
  248.                     log.info(subFile.getPath());
  249.                     uploadFileAndDelete(subFile);
  250.                 }
  251.             }
  252.         }
  253.         uploadFileAndDeleteByFile(file, null);
  254.     }*/
  256.     public static String getDatePath(){
  258.         return "/" + DateFormatUtils.format(new Date(), "yyyy-MM-dd").replaceAll("-","/") + "/";
  259.     }
  261. }

3 : 测试

3.1、文件上传

在这里插入图片描述
在这里插入图片描述

在这里插入图片描述
在OSS上存储的路径为：OSS文件夹（image）+ 业务自定义文件夹名称（org）+ 年月日时间路径 + 重命名文件名称。

3.2、文件迁移

大致思路：
1、根据业务需要，查询数据库中的文件路径及名称，到服务器磁盘中查找该文件。
2、调用简易版的文件上传，上传至OSS中。
3、上传之后回调阿里自带方法doesObjectExist进行回溯校验，检查是否在OSS中存在。
4、如存在该文件，则删除服务器磁盘对应的文件即可。

因代码需根据业务数据来进行数据的查询等操作，可自行修改并验证。

4 : 总结

4.1、参考资料

参考资料：异常官网链接：https://help.aliyun.com/document_detail/32023.html

4.2、注意事项

注意事项：在配置的时候上面4个重要参数的位置，以及名称一定不能修改，否则会报找不到endPoint的错

4.3、源码链接

CSDN资源链接：https://download.csdn.net/download/qq_38254635/87352781
百度网盘资源链接：https://pan.baidu.com/s/1kl6KIntr1qvcJPG642DWAA?pwd=fsj2
提取码: fsj2

有什么不对的还望指正，书写不易，觉得有帮助就点个赞吧！

发表评论

表情：
评论列表 （有 0 条评论，160人围观）

还没有评论，来说两句吧...

相关阅读

    相关 阿里云存储OSS

    为了解决海量数据存储与弹性扩容，项目中我们采用云存储的解决方案- 阿里云OSS。 一 开通“对象存储OSS”服务 1 申请阿里云账号 2 实名认证 3 开

    Dear 丶Dear 丶/ 0 赞/ 774 阅读