SpringBoot對接阿裡雲OSS上傳文件以及回調（有坑）

### 前言今天在對接阿裡雲OSS對象存儲，把這過程記錄下來 ### 鏈接阿裡雲的內容很多，文檔是真的難找又難懂本文主要是用的PostObject API 加上 Callback參數 PostObject -> [https://help.aliyun.com/document_detail ...

前言

今天在對接阿裡雲OSS對象存儲，把這過程記錄下來

鏈接

阿裡雲的內容很多，文檔是真的難找又難懂
本文主要是用的PostObject API 加上 Callback參數
PostObject -> https://help.aliyun.com/document_detail/31988.html?spm=a2c4g.31989.0.0
Callback -> https://help.aliyun.com/document_detail/31989.html?spm=a2c4g.31988.0.0

對接過程

前端向後端發送請求獲取簽名
後端與OSS伺服器交互，返回前端簽名
前端拿到簽名，直接上傳到OSS伺服器
上傳成功，OSS回調應用伺服器，應用伺服器給前端返回上傳的信息

相比應用伺服器直接上傳到OSS，大大減少了帶寬和應用伺服器的壓力，缺點就是相對麻煩一點

1. pom.xml

我們用的是SpringBoot，我們導入aliyun-oss-spring-boot-starter包，因為我這個是 SpringCloud項目父項目管理了SpringCloud 和 SpringCloud Alibaba 、SpringBoot版本的，所以一開始我是沒有寫版本號的，結果一直爆紅，導不進來，然後仔細一看，原來這是aliyun-oss-spring-boot-starter，註意這個boot-starter，我還以為是cloud系列的，然而哈哈，然後導入aliyun-spring-boot-dependencies，我在倉庫裡面去找版本號，然而它也只有這一個1.0.0版本

<dependencies>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-web</artifactId>
	</dependency>

	<!-- 阿裡雲OSS -->
	<dependency>
		<groupId>com.alibaba.cloud</groupId>
		<artifactId>aliyun-oss-spring-boot-starter</artifactId>
	</dependency>
</dependencies>
<dependencyManagement>
	<dependency>
		<groupId>com.alibaba.cloud</groupId>
		<artifactId>aliyun-spring-boot-dependencies</artifactId>
		<version>1.0.0</version>
		<type>pom</type>
		<scope>import</scope>
      </dependency>
</dependencyManagement>

2. application.yml

alibaba:
  cloud:
    # 阿裡控制台OSS子賬戶的信息 
    access-key: LTAI5tDZ51bANyHxYpwZzvpi
    secret-key: zPxHPuaZMTPzTPy0WF88vI99HHLOzO
    oss:
      # 深圳endpoint
      endpoint: oss-cn-shenzhen.aliyuncs.com
      # 認證過期 單位秒
      expireTime: 1200
      # 儲存空間名字
      bucket: yues-oss

3. 核心代碼

package com.yues.gulimall.thirdparty.controller;

import com.aliyun.oss.OSS;
import com.aliyun.oss.common.utils.BinaryUtil;
import com.aliyun.oss.model.Callback;
import com.aliyun.oss.model.MatchMode;
import com.aliyun.oss.model.PolicyConditions;

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import java.nio.charset.StandardCharsets;
import java.text.SimpleDateFormat;
import java.util.*;

@RestController
public class OssController {
    @Autowired
    private OSS ossClient;
    @Value("${alibaba.cloud.oss.endpoint}")
    private String endpoint;
    @Value("${alibaba.cloud.access-key}")
    private String accessId;
    @Value("${alibaba.cloud.oss.expireTime}")
    private long expireTime;
    @Value("${alibaba.cloud.oss.bucket}")
    private String bucket;

    /**
     * 回調
     * @param request request
     * @return Map
     */
    @RequestMapping("/ossCallback")
    public Map<String,String> ossCallback(HttpServletRequest request) {
        HashMap<String, String> result = new HashMap<>();
        String filename = request.getParameter("filename");
        Map<String, String[]> parameterMap = request.getParameterMap();
        parameterMap.forEach((item,value) -> {
            System.out.println(item);
            System.out.println(Arrays.toString(value));
        });
        filename = "https://".concat(bucket).concat(".").concat(endpoint).concat("/").concat(filename);
        result.put("url", filename);
        result.put("size", request.getParameter("size"));
        result.put("mimeType", request.getParameter("mimeType"));
        return result;
    }


