Gin框架问题
1.初始化/hello
r := gin.Default()//初始化路由
r.GET("/hello",sayhello)
r.Run() //默认8080端口 ":9090" 自定义端口
//sayhello方法实现
func sayhello(c *gin.Context){
//以下是返回json形式
c.JSON(200,gin.H{
"message":"map数组而已",
"message2":"blunt",
})
}
2.匹配模式
// 此规则能够匹配/user/john这种格式,但不能匹配/user/ 或 /user这种格式
r.GET("/user/:name", func(c *gin.Context) {
name := c.Param("name")
c.String(http.StatusOK, "Hello %s", name)
})
// 但是,这个规则既能匹配/user/john/格式也能匹配/user/john/send这种格式
// 如果没有其他路由器匹配/user/john,它将重定向到/user/john/
r.GET("/user/:name/*action", func(c *gin.Context) {
name := c.Param("name")
action := c.Param("action")
message := name + " is " + action
c.String(http.StatusOK, message)
})
3.获取GET参数
//http://localhost:8080/welcome?firstname=simon&lastname=heihei
r.GET("/welcome", func(c *gin.Context) {
firstname := c.DefaultQuery("firstname","Guest") //填充一个默认值。如果没有firstname 则返回Guest
lastname := c.Query("lastname") // 获取get url中的这个参数 如果没有得到 则为空
c.String(http.StatusOK,"Hello %s %s", firstname, lastname)
})
4.获取post参数
//localhost:8080/form_post
r.POST("/form_post", func(c *gin.Context) {
message := c.PostForm("message")
nick := c.DefaultPostForm("nick","any") //填充一个默认值。 如果没有 则返回any
c.JSON(http.StatusOK,gin.H{
"status":"posted",
"message":message,
"nick":nick,
})
})
5.Get + Post 混合
r.POST("/post", func(c *gin.Context) {
id := c.Query("id") // 从请求头拿出字段
page := c.DefaultQuery("page","0")
name := c.PostForm("name") //从post参数拿出字段
message := c.PostForm("message")
c.String(200,"id: %s; page: %s; name: %s; message: %s", id, page, name, message)
})
6.文件上传
6.1单文件上传
r.MaxMultipartMemory = 8 << 20 //这里默认最大为32m 8 << 20 为8m 设置为8兆
r.POST("/upload", func(c *gin.Context) {
//从请求中拿到文件流
file ,err := c.FormFile("file")
if err != nil{
panic(err)
c.JSON(500,gin.H{
"message" : "上传文件出错",
})
}
log.Println(file.Filename)//打印日志
//有时间再细化
// 如果没有upload目录 将无法存储 但也不会抛出异常
// 存入upload目录下 并为他署名
dst := path.Join("./upload",file.Filename)
//保存文件
c.SaveUploadedFile(file,dst)
//返回字符串
c.String(http.StatusOK, fmt.Sprintf("'%s' uploaded!", file.Filename))
})
6.2多文件上传
r.POST("/upload2", func(c *gin.Context) {
form,_ := c.MultipartForm()
files := form.File["upload[]"]
for _,file := range files {
log.Println(file.Filename)
//加存储方法
}
c.String(200,fmt.Sprintf("%d files uploaded!", len(files)))
})
7.路由分组
// Simple group: v1
v1 := r.Group("/v1") //组名
{
v1.POST("/login", func(c *gin.Context) {
c.String(200,"1")
})
v1.POST("/submit", func(c *gin.Context) {
c.String(200,"2")
})
v1.POST("/read", func(c *gin.Context) {
c.String(200,"3")
})
}
// Simple group: v2
v2 := r.Group("/v2")//组名
{
v2.POST("/login", func(c *gin.Context) {
c.String(200,"4")
})
v2.POST("/submit", func(c *gin.Context) {
c.String(200,"5")
})
v2.POST("/read", func(c *gin.Context) {
c.String(200,"6")
})
v2.POST("/out " , func(c *gin.Context) {
c.String(200, "111")
})
}
8.无中间件启动
r := gin.New()
代替
r := gon.Defailt() // 默认启动方式,包含 Logger、Recovery 中间件
9.使用中间件
func main() {
// 创建一个不包含中间件的路由器
r := gin.New()
// 全局中间件
// 使用 Logger 中间件
r.Use(gin.Logger())
// 使用 Recovery 中间件
r.Use(gin.Recovery())
// 路由添加中间件,可以添加任意多个
r.GET("/benchmark", MyBenchLogger(), benchEndpoint)
// 路由组中添加中间件
// authorized := r.Group("/", AuthRequired())
// exactly the same as:
authorized := r.Group("/")
// per group middleware! in this case we use the custom created
// AuthRequired() middleware just in the "authorized" group.
authorized.Use(AuthRequired()) //这里就可以实现不同组的过滤器
{
authorized.POST("/login", loginEndpoint)
authorized.POST("/submit", submitEndpoint)
authorized.POST("/read", readEndpoint)
// nested group
testing := authorized.Group("testing") //组中组
testing.GET("/analytics", analyticsEndpoint)
}
// Listen and serve on 0.0.0.0:8080
r.Run(":8080")
}
10.写入日志文件
func main() {
// 禁用控制台颜色
gin.DisableConsoleColor()
// 创建记录日志的文件
f, _ := os.Create("gin.log")
gin.DefaultWriter = io.MultiWriter(f)
// 如果需要将日志同时写入文件和控制台,请使用以下代码
// gin.DefaultWriter = io.MultiWriter(f, os.Stdout)
router := gin.Default()
router.GET("/ping", func(c *gin.Context) {
c.String(200, "pong")
})
router.Run(":8080")
}
11.自定义日志输出
func main() {
router := gin.New()
// LoggerWithFormatter 中间件会将日志写入 gin.DefaultWriter
// By default gin.DefaultWriter = os.Stdout
router.Use(gin.LoggerWithFormatter(func(param gin.LogFormatterParams) string {
// 你的自定义格式
return fmt.Sprintf("%s - [%s] \"%s %s %s %d %s \"%s\" %s\"\n",
param.ClientIP,
param.TimeStamp.Format(time.RFC1123),
param.Method,
param.Path,
param.Request.Proto,
param.StatusCode,
param.Latency,
param.Request.UserAgent(),
param.ErrorMessage,
)
}))
router.Use(gin.Recovery())
router.GET("/ping", func(c *gin.Context) {
c.String(200, "pong")
})
router.Run(":8080")
}
demo
func main() {
//禁用控制台颜色
gin.DisableConsoleColor()
//创建记录日志文件
f,err := os.Create("gin.log")
if err != nil {
panic(err)
}
gin.DefaultWriter = io.MultiWriter(f,os.Stdout)
r := gin.New()
r.Use(gin.LoggerWithFormatter(func(param gin.LogFormatterParams) string {
// 你的自定义格式
return fmt.Sprintf("%s - [%s] \"%s %s %s %d %s \"%s\" %s\"\n",
param.ClientIP,
param.TimeStamp.Format(time.RFC1123),
param.Method,
param.Path,
param.Request.Proto,
param.StatusCode,
param.Latency,
param.Request.UserAgent(),
param.ErrorMessage,
)
}))
r.Use(gin.Recovery())
r.GET("/pong", func(c *gin.Context) {
c.String(200,"hello")
})
r.Run()
}
12模型绑定和验证
package main
import (
"github.com/gin-gonic/gin"
"net/http"
)
// 绑定为json
type Login struct {
User string `form:"user" json:"user" xml:"user" binding:"required"`
Password string `form:"password" json:"password" xml:"password" binding:"required"`
}
func main() {
router := gin.Default()
// Example for binding JSON ({"user": "manu", "password": "123"})
router.POST("/loginJSON", func(c *gin.Context) {
var json Login
if err := c.ShouldBindJSON(&json); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
if json.User != "manu" || json.Password != "123" {
c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
return
}
c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
})
// Example for binding XML (
// <?xml version="1.0" encoding="UTF-8"?>
// <root>
// <user>user</user>
// <password>123</password>
// </root>)
router.POST("/loginXML", func(c *gin.Context) {
var xml Login
if err := c.ShouldBindXML(&xml); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
if xml.User != "manu" || xml.Password != "123" {
c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
return
}
c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
})
// Example for binding a HTML form (user=manu&password=123)
router.POST("/loginForm", func(c *gin.Context) {
var form Login
// This will infer what binder to use depending on the content-type header.
if err := c.ShouldBind(&form); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
if form.User != "manu" || form.Password != "123" {
c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
return
}
c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
})
// Listen and serve on 0.0.0.0:8080
router.Run(":8080")
}
要用json格式发送
13 自定义验证器
注意包引用
github.com/go-playground/validator/v10 //使用此包 方法定义会报错 可能是新出的包 暂时没有多研究
gopkg.in/go-playground/validator.v8
遗留问题 没跑通
package main
import (
"fmt"
"net/http"
"time"
"github.com/gin-gonic/gin"
"github.com/gin-gonic/gin/binding"
"github.com/go-playground/validator/v10"
)
// Booking contains binded and validated data.
type Booking struct {
CheckIn time.Time `form:"check_in" binding:"required,bookabledate" time_format:"2006-01-02"`
CheckOut time.Time `form:"check_out" binding:"required,gtfield=CheckIn" time_format:"2006-01-02"`
}
func bookableDate( f validator.FieldLevel) bool {
/* if date, ok := f.FieldName().(time.Time); ok {
today := time.Now()
if today.Year() > date.Year() || today.YearDay() > date.YearDay() {
return false
}
}*/
fmt.Println(f.FieldName())
fmt.Println(f.Field())
fmt.Println(f.GetTag())
fmt.Println(f.StructFieldName())
fmt.Println(f.Top())
fmt.Println(f.Field())
fmt.Println(f.Field())
fmt.Println(f.Field())
fmt.Println(f.Field())
fmt.Println(f.Field())
return true
}
func main() {
route := gin.Default()
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
v.RegisterValidation("bookabledate", bookableDate,)
}
route.GET("/bookable", getBookable)
route.Run()
}
func getBookable(c *gin.Context) {
var b Booking
if err := c.ShouldBindWith(&b, binding.Query); err == nil {
c.JSON(http.StatusOK, gin.H{"message": "Booking dates are valid!"})
} else {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
}
}
14 只绑定get请求
func main() {
r := gin.Default()
r.Any("/testing", func(c *gin.Context) {
var person Person
if c.BindQuery(&person)==nil {
log.Println("=====Only bind by Query String =======")
log.Println(person.Name)
log.Println(person.Address)
}
c.String(200,"success")
})
r.Run()
}
type Person struct {
Name string `form : "name" `
Address string `form : "address" `
}
文档上使用的是c.ShouldBindQuery方法 但是无法接收到参数内容 改用 c.BIndQuery() get请求可以获取到参数内容
POST请求无法获取到参数。
15.绑定Get参数或者Post参数
package main
import (
"github.com/gin-gonic/gin"
"log"
"time"
)
func main() {
r := gin.Default()
r.POST("/testing",startPage)
r.Run()
}
type Person struct {
Name string `form:"name" ` //这里一定不要有空格 很重要不然 接不到参数
Address string `form:"address" `
Birthday time.Time `form:"birthday" time_format:"2006-01-02" time_utc :"1" `
}
func startPage(c *gin.Context){
var person Person
if c.ShouldBind(&person) == nil {
log.Println(person.Name)
log.Println(person.Address)
log.Println(person.Birthday)
}
c.String(200,"success")
}
16 绑定html复选框
type myForm struct {
Colors []string `form:"colors[]"`
}
...
func formHandler(c *gin.Context) {
var fakeForm myForm
c.ShouldBind(&fakeForm)
c.JSON(200, gin.H{"color": fakeForm.Colors})
}
<form action="/" method="POST">
<p>Check some colors</p>
<label for="red">Red</label>
<input type="checkbox" name="colors[]" value="red" id="red">
<label for="green">Green</label>
<input type="checkbox" name="colors[]" value="green" id="green">
<label for="blue">Blue</label>
<input type="checkbox" name="colors[]" value="blue" id="blue">
<input type="submit">
</form>