Go Web轻量级框架Gin学习系列:多种数据响应格式
ccwgpt 2024-09-18 12:19 36 浏览 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应用程序的开发，会大大提升开发速度与效率的。
相关推荐
- 一个基于.Net Core遵循Clean Architecture原则开源架构
-
今天给大家推荐一个遵循CleanArchitecture原则开源架构。项目简介这是基于Asp.netCore6开发的，遵循CleanArchitecture原则，可以高效、快速地构建基于Ra...
- AI写代码翻车无数次，我发现只要提前做好这3步，bug立减80%
-
写十万行全是bug之后终于找到方法了开发"提示词管理助手"新版本那会儿，我差点被bug整崩溃。刚开始两周，全靠AI改代码架构，结果十万行程序漏洞百出。本来以为AI说没问题就稳了，结果...
- OneCode低代码平台的事件驱动设计:架构解析与实践
-
引言：低代码平台的事件驱动范式在现代软件开发中，事件驱动架构（EDA）已成为构建灵活、松耦合系统的核心范式。OneCode低代码平台通过创新性的注解驱动设计，将事件驱动理念深度融入平台架构，实现了业务...
- 国内大厂AI插件评测:根据UI图生成Vue前端代码
-
在IDEA中安装大厂的AI插件，打开ruoyi增强项目：yudao-ui-admin-vue31.CodeBuddy插件登录腾讯的CodeBuddy后，大模型选择deepseek-v3，输入提示语：...
- AI+低代码技术揭秘(二):核心架构
-
本文档介绍了为VTJ低代码平台提供支持的基本架构组件，包括Engine编排层、Provider服务系统、数据模型和代码生成管道。有关UI组件库和widget系统的信息，请参阅UI...
- GitDiagram用AI把代码库变成可视化架构图
-
这是一个名为gitdiagram的开源工具，可将GitHub仓库实时转换为交互式架构图，帮助开发者快速理解代码结构。核心功能一键可视化：替换GitHubURL中的"hub...
- 30天自制操作系统:第六天:代码架构整理与中断处理
-
1.拆开bootpack.c文件。根据设计模式将对应的功能封装成独立的文件。2.初始化pic:pic(可编程中断控制器)：在设计上，cpu单独只能处理一个中断。而pic是将8个中断信号集合成一个中断...
- AI写代码越帮越忙?2025年研究揭露惊人真相
-
近年来，AI工具如雨后春笋般涌现，许多人开始幻想程序员的未来就是“对着AI说几句话”，就能轻松写出完美的代码。然而，2025年的一项最新研究却颠覆了这一期待，揭示了一个令人意外的结果。研究邀请了16位...
- 一键理解开源项目:两个自动生成GitHub代码架构图与说明书工具
-
一、GitDiagram可以一键生成github代码仓库的架构图如果想要可视化github开源项目：https://github.com/luler/reflex_ai_fast，也可以直接把域名替换...
- 5分钟掌握 c# 网络通讯架构及代码示例
-
以下是C#网络通讯架构的核心要点及代码示例，按协议类型分类整理：一、TCP协议（可靠连接）1.同步通信//服务器端usingSystem.Net.Sockets;usingTcpListene...
- 从复杂到优雅:用建造者和责任链重塑代码架构
-
引用设计模式是软件开发中的重要工具，它为解决常见问题提供了标准化的解决方案，提高了代码的可维护性和可扩展性，提升了开发效率，促进了团队协作，提高了软件质量，并帮助开发者更好地适应需求变化。通过学习和应...
- 低代码开发当道，我还需要学习LangChain这些框架吗?| IT杂谈
-
专注LLM深度应用，关注我不迷路前两天有位兄弟问了个问题：当然我很能理解这位朋友的担忧：期望效率最大化，时间用在刀刃上，“不要重新发明轮子”嘛。铺天盖地的AI信息轰炸与概念炒作，很容易让人浮躁与迷茫。...
- 框架设计并不是简单粗暴地写代码，而是要先弄清逻辑
-
3.框架设计3.框架设计本节我们要开发一个UI框架，底层以白鹭引擎为例。框架设计的第一步并不是直接撸代码，而是先想清楚设计思想，抽象。一个一个的UI窗口是独立的吗？不是的，...
- 大佬用 Avalonia 框架开发的 C# 代码 IDE
-
AvalonStudioAvalonStudio是一个开源的跨平台的开发编辑器（IDE），AvalonStudio的目标是成为一个功能齐全，并且可以让开发者快速使用的IDE，提高开发的生产力。A...
- 轻量级框架Lagent 仅需20行代码即可构建自己的智能代理
-
站长之家（ChinaZ.com）8月30日消息:Lagent是一个专注于基于LLM模型的代理开发的轻量级框架。它的设计旨在简化和提高这种模型下代理的开发效率。LLM模型是一种强大的工具，可以...
欢迎 你 发表评论:
- 一周热门
- 最近发表
- 标签列表
-
- 框架图 (58)
- flask框架 (53)
- quartz框架 (51)
- abp框架 (47)
- springmvc框架 (49)
- 分布式事务框架 (65)
- scrapy框架 (56)
- shiro框架 (61)
- 定时任务框架 (56)
- java日志框架 (61)
- mfc框架 (52)
- abb框架断路器 (48)
- beego框架 (52)
- java框架spring (58)
- grpc框架 (65)
- tornado框架 (48)
- 前端框架bootstrap (54)
- orm框架有哪些 (51)
- 知识框架图 (52)
- ppt框架 (55)
- 框架图模板 (59)
- 内联框架 (52)
- cad怎么画框架 (58)
- ssm框架实现登录注册 (49)
- oracle字符串长度 (48)