【9.1】Golang后端开发系列--Gin快速入门指南

文章目录

    • 一、引言 🌟
    • 二、Gin 框架概述 📖
      • (一)什么是 Gin
      • (二)为什么选择 Gin
    • 三、安装 Gin 框架 📦
      • (一)安装 Go 语言环境
      • (二)使用 Go Modules 安装 Gin
    • 四、路由基础 🌐
      • (一)基本路由定义
      • (二)路由参数
      • (三)查询参数
    • 五、请求处理和响应 📨
      • (一)处理 JSON 数据
      • (二)处理表单数据
    • 六、中间件的使用 🛡️
      • (一)内置中间件
      • (二)中间件的执行顺序
    • 七、模板渲染 🎨
      • (一)使用 HTML 模板
      • (二)模板语法和数据传递
    • 八、错误处理 ❌
      • (一)自定义错误处理
      • (二)全局错误处理
    • 九、文件上传和下载 📁
      • (一)文件上传

一、引言 🌟

在当今的后端开发领域,Go 语言凭借其高效、简洁和强大的并发特性备受开发者青睐。而 Gin 框架更是 Go 语言中构建 Web 服务的利器,它以轻量级和高性能著称,让开发者能够快速搭建功能强大的后端服务。使用 Gin 框架,就像拥有了一把神奇的魔法棒,能将我们的开发效率提升到一个新的高度,轻松应对各种复杂的 Web 应用需求。让我们开启 Gin 后端开发的奇妙之旅吧 🌈

二、Gin 框架概述 📖

(一)什么是 Gin

Gin 是一个用 Go 语言编写的 HTTP Web 框架,它提供了类似于 Martini 框架的 API,但性能更优。Gin 采用了高效的路由和中间件机制,允许开发者快速构建 RESTful API 和 Web 服务。它的语法简洁明了,能够极大地简化 Web 开发流程,减少样板代码,让我们把更多的精力集中在业务逻辑上。可以将 Gin 看作是一个超级高效的桥梁,连接客户端和服务器端,为我们的 Web 应用提供强大的支撑。用 🚀 图标来代表 Gin 框架的高效性。

(二)为什么选择 Gin

  • 性能卓越:Gin 基于 HTTPRouter 构建,具有高性能的路由匹配功能,在处理大量并发请求时表现出色。它使用了高效的路由树算法,能够快速找到对应的处理函数,就像闪电一样快。
  • 中间件支持:Gin 提供了强大的中间件支持,方便我们在请求处理的不同阶段添加自定义逻辑,如日志记录、认证、授权等。中间件就像是一个个功能插件,可以灵活地插拔到请求处理的流程中,增强了程序的可扩展性和可维护性。可以用 🛠️ 图标表示中间件的工具属性。
  • 简洁易用:Gin 的 API 设计简洁直观,容易上手,对于新手来说非常友好。其代码结构清晰,使得开发过程更加流畅,能够让我们快速构建出功能完善的 Web 服务。

三、安装 Gin 框架 📦

(一)安装 Go 语言环境

首先,确保你已经安装了 Go 语言环境。你可以从 Go 官方网站 下载并安装最新版本的 Go。安装完成后,可以通过以下命令检查 Go 版本:

go version

(二)使用 Go Modules 安装 Gin

在 Go 1.11 及以上版本中,推荐使用 Go Modules 来管理依赖。创建一个新的 Go 项目,并初始化 Go Modules:

mkdir gin-example
cd gin-example
go mod init example.com/gin-example

然后,使用以下命令安装 Gin 框架:

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

这个命令会将 Gin 及其依赖添加到你的项目中。可以使用 go.mod 文件查看项目的依赖情况。

以下是一个简单的代码示例,用于检查 Gin 是否安装成功:

package main

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

func main() {
	// 创建一个默认的 Gin 引擎
	r := gin.Default()
	// 启动服务,监听在 8080 端口
	r.Run(":8080")
}

在上述代码中:

  • gin.Default() 创建了一个默认的 Gin 引擎,这个引擎包含了一些常用的中间件,如日志记录和恢复机制。
  • r.Run(":8080") 启动了一个 HTTP 服务器,监听在 8080 端口。

运行代码:

go run main.go

如果一切正常,你会看到服务器启动的日志信息,并且可以在浏览器中访问 http://localhost:8080,虽然此时它只会返回 404 错误,因为我们还没有定义路由。

