使用Go-Gin框架实现 OSS 前端直传功能

2023-12-31 18:12

本文主要是介绍使用Go-Gin框架实现 OSS 前端直传功能,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

引言

在现代 Web 应用中,文件上传是一项常见功能。传统的上传方式通常需要文件经过后端服务器转发到对象存储服务(如阿里云 OSS)。然而,这种方法可能对服务器造成额外的负担,并降低上传效率。本文将探讨如何使用 Go-Gin 框架实现 OSS 前端直传,从而提高效率并减轻服务器负担。

OSS 前端直传的好处

  • 减少服务器带宽和存储需求:直接上传到 OSS 可以减少服务器流量和存储空间的使用。
  • 提高文件上传速度:文件直接从客户端上传到 OSS,减少了中转时间。
  • 增强数据安全性:文件不经过服务器,降低数据泄露风险。
  • 简化分布式系统的数据管理:当应用采用分布式架构时,直接上传文件到 OSS 可以避免在多个服务器之间同步数据。这种方法减少了分布式环境中数据一致性和同步的复杂性

OSS 设置

在阿里云 OSS 中,首先需要创建一个 Bucket,并设置合适的权限。接着,获取 Access Key ID 和 Access Key Secret,用于后续的 API 调用。我们在获取Access Key ID 和 Access Key Secret时,一定要新建一个新的管理员,这个管理员只可以用来管理OSS,以后就算这个Access Key ID 和 Access Key Secret泄露出去也可以及时补救。此外,我们也要设置合适的 CORS 规则以允许前端直接向 OSS 发送请求。

代码实现

前端代码

我们构建了一个简单的上传界面,用户可以选择文件并点击上传。下面的 JavaScript 代码段展示了上传逻辑:

// 获取上传表单元素
const uploadForm = document.getElementById('upload-form');// 上传文件事件监听
uploadForm.addEventListener('submit', (event) => {event.preventDefault(); // 阻止表单默认提交行为// 获取上传文件const fileInput = document.querySelector('#customFile');const file = fileInput.files[0];// 文件大小验证const maxSize = 5 * 1024 * 1024; // 5MB 的大小限制if(file.size > maxSize) {alert('文件不能超过5MB');return;}// 使用 uuid 库生成 UUIDconst myUUID = uuid.v4(); const secondname = myUUID + '.csv'; // 创建基于 UUID 的文件名const filename = file.name; // 获取原始文件名// 向后端发起请求,获取用于上传文件的签名后的 URLfetch(`/project/upload?filename=${secondname}`, { method: "GET" }).then((response) => response.json()) // 将响应解析为 JSON 格式.then((data) => {const url = data.url; // 从响应中提取签名后的 URL// 使用提取的 URL 和 PUT 方法直接上传文件到 OSSreturn fetch(url, {method: "PUT",headers: new Headers({'Content-Type': 'text/csv', // 设置内容类型为 CSV}),body: file, // 文件内容});});
});

后端 Go-Gin 代码

Controller Layer

UploadToken 函数,位于后端的控制器层(Controller Layer),是整个文件上传功能中的一个关键环节。这个函数的主要职责是处理前端发起的 GET 请求。作为服务器端的一部分,它在申请 OSS(对象存储服务)授权和处理上传逻辑方面发挥着至关重要的作用。以下是其详细的职责描述:

  1. 接收请求和解析参数:作为控制器层的一部分,UploadToken 首先从前端的请求中提取必要的参数,例如文件名。

  2. 调用服务层以获取授权:这个函数进一步将这些参数传递给服务层,这里是与 OSS 交互以申请和获取上传文件所需授权的地方。

  3. 返回授权 URL 给前端:服务层成功获取授权后的 URL,UploadToken 函数则负责将这个 URL 返回给前端。这个 URL 是经过签名的,具有一定的有效期,保障了上传流程的安全性。

  4. 前端使用 URL 完成直传:前端获取到授权后的 URL 后,便可以利用它直接将文件上传到 OSS,从而避免了文件经过后端服务器的需要,提高了上传效率并减轻了服务器的负担。

