「项目阅读系列」go-gin-example star 6.5k！（1）

最新推荐文章于 2024-05-31 05:36:43 发布
最新推荐文章于 2024-05-31 05:36:43 发布
阅读量529 收藏 1
点赞数
文章标签： golang gin 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_37393071/article/details/134488457
版权

文章目录

准备工作

适宜人群

初学 go 语法，希望了解 go 项目的构建过程和方式。

项目信息

go-gin-example 项目是使用 gin 框架构建一个简易的 blog 服务，包括对 blog 的增删改查操作以及 blog tag 的增删改查等。

  • 代码仓库：https://github.com/eddycjy/go-gin-example
  • 版本：565e1a9395471e829abdb2201e00321c327626cd 第一次提交版本

项目结构

项目代码结构如下

  • conf 配置相关
  • middleware 中间件
  • models 数据库相关对象以及操作
  • pkg 项目相关的模块包
  • routers 路由相关
  • main 主函数
    在这里插入图片描述

代码阅读

主要模块代码

首先看一下整体项目中比较重要的模块，包括 主函数、路由模块、授权模块、数据库模块。

主函数模块

func main() {
	router := routers.InitRouter()

	s := &http.Server{
		Addr:           fmt.Sprintf(":%d", setting.HTTPPort),
		Handler:        router,
		ReadTimeout:    setting.ReadTimeout,
		WriteTimeout:   setting.WriteTimeout,
		MaxHeaderBytes: 1 << 20,
	}

	s.ListenAndServe()
}

主函数工作

  • 初始化路由
  • server 配置
  • 启动

router 路由模块

func InitRouter() *gin.Engine {
    r := gin.New()

    r.Use(gin.Logger())

    r.Use(gin.Recovery())

    gin.SetMode(setting.RunMode)

    r.GET("/auth", api.GetAuth)

    apiv1 := r.Group("/api/v1")
    apiv1.Use(jwt.JWT())
    {
        //获取标签列表
        apiv1.GET("/tags", v1.GetTags)
        //新建标签
        apiv1.POST("/tags", v1.AddTag)
        //更新指定标签
        apiv1.PUT("/tags/:id", v1.EditTag)
        //删除指定标签
        apiv1.DELETE("/tags/:id", v1.DeleteTag)

        //获取文章列表
        apiv1.GET("/articles", v1.GetArticles)
        //获取指定文章
        apiv1.GET("/articles/:id", v1.GetArticle)
        //新建文章
        apiv1.POST("/articles", v1.AddArticle)
        //更新指定文章
        apiv1.PUT("/articles/:id", v1.EditArticle)
        //删除指定文章
        apiv1.DELETE("/articles/:id", v1.DeleteArticle)
    }

    return r
}

主要工作

  • 创建 gin 对象
  • 添加 Logger、Recovery 中间件
    • Logger 日志处理
    • Recovery 异常捕获
  • 设置 /auth 路径的处理器
  • 设置 /api/v1 group，通过 JWT 进行授权验证
  • 设置 /api/v1 下各个请求的处理方式

auth 授权模块

type auth struct {
	Username string `valid:"Required; MaxSize(50)"`
	Password string `valid:"Required; MaxSize(50)"`
}

func GetAuth(c *gin.Context) {
	username := c.Query("username")
	password := c.Query("password")

	valid := validation.Validation{}
	a := auth{Username: username, Password: password}
	ok, _ := valid.Valid(&a)

	data := make(map[string]interface{})
	code := e.INVALID_PARAMS
	if ok {
		isExist := models.CheckAuth(username, password)
		if isExist {
			token, err := util.GenerateToken(username, password)
			if err != nil {
				code = e.ERROR_AUTH_TOKEN
			} else {
				data["token"] = token
				
				code = e.SUCCESS
			}

		} else {
			code = e.ERROR_AUTH
		}
	} else {
		for _, err := range valid.Errors {
            logging.Info(err.Key, err.Message)
        }
	}

	c.JSON(http.StatusOK, gin.H{
        "code" : code,
        "msg" : e.GetMsg(code),
        "data" : data,
    })
}

工作：

  • 获取用户 username password
  • 验证 username password 是否符合格式
    • 符合，通过 models 进行授权检查，组装 data
    • 不符合，打印错误日志
  • 使用 JSON 格式返回

数据库

