Go Web轻量级框架Gin学习系列:多种数据响应格式
ccwgpt 2024-09-18 12:19 23 浏览 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应用程序的开发，会大大提升开发速度与效率的。
相关推荐
- 5 分钟搭建 Node.js 微服务原型（node 微服务架构）
-
微服务已成为在Node.js中构建可扩展且强大的云应用的主流方法。同时也存在一些门槛，其中一些难点需要你在以下方面做出决策：组织项目结构。将自定义服务连接到第三方服务（数据库，消息代理等）处理微服...
- 当前的前端，真的不配叫程序员吗?
-
今天看到一个比较令人震惊的帖子，说前端不配叫程序员，令我很吃鲸，是谁我就不说了，帖子出处是一个大龄程序员组里面的，想想也不觉得奇怪了，毕竟对于年龄比较大的程序员来说，前端起步比较晚，最开始就是一个切图...
- 聊聊asp.net中Web Api的使用（asp.net core web api教程）
-
扯淡随着app应用的崛起，后端服务开发的也越来越多，除了很多优秀的nodejs框架之外，微软当然也会在这个方面提供更便捷的开发方式。这是微软一贯的作风，如果从开发的便捷性来说的话微软是当之无愧的老大哥...
- NodeJS中，listen Access:permission denied解决办法
-
错误描述：Win10系统，NodeJS程序。使用express框架开发的http服务器，启动时出现错误提示“listenAccess：permissiondenied"。错误原因：这是由于...
- Hono — 下一代高性能web框架（天融信下一代vnp）
-
最近公司可能要有变革，要统计我们的技能。真的是很无语，但是有没有办法。哎，问豆包吧提起Hono大家可能很陌生，这是什么？但是我提到Expressjs、nodejs想必前端小伙伴很熟悉啊。那么Hon...
- 生活例子说明线程，简单明了（列举一个日常生活中的例子以程序的形式表示）
-
1.程序设计的目标在我看来单从程序的角度来看，一个好的程序的目标应该是性能与用户体验的平衡。当然一个程序是否能够满足用户的需求暂且不谈，这是业务层面的问题，我们仅仅讨论程序本身。围绕两点来展开，性能...
- Node实战006:自定义模块的创建和使用详解
-
Node的应用是由模块组成的，每个文件的定义都是一个模块（module变量代表当前模块）并有自己的作用域。Node遵循commonjs的模块规范，用来隔离每个模块的作用域，使每一个模块在自身的命名空间...
- Node.js基本内容和知识点（node.js的概念）
-
简单的说Node.js就是运行在服务端的JavaScript，起初段定位是后端开发语言，由于技术的不够成熟，一般小型项目会完全使用node.js作为后台支撑，大项目中，运行不够稳定，不会轻易使用...
- 干货 | 如何利用Node.js 构建分布式集群
-
引言在软件定义的世界里，企业通过Web应用和移动应用程序来提供大部分的服务，Node.js迅速成为时下最为流行的一个平台之一，就和它可以搭建响应速度快、易于扩展的web应用和移动应用有很大关系，并凭...
- nodejs mongodb 实现简易留言板（node.js留言板）
-
一个朋友问了一下mongodb的一些操作问题我就做了下面这个简单的留言板给他做一个实例希望能帮助到他express的框架就不说了express的问题请移步nodejs之expressht...
- nodejs mqtt 智能售货机系统物联网控制系统源码分享
-
智能售货机系统(Moleintelligentvendingmachinesystem)是一套物联网控制系统性的解决方案。主要涉及到的语言和库有c,c++,js,nodejs,vue.js,...
- 为什么 Node.js 这么火，而同样异步模式 Python 框架 Twisted 却十几年一直不温不火?
-
说nodejs只是靠营销的是否太天真了些？当初nodejs出来的时候各种BUG，我简单的测试其大文件传输都会出现各种问题。而同時期的其他阵营早就甩其几条街了。但是为什么却能一直不断发展壮大？...
- 2020年14个最有用的NodeJS库（node用什么数据库）
-
Express快速，简单，极简的节点Web框架对…有好处·易于处理多种类型的请求，例如GET，PUT，POST和DELETE请求·快速构建单页，多页和混合Web应用程序每周下载1100万Lice...
- 连载:2016年最好的JS框架和库(下)
-
继续上一期的介绍：Agility.jsAgility.js是专为JS服务的MVC库，你可以免费编写可再用和可维护的浏览器代码，Agility支持Js，样式(CSS)、内容(HTML)和行为(JS)。C...
- awesome-nodejs 终极资源库:60K+星标的开发者宝藏
-
Node.js终极资源库:60K+星标的开发者宝藏引言在GitHub上，有一个备受瞩目的Node.js资源仓库，以其惊人的60.6k星标量和6kfork量，成为了Node.js开发者的必备参考。这个...
欢迎 你 发表评论:
- 一周热门
- 最近发表
-
- 5 分钟搭建 Node.js 微服务原型（node 微服务架构）
- 当前的前端，真的不配叫程序员吗?
- 聊聊asp.net中Web Api的使用（asp.net core web api教程）
- NodeJS中，listen Access:permission denied解决办法
- Hono — 下一代高性能web框架（天融信下一代vnp）
- 生活例子说明线程，简单明了（列举一个日常生活中的例子以程序的形式表示）
- Node实战006:自定义模块的创建和使用详解
- Node.js基本内容和知识点（node.js的概念）
- 干货 | 如何利用Node.js 构建分布式集群
- nodejs mongodb 实现简易留言板（node.js留言板）
- 标签列表
-
- MVC框架 (46)
- spring框架 (46)
- 框架图 (58)
- bootstrap框架 (43)
- flask框架 (53)
- quartz框架 (51)
- abp框架 (47)
- jpa框架 (47)
- laravel框架 (46)
- express框架 (43)
- springmvc框架 (49)
- 分布式事务框架 (65)
- scrapy框架 (56)
- shiro框架 (61)
- java框架spring (43)
- grpc框架 (55)
- ppt框架 (48)
- 内联框架 (52)
- winform框架 (46)
- gui框架 (44)
- cad怎么画框架 (58)
- ps怎么画框架 (47)
- ssm框架实现登录注册 (49)
- oracle字符串长度 (48)
- oracle提交事务 (47)