在整个架构中,UploadToken 函数作为控制器层的组成部分,不仅确保了代码的模块化和清晰的职责划分,还优化了资源的使用和前后端的交互流程,使得文件上传操作更加直接、高效和安全。

// UploadToken 处理前端的上传令牌请求
func UploadToken(c *gin.Context) {filename := c.Query("filename") // 从请求中获取文件名tokenservice, downloadURL := service.TokenService(filename) // 调用 Service 层获取签名 URLfmt.Println("uploadToken", downloadURL)// 返回签名 URL 和下载 URLdata := map[string]interface{}{"url":         tokenservice,"downloadURL": downloadURL,}c.JSON(http.StatusOK, data) // 发送 JSON 响应
}
Service Layer

TokenService 函数是服务层(Service Layer)中的核心组件,负责与阿里云的对象存储服务(OSS)进行交互,以生成用于上传和下载文件的签名 URL。以下是其具体职责和工作流程的详细解释:

  1. 加载环境变量:函数首先加载 .env 文件中的环境变量。这是一个安全的做法,用于存储敏感信息,如 OSS 的端点(EndPoint)、访问密钥(Access Key ID 和 Access Key Secret)以及 Bucket 名称。通过这种方式,可以避免将敏感信息硬编码在代码中。

  2. 初始化 OSS 客户端:使用从环境变量中获取的配置信息(如 EndPoint 和访问密钥),函数初始化 OSS 客户端。这个客户端用于执行后续的操作,如生成签名 URL。

  3. 获取 Bucket:通过 OSS 客户端获取指定的 Bucket。Bucket 是 OSS 中用于存储文件的基本单元。

  4. 生成签名 URL:函数为上传操作生成一个 PUT 方法的签名 URL,并为下载操作生成一个 GET 方法的签名 URL。这些签名 URL 是带有时间限制的,确保了操作的安全性。签名 URL 允许前端直接与 OSS 交互,无需通过服务器进行文件传输。

  5. 返回签名 URL:最后,函数返回这两个签名 URL(一个用于上传,另一个用于下载),供前端使用。

通过 TokenService 函数的设计和实现,服务层在保护敏感信息的同时,有效地与 OSS 进行交互,支持了高效且安全的文件上传和下载流程。这种设计减轻了服务器的负担,提高了整体的应用性能,并确保了数据传输过程的安全性。

package serviceimport ("log""os""github.com/aliyun/aliyun-oss-go-sdk/oss""github.com/joho/godotenv"
)// TokenService 生成用于 OSS 上传和下载的签名 URL
func TokenService(filename string) (string, string) {// 加载环境变量,用于获取 OSS 的配置err := godotenv.Load()if err != nil {log.Fatal("Error loading .env file:", err)}// 获取 OSS 配置信息OSS_END_POINT := os.Getenv("OSS_END_POINT")OSS_ACCESS_KEY_ID := os.Getenv("OSS_ACCESS_KEY_ID")OSS_ACCESS_KEY_SECRET := os.Getenv("OSS_ACCESS_KEY_SECRET")OSS_BUCKET := os.Getenv("OSS_BUCKET")// 初始化 OSS 客户端client, err := oss.New(OSS_END_POINT, OSS_ACCESS_KEY_ID, OSS_ACCESS_KEY_SECRET)if err != nil {log.Fatal("Error initializing OSS client:", err)}// 获取指定的 Bucketbucket, err := client.Bucket(OSS_BUCKET)if err != nil {log.Fatal("Error getting bucket:", err)}// 设置上传文件的内容类型options := []oss.Option{oss.ContentType("text/csv"),}// 构建文件在 OSS 上的存储路径key := "uploadfile/" + filename// 生成 PUT 方法的签名 URLsignedPutURL, err := bucket.SignURL(key, oss.HTTPPut, 600, options...)if err != nil {log.Fatal("Error generating signed PUT URL:", err)}// 生成 GET 方法的签名 URLsignedGetURL, err := bucket.SignURL(key, oss.HTTPGet, 600)if err != nil {log.Fatal("Error generating signed GET URL:", err)}return signedPutURL, signedGetURL
}