数据库信息的设置在 models 文件夹下，主要包括 model 文件以及其他具体表文件。

  • model.go 模块通用参数、全局数据库对象、初始化方法&&数据库关闭方法
  • article.go article 对象及其操作方法

重点看一下 model 文件。

var db *gorm.DB

type Model struct {
	ID int `gorm:"primary_key" json:"id"`
	CreatedOn int `json:"created_on"`
	ModifiedOn int `json:"modified_on"`
}

func init() {
	var (
		err error
		dbType, dbName, user, password, host, tablePrefix string
	)

	sec, err := setting.Cfg.GetSection("database")
	if err != nil {
		log.Fatal(2, "Fail to get section 'database': %v", err)
	}

	dbType = sec.Key("TYPE").String()
	dbName = sec.Key("NAME").String()
	user = sec.Key("USER").String()
	password = sec.Key("PASSWORD").String()
	host = sec.Key("HOST").String()
	tablePrefix = sec.Key("TABLE_PREFIX").String()

	db, err = gorm.Open(dbType, fmt.Sprintf("%s:%s@tcp(%s)/%s?charset=utf8&parseTime=True&loc=Local", 
		user, 
		password, 
		host, 
		dbName))

	if err != nil {
		log.Println(err)
	}

	gorm.DefaultTableNameHandler = func (db *gorm.DB, defaultTableName string) string  {
	    return tablePrefix + defaultTableName;
	}

	db.SingularTable(true)
	db.DB().SetMaxIdleConns(10)
	db.DB().SetMaxOpenConns(100)
}

func CloseDB() {
	defer db.Close()
}

组成部分

  • 全局变量 db，用于操作数据库
  • Model 结构体，各个数据库表的通用字段
  • init 方法 && closeDB 方法：数据库初始化以及关闭方法

从中可知，db 主要是通过使用 gorm 框架进行操作，操作中需要设置数据库相关参数以及最大连接数。

models 下其他具体的数据库表信息在此不做赘述，基本就是数据库表的 struct 定义以及相应操作，下面贴出该项目涉及的三个数据库表及其字段。

type Article struct {
	Model

	TagID int `json:"tag_id" gorm:"index"`
	Tag   Tag `json:"tag"`

	Title string `json:"title"`
	Desc string `json:"title"`
	Content string `json:"content"`
	CreatedBy string `json:"created_by"`
	ModifiedBy string `json:"modified_by"`
	State int `json:"state"`
}

type Tag struct {
	Model

	Name string `json:"name"`
	CreatedBy string `json:"created_by"`
	ModifiedBy string `json:"modified_by"`
	State int `json:"state"`
}

type Auth struct {
	ID int `gorm:"primary_key" json:"id"`
	Username string `json:"username"`
	Password string `json:"password"`
}

修改文章请求分析

主要模块已经了解后，我们查看修改文章 api 的请求过程和具体实现。

  • 请求 URL：/articles/:id
  • 请求方法 ：PUT
  • 处理函数： v1.EditArticle

上述主要代码模块，已经了解到 main 函数启动后，会初始化路由，路由中包含了「修改文章」请求的具体处理函数，这里看看具体函数操作。

func EditArticle(c *gin.Context) {
	valid := validation.Validation{}

	id, _ := com.StrTo(c.Param("id")).Int()
	tagId, _ := com.StrTo(c.Query("tag_id")).Int()
	title := c.Query("title")
	desc := c.Query("desc")
	content := c.Query("content")
	modifiedBy := c.Query("modified_by")

	var state int = -1
	if arg := c.Query("state"); arg != "" {
		state, _ = com.StrTo(arg).Int()
		valid.Range(state, 0, 1, "state").Message("状态只允许0或1")
	}

	valid.Min(id, 1, "id").Message("ID必须大于0")
	valid.MaxSize(title, 100, "title").Message("标题最长为100字符")
    valid.MaxSize(desc, 255, "desc").Message("简述最长为255字符")
    valid.MaxSize(content, 65535, "content").Message("内容最长为65535字符")
	valid.Required(modifiedBy, "modified_by").Message("修改人不能为空")
    valid.MaxSize(modifiedBy, 100, "modified_by").Message("修改人最长为100字符")

  	code := e.INVALID_PARAMS
  	if ! valid.HasErrors() {
  		if models.ExistArticleByID(id) {
  			if models.ExistTagByID(tagId) {
  				data := make(map[string]interface {})
	  			if tagId > 0 {
	  				data["tag_id"] = tagId
	  			}
	  			if title != "" {
	  				data["title"] = title
	  			}
	  			if desc != "" {
	  				data["desc"] = desc
	  			}
	  			if content != "" {
	  				data["content"] = content
	  			}

	  			data["modified_by"] = modifiedBy

	  			models.EditArticle(id, data)
	  			code = e.SUCCESS
  			} else {
  				code = e.ERROR_NOT_EXIST_TAG
  			}
		} else {
			code = e.ERROR_NOT_EXIST_ARTICLE
		}
	} else {
		for _, err := range valid.Errors {
            logging.Info(err.Key, err.Message)
        }
	}

	c.JSON(http.StatusOK, gin.H{
        "code" : code,
        "msg" : e.GetMsg(code),
        "data" : make(map[string]string),
    })
}

