Go项目技巧

Go 语言被设计成一门应用于搭载 Web 服务器,存储集群或类似用途的巨型中央服务器的系统编程语言。对于高性能分布式系统领域而言,Go 语言无疑比大多数其它语言有着更高的开发效率。它提供了海量并行的支持,这对于游戏服务端的开发而言是再好不过了。

本文围绕一个完整的 Go Web 项目,梳理从**基础框架搭建、数据库处理到 Swagger、表单校验、MD5 加密、Redis 与 WebSocket 等常用技术栈的落地技巧**,帮助开发者快速拼装出可运行的项目骨架。

传统方式下,配置读取、数据库绑定、路由组织与各类中间件需要逐个零散摸索;本文把这些高频组件的安装、初始化与使用方式集中成一套可直接复用的工程实践,降低从零搭建 Go Web 项目的成本。
Go Web 实战

1. 概述

本文面向 Go Web 开发者,以一个完整的 Gin + GORM 待办事项项目为主线,系统梳理了从基础框架搭建、数据库处理到 Swagger、表单校验、MD5 加密、Redis 与 WebSocket 等常用技术栈的落地技巧。文章把这些高频组件的安装、初始化与使用方式集中成一套可直接复用的工程实践,帮助开发者降低从零搭建 Go Web 项目的成本。

如果是运行一个完整项目,可以使用下面的命令安装依赖

go mod tidy

2. Go项目搭建

本节从零搭建一个基于 Gin + GORM 的待办事项(Todo)项目,依次覆盖基础框架、数据库处理、基础架构与完整项目实现,最后说明项目文件结构。

1.1 搭建基础框架

使用 Viper 读取配置,并在 config 目录下新建 application.yml 文件。

go get github.com/spf13/viper
go get -u github.com/jinzhu/gorm
go get github.com/gin-gonic/gin

application.yml 中的 MySQL 配置示例:

mysql:
  host: 127.0.0.1
  port: 3306
  database: study_room_management
  password: password
  username: root

基础框架入口代码(路由分组与静态文件托管):

package main

import (
  "fmt"
  "github.com/gin-gonic/gin"
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/mysql"
  "net/http"
)

type TodoList struct {
  ID     int    `json:"id"`
  Title  string `json:"title"`
  Status bool   `json:"status"`
}

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

  //连接数据库
  open, err := gorm.Open("mysql", "")
  if err != nil {
    return
  }
  //告诉gin框架引用的静态文件在哪里
  r.StaticFS("/js", http.Dir("./static/js"))
  r.StaticFS("/css", http.Dir("./static/css"))
  r.LoadHTMLGlob("templates/*")
  r.GET("/", func(c *gin.Context) {
    c.HTML(http.StatusOK, "index.html", nil)
  })

  v1 := r.Group("/v1")
  {
    //待办事项
    //添加
    v1.POST("/todo", func(context *gin.Context) {

    })
    //查看所有
    v1.GET("/todo", func(context *gin.Context) {

    })
    //查看一个
    v1.GET("/todo/:id", func(context *gin.Context) {

    })
    //修改
    v1.PUT("/todo/:id", func(context *gin.Context) {

    })
    //删除
    v1.DELETE("/todo/:id", func(context *gin.Context) {

    })
  }

  err = r.Run(":8080")
  if err != nil {
    fmt.Println(err)
  }
}
**配置读取** 使用 viper 可以在 config/application.yml 中集中管理数据库连接信息,避免在代码中硬编码。

1.2 数据库的处理

通过 GORM 连接 MySQL,并完成模型自动迁移与连通性校验。

func initMysql() {
  //连接数据库
  open, err := gorm.Open("mysql", "root:password(127.0.0.1:3306)/mp?charset=utf8&parseTime=True&loc=Local")
  if err != nil {
    return
  }
  defer open.Close()
  //模型绑定
  open.AutoMigrate(&TodoList{})
  err = open.DB().Ping()
  if err != nil {
    panic(err)
  }
}

1.3 基础架构

