Go语言学习--Gin框架之响应

double_happy1112024-03-22 10:38

Go语言学习--Gin框架之响应

文章目录

  • Go语言学习--Gin框架之响应
    • [1. 响应类型为string](#1. 响应类型为string)
    • [2. 响应类型为JSON](#2. 响应类型为JSON)
      • [2.1 不带json的tag](#2.1 不带json的tag)
      • [2.2 带json的tag](#2.2 带json的tag)
      • [2.3 不需要使用的tag](#2.3 不需要使用的tag)
      • [2.4 响应map](#2.4 响应map)
      • [2.5 直接响应json](#2.5 直接响应json)
    • [3. 响应类型为xml](#3. 响应类型为xml)
    • [4. 响应类型为yaml](#4. 响应类型为yaml)
    • [5. 代码](#5. 代码)

1. 响应类型为string

  • stringResponse.go
shell 复制代码 
package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

// 当客户端以GET方法请求/string路径时, 执行以下函数
func StringResponse(c *gin.Context) {
	c.String(http.StatusOK, "This is string response")
}

func main() {
	// 创建默认路由引擎
	r := gin.Default()

	// GET：请求方式；/string：请求的路径
	// 当客户端以GET方法请求/string路径时，会执行StringResponse函数
	r.GET("/string", StringResponse)

	// 启动HTTP服务，监听本机的8080端口
	r.Run(":8080")
}
  • 运行程序
  • 浏览器访问
shell 复制代码 
# 在浏览器的地址栏输入 http://127.0.0.1:8080/string

# 浏览器的响应结果
This is string response
  • 监听结果
shell 复制代码 
[GIN] 2024/03/21 - 16:38:34 | 200 |            0s |       127.0.0.1 | GET      "/string"

2. 响应类型为JSON

2.1 不带json的tag

  • jsonResponse.go
shell 复制代码 
package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

// 当客户端以GET方法请求/json路径时, 执行以下函数
func JsonResponse(c *gin.Context) {
	type UserInfo struct {
		UserName string 
		Age      int   
	}
	user := UserInfo{UserName: "json", Age: 20}
	c.JSON(http.StatusOK, user)
}

func main() {
	// 创建默认路由引擎
	r := gin.Default()

	// GET：请求方式；/json：请求的路径
	// 当客户端以GET方法请求/json路径时，会执行JsonResponse函数
	r.GET("/json", JsonResponse)

	// 启动HTTP服务，监听本机的8080端口
	r.Run(":8080")
}
  • 运行程序
  • 浏览器访问
shell 复制代码 
# 在浏览器的地址栏输入 http://127.0.0.1:8080/json

# 浏览器的响应结果
{"UserName":"json","Age":20}
  • 监听结果
shell 复制代码 
[GIN] 2024/03/21 - 16:44:02 | 200 |       676.3µs |       127.0.0.1 | GET      "/json"

2.2 带json的tag

  • jsonResponse.go
shell 复制代码 
package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

// 当客户端以GET方法请求/json路径时, 执行以下函数
func JsonResponse(c *gin.Context) {
	type UserInfo struct {
		UserName string `json:"user_name"`
		Age      int    `json:"age"`
	}
	user := UserInfo{UserName: "json", Age: 20}
	c.JSON(http.StatusOK, user)
}

func main() {
	// 创建默认路由引擎
	r := gin.Default()

	// GET：请求方式；/json：请求的路径
	// 当客户端以GET方法请求/json路径时，会执行JsonResponse函数
	r.GET("/json", JsonResponse)

	// 启动HTTP服务，监听本机的8080端口
	r.Run(":8080")
}
  • 运行程序
  • 浏览器访问
shell 复制代码 
# 在浏览器的地址栏输入 http://127.0.0.1:8080/json

# 浏览器的响应结果
{"user_name":"json","age":20}
  • 监听结果
shell 复制代码 
[GIN] 2024/03/21 - 16:48:58 | 200 |      1.0047ms |       127.0.0.1 | GET      "/json"

2.3 不需要使用的tag

  • jsonResponse.go
shell 复制代码 
package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

// 当客户端以GET方法请求/json路径时, 执行以下函数
func JsonResponse(c *gin.Context) {
	type UserInfo struct {
		UserName string `json:"user_name"`
		Age      int    `json:"age"`
		// 当有些内容不适合暴露是，可以使用"-"来忽略转化成json格式
		Password string `json:"-"`
	}
	user := UserInfo{UserName: "json", Age: 20}
	c.JSON(http.StatusOK, user)
}

func main() {
	// 创建默认路由引擎
	r := gin.Default()

	// GET：请求方式；/json：请求的路径
	// 当客户端以GET方法请求/json路径时，会执行JsonResponse函数
	r.GET("/json", JsonResponse)

	// 启动HTTP服务，监听本机的8080端口
	r.Run(":8080")
}
  • 运行程序
  • 浏览器访问
shell 复制代码 
# 在浏览器的地址栏输入 http://127.0.0.1:8080/json

# 浏览器的响应结果
{"user_name":"json","age":20}
  • 监听结果
shell 复制代码 
[GIN] 2024/03/21 - 16:54:03 | 200 |            0s |       127.0.0.1 | GET      "/json"

2.4 响应map

  • jsonResponse.go
shell 复制代码 
package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

// 当客户端以GET方法请求/json路径时, 执行以下函数
func JsonResponse(c *gin.Context) {
	c.JSON(http.StatusOK, map[string]string{"userName": "json", "age": "10"})
}

func main() {
	// 创建默认路由引擎
	r := gin.Default()

	// GET：请求方式；/json：请求的路径
	// 当客户端以GET方法请求/json路径时，会执行JsonResponse函数
	r.GET("/json", JsonResponse)

	// 启动HTTP服务，监听本机的8080端口
	r.Run(":8080")
}
  • 运行程序
  • 浏览器访问
shell 复制代码 
# 在浏览器的地址栏输入 http://127.0.0.1:8080/json

# 浏览器的响应结果
{"age":"10","userName":"json"}
  • 监听结果
shell 复制代码 
[GIN] 2024/03/21 - 17:01:41 | 200 |            0s |       127.0.0.1 | GET      "/json"

2.5 直接响应json

  • jsonResponse.go
shell 复制代码 
package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

// 当客户端以GET方法请求/json路径时, 执行以下函数
func JsonResponse(c *gin.Context) {
	c.JSON(http.StatusOK, gin.H{
		"userName": "json",
		"age":      "10",
	})
}

func main() {
	// 创建默认路由引擎
	r := gin.Default()

	// GET：请求方式；/json：请求的路径
	// 当客户端以GET方法请求/json路径时，会执行JsonResponse函数
	r.GET("/json", JsonResponse)

	// 启动HTTP服务，监听本机的8080端口
	r.Run(":8080")
}
  • 运行程序
  • 浏览器访问
shell 复制代码 
# 在浏览器的地址栏输入 http://127.0.0.1:8080/json

# 浏览器的响应结果
{"age":"10","userName":"json"}
  • 监听结果
shell 复制代码 
[GIN] 2024/03/21 - 17:05:22 | 200 |            0s |       127.0.0.1 | GET      "/json"

3. 响应类型为xml

  • xmlResponse.go
shell 复制代码 
package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

// 当客户端以GET方法请求/xml路径时, 执行以下函数
func XmlResponse(c *gin.Context) {
	c.XML(http.StatusOK, gin.H{
		"UserName": "张三",
		"Age":      20,
		"Sex":      "男",
	})
}

func main() {
	// 创建默认路由引擎
	r := gin.Default()

	// GET：请求方式；/xml：请求的路径
	// 当客户端以GET方法请求/xml路径时，会执行XmlResponse函数
	r.GET("/xml", XmlResponse)

	// 启动HTTP服务，监听本机的8080端口
	r.Run(":8080")
}
  • 运行程序
  • 浏览器访问
shell 复制代码 
# 在浏览器的地址栏输入 http://127.0.0.1:8080/json

# 浏览器的响应结果
<map>
  <UserName>张三</UserName>
  <Age>20</Age>
  <Sex>男</Sex>
</map>
  • 监听结果
shell 复制代码 
[GIN] 2024/03/21 - 17:14:14 | 200 |      1.0007ms |       127.0.0.1 | GET      "/xml"

4. 响应类型为yaml

  • xmlResponse.go
shell 复制代码 
package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

// 当客户端以GET方法请求/xml路径时, 执行以下函数
func XmlResponse(c *gin.Context) {
	c.XML(http.StatusOK, gin.H{
		"UserName": "张三",
		"Age":      20,
		"Sex":      "男",
	})
}

func main() {
	// 创建默认路由引擎
	r := gin.Default()

	// GET：请求方式；/xml：请求的路径
	// 当客户端以GET方法请求/xml路径时，会执行XmlResponse函数
	r.GET("/xml", XmlResponse)

	// 启动HTTP服务，监听本机的8080端口
	r.Run(":8080")
}
  • 运行程序
  • 浏览器访问
shell 复制代码 
# 在浏览器的地址栏输入 http://127.0.0.1:8080/json

# 浏览器的响应结果
# 浏览器会执行下载操作，文件内容如下：
Age: 20
Sex: 男
UserName: 张三
  • 监听结果
shell 复制代码 
[GIN] 2024/03/21 - 17:23:54 | 200 |            0s |       127.0.0.1 | GET      "/yaml"

5. 代码

  • response.go
shell 复制代码 
package main

import (
	"net/http"

	"github.com/gin-gonic/gin"
)

// 当客户端以GET方法请求/string路径时, 执行以下函数
func StringResponse(c *gin.Context) {
	c.String(http.StatusOK, "This is string response")
}

// 当客户端以GET方法请求/json路径时, 执行以下函数
func JsonResponse(c *gin.Context) {
	//type UserInfo struct {
	//	UserName string `json:"user_name"`
	//	Age      int    `json:"age"`
	//	Password string `json:"-"`
	//}
	//user := UserInfo{UserName: "json", Age: 20, Password: "123456"}
	//c.JSON(http.StatusOK, user)

	//c.JSON(http.StatusOK, map[string]string{"userName": "json", "age": "10"})

	c.JSON(http.StatusOK, gin.H{
		"userName": "json",
		"age":      "10",
	})
}

// 当客户端以GET方法请求/xml路径时, 执行以下函数
func XmlResponse(c *gin.Context) {
	c.XML(http.StatusOK, gin.H{
		"UserName": "张三",
		"Age":      20,
		"Sex":      "男",
	})
}

// 当客户端以GET方法请求/yaml路径时, 执行以下函数
func YamlResponse(c *gin.Context) {
	c.YAML(http.StatusOK, gin.H{
		"UserName": "张三",
		"Age":      20,
		"Sex":      "男",
	})
}

func main() {
	// 创建默认路由引擎
	r := gin.Default()

	// GET：请求方式；/string：请求的路径
	// 当客户端以GET方法请求/string路径时，会执行StringResponse函数
	r.GET("/string", StringResponse)

	// GET：请求方式；/json：请求的路径
	// 当客户端以GET方法请求/json路径时，会执行JsonResponse函数
	r.GET("/json", JsonResponse)

	// GET：请求方式；/xml：请求的路径
	// 当客户端以GET方法请求/xml路径时，会执行XmlResponse函数
	r.GET("/xml", XmlResponse)

	// GET：请求方式；/yaml：请求的路径
	// 当客户端以GET方法请求/yaml路径时，会执行YamlResponse函数
	r.GET("/yaml", YamlResponse)

	// 启动HTTP服务，监听本机的8080端口
	r.Run(":8080")
}
相关推荐
stark张宇7 天前
微服务架构必备：Gin + gRPC + Consul + Nacos + GORM 打造用户服务
微服务·gin·grpc
刀法如飞10 天前
一款Go语言Gin框架MVC脚手架，满足大部分场景
go·mvc·gin
花酒锄作田11 天前
Gin 框架中的规范响应格式设计与实现
golang·gin
西岸行者11 天前
学习笔记：SKILLS 能帮助更好的vibe coding
笔记·学习
悠哉悠哉愿意11 天前
【单片机学习笔记】串口、超声波、NE555的同时使用
笔记·单片机·学习
别催小唐敲代码11 天前
嵌入式学习路线
学习
毛小茛11 天前
计算机系统概论——校验码
学习
babe小鑫11 天前
大专经济信息管理专业学习数据分析的必要性
学习·数据挖掘·数据分析
winfreedoms11 天前
ROS2知识大白话
笔记·学习·ros2
在这habit之下11 天前
Linux Virtual Server（LVS）学习总结
linux·学习·lvs
热门推荐
01GitHub 镜像站点02OpenClaw 使用和管理 MCP 完全指南03OpenClaw 连接飞书完整指南：插件安装、配置与踩坑记录04Window 10部署openclaw报错node.exe : npm error code 12805本地部署 OpenClaw + DeepSeek-R1 完全指南06OpenClaw + 飞书（Feishu）环境搭建指南07npm-error code 128问题解决方法08Clawdbot部署教程：解决‘gateway token missing’授权问题的完整步骤09Claude Code + GLM4.7 避坑指南：解决 Unable to connect to Anthropic services10OpenClaw 飞书机器人不回复消息？3 小时踩坑总结