oss服务端签名后直传分析与代码实现

Dear 丶 2024-04-24 14:35 163阅读 0赞

文章目录

  • 1.简介
    • 1.1 普通上传方式
    • 1.2 服务端签名后直传
  • 3.服务端签名后直传文档
    • 3.1 用户向应用服务器请求上传Policy和回调。
    • 3.2 应用服务器返回上传Policy和签名给用户。
    • 3.3 用户使用Post方法向OSS发送文件上传请求。
  • 4.实战开发-后端
    • 4.1 pom.xml核心配置
    • 4.2 application.yml核心配置
    • 4.3 OssClientUtils工具类
    • 4.4 OssConfig配置类
    • 4.5 OssConstants常量类
    • 4.6 OssServiceController控制器
    • 4.7 Apifox测试
  • 5.注意事项和细节说明
    • 5.1 解决后端跨域问题
    • 5.2 解决阿里云跨域问题

1.简介

阿里云对象存储 OSS（Object Storage Service）是一款海量、安全、低成本、高可靠的云存储服务，提供数据高可用性, 多种存储类型供选择，全面优化存储成本。

1.1 普通上传方式

image-20221113114912837

  • 上传慢：用户数据需先上传到应用服务器，之后再上传到OSS。网络传输时间比直传到OSS多一倍。如果用户数据不通过应用服务器中转，而是直传到OSS，速度将大大提升。
  • 扩展性差：如果后续用户多了，应用服务器会成为瓶颈。
  • 费用高：需要准备多台应用服务器。由于OSS上传流量是免费的，如果数据直传到OSS，不通过应用服务器，那么将能省下几台应用服务器。

1.2 服务端签名后直传

image-20221113115032842

  • Web端向服务端请求签名，然后直接上传，不会对服务端产生压力，而且安全可靠。
  • 但服务端无法实时了解用户上传了多少文件，上传了什么文件。如果想实时了解用户上传了什么文件，可以采用服务端签名直传并设置上传回调。
  • 但存在着恶意上传的风险，造成存储空间的浪费

3.服务端签名后直传文档

? https://help.aliyun.com/document\_detail/31926.html

基于Post Policy的使用规则在服务端通过各种语言代码完成签名，然后通过表单直传数据到OSS。由于服务端签名直传无需将AccessKey暴露在前端页面，相比JavaScript客户端签名直传具有更高的安全性。

image-20221113145618805

3.1 用户向应用服务器请求上传Policy和回调。

请将客户端源码中的upload.js文件的如下代码片段的变量serverUrl的值设置为应用服务器的URL。

  1. // serverUrl是用户获取签名和Policy等信息的应用服务器的URL，请将下面的IP和Port配置为您自己的真实信息。
  2. serverUrl = 'http://88.88.88.88:8888'

设置完成后，客户端会向该serverUrl发送Get请求来获取需要的信息。客户端源码下载地址，请参见aliyun-oss-appserver-js-master.zip。

本场景为服务端签名后直传，不涉及上传回调。因此，您需要注释客户端源码的upload.js文件内的'callback' : callbackbody字段，以关闭上传回调功能。

  1. {
  3.   'key' : key + '${filename}',
  4.   'policy': policyBase64,
  5.   'OSSAccessKeyId': accessid,
  6.    // 设置服务端返回200状态码，默认返回204。
  7.   'success_action_status' : '200', 
  8.   'callback' : callbackbody,
  9.   'signature': signature,
  10. }

3.2 应用服务器返回上传Policy和签名给用户。

应用服务器侧的签名直传服务会处理客户端发送的Get请求消息，您可以设置对应的代码让应用服务器能够给客户端返回正确的消息。

以下是签名直传服务返回给客户端消息Body内容的示例：

  1. {
  3. "accessid":"LTAI5tBDFVar1hoq****",
  4. "host":"http://post-test.oss-cn-hangzhou.aliyuncs.com",
  5. "policy":"eyJleHBpcmF0aW9uIjoiMjAxNS0xMS0wNVQyMDoyMzoyM1oiLCJjxb25kaXRpb25zIjpbWyJjcb250ZW50LWxlbmd0aC1yYW5nZSIsMCwxMDQ4NTc2MDAwXSxbInN0YXJ0cy13aXRoIiwiJGtleSIsInVzZXItZGlyXC8i****",
  6. "signature":"VsxOcOudx******z93CLaXPz+4s=",
  7. "expire":1446727949,
  8. "dir":"user-dirs/"
  9. }

Body中的各字段说明如下：


































字段 描述
accessid 用户请求的AccessKey ID。
host 用户发送上传请求的域名。
policy 用户表单上传的策略（Policy），Policy为经过Base64编码过的字符串。详情请参见Post Policy。
signature 对Policy签名后的字符串。详情请参见Post Signature。
expire 由服务器端指定的Policy过期时间，格式为Unix时间戳（自UTC时间1970年01月01号开始的秒数）。
dir 限制上传的文件前缀。

