Go集成Gin框架

已于 2023-02-14 18:35:16 修改
阅读量1.1k 收藏 3
点赞数 1
分类专栏： Go 文章标签： golang gin
于 2023-02-14 18:03:33 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_38924779/article/details/129031438
版权

1. Gin框架概述

Gin 是一个用 Go (Golang) 编写的 web 框架。它具有运行速度快，分组的路由器，良好的异常捕获和错误处理，非常好的支持中间件和 json 等特性。

2. Gin框架安装

在终端输入以下命令下载Gin

go get github.com/gin-gonic/gin

image.png

2.1 编辑 main.go 文件

package main

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

func main() {
    r := gin.Default()
    r.GET("/ping", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "pong",
        })
    })
    // 默认端口 8080
    r.Run()
}

2.2 启动

go run main.go

image.png
可以看到，我们在main方法中声明了 path 为 /ping 的接口，我们使用Postman上请求下
image.png

3. 配置路由

在这里可以做很多事情，比如声明接口是否需要授权、对API进行版本控制等
为了更好的熟悉，我们先定义个需求：

  1. 定义两个接口，分别为获取用户列表、添加用户
  2. 对添加用户接口进行授权验证

3.1 鉴权

3.1.1 准备工作
3.1.1.1 常量类
  • 创建包 constant/server
package server
// 服务相关常量
const (
    // 服务默认端口
	PORT       = ":8080"
    // 默认token
	SECRET     = "4b58856e-c396-4427-656f-4cf053f4bd67"
    // token名称
	TOKEN_NAME = "token"
)
3.1.1.2 工具类
  • 创建包 util/security
package security

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

// 创建签名
func CreateSign(request *gin.Context) {
	request.Header(server.TOKEN_NAME, server.SECRET)
}

// 验证签名
func VerifySign(request *gin.Context) {
	requestToken := request.GetHeader(server.TOKEN_NAME)
	if requestToken == "" && requestToken != server.SECRET {
		request.JSON(http.StatusInternalServerError, "Token verify fail")
		request.Abort()
		return
	}
}
3.1.1.3 服务类
  • 创建包 service/login
package login

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

// 登录获取Token
func Login(request *gin.Context) {
	security.CreateSign(request)
	request.JSON(http.StatusOK, "请求成功")
}
  • 创建包 service/user
package user

import (
	"net/http"
	userMapper "MyGo/mapper/user"
	"MyGo/model"
	"github.com/gin-gonic/gin"
)

// 查询用户列表
func QueryAll(request *gin.Context) {
	users := userMapper.QueryUsers()
	request.JSON(http.StatusOK, users)
}

// 添加用户
func AddUser(request *gin.Context) {
	var user model.User
	err := request.ShouldBind(&user)
	if err != nil {
		request.JSON(http.StatusInternalServerError, "参数解析失败")
	}
	userMapper.AddUser(&user)
	request.JSON(http.StatusOK, "请求成功")
}
3.1.1.4 配置路由
  • 创建包 router
package router

import (
	"MyGo/service/login"
	userService "MyGo/service/user"
	"MyGo/util/security"
	"github.com/gin-gonic/gin"
)

func InitRouter(r *gin.Engine) {

	// 定义开放API分组
	GroupOpen := r.Group("/login")
	{
		GroupOpen.GET("/login", login.Login)
	}

	// 定义 v1 API分组
	GroupV1 := r.Group("/v1")
	{
		GroupV1.GET("/user/list", userService.QueryAll)
	}

	// 定义 v2 API分组,该分组使用 security 工具类中 VerifySign 函数校验Token
	GroupV2 := r.Group("/v2", security.VerifySign)
	{
		GroupV2.POST("/user/add", userService.AddUser)
	}
}
3.1.1.5 编辑main.go文件
package main

import (
	"MyGo/constant/server"
	"MyGo/router"
	"github.com/gin-gonic/gin"
)

func main() {
	engine := gin.Default()
    // 注册router配置
	router.InitRouter(engine)
	// 默认端口 8080
	engine.Run(server.PORT)
}
3.1.2 测试鉴权
3.1.2.1 测试 v1 分组API

