gin框架使用系列之四——json和protobuf的渲染

news2024/11/29 2:51:07

系列目录
- 《gin框架使用系列之一——快速启动和url分组》
- 《gin框架使用系列之二——uri占位符和占位符变量的获取》
- 《gin框架使用系列之三——获取表单数据》

上篇我们介绍了如何获取数据，本篇我们介绍一下如何返回固定格式的数据。

一、返回JSON数据

在web开发中，我们最常用的数据传输格式就是json数据，其视前面的示例中我们都是返回的json数据，在这里我们再做一个总结，在gin中，我们使用c.JSON()函数来返回json数据，其中第一个参数是返回的状态码，第二个是具体的数据,在这里，我们并不需要将具体的对象转换成json然后再发出，只需要将对象传入即可，JSON()函数内部会帮我们转换好数据，

type Message struct {
	Msg    string
	Number int
	Name   string
}
func main() {
	router := gin.Default()
	router.GET("/moreJSON", func(c *gin.Context) {
		msg := Message{
			Number: 12,
			Name:   "hong",
			Msg:    "测试返回json",
		}
		c.JSON(http.StatusOK, msg)
	})
	router.Run() // listen and serve on 0.0.0.0:8080
}

当在浏览器中输入url时，会返回正确的json数据
在这里插入图片描述

二、返回protoBuf数据

相对于json数据，数据传输的方式还有proto，这种数据结构更加紧凑，因此在网络要求比较严格的情况下，经常使用proto的数据格式进行数据的传输。proto的数据格式相关的内容，可以自行下来了解以下，我后续也会新增这方面的博客，本篇主要讲解数据在gin中的使用

首先我们需要编写一个proto文件，新建一个Message.proto文件，内容如下

syntax = "proto3";

option go_package = ".;proto";

message MessageProto {
  string Msg = 1;
  int32 Number = 2;
  string Name = 3;
}

然后在控制台找到编写的proto文件所在的目录，执行如下命令

 protoc --go_out=. --go-grpc_out=. Message.proto

这样就会生成对应的Message.pb.go文件，然后编写如下的代码，返回proto数据

func main() {
	router := gin.Default()
	router.GET("/more_protoBuf", func(c *gin.Context) {
		msg := proto.MessageProto{
			Number: 55,
			Name:   "rouc",
			Msg:    "测试返回proto",
		}
		c.ProtoBuf(http.StatusOK, &msg)
	})

	router.Run() // listen and serve on 0.0.0.0:8080
}