Go Web轻量级框架Gin学习系列:多种数据响应格式
ccwgpt 2024-09-18 12:19 30 浏览 0 评论
Go Web轻量级框架Gin学习系列：多种数据响应格式
我们在《Go Web轻量级框架Gin学习系列：安装与使用》已经讲过如何安装Gin框架以及如何定义各种处理HTTP请求的方法了，这篇文章就接着讲讲接收到客户端请求后，怎么响应客户端请求以及有多种响应数据格式。
r.GET("/test",func(c *gin.Context){
//省略处理请求的代码
})
复制代码
上面的例子中，我们定义了一个处理HTTP GET请求的方法，回调用函数的参数为*gin.Context,Gin框架在*gin.Context实例中封装了所以处理请求并响应客户端的方法，Gin支持多种响应方法，包括我们常见的String,HTML,JSON,XML,YAML,JSONP,也支持直接响应Reader和[]byte，而且还支持重定向。
下面列表出gin.Context中响应客户端的方法列表：
func (c *Context) AsciiJSON(code int, obj interface{})
func (c *Context) Data(code int, contentType string, data []byte)
func (c *Context) DataFromReader(code int, contentLength int64, contentType string,
reader io.Reader, extraHeaders map[string]string)
func (c *Context) HTML(code int, name string, obj interface{})
func (c *Context) IndentedJSON(code int, obj interface{})
func (c *Context) JSON(code int, obj interface{})
func (c *Context) JSONP(code int, obj interface{})
func (c *Context) ProtoBuf(code int, obj interface{})
func (c *Context) PureJSON(code int, obj interface{})
func (c *Context) Redirect(code int, location string)
func (c *Context) Render(code int, r render.Render)
func (c *Context) SecureJSON(code int, obj interface{})
func (c *Context) String(code int, format string, values ...interface{})
func (c *Context) XML(code int, obj interface{})
func (c *Context) YAML(code int, obj interface{})
复制代码
下面是多种响应数据格式的详细讲：
JSON
json是轻量级数据交互格式，应用很广泛，尤其是Web API服务方面，因此Gin框架为JSON提供了支持，使用gin.Context中的JSON方法将格式化后的JSON数据返回给客户端。
package main
import (
"github.com/gin-gonic/gin"
"net/http"
)
type User struct {
Uid int `json:"uid" xml:"uid"`
Username string `json:"username" xml:"username"`
}
func main() {
r := gin.Default()
r.GET("test", func(c *gin.Context) {
data := &User{Uid:1,Username:"测试账号"}
c.JSON(http.StatusOK,data)
})
r.Run()
}
复制代码
XML,YAML,String
响应XML、YAML或String格式的数据，处理方式如同JSON一样，Gin都提供相应的函数，示例如下：
//xml
r.GET("xml",func(c *gin.Context){
data := gin.H{"xml":"Hello World"}
c.XML(200,data)
})
//yaml
r.GET("yaml",func(c *gin.Context){
data := gin.H{"xml":"Hello World"}
c.YAML(200,data)
})
//string
r.GET("yaml",func(c *gin.Context){
c.String(200,"Hello World")
})
复制代码
上面的例子中， 我们使用了一个叫gin.H类型，实际gin.H在gin包中的定义如下：
type H map[string]interface{}
复制代码
Protobuf
Protobuf是一种与平台无关和语言无关，且可扩展且轻便高效的序列化数据结构的协议，可以用于网络通信和数据存储，其实序列化的速度要比JSON和XML快，但其易用性和可阅读性远不如JSON和XML，因此并没有广泛使用。
不过Gin也为Protobuf数据响应提供了支持，以下例子来自Gin官方文档：
r.GET("/someProtoBuf", func(c *gin.Context) {
reps := []int64{int64(1), int64(2)}
label := "test"
// protobuf 的具体定义写在 testdata/protoexample 文件中。
data := &protoexample.Test{
Label: &label,
Reps: reps,
}
// 请注意，数据在响应中变为二进制数据
// 将输出被 protoexample.Test protobuf 序列化了的数据
c.ProtoBuf(http.StatusOK, data)
})
复制代码
HTML渲染
Gin也支持传统Web编程中的HTML模板渲染，直接返回HTML代码给客户端，主要步骤如下：
1. 定义HTML模板
HTML模板文件：templates/index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
{{.foo}}
</body>
</html>
复制代码
2. 加载模板
定义好模板之后，在渲染之前，要使用gin.Engine中的LoadHTMLFiles()或LoadHTMLGlob()方法加载模板。
LoadHTMLFiles(files ...string)方法可以接收一个或多个参数，用于加载单个或多个模板文件。
r := gin.Default()
r.LoadHTMLFiles("./templates/index.html")
复制代码
LoadHTMLGlob(pattern string)方法则用于加载整个目录下的模板文件，如果目录不存在或目录下没有模板文件会引发panic错误。
r := gin.Default()
r.LoadHTMLGlob("./templates/*")
复制代码
3. 完整示例
func main() {
r := gin.Default()
r.LoadHTMLFiles("./templates/index.html")
//r.LoadHTMLGlob("./templates/*")
r.GET("html", func(c *gin.Context) {
data := map[string]interface{}{
"foo": "bar",
}
c.HTML(http.StatusOK,"index.html",data)
})
r.Run()
}
复制代码
JSONP
JSONP是一种基于JSON，而用于解决浏览器跨域访问问题的机制，使用gin.Context的JSONP()返回数据时，会将URL中的callback参数按照JSONP的数据格式放在json数据前面,并返回给客户端。
func main() {
r := gin.Default()
r.GET("/JSONP?callback=test", func(c *gin.Context) {
data := map[string]interface{}{
"foo": "bar",
}
c.JSONP(http.StatusOK,data)
})
r.Run()
}
复制代码
Reader
使用gin.Context中的DataFromReader()方法，可以直接从Reader读取数据，下面演示一个下载图片的HTTP请求：
func main() {
r := gin.Default()
r.GET("file", func(c *gin.Context) {
fileName := "./1.jpg"
file, _ := os.Open(fileName)
fileInfo, _ := os.Lstat(fileName)
extraHeaders := map[string]string{
"Content-Disposition": `attachment; filename="` + fileName + `"`,
}
c.DataFromReader(200, fileInfo.Size(), "image/png", file, extraHeaders)
})
r.Run()
}
复制代码
字节数组
使用gin.Context中的Data()方法，可以返回一个字节数组([]byte)给客户端，下面的例子演示从图片中读取二进制数组并返回给客户端。
func main() {
r := gin.Default()
r.GET("file", func(c *gin.Context) {
file, _ := os.Open("./1.jpg")
b, _ := ioutil.ReadAll(file)
c.Data(200, "image/png", b)
})
r.Run()
}
复制代码
重定向
除了返回不同格式的数据给客户端，Gin框架也支持重定向操作，重定向分为外部和内部重定向。
1. 外部重定向
用于跳转其他外部的链接。
func main(){
r := gin.Default()
r.GET("Redirect",func(c *gin.Context){
c.Redirect(http.StatusMovedPermanently,"https://.im")
})
r.Run()
}
复制代码
2. 内部重定向
用于跳转内部路由。
func main() {
r := gin.Default()
r.GET("test", func(c *gin.Context) {
c.Request.URL.Path = "/profile"
r.HandleContext(c)
})
r.GET("profile", func(c *gin.Context) {
username := c.Query("username")
fmt.Println(username)
c.JSON(200, gin.H{"user": "profile"})
})
r.Run()
}
复制代码
小结
从上面的多个例子中可以看到Gin响应Web请求的良好封装，因此使用Gin进入Web应用程序的开发，会大大提升开发速度与效率的。
相关推荐
- Python+ Appium:Android手机连接与操作详解(附源码)
-
在移动端自动化测试领域，Appium一直是最热门的开源工具之一。今天这篇文章，我们聚焦Android端自动化测试的完整流程，从环境配置到代码实战，一步一步带你掌握用Python控制Android...
- 全平台开源即时通讯IM框架MobileIMSDK开发指南，支持鸿蒙NEXT
-
写在前面在着手基于MobileIMSDK开发自已的即时通讯应用前，建议以Demo工程为脚手架，快速上手MobileIMSDK！Demo工程主要用于演示SDK的API调用等，它位于SDK完整下载包的如下...
- 移动开发(一):使用.NET MAUI开发第一个安卓APP
-
对于工作多年的C#程序员来说，近来想尝试开发一款安卓APP，考虑了很久最终选择使用.NETMAUI这个微软官方的框架来尝试体验开发安卓APP，毕竟是使用VisualStudio开发工具，使用起来也...
- 在安卓系统上开发一款软件详细的流程
-
安卓app软件开发流程是一个系统而复杂的过程，涉及多个阶段和环节。以下是一个典型的安卓软件开发流程概述：1.需求分析目的：了解用户需求，确定APP的目标、功能、特性和预期效果。活动：开发团队与客户进...
- ArkUI-X在Android上使用Fragment开发指南
-
本文介绍将ArkUI框架的UIAbility跨平台部署至Android平台Fragment的使用说明，实现Android原生Fragment和ArkUI跨平台Fragment的混合开发，方便开发者灵活...
- Web3开发者必须要知道的6个框架与开发工具
-
在Web3领域，随着去中心化应用和区块链的兴起，开发者们需要掌握适用于这一新兴技术的框架与开发工具。这些工具和框架能够提供简化开发流程、增强安全性以及提供更好的用户体验。1.Truffle：Truff...
- Python开发web指南之创建你的RESTful APP
-
上回我们说到了：PythonFlask开发web指南：创建RESTAPI。我们知道了Flask是一个web轻量级框架，可以在上面做一些扩展，我们还用Flask创建了API，也说到了...
- python的web开发框架有哪些（python主流web框架）
-
python在web开发方面有着广泛的应用。鉴于各种各样的框架，对于开发者来说如何选择将成为一个问题。为此，我特此对比较常见的几种框架从性能、使用感受以及应用情况进行一个粗略的分析。 1Dja...
- Qwik:革新Web开发的新框架（webview开源框架）
-
听说关注我的人，都实现了财富自由！你还在等什么？赶紧加入我们，一起走向人生巅峰！Qwik：革新Web开发的新框架Qwik橫空出世：一场颠覆前端格局的革命？是炒作还是未来？前端框架的更新迭代速度，如同...
- Python中Web开发框架有哪些?（python主流web框架）
-
Python为Web开发提供了许多优秀的框架。以下是一些流行的PythonWeb框架：1.Django：一个高级的Web框架，旨在快速开发干净、实用的Web应用。Django遵...
- WPF 工业自动化数据管控框架，支持热拔插 DLL与多语言实现
-
前言工业自动化开发中，设备数据的采集、处理与管理成为提升生产效率和实现智能制造的关键环节。为了简化开发流程、提高系统的灵活性与可维护性，StarRyEdgeFramework应运而生。该框架专注...
- [汇川PLC] 汇川IFA程序框架06-建立气缸控制FB块
-
前言：汇川的iFA要跟西门子对标啦，这可是新的选择！就在2月14日，汇川刚发布的iFA平台，一眼就能看出来是对标西门子的全集成自动化平台博途（TIAPortal）。这个平台能在同一个...
- 微软发布.NET 10首个预览版:JIT编译器再进化、跨平台开发更流畅
-
IT之家2月26日消息，微软.NET团队昨日（2月25日）发布博文，宣布推出.NET10首个预览版更新，重点改进.NETRuntime、SDK、libraries、C#、AS...
- 大模型部署革命:GGUF量化+vLLM推理的极致性能调优方案
-
本文较长，建议点赞收藏，以免遗失。更多AI大模型应用开发学习视频及资料，尽在官网-聚客AI学院大模型应用开发微调项目实践课程学习平台一、模型微调核心概念与技术演进1.1微调的本质与优势数学表达：1....
- 拓扑学到底在研究什么?（拓扑学到底在研究什么问题）
-
拓扑是“不量尺寸的几何学”，那么它的核心内容，主要方法是什么？如果你问罗巴切夫斯基，他会说“附贴性是物体的一个特殊的属性。如果我们把这个性质掌握，而把物体其他的一切属性，不问是本质的或偶然出现的，均不...
欢迎 你 发表评论:
- 一周热门
- 最近发表
-
- Python+ Appium:Android手机连接与操作详解(附源码)
- 全平台开源即时通讯IM框架MobileIMSDK开发指南，支持鸿蒙NEXT
- 移动开发(一):使用.NET MAUI开发第一个安卓APP
- 在安卓系统上开发一款软件详细的流程
- ArkUI-X在Android上使用Fragment开发指南
- Web3开发者必须要知道的6个框架与开发工具
- Python开发web指南之创建你的RESTful APP
- python的web开发框架有哪些（python主流web框架）
- Qwik:革新Web开发的新框架（webview开源框架）
- Python中Web开发框架有哪些?（python主流web框架）
- 标签列表
-
- MVC框架 (46)
- spring框架 (46)
- 框架图 (58)
- flask框架 (53)
- quartz框架 (51)
- abp框架 (47)
- jpa框架 (47)
- laravel框架 (46)
- springmvc框架 (49)
- 分布式事务框架 (65)
- scrapy框架 (56)
- shiro框架 (61)
- 定时任务框架 (56)
- java日志框架 (61)
- JAVA集合框架 (47)
- grpc框架 (55)
- ppt框架 (48)
- 内联框架 (52)
- winform框架 (46)
- gui框架 (44)
- cad怎么画框架 (58)
- ps怎么画框架 (47)
- ssm框架实现登录注册 (49)
- oracle字符串长度 (48)
- oracle提交事务 (47)