Go -【gin】框架搭建基本使用

本文介绍: Gin是一个快速的Golang web 框架，它使用了http router来处理路由和速度，而不是使用内置的Go路由。

一. 前言

Gin是一个快速的Golang web 框架，它使用了http router来处理路由和速度，而不是使用内置的Go路由。以下是Gin 框架的搭建和使用：

二. 安装Gin 框架

1. 使用以下命令在您的计算机上安装Gin 框架：

go get -u github.com/gin-gonic/gin

这将从Gin Gi tHub 仓库中安装最新版本的Gin 框架。

2. 搭建Gin 应用程序

在搭建一个Gin应用程序之前，让我们了解一下Gin的基本架构：

Rout e r：它是Gin应用程序的核心部分，它接收HTTP请求并根据请求的路径和HTTP方法将其路由到正确的处理程序。
Handlers：它是Gin应用程序中的业务逻辑代码，它接收HTTP请求并返回HTTP响应。
Mid dleware：它是在HTTP请求和处理程序之间发生的代码。它可以用来完成一些常见的操作，如身份验证、日志记录、处理请求等。

接下来，我们将创建一个简单的Gin应用程序，该应用程序具有以下路由：

GET /：返回“Hello World！”
GET /ping：返回“pong！”
POST /submit：返回HTTP请求的JSON数据

下面是代码示例：

package main

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

func main() {
	// 创建一个Gin路由器
	r := gin.Default()

	// 定义路由
	r.GET("/", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "Hello World!",
		})
	})

	r.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong!",
		})
	})

	r.POST("/submit", func(c *gin.Context) {
		var json struct {
			Name string `json:"name"`
			Email string `json:"email"`
		}

		if err := c.Bind(&amp;json); err == nil {
			c.JSON(200, gin.H{
				"message": "JSON received",
				"name":    json.Name,
				"email":   json.Email,
			})
		} else {
			c.JSON(400, gin.H{"error": err.Error()})
		}
	})

	// 启动Gin应用程序
	r.Run()
}

3. 运行Gin应用程序

使用以下命令运行上面的Gin应用程序：

go run main.go

4. 测试 应用

这将在本地主机的默认端口8000上启动Gin应用程序。也可以在运行的时候可以指定端口

r := gin.Default()
r.Run(":8000")

现在，您可以使用浏览器访问以下路由：

http://localhost:8080/
http://localhost:8080/ping

POST请求，http://localhost:8080/submit，发送JSON数据

至此，你已经成功的搭建并使用了Gin框架。你可以在应用中添加更多的路由和处理器函数来实现更多的功能。

三. 项目 目录 结构

1. 下面是一个简单的gin项目 目录 示例：

├── app
│   ├── config
│   │   └── config.go
│   ├── controllers
│   │   ├── auth.go
│   │   └── user.go
│   ├── middleware
│   │   ├── auth.go
│   │   └── logger.go
│   ├── models
│   │   ├── user.go
│   │   └── db.go
│   └── routes
│       └── routes.go
├── main.go
└── go.mod

其中：

app – 应用程序的所有内容都放在这个文件夹中。
config – 存储应用程序的所有配置。
controller s – 包含所有的控制器文件，每个文件处理一个对应的路由。
middleware – 存储中间件（例如身份验证、日志记录）。
models – 存储数据库模型和数据库连接配置。
routes – 存储所有定义的路由。
main.go – 应用程序的入口点。
go.mod – 记录应用程序所需的依赖项。

二. Gin项目的典型目录 结构 如下：

├── configs
│   ├── config.yaml
│   └── db.yaml
├── controllers
│   ├── auth_controller.go
│   └── user_controller.go
├── middleware
│   ├── auth_middleware.go
│   └── logger_middleware.go
├── models
│   ├── db.go
│   ├── user.go
│   └── ...
├── routes
│   └── routes.go
├── services
│   ├── auth_service.go
│   └── user_service.go
├── utils
│   ├── response.go
│   └── ...
├── main.go
└── README.md