使用Postman请求 /v1/user/list接口
image.png
可以看到,该接口没有token也可以请求成功

3.1.2.1 测试 v2 分组API

使用Postman请求 /v2/user/add 接口
image.png
该接口没有token,请求失败了,提示 “Token verify fail” 错误,证明请求进入了 VerifySign 函数内
在这里插入图片描述

3.1.2.3 获取token再次访问 v2分组API

获取token
image.png
将token写入header再次请求add方法
image.png
请求成功了
image.png
数据也写进去了

3.2 日志

Gin 框架的日志默认只会在控制台输出，咱们利用 Logrus 封装一个中间件，将日志记录到文件中。

3.2.1 安装依赖包
go get github.com/sirupsen/logrus
go get github.com/lestrrat-go/file-rotatelogs
go get github.com/rifflock/lfshook
3.2.2 添加日志配置
log:
  path: /newCode/go/MyGo/logs
  name: system.log

自动创建目录文件暂时还不了解,所以先手动在该目录下创建 system.log 文件

3.2.3 创建日志工具类
  • 创建包 util/log
package log

import (
    "MyGo/util/config"
    "fmt"
    "github.com/gin-gonic/gin"
    rotatelogs "github.com/lestrrat-go/file-rotatelogs"
    "github.com/rifflock/lfshook"
    "github.com/sirupsen/logrus"
    "os"
    "path"
    "time"
)

func LoggerWrite() gin.HandlerFunc {

    config := config.GetConfig("./config/", "config_dev", config.YAML)
    logFilePath := config.GetString("log.path")
    logFileName := config.GetString("log.name")

    // 日志文件
    fileName := path.Join(logFilePath, logFileName)

    // 写入文件
    src, err := os.OpenFile(fileName, os.O_CREATE|os.O_RDWR|os.O_APPEND, 0644)
    if err != nil {
        fmt.Println("err", err)
    }

    // 实例化
    logger := logrus.New()

    // 设置输出
    logger.Out = src

    // 设置日志级别
    logger.SetLevel(logrus.DebugLevel)

    // 设置 rotatelogs
    logWriter, err := rotatelogs.New(
        // 分割后的文件名称
        fileName+".%Y%m%d.log",

        // 生成软链，指向最新日志文件
        rotatelogs.WithLinkName(fileName),

        // 设置最大保存时间(7天)
        rotatelogs.WithMaxAge(7*24*time.Hour),

        // 设置日志切割时间间隔(1天)
        rotatelogs.WithRotationTime(24*time.Hour),
    )

    writeMap := lfshook.WriterMap{
        logrus.InfoLevel:  logWriter,
        logrus.FatalLevel: logWriter,
        logrus.DebugLevel: logWriter,
        logrus.WarnLevel:  logWriter,
        logrus.ErrorLevel: logWriter,
        logrus.PanicLevel: logWriter,
    }

    lfHook := lfshook.NewHook(writeMap, &logrus.JSONFormatter{
        TimestampFormat: "2006-01-02 15:04:05",
    })

    // 新增钩子
    logger.AddHook(lfHook)

    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.WithFields(logrus.Fields{
            "status_code":  statusCode,
            "latency_time": latencyTime,
            "client_ip":    clientIP,
            "req_method":   reqMethod,
            "req_uri":      reqUri,
        }).Info()
    }
}
3.2.4 开启日志
package main

import (
	"MyGo/constant/server"
	"MyGo/router"
	"MyGo/util/log"
	"github.com/gin-gonic/gin"
)

func main() {
	// 默认为 debug 模式，设置为发布模式
	gin.SetMode(gin.ReleaseMode)
	engine := gin.Default()
	// 配置日志
	engine.Use(log.LoggerWrite())
	// 配置路由
	router.InitRouter(engine)
	// 默认端口 8080
	engine.Run(server.PORT)
}
3.2.5 请求接口,校验日志是否开启

image.png
日志信息成功写入文件,但是可以发现是有个failed的