结论

使用 Go-Gin 框架结合 OSS 实现前端直传是一种高效且安全的方法。它适用于需要处理大量文件上传的应用,能够显著提升用户体验和系统性能。

参考资料

阿里云OSS文档:阿里云OSS文档

Go-gin Github官网:Go-gin Github官网

这篇关于使用Go-Gin框架实现 OSS 前端直传功能的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/556795

相关文章

C#实现将Excel表格转换为图片(JPG/ PNG)

《C#实现将Excel表格转换为图片(JPG/PNG)》Excel表格可能会因为不同设备或字体缺失等问题,导致格式错乱或数据显示异常,转换为图片后,能确保数据的排版等保持一致,下面我们看看如何使用C... 目录通过C# 转换Excel工作表到图片通过C# 转换指定单元格区域到图片知识扩展C# 将 Excel

Java使用ANTLR4对Lua脚本语法校验详解

《Java使用ANTLR4对Lua脚本语法校验详解》ANTLR是一个强大的解析器生成器,用于读取、处理、执行或翻译结构化文本或二进制文件,下面就跟随小编一起看看Java如何使用ANTLR4对Lua脚本... 目录什么是ANTLR?第一个例子ANTLR4 的工作流程Lua脚本语法校验准备一个Lua Gramm

Java Optional的使用技巧与最佳实践

《JavaOptional的使用技巧与最佳实践》在Java中,Optional是用于优雅处理null的容器类,其核心目标是显式提醒开发者处理空值场景,避免NullPointerExce... 目录一、Optional 的核心用途二、使用技巧与最佳实践三、常见误区与反模式四、替代方案与扩展五、总结在 Java

Vue3组件中getCurrentInstance()获取App实例,但是返回null的解决方案

《Vue3组件中getCurrentInstance()获取App实例,但是返回null的解决方案》:本文主要介绍Vue3组件中getCurrentInstance()获取App实例,但是返回nu... 目录vue3组件中getCurrentInstajavascriptnce()获取App实例,但是返回n

基于Java实现回调监听工具类

《基于Java实现回调监听工具类》这篇文章主要为大家详细介绍了如何基于Java实现一个回调监听工具类,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录监听接口类 Listenable实际用法打印结果首先,会用到 函数式接口 Consumer, 通过这个可以解耦回调方法,下面先写一个

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown(MD)因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析

Qt中QGroupBox控件的实现

《Qt中QGroupBox控件的实现》QGroupBox是Qt框架中一个非常有用的控件,它主要用于组织和管理一组相关的控件,本文主要介绍了Qt中QGroupBox控件的实现,具有一定的参考价值,感兴趣... 目录引言一、基本属性二、常用方法2.1 构造函数 2.2 设置标题2.3 设置复选框模式2.4 是否

Qt中QUndoView控件的具体使用

《Qt中QUndoView控件的具体使用》QUndoView是Qt框架中用于可视化显示QUndoStack内容的控件,本文主要介绍了Qt中QUndoView控件的具体使用,具有一定的参考价值,感兴趣的... 目录引言一、QUndoView 的用途二、工作原理三、 如何与 QUnDOStack 配合使用四、自

C++使用printf语句实现进制转换的示例代码

《C++使用printf语句实现进制转换的示例代码》在C语言中,printf函数可以直接实现部分进制转换功能,通过格式说明符(formatspecifier)快速输出不同进制的数值,下面给大家分享C+... 目录一、printf 原生支持的进制转换1. 十进制、八进制、十六进制转换2. 显示进制前缀3. 指

springboot整合阿里云百炼DeepSeek实现sse流式打印的操作方法

《springboot整合阿里云百炼DeepSeek实现sse流式打印的操作方法》:本文主要介绍springboot整合阿里云百炼DeepSeek实现sse流式打印,本文给大家介绍的非常详细,对大... 目录1.开通阿里云百炼,获取到key2.新建SpringBoot项目3.工具类4.启动类5.测试类6.测