四、路由基础 🌐

(一)基本路由定义

路由是将 HTTP 请求映射到相应处理函数的机制。在 Gin 中,我们可以轻松定义路由。以下是一些基本路由的示例:

package main

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

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

	// GET 请求路由
	r.GET("/hello", func(c *gin.Context) {
		c.String(http.StatusOK, "Hello, Gin!")
	})

	// POST 请求路由
	r.POST("/create", func(c *gin.Context) {
		c.String(http.StatusCreated, "Created")
	})

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

在这个示例中:

  • r.GET("/hello", func(c *gin.Context) {...}) 定义了一个处理 GET 请求的路由,当访问 /hello 路径时,会调用相应的处理函数。
  • c.String(http.StatusOK, "Hello, Gin!") 使用 gin.ContextString 方法发送一个带有状态码和响应内容的响应。
  • 类似地,r.POST("/create", func(c *gin.Context) {...}) 定义了一个处理 POST 请求的路由。

(二)路由参数

我们可以在路由中定义参数,以便从 URL 中获取动态信息。以下是一个示例:

package main

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

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

	// 定义带参数的路由
	r.GET("/user/:id", func(c *gin.Context) {
		id := c.Param("id")
		c.String(http.StatusOK, "User ID: %s", id)
	})

	r.Run(":8080")
}

在这个代码中:

  • r.GET("/user/:id", func(c *gin.Context) {...}) 中的 :id 是一个路由参数。
  • c.Param("id")gin.Context 中获取 id 参数的值。

(三)查询参数

除了路由参数,我们还可以使用查询参数,就像在 URL 中添加 ?key=value 的部分。以下是一个示例:

package main

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

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

	r.GET("/search", func(c *gin.Context) {
		query := c.Query("q")
		c.String(http.StatusOK, "Search query: %s", query)
	})

	r.Run(":8080")
}

在这个示例中:

  • c.Query("q") 从查询参数中获取 q 的值。

五、请求处理和响应 📨

(一)处理 JSON 数据

在实际开发中,处理 JSON 数据是很常见的。以下是如何接收和发送 JSON 数据的示例:

package main

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

type User struct {
	Name  string `json:"name"`
	Age   int    `json:"age"`
	Email string `json:"email"`
}

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

	// 发送 JSON 数据
	r.GET("/user", func(c *gin.Context) {
		user := User{
			Name:  "Alice",
			Age:   25,
			Email: "alice@example.com",
		}
		c.JSON(http.StatusOK, user)
	})

	// 接收 JSON 数据
	r.POST("/user", func(c *gin.Context) {
		var newUser User
		if err := c.ShouldBindJSON(&newUser); err == nil {
			c.JSON(http.StatusCreated, gin.H{
				"message": "User created",
				"user":    newUser,
			})
		} else {
			c.JSON(http.StatusBadRequest, gin.H{
				"error": err.Error(),
			})
		}
	})

	r.Run(":8080")
}

在这个示例中:

  • c.JSON(http.StatusOK, user) 发送一个 JSON 格式的响应。
  • c.ShouldBindJSON(&newUser) 从请求中解析 JSON 数据到 User 结构体中。

(二)处理表单数据

处理表单数据也是常见的需求,以下是一个示例:

package main

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

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

	r.POST("/form", func(c *gin.Context) {
		username := c.PostForm("username")
		password := c.PostForm("password")
		c.String(http.StatusOK, "Username: %s, Password: %s", username, password)
	})

	r.Run(":8080")
}

在这个代码中:

  • c.PostForm("username")c.PostForm("password") 分别从表单中获取 usernamepassword 的值。

六、中间件的使用 🛡️

(一)内置中间件

Gin 自带了一些内置的中间件,如日志记录和恢复中间件。以下是如何使用自定义中间件的示例:

package main

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

func Logger() gin.HandlerFunc {
	return func(c *gin.Context) {
		start := time.Now()
		// 处理请求
		c.Next()
		// 计算处理时间
		duration := time.Since(start)
		log.Printf("Request processed in %v", duration)
	}
}

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

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

	r.GET("/middleware", func(c *gin.Context) {
		c.String(200, "This is a middleware example")
	})

	r.Run(":8080")
}

在这个示例中:

  • Logger 是一个自定义中间件函数,它在请求处理前后记录时间并计算处理时长。
  • r.Use(Logger()) 将自定义中间件添加到路由组中。

