Gin教程--路由与控制器设计（三）

一、路由设计

1.1 介绍

1.1.1 什么是路由

路由就是URL到函数的映射，确定数据交换和页面展现的目标。

 

1.1.2 什么是路由组

就是相同路由前缀的路由集合，例如/admin下可以有用户、设置等等。

 

1.2 请求方式

请求方式	介绍	备注
Get	Get请求，一般用于查询数据的请求
Post	Post请求，一般用于创建数据的请求
Put	一般用于修改数据的请求
Delete	一般用于删除操作的请求
Patch	和Put一样的功能，唯一的不同是，这个是非幂等性的操作
Head	HTTP方法请求将返回的标头
Options	HTTP方法请求给定URL或服务器允许的通信选项

 

1.3 请求头参数

应答头	说明	备注
Allow	服务器支持哪些请求方法（如GET、POST等）。
Content-Encoding	文档的编码（Encode）方法。只有在解码之后才可以得到Content-Type头指定的内容类型。利用gzip压缩文档能够显著地减少HTML文档的下载时间。Java的GZIPOutputStream可以很方便地进行gzip压缩，但只有Unix上的Netscape和Windows上的IE 4、IE 5才支持它。因此，Servlet应该通过查看Accept-Encoding头（即request.getHeader(“Accept-Encoding”)）检查浏览器是否支持gzip，为支持gzip的浏览器返回经gzip压缩的HTML页面，为其他浏览器返回普通页面。
Content-Length	表示内容长度。只有当浏览器使用持久HTTP连接时才需要这个数据。如果你想要利用持久连接的优势，可以把输出文档写入 ByteArrayOutputStream，完成后查看其大小，然后把该值放入Content-Length头，最后通过byteArrayStream.writeTo(response.getOutputStream()发送内容。
Content-Type	表示后面的文档属于什么MIME类型。Servlet默认为text/plain，但通常需要显式地指定为text/html。由于经常要设置Content-Type，因此HttpServletResponse提供了一个专用的方法setContentType。
Date	当前的GMT时间。你可以用setDateHeader来设置这个头以避免转换时间格式的麻烦。
Expires	应该在什么时候认为文档已经过期，从而不再缓存它？
Last-Modified	文档的最后改动时间。客户可以通过If-Modified-Since请求头提供一个日期，该请求将被视为一个条件GET，只有改动时间迟于指定时间的文档才会返回，否则返回一个304（Not Modified）状态。Last-Modified也可用setDateHeader方法来设置。
Location	表示客户应当到哪里去提取文档。Location通常不是直接设置的，而是通过HttpServletResponse的sendRedirect方法，该方法同时设置状态代码为302。
Refresh	表示浏览器应该在多少时间之后刷新文档，以秒计。除了刷新当前文档之外，你还可以通过setHeader(“Refresh”, “5; URL=http://host/path”)让浏览器读取指定的页面。 注意这种功能通常是通过设置HTML页面HEAD区的＜META HTTP-EQUIV=“Refresh” CONTENT=“5;URL=http://host/path"＞实现，这是因为，自动刷新或重定向对于那些不能使用CGI或Servlet的HTML编写者十分重要。但是，对于Servlet来说，直接设置Refresh头更加方便。 注意Refresh的意义是"N秒之后刷新本页面或访问指定页面”，而不是"每隔N秒刷新本页面或访问指定页面"。因此，连续刷新要求每次都发送一个Refresh头，而发送204状态代码则可以阻止浏览器继续刷新，不管是使用Refresh头还是＜META HTTP-EQUIV=“Refresh” …＞。 注意Refresh头不属于HTTP 1.1正式规范的一部分，而是一个扩展，但Netscape和IE都支持它。
Server	服务器名字。Servlet一般不设置这个值，而是由Web服务器自己设置。
Set-Cookie	设置和页面关联的Cookie。Servlet不应使用response.setHeader(“Set-Cookie”, …)，而是应使用HttpServletResponse提供的专用方法addCookie。参见下文有关Cookie设置的讨论。
WWW-Authenticate	客户应该在Authorization头中提供什么类型的授权信息？在包含401（Unauthorized）状态行的应答中这个头是必需的。例如，response.setHeader(“WWW-Authenticate”, “BASIC realm=＼“executives＼””)。 注意Servlet一般不进行这方面的处理，而是让Web服务器的专门机制来控制受密码保护页面的访问（例如.htaccess）。

 

1.4 路由实现方案

路由设计有两种方式，一种是直接在路由地址后面直接写函数，另一种的设计相关的控制器，将控制器引入到此处即可

func main() {
	router := gin.Default()

	// 此 handler 将匹配 /user/john 但不会匹配 /user/ 或者 /user
	router.GET("/user/:name", func(c *gin.Context) {
		name := c.Param("name")
		c.String(http.StatusOK, "Hello %s", name)
	})

	// 此 handler 将匹配 /user/john/ 和 /user/john/send
	// 如果没有其他路由匹配 /user/john，它将重定向到 /user/john/
	router.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)
	})

	router.Run(":8080")
}

LoginController是一个控制器，里面包含Login、Logout、Test等方法

package routers

import (
	"github.com/gin-gonic/gin"

	admin "zhao_god_service/app/controllers/Admin"
	"zhao_god_service/app/middlewares"
)