failed to rotate: failed to create new symlink: symlink \newCode\go\MyGo\logs\system.log.20230214.log /newCode/go/MyGo/logs/system.log.20230214.log_symlink: A required privilege is not held by the client.

使用的为 win10系统,需要开启开发者模式

Ma.wenda
关注
  • 1
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
go下载gin框架
qq_40787608的博客
03-31 1539
golang下载gin框架
go 语言框架 gin中文文档
09-11
Gin 是一个基于 Go（Golang）语言的轻量级Web框架，它以其高效、简洁的API设计受到了广大开发者的喜爱。Gin 使用了 Martini-like API，使得构建Web服务变得异常简单。在本文档中，我们将深入探讨 Gin 的各个方面，...
基于go语言gin框架封装的web项目骨架
02-19
基于go语言gin框架封装的web项目骨架
Go Gin 入门教程
u013302168的博客
09-27 1988
Gin 是使用 Go/golang 语言实现的 HTTP Web 框架。接口简洁、性能极高。
golang——Gin框架及路由介绍
最新发布
weixin_57023347的博客
06-26 1971
gin框架中采用的路由库是基于httprouter做的支持Restful风格的API，意思是"表面层状态转化"，是一个互联网应用程序的API设计理念：URL定位资源。可以创建路由组，为了管理相同的URL。import ("net/http"//将应用切换到“发布模式”以提升性能//创建路由//默认使用了两个中间件Logger()，Recovery()})})//路由组1})})//路由组2})})//监听端口，默认绑定端口8080。
Go -【gin】框架搭建基本使用
Mr_WoLong
07-03 7032
Gin是一个快速的Golang web框架，它使用了httprouter来处理路由和速度，而不是使用内置的Go路由。
go语言Gin框架快速指南
weixin_44865158的博客
03-21 850
Gin框架介绍 Gin是一个用Go语言编写的web框架。它是一个类似于martini但拥有更好性能的API框架, 由于使用了httprouter，速度提高了近40倍。 如果你是性能和高效的追求者, 你会爱上Gin。 Gin框架介绍 Go世界里最流行的Web框架，Github上有32K+star。 基于httprouter开发的Web框架。 中文文档齐全，简单易用的轻量级框架。 Gin框架安装与使用 安装 下载并安装Gin: go get -u github.com/gin-gonic/gin gin实现h
go集成gin+swagger
不积跬步，无以至千里；不积小流，无以成江海。
01-22 1258
1.安装 swag go get github.com/swaggo/swag/cmd/swag swag 用于生成 docs 文件夹(swagger文档程序使用) 安装完成后会在 ${GOPATH}/bin生成一个执行文件 2.编写代码 /** * Created by liuyusnhengsir on 23/01/2022 */ package main import ( _ "lys_gin_swag/docs" "github.com/gin-gonic/gin" ginSw
Go-Gin框架
u013302168的博客
08-08 4126
Gin是一个用Go编写的HTTPweb框架。它是一个类似于martini但拥有更好性能的API框架, 优于httprouter，速度提高了近 40 倍。点击此处访问Gin官方中文文档。
Go: Gin
Huntinux
03-29 477
0. 简介 Gin是一个使用golang编写的HTTP web框架，主页在此： https://github.com/gin-gonic/gin 1. 使用记录 1.1 POST binding tag 加入太多tab会有问题，目前只加一个空格没有什么问题，就是格式上有点丑，尚不清楚原因。 1.2 Database http://www.01happy.co...
go语言导入Gin框架
石斑的博客
02-04 410
这里写自定义目录标题欢迎使用Markdown编辑器新的改变功能快捷键合理的创建标题，有助于目录的生成如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义列表如何创建一个注脚注释也是必不可少的KaTeX数学公式新的甘特图功能，丰富你的文章UML 图表FLowchart流程图导出与导入导出导入 欢迎使用Markdown编辑器 你好！ 这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Mar
基于Go语言Gin框架的选课系统源码.zip
05-18
《基于Go语言Gin框架的选课系统源码解析》 在现代的互联网开发中，后端技术扮演着至关重要的角色。本篇文章将深入探讨一个采用Go语言与Gin框架构建的选课系统源码，旨在帮助开发者理解如何利用这两种强大的工具来...
Golang(Gin框架)+websocket 实现的多人聊天室+代码+详细文档
05-15
在实际项目中，你需要将这个函数集成到Gin框架的路由中，同时处理其他如认证、数据库操作等细节。提供的代码压缩包`go-gin-chat(2)`可能包含了完整的实现，包括详细文档和示例代码，这将帮助你更好地理解和实践这个...
Go-easy-gin一套基于Gin框架的MVC脚手架
08-13
其中，Gin框架是Go语言中最受欢迎的Web框架之一，它提供了强大的路由功能和中间件支持，使得构建Web应用变得更加简单。本文将深入探讨"Go-easy-gin"这套基于Gin框架的MVC（Model-View-Controller）脚手架，以及如何...
GO: 引入GIn框架
YDDUONG的博客
03-31 3251
新建项目： 找一个合适地方新建一个项目根文件夹：ginTest 在命令行中进入这个文件夹： go mod init ginTest // 初始化mod go mod tidy // 更新包 使用gin: 可以import直接导入使用，然后你在go run运行的时候，会自动的下载gin包编译使用。(也可以在go run之前通过go mod tidy来下载依赖的模块) package main import ( "github.com/gin-gonic/gin" ) // 在 RESTful API
go gin
qq_34103387的博客
02-01 141
gin类似java 的springmvc,接收请求 1.参考野中文文档 https://www.kancloud.cn/shuangdeyu/gin_book/949413 2. 添加引用 github.com/gin-gonic/gin 3.样例 func main() { // Disable Console Color // gin.DisableConsoleColor() // 使用默认中间件创建一个gin路由器 // logger and recovery (crash-free
go--gin
Yu的博客
01-17 718
1.下载与安装:$ go get github.com/gin-gonic/gin2.导入：     import "github.com/gin-gonic/gin"3.  请求方式：GET、POST、PUT、PATCH、DELETE、OPTIONS4.得到默认路由：   router := gin.Default()5.路径上的参数：router.GET("/user/:name") fu
Go gin框架（详细版）
原来45的博客
04-09 4236
golang gin框架 go web开发 中间件 全栈
用Go Modules 下载Gin框架
克里斯蒂亚诺更新的博客
04-16 353
假设我们要创建一个简单的 Go Web 项目，使用 Gin 框架来构建一个 HTTP 服务器。Go Modules 已经帮助我们管理了项目的依赖关系，使得项目的构建和维护更加简单和可靠。命令来添加你的项目所需的依赖包。现在，你的 Go Web 服务器已经运行起来了，可以通过访问。：确保你的 Go 版本在 Go 1.11 及以上，并设置。：编写你的 Go 代码，使用导入路径来引用依赖包。命令来初始化一个新的 Go Modules。现在，我们创建一个简单的 Go 文件。命令来构建你的项目，并使用。
go的gin框架和beego框架比较
05-23
Gin和Beego都是流行的Go语言Web框架，它们都有自己的优缺点和适用场景。 Gin是一个轻量级的Web框架，它具有良好的性能和高度的可定制性。Gin的设计非常简洁，没有太多的依赖和抽象，易于学习和使用。Gin支持中间件，可以很方便地实现一些常见的功能，比如日志记录、认证授权、缓存等。Gin的缺点是它缺乏一些高级特性，比如自动化路由、ORM等，并且需要手动处理错误。 Beego是一个完整的Web框架，它集成了很多常用的功能，比如自动路由、ORM、模板引擎、Session管理等。Beego的设计也非常简单，易于学习和使用，适合快速开发。Beego的缺点是它比较重，需要依赖很多第三方库，并且在高并发情况下性能可能会受到影响。 综上所述，如果你需要一个简单、轻量级的Web框架，可以考虑使用Gin；如果你需要一个功能齐全、易于使用的Web框架，可以考虑使用Beego。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值