导航

• 引言
• 总体思路
• 七牛云相关的配置文件
• 获取七牛云上传token
  • 相关类定义
  • 核心代码实现
• 获取七牛云图片下载链接
  • 公开空间
  • 私有空间
  • 核心代码实现
• 结语
• 参考

引言

我们在成长，代码也要成长。

多媒体图片在各种网站、小程序和app中应用广泛，同时也大大增强了用户体验。

随着云服务的兴起，越来越多的应用选择将数据托管在云端。

而多媒体素材上云技术更是日趋成熟，不仅能降本增效，还能给用户带来极速体验。

本文主要介绍在web/小程序项目中，图片文件基于七牛云的上传和下载的通用实现。

总体思路

我们先来看一下，我们在实际项目中（特别是前后端分离）上传和下载图片的流程。

上面的流程比较清晰的展示了用户-客户端-WebAPI-七牛云之间的交互逻辑。
其中，我们重点讲解一下黄色部分的实现。

七牛云相关的配置文件

我们把图片上传到七牛云，这就涉及到一些七牛云相关的配置。

 // 七牛KEY
 "QiNiu": {
   "Key": "七牛云key",
   "Skey": "七牛云skey",
   "ImgServerUrl": "https://devcdn.xx.com/",//根据实际来配置
   "DefaultBucket": "公有空间bucketName",//根据实际来配置
   "privateUrl": "https://cdn-dev-private.xxx.com",//根据实际来配置
   "https": null, //cdn-dev-private.meb.com/
   "privateBucket": "私有空间bucketName",//根据实际来配置
   "publicUrl": "https://cdn.xxx.com/"//根据实际来配置
 },

相关的配置可以登录七牛云查看。

比如，这是我自己的AccessKey/SecretKey：

获取七牛云上传token

相关类定义

/// <summary>
/// 七牛上传空间类型
/// </summary   
public enum FileUploadBucketEnum
{
    /// <summary>
    /// 未知
    /// </summary>
    [Description("未知")]
    UN_KNOW = -1,

    /// <summary>
    /// 公有
    /// </summary>
    [Description("公有")]
    PUBLIC_BUCKET = 0,
    /// <summary>
    /// 私有
    /// </summary>
    [Description("私有")]
    PRIVATE_BUCKET = 1
}

/// <summary>
 ///  客户端传递的参数 区分公共空间和私有空间
 /// </summary>
public class GetQINiuTokenDto
{
    public string path;
    [Required(ErrorMessage = "空间类型必填")]
    public FileUploadBucketEnum bucket = FileUploadBucketEnum.UN_KNOW;
}

 /// <summary>
 ///  返回给客户端的参数
 /// </summary>
public  class QiniuTokenRsp
 {
     /// <summary>
     /// Token
     /// </summary>
     public string uptoken { get; set; }
     /// <summary>
     /// 文件名
     /// </summary>
     public string FileName { get; set; }
     
 }

实现代码

 /// <summary>
 /// 获取图片上传七牛云token
 /// </summary>
 /// <param name="dto"></param>
 /// <returns></returns>
 public QiniuTokenRsp GetQiNiuToken(GetQINiuTokenDto dto)
 {
     Mac mac = new Mac(ConfigManager.AppSettings["QiNiu:Key"], ConfigManager.AppSettings["QiNiu:SKey"]);
     PutPolicy putPolicy = new PutPolicy
     {
         Scope = dto.bucket == FileUploadBucketEnum.PRIVATE_BUCKET ? ConfigManager.AppSettings["QiNiu:privateBucket"] : ConfigManager.AppSettings["QiNiu:DefaultBucket"]
     };
     putPolicy.SetExpires(3600);
     // 暂时限制只能传图片
     putPolicy.MimeLimit = "image/jpeg;image/png;audio/mpeg;";
     // 暂时后端限制20 前端限制10，因为还有载入，格式转换，裁剪之类的
     putPolicy.FsizeLimit = 1024 * 1024 * 20;

     string jstr = putPolicy.ToJsonString();
     string token = Auth.CreateUploadToken(mac, jstr);
     var fileKey = $"{dto.path}/{DateTime.Now:yyyyMMddHHmmss}{Guid.NewGuid()}";

     return new QiniuTokenRsp
     {
         uptoken = token,
         FileName = fileKey
     };
 }