(二)中间件的执行顺序

中间件的执行顺序非常重要。以下是一个示例,展示多个中间件的执行顺序:

package main

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

func FirstMiddleware() gin.HandlerFunc {
	return func(c *gin.Context) {
		log.Println("First middleware: before")
		c.Next()
		log.Println("First middleware: after")
	}
}

func SecondMiddleware() gin.HandlerFunc {
	return func(c *gin.Context) {
		log.Println("Second middleware: before")
		c.Next()
		log.Println("Second middleware: after")
	}
}

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

	r.Use(FirstMiddleware())
	r.Use(SecondMiddleware())

	r.GET("/middleware-order", func(c *gin.Context) {
		c.String(200, "Middleware order example")
	})

	r.Run(":8080")
}

在这个示例中:

  • 当请求 /middleware-order 时,你会看到中间件的执行顺序是按照添加顺序进行的,同时 c.Next() 控制着请求继续向下传递。

七、模板渲染 🎨

(一)使用 HTML 模板

Gin 支持 HTML 模板渲染,以下是一个简单的示例:

package main

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

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

	// 加载模板文件
	r.LoadHTMLGlob("templates/*.html")

	r.GET("/html", func(c *gin.Context) {
		c.HTML(http.StatusOK, "index.html", gin.H{
			"title": "Gin HTML Template",
		})
	})

	r.Run(":8080")
}

在这个示例中:

  • r.LoadHTMLGlob("templates/*.html") 加载 templates 目录下的所有 HTML 模板文件。
  • c.HTML(http.StatusOK, "index.html", gin.H{"title": "Gin HTML Template"}) 渲染 index.html 模板并传递数据。

你需要在 templates 目录下创建一个 index.html 文件,例如:

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

(二)模板语法和数据传递

在 HTML 模板中,可以使用 Go 的模板语法传递和显示数据。以下是一个更复杂的示例:

package main

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

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

	// 加载模板文件
	r.LoadHTMLGlob("templates/*.html")

	r.GET("/user", func(c *gin.Context) {
		users := []string{"Alice", "Bob", "Charlie"}
		c.HTML(http.StatusOK, "user.html", gin.H{
			"users": users,
		})
	})

	r.Run(":8080")
}

templates 目录下的 user.html 文件可以这样写:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>User List</title>
</head>
<body>
    <h1>User List</h1>
    <ul>
        {{ range.users }}
        <li>{{. }}</li>
        {{ end }}
    </ul>
</body>
</html>

在这个示例中:

  • {{ range.users }}...{{ end }} 是 Go 的模板语法,用于遍历 users 切片并生成列表项。

八、错误处理 ❌

(一)自定义错误处理

我们可以在 Gin 中自定义错误处理,以下是一个示例:

package main

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

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

	// 自定义 404 错误处理
	r.NoRoute(func(c *gin.Context) {
		c.JSON(http.StatusNotFound, gin.H{
			"error": "Page not found",
		})
	})

	// 自定义 500 错误处理
	r.NoError(func(c *gin.Context, err interface{}) {
		c.JSON(http.StatusInternalServerError, gin.H{
			"error": "Internal server error",
		})
	})

	r.Run(":8080")
}

在这个示例中:

  • r.NoRoute(func(c *gin.Context) {...}) 自定义了 404 错误的处理逻辑。
  • r.NoError(func(c *gin.Context, err interface{}) {...}) 自定义了 500 错误的处理逻辑。

(二)全局错误处理

我们也可以设置全局的错误处理中间件,以下是一个示例:

package main

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

func ErrorHandler() gin.HandlerFunc {
	return func(c *gin.Context) {
		defer func() {
			if err := recover(); err!= nil {
				log.Printf("Error occurred: %v", err)
				c.JSON(http.StatusInternalServerError, gin.H{
					"error": "Internal server error",
				})
			}
		}()
		c.Next()
	}
}

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

	// 添加全局错误处理中间件
	r.Use(ErrorHandler())

	r.GET("/error", func(c *gin.Context) {
		// 模拟一个错误
		panic("Something went wrong")
	})

	r.Run(":8080")
}

在这个示例中:

  • ErrorHandler 中间件使用 recover 来捕获 panic,并将其转换为一个错误响应。

九、文件上传和下载 📁

(一)文件上传

以下是一个文件上传的示例:

package main

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

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

	r.POST("/upload", func(c *gin.Context) {
		file, err := c.FormFile("file")
		if err!= nil {
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
			return
		}
		// 保存文件
		c.SaveUploadedFile(file, "./uploads/"+file.Filename)
		c.JSON(http.StatusOK, gin.H{"message": "File uploaded successfully"})
	})

	r.Run(":8080")
}

在这个示例中:

  • c.FormFile("file") 从请求中获取上传的文件。
  • c.SaveUploadedFile(file, "./uploads/"+file.Filename) 将文件保存到 uploads 目录

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:/a/954063.html

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

python 连接高斯数据库报错

问题1&#xff1a;报错信息&#xff1a; import psycopg2时报错 /lib64/libgssapi_krib5.so.2 symbol krb5_ser_contect_init version krb5_3_MIT not defined in file libkrb5.so.3 错误原因&#xff1a; 解决&#xff1a; 若通过更换krb相关安装包&#xff0c;psycopg2 …

excel 整理表格,分割一列变成多列数据

数据准备 对于很多系统页面的数据是没有办法下载的。 这里用表格数据来举例。随便做数据的准备。想要看excel部分的可以把这里跳过&#xff0c;从数据准备完成开始看。 需要一点前端基础知识&#xff0c;但不多&#xff08;不会也行&#xff09;。 把鼠标放在你想要拿到本地的…

刀客doc:快手的商业化架构为什么又调了?

一、 1月10日&#xff0c;快手商业化及电商事业部进行新一轮的架构调整。作为2025年快手的第一次大调整&#xff0c;变动最大的是负责广告业务的商业化事业部。快手商业化将原来的8个业务中心&#xff0c;现在统合成了5个&#xff0c;行业归拢看上去更加明晰了。 根据自媒体《…

thinkphp 5.0 结合redis 做延迟队列,队列无法被消费

目录 一、Linux 环境下 二、如何验证消息队列被正确监听 一、Linux 环境下 项目部署在Linux 环境下&#xff0c;首先找到项目的部署路径&#xff0c;接着输入命令,这个命令是以守护进程方式进行监听你的队列&#xff0c;只要redis 不关闭 就可以一直监听这个队列 nohup php …

计算机网络 (40)域名系统DNS

前言 计算机网络域名系统DNS&#xff08;Domain Name System&#xff09;是互联网的基础技术之一&#xff0c;它负责将人类可读的域名转换为计算机用来通信的数字IP地址。 一、基本概念 DNS的主要目的是将域名解析或翻译为IP地址&#xff0c;使得用户可以通过简单易记的域名来访…

做一个 简单的Django 《股票自选助手》显示 用akshare 库(A股数据获取)

图&#xff1a; 股票自选助手 这是一个基于 Django 开发的 A 股自选股票信息查看系统。系统使用 akshare 库获取实时股票数据&#xff0c;支持添加、删除和更新股票信息。 功能特点 支持添加自选股票实时显示股票价格和涨跌幅一键更新所有股票数据支持删除不需要的股票使用中…

C#使用OpenTK绘制3D可拖动旋转图形三棱锥

接上篇,绘制着色矩形 C#使用OpenTK绘制一个着色矩形-CSDN博客 上一篇安装OpenTK.GLControl后,这里可以直接拖动控件GLControl 我们会发现GLControl继承于UserControl //// 摘要:// OpenGL-aware WinForms control. The WinForms designer will always call the default//…

《C++11》nullptr介绍:从NULL说起

在C11之前&#xff0c;我们通常使用NULL来表示空指针。然而&#xff0c;NULL在C中有一些问题和限制&#xff0c;这就是C11引入nullptr的原因。本文将详细介绍nullptr的定义、用法和优点。 1. NULL的问题 在C中&#xff0c;NULL实际上是一个整数0&#xff0c;而不是一个真正的…

Postman 接口测试平替工具,可视化开发省事!

在软件开发的漫长旅程中&#xff0c;接口测试工具一直是开发者的得力助手。Postman 作为全球知名的接口测试工具&#xff0c;长期占据市场主导地位。然而&#xff0c;随着国产工具的崛起&#xff0c;越来越多的开发者开始寻找更适合中国开发者的替代方案。一款 Apifox&#xff…

代码随想录算法训练营day20(0113)