// models article.go
func EditArticle(id int, data interface {}) bool {
	db.Model(&Article{}).Where("id = ?", id).Updates(data)

	return true
}

工作：

  • 参数获取
  • 设置校验规则并进行校验
    • 校验成功
      • 文章是否已经存在
        • 是，构建 data 参数，通过 models EditAriticle 修改，具体修改逻辑：找到主键等于 id 的数据，并通过 update 进行更新。
        • 否，设置文章不存在错误码
    • 校验失败
      • 打印错误日志
    • JSON 响应

其他依赖

  • go-ini 库
    • 该项目通过 ini 文件进行配置管理，go-ini 是 Go 语言中用于操作 ini 文件的第三方库。
  • beego
    • 另一个 go web 框架，项目中主要使用了 beego 的vaild 功能
  • gorm
    • go ORM 框架
  • go-vendor
    • 该项目第一次提交为 18 年，通过 vendor 来管理依赖，现在 go mod 诞生后，这种方式已被放弃

总结

该项目第一版提交，大体上完成了 blog 项目所需的基本功能，在目录结构上也相对清晰。

不足：

  1. 返回信息的 Code、Msg 对象设计比较一般。每次响应需要自己构建响应格式{code；msg；data}。
  2. 配置管理相对粗糙，直接读取配置文件而不是通过 global 统一管理调度。
