gin/go面向接口设计

前言：在go语言中使用gin框架的时候，我们定义路由接口的时候，一般用包的方式直接使用方法名定义。这里介绍一种“服务契约”（源自wcf）的和“控制器继承”的概念，以达到更佳的设计。

正文：

先贴出本次演示的项目结构（注意：下面是常见的mvc架构）：

                                               

 

一、服务契约

在wcf中，注解关键词ServiceContract代表服务契约（表示与客户端约定的接口方法），实际上的就是通过interface来定义约定。通过这种设计，可以增加代码可读性以及可维护性。

如下，我们在userApis.go文件中定义接口，并在userController.go文件中实现它。这样，一方面，我们可以在检查我们的接口列表时可以快速浏览所有接口（而不是在controller层某个文件中通过折叠代码的方式浏览所有方法），二方面可以检查我们的interface里还有哪些接口没有实现（实现了，可以通过下拉箭头鼠标直达）。

 

 下面我们在gin路由中可以这样编写：

router.GET("/userSearch", controller.IUserApiImpl{}.GetUsers) //查询用户
//router.GET("/getMsgs", controller.GetMsg) //没有使用接口协议的普通写法

 二、控制器继承

如果我们有很多控制器，但是他们有一些通用业务需要处理，为了避免重复编写，我们可以在控制器基类中编写该业务。

如，在baseController.go文件中，我们定义一个控制器基类：

package controller

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

type BaseController struct{}

func (con BaseController) Success(c *gin.Context, msg string) {
	c.JSON(http.StatusOK, gin.H{
		"code":    0,
		"message": msg,
	})
}

func (con BaseController) Error(c *gin.Context, msg string) {
	c.JSON(http.StatusOK, gin.H{
		"code":    1,
		"message": msg,
	})
}

然后在具体的控制器中，就可以直接使用上述Success、Error方法：

 好了，以上就是介绍在go语言中设计路由以及封装控制器的一种方式。如有疑问，欢迎沟通。

祝大家生活学习愉快~