3.3 用户使用Post方法向OSS发送文件上传请求。

  1. new_multipart_params = {
  3.      // key表示上传到Bucket内的Object的完整路径，例如exampledir/exampleobject.txtObject，完整路径中不能包含Bucket名称。
  4.      // filename表示待上传的本地文件名称。
  5.      'key' : key + '${filename}',
  6.      'policy': policyBase64,
  7.      'OSSAccessKeyId': accessid,
  8.      // 设置服务端返回状态码为200，不设置则默认返回状态码204。
  9.      'success_action_status' : '200',    
  10.      'signature': signature,
  11.  };

4.实战开发-后端

4.1 pom.xml核心配置

  1. <dependencyManagement>
  2.     <dependencies>
  3.         <dependency>
  4.             <groupId>com.alibaba.cloud</groupId>
  5.             <artifactId>spring-cloud-alibaba-dependencies</artifactId>
  6.             <version>2.1.0.RELEASE</version>
  7.             <type>pom</type>
  8.             <scope>import</scope>
  9.         </dependency>
  10.     </dependencies>
  11. </dependencyManagement>
  13. <dependencies>
  14.     <dependency>
  15.         <groupId>com.alibaba.cloud</groupId>
  16.         <artifactId>spring-cloud-starter-alicloud-oss</artifactId>
  17.         <!--<version>2.1.0.RELEASE</version>-->
  18.     </dependency>

4.2 application.yml核心配置

  1. server:
  2.   port: 9101
  3.   max-http-header-size: 2MB
  4.   servlet:
  5.     context-path: /service
  6. spring:
  7.   cloud:
  8.     alicloud:
  9.       access-key: LTAI5tKcWoeuxTK8********
  10.       secret-key: TQXiDtEnaR8Y7tXetvYZ0t********
  11.       oss:
  12.         endpoint: oss-cn-hangzhou.aliyuncs.com
  13.         bucket: waveedu

4.3 OssClientUtils工具类

  1. package com.zhulang.waveedu.sms.util;
  3. import com.aliyun.oss.OSS;
  4. import com.aliyun.oss.common.utils.BinaryUtil;
  5. import com.aliyun.oss.model.MatchMode;
  6. import com.aliyun.oss.model.PolicyConditions;
  7. import com.zhulang.waveedu.common.entity.Result;
  9. import java.text.SimpleDateFormat;
  10. import java.util.Date;
  11. import java.util.LinkedHashMap;
  12. import java.util.Map;
  14. /**
  15.  * @author 狐狸半面添
  16.  * @create 2023-01-29 1:36
  17.  */
  19. public class OssClientUtils {
  21.     private OSS ossClient;
  22.     private String accessId;
  24.     private String endpoint;
  26.     private String bucket;
  28.     public OssClientUtils(OSS ossClient, String accessId, String endpoint, String bucket) {
  30.         this.ossClient = ossClient;
  31.         this.accessId = accessId;
  32.         this.endpoint = endpoint;
  33.         this.bucket = bucket;
  34.     }
  37.     public Result policy(String dirType) {
  39.         // 1.指定填写Host地址，格式为https://bucketname.endpoint
  40.         String host = "https://" + bucket + "." + endpoint;
  42.         // 2.设置上传到OSS文件的前缀，可置空此项。置空后，文件将上传至Bucket的根目录下。
  43.         String format = new SimpleDateFormat("/yyyy/MM/").format(new Date());
  44.         String dir = dirType + format;
  46.         Map<String, String> respMap = null;
  47.         try {
  49.             // 3.指定默认超时时间是30s
  50.             long expireTime = 30;
  52.             // 4.得到最终的截止时间
  53.             long expireEndTime = System.currentTimeMillis() + expireTime * 1000;
  54.             Date expiration = new Date(expireEndTime);
  56.             // 5.封装签名
  57.             PolicyConditions policyConds = new PolicyConditions();
  58.             // 5.1 设置可上传文件的大小，这里设置为 0 - 10MB
  59.             policyConds.addConditionItem(PolicyConditions.COND_CONTENT_LENGTH_RANGE, 0, 10485760);
  60.             // 5.2 设置上传文件的前缀、可忽略
  61.             policyConds.addConditionItem(MatchMode.StartWith, PolicyConditions.COND_KEY, dir);
  62.             // 5.3 对Policy签名后的字符串。
  63.             String postPolicy = ossClient.generatePostPolicy(expiration, policyConds);
  64.             String postSignature = ossClient.calculatePostSignature(postPolicy);
  66.             // 6.用户表单上传的策略（Policy），Policy为经过Base64编码过的字符串。
  67.             byte[] binaryData = postPolicy.getBytes("utf-8");
  68.             String encodedPolicy = BinaryUtil.toBase64String(binaryData);
  70.             // 7.封装签名直传服务返回给客户端消息Body内容
  71.             respMap = new LinkedHashMap<>();
  72.             // 7.1 用户请求的AccessKey ID。
  73.             respMap.put("accessid", accessId);
  74.             // 7.2 用户表单上传的策略（Policy），Policy为经过Base64编码过的字符串。
  75.             respMap.put("policy", encodedPolicy);
  76.             // 7.3 对Policy签名后的字符串。
  77.             respMap.put("signature", postSignature);
  78.             // 7.4 限制上传的文件前缀。
  79.             respMap.put("dir", dir);
  80.             // 7.5 用户发送上传请求的域名。
  81.             respMap.put("host", host);
  82.             // 7.6 由服务器端指定的Policy过期时间，格式为Unix时间戳（自UTC时间1970年01月01号开始的秒数）。
  83.             respMap.put("expire", String.valueOf(expireEndTime / 1000));
  85.         } catch (Exception e) {
  87.             return Result.error();
  88.         }
  89.         return Result.ok(respMap);
  90.     }
  92. }

