今日份学习笔记
gin学习知识点:
GET/POST接口编写方法- 解析
JSON参数,并绑定到对象- 解析
Header参数,并绑定到对象logrus日志的基本使用
0x01 完整代码
- 完整代码
先上完整代码 , 有用到第三方依赖的地方, 请自行go get -u XXX即可.
package main
import (
"net/http"
"os"
"time"
"github.com/gin-gonic/gin"
"github.com/sirupsen/logrus"
)
var log = logrus.New()
func init() {
fileName := "D:\\go_base\\src\\go_study\\info.log"
src, _ := os.OpenFile(fileName, os.O_APPEND|os.O_WRONLY, os.ModeAppend)
log.Out = src
log.SetLevel(logrus.InfoLevel)
log.SetFormatter(&logrus.TextFormatter{})
}
func main() {
r := gin.Default()
r.Use(LoggerToFile())
r.GET("/ping", func(c *gin.Context) {
c.String(http.StatusOK, "pong")
log.Infof("hello info")
})
// URL路径参数
r.GET("/user/:name", func(c *gin.Context) {
user := c.Params.ByName("name")
c.JSON(http.StatusOK, gin.H{"user": user})
log.Infof("user")
})
// URL后面的请求参数
r.GET("/guide", func(c *gin.Context) {
name := c.DefaultQuery("name", "gorey")
c.JSON(200, gin.H{"name": name})
})
// 解析JSON请求
r.POST("/login", func(c *gin.Context) {
var header MyHeader
var param Login
// 解析Header
if c.BindHeader(&header) != nil {
c.JSON(200, gin.H{"err": "invalid header"})
return
}
// 解析JSON
if c.BindJSON(¶m) != nil {
c.JSON(200, gin.H{"err": "invalid param"})
return
}
c.JSON(200, gin.H{"hello": param.Username, "world": param.Password, "from": header.From})
})
r.Run(":80")
}
type Login struct {
Username string `json:"user" binding:"required"`
Password string `json:"password"`
}
type MyHeader struct {
From string `header:"from" binding:"required"`
Version int `header:"version"`
}
// Logrus 日志
func LoggerToFile() gin.HandlerFunc {
fileName := "D:\\go_base\\src\\go_study\\gin.log"
src, _ := os.OpenFile(fileName, os.O_APPEND|os.O_WRONLY, os.ModeAppend)
logger := logrus.New()
logger.Out = src
logger.SetLevel(logrus.DebugLevel)
logger.SetFormatter(&logrus.TextFormatter{})
return func(c *gin.Context) {
startTime := time.Now()
// 处理请求
c.Next()
// 结束时间
endTime := time.Now()
// 执行时间
latencyTime := endTime.Sub(startTime)
// 请求方式
reqMethod := c.Request.Method
// 请求路由
reqUri := c.Request.RequestURI
// 状态码
statusCode := c.Writer.Status()
// 请求IP
clientIP := c.ClientIP()
// 日志格式
logger.Infof("| %3d | %13v | %15s | %s | %s |",
statusCode,
latencyTime,
clientIP,
reqMethod,
reqUri,
)
}
}
0x02 知识点详解
-
POST请求方法
// 解析JSON请求
r.POST("/login", func(c *gin.Context) {
var header MyHeader
var param Login
// 解析Header
if c.BindHeader(&header) != nil {
c.JSON(200, gin.H{"err": "invalid header"})
return
}
// 解析JSON
if c.BindJSON(¶m) != nil {
c.JSON(200, gin.H{"err": "invalid param"})
return
}
c.JSON(200, gin.H{"hello": param.Username, "world": param.Password, "from": header.From})
})
我们在接口开发时, 比较常用的一种接口交互方式为: 以
POST方式提交JSON格式参数.
同时,在Header部添加附加参数信息.为了方便处理请求参数, 我们习惯性的会把请求参数自动封装到一个实体类里.这个过程称之为绑定(
Bind)
可以看到, gin.Context已经提供了BindHeader()和BindJSON()方法为我们解决此类问题.
入参为一个struct对象的引用.
那么, 绑定过程失败的话, 就会返回一个error,所以需要对每次绑定过程, 都添加异常处理.
- 接一下看一下
struct的写法:
type Login struct {
Username string `json:"user" binding:"required"`
Password string `json:"password"`
}
type MyHeader struct {
From string `header:"from" binding:"required"`
Version int `header:"version"`
}
以下面这行语句为例, 进行说明 :
Username string `json:"user" binding:"required"`
Username string定义了内部参数名称, 之所以定义为大写开头, 表示此属性为public访问权限json:"user"意思是:这个struct在解析json时, 它会自动绑定的json keybinding:"required"是否必需包含此参数. 如果请求参数里 没有这个key,在绑定操作时会返回异常.
-
JSON输出
c.JSON(200, gin.H{"err": "invalid header"})
gin.Context支持多种输出格式的渲染.
这里我们需要返回JSON,可以直接使用 c.JSON()方法.
第一个参数为 http status code, 可以写为http.StatusOK, 也可以直接写成 200.
第二个参数 g.H, 其实是 type H map[string]interface{}, 类似于java里的Map对象.
0x03 在方法内部打印logrus日志
目前网上查到使用比较多的go日志就是 https://github.com/sirupsen/logrus
这里介绍一下最基础的使用方法和注意点:
- 在方法内部打日志
var log = logrus.New()
func init() {
fileName := "D:\\go_base\\src\\go_study\\info.log"
src, _ := os.OpenFile(fileName, os.O_APPEND|os.O_WRONLY, os.ModeAppend)
log.Out = src
log.SetLevel(logrus.InfoLevel)
log.SetFormatter(&logrus.TextFormatter{})
}
首先我们需求创建一个日志对象 log, 需要设定日志文件位置和输出格式.
接下来, 就可以在方法里像java一样使用:
log.Infof("user")
需要注意的是: 这个日志文件,需要先手动创建. 否则会报错
0x04 以监听器的方式使用日志
代码最后是一个 gin.HandlerFunc的生成器.
它是以gin中间件的形式执行: r.Use(LoggerToFile())
// Logrus 日志
func LoggerToFile() gin.HandlerFunc {
fileName := "D:\\go_base\\src\\go_study\\gin.log"
src, _ := os.OpenFile(fileName, os.O_APPEND|os.O_WRONLY, os.ModeAppend)
logger := logrus.New()
logger.Out = src
logger.SetLevel(logrus.DebugLevel)
logger.SetFormatter(&logrus.TextFormatter{})
return func(c *gin.Context) {
startTime := time.Now()
// 处理请求
c.Next()
// 结束时间
endTime := time.Now()
// 执行时间
latencyTime := endTime.Sub(startTime)
// 请求方式
reqMethod := c.Request.Method
// 请求路由
reqUri := c.Request.RequestURI
// 状态码
statusCode := c.Writer.Status()
// 请求IP
clientIP := c.ClientIP()
// 日志格式
logger.Infof("| %3d | %13v | %15s | %s | %s |",
statusCode,
latencyTime,
clientIP,
reqMethod,
reqUri,
)
}
}
- 代码功能
这一长块代码的功能是: 记录每一次客户端请求的处理时长, 和其他信息, 并写入外部日志文件.
可以看到,c.Next()就是执行原定方法的过程,
那么我们不难理解,这其实与Spring的AOP切面编程是一个道理.
startTime := time.Now()
// 处理请求
c.Next()
// 结束时间
endTime := time.Now()
0x05 TODO
logrus日志
使用起来配置项有点多, 而且这里还没涉及日志文件的回滚.
日志这一块, 还需要详细研究一下. 甚至独立出一篇笔记.参数校验
今天看到gin项目里自定义校验例子代码,略为复杂, 后面再行研究体验
与Java比起来代码量变少了很多, 码起来还是有种很轻快的感觉(错觉).
0x06 零散知识点
-
Java版的StringBuffer操作
buffer := bytes.NewBufferString("")
for _, v := range str {
buffer.WriteString(v)
buffer.WriteString(sep)
}
return buffer.String()