    /**
     * 簽名
     * @return Map
     */
    @PostMapping("/getOssSecret")
    public Map<String,String> getOssSign() {
        // 填寫Host地址，格式為https://bucketname.endpoint。
        String host = "https://" + bucket + "."+ endpoint;
        // OSS會在文件上傳完成後，把文件上傳信息發送給應用伺服器。需要外網ip
        String callbackUrl = "https://23d4-1-196-175-217.ngrok-free.app/ossCallback";
        // 設置上傳到OSS文件的首碼，可置空此項。置空後，文件將上傳至Bucket的根目錄下。
        // 將日期作為上傳的文件夾目錄
        String format = new SimpleDateFormat("yyyy-MM-dd").format(new Date());
        String dir = format+"/";
        Map<String, String> respMap = null;
        try {
            long expireEndTime = System.currentTimeMillis() + expireTime * 1000;
            // 過期時間
            Date expiration = new Date(expireEndTime);
            // 上傳回調參數。
            Callback callback = new Callback();
            callback.setCallbackUrl(callbackUrl);
            // 設置回調請求消息頭中Host的值，即您的伺服器配置Host的值。需要外網ip
             callback.setCallbackHost("23d4-1-196-175-217.ngrok-free.app");
            // 設置發起回調時請求body的值。
            callback.setCallbackBody("filename=${object}&size=${size}&mimeType=${mimeType}");
            // 設置發起回調請求的Content-Type。
            callback.setCalbackBodyType(Callback.CalbackBodyType.JSON);
            // 設置發起回調請求的自定義參數，由Key和Value組成，Key必須以x:開始。
            callback.addCallbackVar("x:var1", "value1");
            callback.addCallbackVar("x:var2", "value2");
            // 序列化callback
            String callbackString = BinaryUtil.toBase64String(new ObjectMapper().writeValueAsString(callback).getBytes(StandardCharsets.UTF_8));

            PolicyConditions policyConds = new PolicyConditions();
            policyConds.addConditionItem(PolicyConditions.COND_CONTENT_LENGTH_RANGE, 0, 1048576000);
            // 添加目錄許可權，返回的認證信息只能在這個目錄下進行操作
            policyConds.addConditionItem(MatchMode.StartWith, PolicyConditions.COND_KEY, dir);

            // 生成認證 添加過期時間
            String postPolicy = ossClient.generatePostPolicy(expiration, policyConds);
            byte[] binaryData = postPolicy.getBytes(StandardCharsets.UTF_8);
            // 轉為Base64
            String encodedPolicy = BinaryUtil.toBase64String(binaryData);
            String postSignature = ossClient.calculatePostSignature(postPolicy);

            respMap = new LinkedHashMap<>();
            respMap.put("OSSAccessKeyId", accessId);
            respMap.put("policy", encodedPolicy);
            respMap.put("Signature", postSignature);
            respMap.put("dir", dir);
            respMap.put("host", host);
            respMap.put("callback", callbackString);
            // 過期時間的時間戳
            respMap.put("expire", String.valueOf(expireEndTime / 1000));
        } catch (Exception e) {
            throw new RuntimeException("aliyun上傳文件獲取認證信息失敗：" + e.getMessage());
        }
        return  respMap;
    }
}

4. postman 調用獲取簽名返回

{
    "OSSAccessKeyId": "LTAI5tDZ51bANyHxYpwZzvpi",
    "policy": "eyJleHBpcmF0aW9uIjoiMjAyMy0wNy0wM1QxNzoxNzo1MS44ODBaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIyMDIzLTA3LTA0LyJdXX0=",
    "Signature": "yK5oF8Cj0ncR0ceuIMtXdMW1yco=",
    "dir": "2023-07-04/",
    "host": "https://yues-oss.oss-cn-shenzhen.aliyuncs.com",
    "callback": "eyJjYWxsYmFja1VybCI6Imh0dHBzOi8vMjNkNC0xLTE5Ni0xNzUtMjE3Lm5ncm9rLWZyZWUuYXBwL29zc0NhbGxiYWNrIiwiY2FsbGJhY2tIb3N0IjoiMjNkNC0xLTE5Ni0xNzUtMjE3Lm5ncm9rLWZyZWUuYXBwIiwiY2FsbGJhY2tCb2R5IjoiZmlsZW5hbWU9JHtvYmplY3R9JnNpemU9JHtzaXplfSZtaW1lVHlwZT0ke21pbWVUeXBlfSIsImNhbGJhY2tCb2R5VHlwZSI6IkpTT04iLCJjYWxsYmFja1ZhciI6eyJ4OnZhcjIiOiJ2YWx1ZTIiLCJ4OnZhcjEiOiJ2YWx1ZTEifX0=",
    "expire": "1688404671"
}

5. 前端上傳到OSS

拿到第四步的JSON後，請求JSON中的host，key = dir + 文件名.尾碼，然後按照下圖方式請求

註意：

Content-Type要為multipart/form-data;
file 必須在表單數據中最後一個
上傳的file大小不能超過5 GB
不知道為什麼我這邊postman上傳的file，它的文件名字不能是中文的，不然就會返回405，這個問題調試我半天，我覺得應該是字元編碼哪裡要設置一下，沒有具體研究下去了