4.4 OssConfig配置类

  1. package com.zhulang.waveedu.sms.config;
  3. import com.aliyun.oss.OSS;
  4. import com.zhulang.waveedu.sms.util.OssClientUtils;
  5. import org.springframework.beans.factory.annotation.Value;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  9. import javax.annotation.Resource;
  11. /**
  12.  * @author 狐狸半面添
  13.  * @create 2023-01-29 1:41
  14.  */
  15. @Configuration
  16. public class OssConfig {
  18.     @Resource
  19.     private OSS ossClient;
  21.     @Value("${spring.cloud.alicloud.access-key}")
  22.     private String accessId;
  24.     @Value("${spring.cloud.alicloud.oss.endpoint}")
  25.     private String endpoint;
  27.     @Value("${spring.cloud.alicloud.oss.bucket}")
  28.     private String bucket;
  30.     @Bean
  31.     public OssClientUtils ossClientUtils() {
  33.         return new OssClientUtils(ossClient, accessId, endpoint, bucket);
  34.     }
  37. }

4.5 OssConstants常量类

  1. package com.zhulang.waveedu.sms.constant;
  3. /**
  4.  * 与Oss相关的常量
  5.  *
  6.  * @author 狐狸半面添
  7.  * @create 2023-01-29 1:55
  8.  */
  9. public class OssConstants {
  11.     public static final String HEAD_IMAGE_DIR = "head-image";
  12. }

4.6 OssServiceController控制器

  1. package com.zhulang.waveedu.sms.controller;
  3. import com.zhulang.waveedu.common.entity.Result;
  4. import com.zhulang.waveedu.sms.constant.OssConstants;
  5. import com.zhulang.waveedu.sms.util.OssClientUtils;
  6. import org.springframework.web.bind.annotation.RequestMapping;
  7. import org.springframework.web.bind.annotation.RestController;
  9. import javax.annotation.Resource;
  10. /**
  11.  * @author 狐狸半面添
  12.  * @create 2023-01-29 1:30
  13.  */
  14. @RestController
  15. @RequestMapping("/oss")
  16. public class OssServiceController {
  18.     @Resource
  19.     private OssClientUtils ossClientUtils;
  21.     /**
  22.      * 获取头像的签名
  23.      *
  24.      * @return 签名信息
  25.      */
  26.     @RequestMapping("/headImage")
  27.     public Result headImage(){
  29.         return ossClientUtils.policy(OssConstants.HEAD_IMAGE_DIR);
  30.     }
  31. }

4.7 Apifox测试

image-20230129160309981

5.注意事项和细节说明

5.1 解决后端跨域问题

  1. package com.zhulang.waveedu.basic.config;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.web.servlet.config.annotation.CorsRegistry;
  5. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  7. /**
  8.  * 解决跨域问题
  9.  *
  10.  * @author 狐狸半面添
  11.  * @create 2023-01-15 23:08
  12.  */
  13. @Configuration
  14. public class CorsConfig implements WebMvcConfigurer {
  17.     @Override
  18.     public void addCorsMappings(CorsRegistry registry) {
  20.         registry.addMapping("/**")
  21.                 .allowedOrigins("*")
  22.                 .allowCredentials(true)
  23.                 .allowedMethods("GET", "POST", "PUT", "DELETE", "OPTIONS")
  24.                 .maxAge(3600);
  25.     }
  26. }

5.2 解决阿里云跨域问题

image-20230129160804310

发表评论

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

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

相关阅读