1.二叉搜索树的最近公共祖先 在上次做完二叉树的最近公共祖先后&#xff0c;此题就显得比较简单了。不过要拓展一下&#xff0c;因为二叉搜索树有一些特性的&#xff0c;可以更加方便的解题。 题目 235. 二叉搜索树的最近公共祖先 给定一个二叉搜索树, 找到该树中两个指定节…

使用C# CEFSharp在WPF中开发桌面程序实现同一网站多开功能

在网络商业运营领域&#xff0c;同时运营多个淘宝店铺的现象屡见不鲜。为了满足这一需求&#xff0c;实现同一网址的多开功能变得尤为关键。这一需求虽然实用&#xff0c;但实现起来却面临诸多挑战。在这个过程中&#xff0c;技术人员们也经历了不少喜怒哀乐。 开发经历回顾 …

Shell 经典面试例题

1.shell 脚本写出检测 /tmp/size.log 文件如果存在显示它的内容&#xff0c;不存在则创建一个文件将创建时间写入。 编写脚本&#xff1a; #!/bin/bash FILE"/tmp/size.log" if [ -f "$FILE" ]; then echo "文件存在&#xff0c;显示文件内容&…

移动云自研云原生数据库入围国采!

近日&#xff0c;中央国家机关2024年度事务型数据库软件框架协议联合征集采购项目产品名单正式公布&#xff0c;移动云自主研发的云原生数据库产品顺利入围。这一成就不仅彰显了移动云在数据库领域深耕多年造就的领先技术优势&#xff0c;更标志着国家权威评审机构对移动云在数…

Centos 宝塔安装

yum install -y wget && wget -O install.sh http://download.bt.cn/install/install_6.0.sh && sh install.sh 安装成功界面 宝塔说明文档 https://www.bt.cn/admin/servers#wcu 或者可以注册宝塔账号 1 快速部署 安装docker 之后 2 需要在usr/bin下下载do…

ros2笔记-6.2 使用urdf创建机器人模型

本节主要跟着小鱼老师的视频操作&#xff0c;不同的仿真平台有不同的建模语言&#xff0c;但是几乎都支持URDF。 本节使用URDF创建一个机器人模型。 6.2.1 帮机器人创建一个身体 URDF使用XML来描述机器人的结构和传感器、执行器等信息。 在chapt6/chap6_ws/src创建功能包:r…

文章复现—面向配电网韧性提升的移动储能预布局与动态调度策略

目录 一、主要内容&#xff1a; 二、实际运行效果&#xff1a; 三、文章介绍&#xff1a; 四、完整代码数据下载&#xff1a; 一、主要内容&#xff1a; &#xff08;matlab代码&#xff09;该程序复现《面向配电网韧性提升的移动储能预布局与动态调度策略》&#xff0c;具…

【ASP.NET学习】Web Forms创建Web应用

文章目录 什么是 Web Forms&#xff1f;ASP.NET Web Forms - HTML 页面用 ASP.NET 编写的 Hello RUNOOB.COM它是如何工作的&#xff1f;经典 ASP ASP.NET Web Forms - 服务器控件经典 ASP 的局限性ASP.NET - 服务器控件ASP.NET - HTML 服务器控件ASP.NET - Web 服务器控件ASP.N…

python-leetcode-旋转图像

48. 旋转图像 - 力扣&#xff08;LeetCode&#xff09; class Solution:def rotate(self, matrix: List[List[int]]) -> None:"""Do not return anything, modify matrix in-place instead."""n len(matrix)# 矩阵转置for i in range(n):for…

GPT 系列论文精读:从 GPT-1 到 GPT-4

学习 & 参考资料 前置文章 Transformer 论文精读 机器学习 —— 李宏毅老师的 B 站搬运视频 自监督式学习(四) - GPT的野望[DLHLP 2020] 來自猎人暗黑大陆的模型 GPT-3 论文逐段精读 —— 沐神的论文精读合集 GPT&#xff0c;GPT-2&#xff0c;GPT-3 论文精读【论文精读】…

《计算机网络》课后探研题书面报告_了解PPPoE协议

PPPoE协议的工作原理与应用分析 摘 要 PPPoE&#xff08;Point-to-Point Protocol over Ethernet&#xff09;是一种广泛应用于宽带接入的网络协议&#xff0c;特别是在DSL&#xff08;数字用户线路&#xff09;和光纤网络中具有重要的应用价值。PPPoE结合了PPP协议的认证、加…