将数据库初始化独立为函数,并在入口中统一处理连接、模型绑定与路由。

package main

import (
  "fmt"
  "github.com/gin-gonic/gin"
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/mysql"
  "net/http"
)

var (
  open *gorm.DB
)

type TodoList struct {
  ID     int    `json:"id"`
  Title  string `json:"title"`
  Status bool   `json:"status"`
}

func initMysql() (err error) {
  //连接数据库
  open, err = gorm.Open("mysql", "root:password@(127.0.0.1:3306)/mp?charset=utf8&parseTime=True&loc=Local")
  if err != nil {
    fmt.Println("error")
    return err
  }
  return open.DB().Ping()
}

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

  err := initMysql()
  if err != nil {
    return
  }
  defer open.Close()
  //模型绑定
  open.AutoMigrate(&TodoList{})

  r.LoadHTMLGlob("templates/*")
  //告诉gin框架引用的静态文件在哪里
  r.StaticFS("/js", http.Dir("./static/js"))
  r.StaticFS("/css", http.Dir("./static/css"))
  r.GET("/", func(c *gin.Context) {
    c.HTML(http.StatusOK, "index.html", nil)
  })

  v1 := r.Group("/v1")
  {
    //待办事项
    //添加
    v1.POST("/todo", func(context *gin.Context) {
      //前端页面填写事项,发起请求
      var todo TodoList
      err := context.BindJSON(&todo)
      if err != nil {
        context.JSON(http.StatusOK, gin.H{
          "error": err,
        })
      }
      if err = open.Create(&todo).Error; err != nil {
        context.JSON(http.StatusOK, gin.H{
          "error": err,
        })
      } else {
        context.JSON(http.StatusOK, todo)
      }

    })
    //查看所有
    v1.GET("/todo", func(context *gin.Context) {
      var todoList []TodoList
      var err error
      if err = open.Find(&todoList).Error; err != nil {
        context.JSON(http.StatusOK, gin.H{
          "error": err,
        })
      } else {
        context.JSON(http.StatusOK, todoList)
      }
    })
    //查看一个
    v1.GET("/todo/:id", func(context *gin.Context) {

    })
    //修改
    v1.PUT("/todo/:id", func(context *gin.Context) {

    })
    //删除
    v1.DELETE("/todo/:id", func(context *gin.Context) {

    })
  }

  err = r.Run(":8080")
  if err != nil {
    fmt.Println(err)
  }
}

1.4 完成项目

在上一节基础上补全“查看一个 / 修改 / 删除”接口,并补充静态字体目录托管。

package main

import (
  "fmt"
  "github.com/gin-gonic/gin"
  "github.com/jinzhu/gorm"
  _ "github.com/jinzhu/gorm/dialects/mysql"
  "net/http"
)

var (
  open *gorm.DB
)

type TodoList struct {
  ID     int    `json:"id"`
  Title  string `json:"title"`
  Status bool   `json:"status"`
}