// 不需要鉴权登录的路由
func NotAuthRoutersInit(router *gin.Engine)  {
	NotAuthRouter := router.Group("/")
	NotAuthRouter.Use(middlewares.Logger("not_auth"))

	NotAuthRouter.POST("/login", admin.LoginController{}.Login)
	NotAuthRouter.POST("/logout", admin.LoginController{}.Logout)
	NotAuthRouter.POST("/test", admin.LoginController{}.Test)
}

路由组也有两种方式：一种是大括号，路由信息全部写入到这里，另一种是直接设定一个变量，用.的方式直接写，按我个人习惯，推荐使用第二种

第一种方案：

package main

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

func main() {
	router := gin.Default()

	// 简单的路由组: v1
	v1 := router.Group("/v1")
	{
		v1.POST("/login", loginEndpoint)
		v1.POST("/submit", submitEndpoint)
		v1.POST("/read", readEndpoint)
	}

	// 简单的路由组: v2
	v2 := router.Group("/v2")
	{
		v2.POST("/login", loginEndpoint)
		v2.POST("/submit", submitEndpoint)
		v2.POST("/read", readEndpoint)
	}

	router.Run(":8080")
}

第二种方案：

package main

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

func main() {
	router := gin.Default()

	// 简单的路由组: v1
	v1 := router.Group("/v1")
	v1.POST("/login", loginEndpoint)
	v1.POST("/submit", submitEndpoint)
	v1.POST("/read", readEndpoint)
	

	// 简单的路由组: v2
	v2 := router.Group("/v2")
	v2.POST("/login", loginEndpoint)
	v2.POST("/submit", submitEndpoint)
	v2.POST("/read", readEndpoint)
	
	router.Run(":8080")
}

 
 
 

二、控制器设计

2.1 介绍

控制器（Controller）是一个用于实现应用API定义的操作的类。它实现一个应用的业务逻辑，它实现了一个应用的业务逻辑，并作为“HTTP/REST API”和“域/数据库模型”之间的桥梁。

 

2.2 Gin的参数获取方式

2.2.1 Query

获取URL上的参数值数据

 

2.2.2 DefaultQuery

获取URL上的参数值数据，若没有此参数，则获取默认值

 

2.2.3 PostForm

获取Post请求中的表单或json等方式的参数

 

2.2.4 DefaultPostForm

获取Post请求中的表单或json等方式的参数，若请求参数中不存在此参数，则取当前设定的默认值

上面2.2.1 ~ 2.2.4 的方案示例：

func main() {
	router := gin.Default()

	router.POST("/post", func(c *gin.Context) {

		id := c.Query("id")
		page := c.DefaultQuery("page", "1")
        pageSize := c.DefaultQuery("pageSize", "20")
		name := c.PostForm("name")
		message := c.PostForm("message")
        title := c.DefaultPostForm("title", "First")

		fmt.Printf("id: %s; page: %s; pageSize: %s; name: %s; message: %s; title: %s", id, page, pageSize, name, message, title)
	})
	router.Run(":8080")
}

请求操作：

curl --location 'http://127.0.0.1:8080/post?id=1234&page=1' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'name=manu' \
--data-urlencode 'message=this_is_great'

输出结果：

id: 1234; page: 1; pageSize: 20; name: manu; message: this_is_great; title: First

 

2.2.5 ShouldBind 参数绑定

参数绑定，一般编写一个自定义结构体，然后进行绑定

package main

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

type LoginForm struct {
	User     string `form:"user" binding:"required"`
	Password string `form:"password" binding:"required"`
}

func main() {
	router := gin.Default()
	router.POST("/login", func(c *gin.Context) {
		// 你可以使用显式绑定声明绑定 multipart form：
		// c.ShouldBindWith(&form, binding.Form)
		// 或者简单地使用 ShouldBind 方法自动绑定：
		var form LoginForm
		// 在这种情况下，将自动选择合适的绑定
		if c.ShouldBind(&form) == nil {
			if form.User == "user" && form.Password == "password" {
				c.JSON(200, gin.H{"status": "you are logged in"})
			} else {
				c.JSON(401, gin.H{"status": "unauthorized"})
			}
		}
	})
	router.Run(":8080")
}

上面的from可以修改，有path、from、json等格式

2.2.6 获取Header参数

token := c.Request.Header.Get("Authorization")

2.3 控制器创建

package Admin

import (
	"github.com/gin-gonic/gin"

	"zhao_god_service/app/helpers"
)

type LoginController struct {
}

type LoginParams struct {
	UserName string `json:"user_name" binding:"required"`
	Password string `json:"password" binding:"required"`
}

func (login LoginController) Login(c *gin.Context) {
	var params LoginParams

	if c.ShouldBind(¶ms) == nil {
		// 获取用户名 和 密码
		passwordHas := md5.Sum([]byte(params.Password))
		passwordMd5 := fmt.Sprintf("%x", passwordHas) //将[]byte转成16进制
		passwordHas = md5.Sum([]byte(passwordMd5))
		passwordMd5 = fmt.Sprintf("%x", passwordHas) //将[]byte转成16进制

		fmt.Println(params.UserName)
		fmt.Println(passwordMd5)
		
		data := map[string]interface{}{}
	}

    c.JSONP(200, "登录控制器")
}

更多内容请去公众号【老罗分享】获取