阿德罗斯
关注
  • 0
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Gin(三):模板tmpl
代码猎奇站
08-09 5754
前面的学习已经对 Gin 有了一个初步的认识和了解，对 router 的简单使用也有了一定的掌握，那么今天就来使用 Gin 来渲染出我们的 html 页面吧。
源代码阅读方法（附Go语言项目的代码阅读技巧）
IT技术快速入门学院的博客
07-12 5786
公众号首发：https://mp.weixin.qq.com/s/qzsn-hKkEdTX8pDqDVuI_g 目录 目录 说明 一：摆正认识 二：找到入口 三：梳理目录 四：逐行阅读 Go项目的一些阅读技巧 技巧1：忽视真正入口之前的代码 技巧2：接口的实现一般就在接口定义的下方 技巧3：见到了类似...
如何阅读 Go 源码
slphahaha的博客
05-27 1677
前言哈喽，大家好，我是asong；最近在看Go语言调度器相关的源码，发现看源码真是个技术活，所以本文就简单总结一下该如何查看Go源码，希望对你们有帮助。Go源码包括哪些？以我个人理解，Go源码主要分为两部分，一部分是官方提供的标准库，一部分是Go语言的底层实现，Go语言的所有源码/标准库/编译器都在src目录下：https://github.com/golang/go/t...
Go Gin Example
kangle0228的博客
10-25 1833
https://github.com/EDDYCJY/go-gin-example/blob/master/README_ZH.md  Go Gin Example gin 的一个例子，包含许多有用特性 目录 本项目提供 Gin实践 的连载示例代码 Gin实践 连载一 Golang介绍与环境安装 Gin实践 连载二 搭建Blog API's（一） Gin实践 连载三 搭建Blog A...
PGL图学习之图神经网络GraphSAGE、GIN图采样算法[系列七]
m0_63642362的博客
11-27 480
本项目主要讲解了GraphSage、PinSage、GIN算法的原理和实践，并在多个数据集上进行仿真实验，基于PGl实现原论文复现和对比，也从多个角度探讨当前算法的异同以及在工业落地的技巧等。
Go-gin-example 添加注释 第一部分 新建项目及api编写
kingsill的博客
01-07 1039
Demo 的router.GET等路由规则可以不写在main包中吗？我们发现router.GET等路由规则，在 Demo 中被编写在了main包中，感觉很奇怪，我们去抽离这部分逻辑！import (//创建新的router而不是默认。//定义router的配置//将处理函数搬到这里})})return r修改main.go文件内容import ("fmt""net/http"├── conf├── models├── pkg│ ├── e│ └── util。
为开源项目 go-gin-api 增加后台任务模块
新亮笔记
09-02 769
文章目录：任务管理界面 (WEB)任务调度器任务执行器小结推荐阅读任务管理界面 (WEB)支持在 WEB 界面 中对任务进行管理，例如：新增任务、编辑任务、启用/禁用任务、手动执行任务 等...
go-gin-example：杜松子酒的一个例子
01-30
跑$ cd $GOPATH/src/go-gin-example$ go run main.go项目信息和现有API [GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production. - using env:export GIN_MODE
基于Vue3和go-gin的全栈开发博客项目源码+项目说明.zip
12-28
基于Vue3和go-gin的全栈开发博客项目源码+项目说明.zip 【技术栈】 后端 Golang 1.19 Gin 1.8.1 (Web框架) GORM 1.23.8 (ORM) MySQL 8 (数据库) 前端 Vue.js 3 Vite 3.1.0 (构建工具) naive-ui / ionicons5 (UI库 /...
golang-gin-restfulAPI-example-app：带有[Gin，MongoDB，gin-jwt，gin-sessions，gin-authz，gin-swagger，validate.v9，casbin，go-ini]的Golang Restful API示例
02-04
一个用go语言基于Gin写的restful风格api服务程序的例子。 项目特性 基于 使用数据库 权限验证 从session里取用户的角色进行权限管理 使用自动生成api文档 将gingin的validator.v8升级到 使用权限管理 使用识读配置...
go-gin-wrapper:Go-gin Web框架示例
05-08
Go-gin-wrapper是 Web框架和反向代理的包装。 ES6的React用于前端的一部分。 但这已经过时了。 该项目自2016年以来就开始研究Golang，并且代码非常混乱。 现在它正在refactoring 。 重构 重构代码 由重构代码 ...
go-gin-someTest:来自eddycjygo-gin-example的fork
04-12
安装$ go get github.com/EDDYCJY/go-gin-example怎么跑必需的MySQL的雷迪斯准备好创建博客数据库并导入Conf 您应该修改conf/app.ini [database]Type = mysqlUser = rootPassword =Host = 127.0.0.1:3306Name = ...
长安链使用Golang编写智能合约教程（三）
目前专注区块链相关技术的学习与分享
05-29 814
长安链使用Golang编写智能合约教程 SDK详细解析
6.2 Go 切片（Slice）
stormsha
05-29 1071
Go 语言以其简洁、高效和并发友好的特性，赢得了开发者的青睐。在 Go 中，切片（Slice）是一种动态数组，它不仅提供了数组的便利性，还具有灵活性和强大的功能。对于中高级开发者来说，掌握 Go 切片的使用技巧，可以大幅提升编程效率和程序性能。本文将深入探讨 Go 切片的高级使用技巧，帮助开发者更深入地理解和运用这一强大的数据结构。
深入了解 Golang 多架构编译：交叉编译最佳实践
xcbeyond|疯狂源自梦想，技术成就辉煌
05-26 808
通过这篇文章，读者可以全面了解 Golang 的多架构编译功能，掌握如何使用这一功能来实现跨平台部署。同时，通过最佳实践示例，读者可以更加直观地理解 Golang 多架构编译的实际应用场景，为日后的开发工作提供参考和指导。
Android USB调试模式下自动上下滑动（Go实现）
听我一言的博客
05-28 507
Golang实现通过ADB控制手机自动上下滑动
Golang | Leetcode Golang题解之第122题买卖股票的最佳时机II
最新发布
weixin_66442839的博客
05-31 209
Golang | Leetcode Golang题解之第122题买卖股票的最佳时机II
gin 项目结构_Gin框架 - 项目目录
05-26
在Gin框架中，通常会建议使用以下的项目结构： ``` ├── config │ ├── config.yaml │ ├── config_dev.yaml │ ├── config_prod.yaml │ └── config_test.yaml ├── controllers │ ├── home_...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值