func initMysql() (err error) {
  //连接数据库
  open, err = gorm.Open("mysql", "root:password@(127.0.0.1:3306)/mp?charset=utf8&parseTime=True&loc=Local")
  if err != nil {
    fmt.Println("error")
    return err
  }
  return open.DB().Ping()
}

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

  err := initMysql()
  if err != nil {
    return
  }
  defer open.Close()
  //模型绑定
  open.AutoMigrate(&TodoList{})

  r.LoadHTMLGlob("templates/*")
  //告诉gin框架引用的静态文件在哪里
  r.StaticFS("/js", http.Dir("./static/js"))
  r.StaticFS("/css", http.Dir("./static/css"))
  r.StaticFS("/static/fonts", http.Dir("./static/fonts"))
  r.GET("/", func(c *gin.Context) {
    c.HTML(http.StatusOK, "index.html", nil)
  })

  v1 := r.Group("/v1")
  {
    //待办事项
    //添加
    v1.POST("/todo", func(context *gin.Context) {
      //前端页面填写事项,发起请求
      var todo TodoList
      err := context.BindJSON(&todo)
      if err != nil {
        context.JSON(http.StatusOK, gin.H{
          "error": err,
        })
      }
      if err = open.Create(&todo).Error; err != nil {
        context.JSON(http.StatusOK, gin.H{
          "error": err,
        })
      } else {
        context.JSON(http.StatusOK, todo)
      }

    })
    //查看所有
    v1.GET("/todo", func(context *gin.Context) {
      var todoList []TodoList
      if err = open.Find(&todoList).Error; err != nil {
        context.JSON(http.StatusOK, gin.H{
          "error": err.Error(),
        })
      } else {
        context.JSON(http.StatusOK, todoList)
      }
    })
    //查看一个
    v1.GET("/todo/:id", func(context *gin.Context) {

    })
    //修改
    v1.PUT("/todo/:id", func(context *gin.Context) {
      id := context.Param("id")
      var todo TodoList
      if err = open.Where("id = ?", id).First(&todo).Error; err != nil {
        context.JSON(http.StatusOK, gin.H{
          "error": err.Error(),
        })
      } else {
        todo.Status = !todo.Status
        if err = open.Save(&todo).Error; err != nil {
          context.JSON(http.StatusOK, gin.H{
            "error": err.Error(),
          })
        } else {
          context.JSON(http.StatusOK, todo)
        }
      }
    })
    //删除
    v1.DELETE("/todo/:id", func(context *gin.Context) {
      id := context.Param("id")
      var todo TodoList
      if err = open.Where("id = ?", id).First(&todo).Error; err != nil {
        context.JSON(http.StatusOK, gin.H{
          "error": err.Error(),
        })
      } else {
        if err = open.Delete(&todo).Error; err != nil {
          context.JSON(http.StatusOK, gin.H{
            "error": err.Error(),
          })
        } else {
          context.JSON(http.StatusOK, todo)
        }
      }
    })
  }

  err = r.Run(":8080")
  if err != nil {
    fmt.Println(err)
  }
}

1.5 项目文件结构

项目中常见目录与文件的分层职责如下:

目录 / 文件 说明
controller 控制层
mapper 连接层,连接 MySQL
models 模型层,实体类和实体类的操作方法
routers 路由层
static 静态文件
templates 模版文件,如 index.html、icon.png

test 2024-10-02 142655.png

3. Go使用swagger

Swagger 用于为 Go Web 接口生成可交互的 API 文档。下面覆盖安装、初始化与注解三个环节。

2.1 安装依赖

命令 说明
go get -u github.com/swaggo/swag/cmd/swag 安装 swag 命令行工具
go get github.com/swaggo/gin-swagger 安装 gin-swagger 中间件
go install github.com/swaggo/swag/cmd/swag@latest 安装最新版 swag
swag init 初始化并扫描注解生成文档

2.2 路由注册

在路由中挂载 Swagger handler,并将 BasePath 置空。

import (
  "github.com/gin-gonic/gin"
  swaggerFiles "github.com/swaggo/files"
  ginSwagger "github.com/swaggo/gin-swagger"
)

func Router() *gin.Engine {
  r := gin.Default()
  docs.SwaggerInfo.BasePath = ""
  r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
}

2.3 接口注解示例

通过注释为接口补充标签、成功响应与路由信息。

// GetIndex
// @Tags 首页
// @Success 200 {string} welcome
// @Router /index [get]
func GetIndex(c *gin.Context) {
  c.JSON(http.StatusOK, gin.H{
    "message": "ok",
  })
}
**生成文档** 编写完注解后执行 swag init,再访问 /swagger/index.html 即可看到自动生成的接口文档。

4. GO使用表单校验

使用 govalidator 对结构体字段做规则校验。

3.1 安装与字段标签

命令 说明
go get github.com/asaskevich/govalidator 安装表单校验库

字段标签示例(正则匹配手机号、邮箱格式校验):

Phone         string    `valid:"matches(^1[3-9]{1}\\d{9}$)"`	/*电话号码*/
Email         string    `valid:"email"`/*邮箱*/

