Golang Gin框架快速入门

最新推荐文章于 2024-05-31 09:47:23 发布

席万里

最新推荐文章于 2024-05-31 09:47:23 发布

阅读量393

点赞数 6

分类专栏： Golang 文章标签： golang gin 开发语言

本文链接：https://blog.csdn.net/m0_73337964/article/details/139010593

版权

Golang 专栏收录该内容

31 篇文章 0 订阅

订阅专栏

Golang Gin框架快速入门

文章目录

Golang Gin框架快速入门

环境准备

在开始之前，请确保你已经安装了Go语言开发环境。如果还没有安装，请前往Go官方网站下载并安装。

第一步：安装Gin框架

在项目目录下，使用go get命令安装Gin框架：

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

第二步：创建项目目录结构

创建一个新的项目目录结构，类似于以下结构：

myginapp/
├── main.go
└── go.mod

第三步：初始化Go模块

在项目根目录下执行以下命令，初始化Go模块：

go mod init myginapp

第四步：编写主程序

在main.go文件中编写以下代码：

package main

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

func main() {
	// 创建一个默认的路由引擎
	r := gin.Default()

	// 注册一个GET请求的路由和处理函数
	r.GET("/ping", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{
			"message": "pong",
		})
	})

	// 启动HTTP服务，监听端口8080
	r.Run(":8080")
}

第五步：运行项目

在项目根目录下执行以下命令运行项目：

go run main.go

此时，Gin服务已经启动，你可以在浏览器中访问http://localhost:8080/ping，应看到以下JSON响应：

{
    "message": "pong"
}

路由与请求处理

路由参数

Gin支持动态路由参数，例如：

r.GET("/user/:name", func(c *gin.Context) {
	name := c.Param("name")
	c.String(http.StatusOK, "Hello %s", name)
})

访问http://localhost:8080/user/John，会返回Hello John。

查询参数

获取URL查询参数：

r.GET("/welcome", func(c *gin.Context) {
	firstname := c.DefaultQuery("firstname", "Guest")
	lastname := c.Query("lastname") // 此方法等同于 c.Request.URL.Query().Get("lastname")

	c.String(http.StatusOK, "Hello %s %s", firstname, lastname)
})

访问http://localhost:8080/welcome?firstname=Jane&lastname=Doe，会返回Hello Jane Doe。

表单参数

处理表单提交的数据：

r.POST("/form", func(c *gin.Context) {
	message := c.PostForm("message")
	nick := c.DefaultPostForm("nick", "anonymous")

	c.JSON(http.StatusOK, gin.H{
		"status":  "posted",
		"message": message,
		"nick":    nick,
	})
})

中间件

Gin支持中间件，可以在请求处理前后执行自定义逻辑。例如，编写一个简单的日志中间件：

func Logger() gin.HandlerFunc {
	return func(c *gin.Context) {
		// 开始时间
		t := time.Now()

		// 设置example变量到上下文
		c.Set("example", "12345")

		// 请求前
		c.Next()

		// 请求后
		latency := time.Since(t)
		log.Print(latency)

		// 获取发送的status
		status := c.Writer.Status()
		log.Println(status)
	}
}

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

	// 使用Logger中间件
	r.Use(Logger())

	r.GET("/ping", func(c *gin.Context) {
		example := c.MustGet("example").(string)
		log.Println(example)

		c.JSON(http.StatusOK, gin.H{
			"message": "pong",
		})
	})

	r.Run(":8080")
}

处理静态文件

Gin可以方便地处理静态文件，例如HTML、CSS、JavaScript文件等：

r.Static("/assets", "./assets")
r.StaticFS("/more_static", http.Dir("my_file_system"))
r.StaticFile("/favicon.ico", "./resources/favicon.ico")

模板渲染

Gin支持HTML模板渲染，首先需要加载模板文件，然后在处理函数中渲染模板：

r.LoadHTMLGlob("templates/*")

r.GET("/index", func(c *gin.Context) {
	c.HTML(http.StatusOK, "index.tmpl", gin.H{
		"title": "Main website",
	})
})

在templates目录下创建index.tmpl文件：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>{{ .title }}</title>
</head>
<body>
    <h1>{{ .title }}</h1>
    <p>Welcome to the Gin framework!</p>
</body>
</html>