获取七牛云图片下载链接

可能很多人并不知道，七牛云公开空间和私有空间的区别，这里简单介绍一下。

文件下载分为公开空间的文件下载和私有空间的文件下载。

公开空间

对于公开空间，其访问的链接主要是将空间绑定的域名（可以是存储空间的默认域名或者是绑定的自定义域名）拼接上空间里面的文件名即可访问，标准情况下需要在拼接链接之前，将文件名进行urlencode以兼容不同的字符。

string domain = "http://if-pbl.qiniudn.com";
string key = "hello/world/七牛/test.png";
string publicUrl = DownloadManager.CreatePublishUrl(domain, key);
Console.WriteLine(publicUrl);

私有空间

对于私有空间，首先需要按照公开空间的文件访问方式构建对应的公开空间访问链接，然后再对这个链接进行私有授权签名。

Mac mac = new Mac(AccessKey, SecretKey);
string domain = "http://if-pri.qiniudn.com";
string key = "hello/world/七牛/test.png";
string privateUrl = DownloadManager.CreatePrivateUrl(mac, domain, key, 3600);
Console.WriteLine(privateUrl);

核心代码实现

在上面官方接口的基础上，笔者做了一下封装，代码如下：

/// <summary>
/// 私有空间完整图片下载地址
/// </summary>
/// <param name="key"></param>
/// <returns></returns>
public static String GetPrivateUrl(string key)
{
    String privateUrl = String.Empty;
    try
    {
        if (String.IsNullOrEmpty(key))
        {
            return privateUrl;
        }
        Mac mac = new Mac(ConfigManager.AppSettings["QiNiu:Key"], ConfigManager.AppSettings["QiNiu:SKey"]);
        //公开空间域名
        string domain = ConfigManager.AppSettings["QiNiu:privateUrl"];
        privateUrl = DownloadManager.CreatePrivateUrl(mac, domain, key, 3600);
        //Console.WriteLine(privateUrl);
    }
    catch (Exception ex)
    {
        LoggerHelper.LogError($"QiNiuHelper.GetPrivateUrl：{ex.Message}");
    }
    return privateUrl;
}

/// <summary>
/// 公共空间完整图片下载地址
/// </summary>
/// <param name="key"></param>
/// <returns></returns>
public static String GetPublicUrl(string key)
{
    String publicUrl = String.Empty;
    try
    {
        if (String.IsNullOrEmpty(key))
        {
            return publicUrl;
        }
        Mac mac = new Mac(ConfigManager.AppSettings["QiNiu:Key"], ConfigManager.AppSettings["QiNiu:SKey"]);
        string domain = ConfigManager.AppSettings["QiNiu:publicUrl"];
        publicUrl = DownloadManager.CreatePublishUrl(domain, key);
    }
    catch (Exception ex)
    {
        LoggerHelper.LogError($"QiNiuHelper.GetPublicUrl：{ex.Message}");
    }
    return publicUrl;
}

结语

笔者近期接到一个紧急需求，需要将客户资料中营业执照等相关资质文件的上传路径，从公共空间迁移到私有空间。

这个涉及到对一些老项目的改造，在这次改造中进一步加深了对七牛云上传和下载思路的理解。

这里笔者只根据个人的工作经验,一点点思考和分享,抛砖引玉,欢迎大家怕批评和斧正。

2024.08.07

成都

参考

• 《七牛云C# SDK》
• 《springboot集成七牛云图片上传、下载》
• 《Springboot实战纪实源码》