3.2 校验调用

对结构体实例执行校验并获取错误:

_, err := govalidator.ValidateStruct(user)

5. md5加密

在 utils 包中封装 MD5 加密相关函数,用于密码等敏感字段的摘要处理。

4.1 utils 包实现

package utils

import (
  "crypto/md5"
  "encoding/hex"
  "strings"
)

// 小写
func Md5Encode(data string) string {
  h := md5.New()
  h.Write([]byte(data))
  tempStr := h.Sum(nil)
  return hex.EncodeToString(tempStr)
}

// 大写
func MD5Encode(data string) string {
  return strings.ToUpper(Md5Encode(data))
}

// 加密
func MakePassword(plainpwd string, salt string) string {
  return Md5Encode(plainpwd + salt)
}

// 解密
func ValidPassword(piainpwd string, salt string) string {
  return Md5Encode(piainpwd + salt)
}
**注意** MD5 为不可逆摘要算法,示例中 ValidPassword 实际是通过“对明文 + salt 重新计算摘要”来比对,并非真正解密,存储与校验时务必配合 salt 使用。

6. go使用redis

使用 go-redis/v9 连接与使用 Redis 缓存。

5.1 安装与初始化

命令 说明
go get github.com/redis/go-redis/v9 安装 go-redis 客户端

初始化客户端并校验连通性:

import (
  "context"
  "fmt"
  "github.com/redis/go-redis/v9"
)

var (
  Red   *redis.Client
)

func InitRedis(addr string, password string, db int, poolSize int, minIdleConns int) (string, error) {
  Red = redis.NewClient(&redis.Options{
    Addr:         addr,         // Redis 服务器地址和端口
    Password:     password,     // Redis 访问密码,如果没有可以为空字符串
    DB:           db,           // 使用的 Redis 数据库编号,默认为 0
    PoolSize:     poolSize,     //指定连接池中的最大连接数
    MinIdleConns: minIdleConns, //指定连接池中的最小空闲连接数
  })
  pong, err := Red.Ping(context.Background()).Result()
  if err != nil {
    fmt.Println(err)
  } else {
    fmt.Println(pong)
  }
  return pong, err
}

5.2 配置文件

redis 配置项示例:

redis:
  addr: ""
  password: ""
  DB: 0
  poolSize: 30
  minIdleConn: 30

7. go使用websocket

使用 gorilla/websocket 在 Go 中实现 WebSocket 通信。

6.1 安装与特点

命令 说明
go get github.com/gorilla/websocket 安装 gorilla/websocket

gorilla/websocket 是一个广泛使用且经过良好测试的 WebSocket 实现,适合大多数 WebSocket 应用开发。其主要特点包括:

简单易用:提供直观的 API,如 WriteMessage 和 ReadMessage。支持多种消息类型:包括文本消息、二进制消息、Ping/Pong 消息等。并发支持:一个连接支持一个并发 reader 和一个并发 writer。

6.2 示例服务

最小可运行的 WebSocket 服务示例:

package main

import (
    "github.com/gorilla/websocket"
    "log"
    "net/http"
)

var upgrader = websocket.Upgrader{
    ReadBufferSize: 1024,
    WriteBufferSize: 1024,
    CheckOrigin: func(r *http.Request) bool {
    return true
    },
}

func handler(w http.ResponseWriter, r *http.Request) {
    conn, err := upgrader.Upgrade(w, r, nil)
    if err != nil {
    log.Fatal(err)
    }
    conn.WriteMessage(websocket.TextMessage, []byte("Hello, World!"))
    conn.Close()
}

func main() {
    http.HandleFunc("/ws", handler)
    http.ListenAndServe(":8181", nil)
}

一句话总结:本文以 Gin + GORM 待办项目为主线,汇总了 Go Web 开发中配置读取、数据库、Swagger、表单校验、MD5 加密、Redis 与 WebSocket 等高频组件的落地技巧与可直接复用的代码骨架。