【Golang】——Gin 框架中的路由与请求处理

文章目录

    • 1. 路由基础
      • 1.1 什么是路由?
      • 1.2 Gin 中的路由概述
    • 2. 创建简单路由
      • 2.1 基本路由定义
      • 2.2 不同请求方法的路由
    • 3. 路由参数
      • 3.1 路径参数
      • 3.2 查询参数
    • 4. 路由分组
      • 4.1 为什么使用路由分组?
      • 4.2 路由分组示例
    • 5. 请求处理与响应
      • 5.1 Gin 中的 Context 对象
      • 5.2 JSON 响应
      • 5.3 常见的响应方法
    • 6. 实践示例:创建用户管理 API
      • 6.1 API 功能需求
      • 6.2 完整代码
      • 6.3 代码解释
      • 6.4 运行与测试
    • 7. 总结

1. 路由基础

1.1 什么是路由?

在 Web 开发中,路由是指 URL 与请求处理函数之间的映射关系。通过路由,可以将客户端请求的路径映射到服务器端的特定处理逻辑,从而根据不同的路径和请求方法执行不同的操作。例如,当用户访问 /products 页面时,服务器可以响应商品数据,而访问 /users 则响应用户数据。

1.2 Gin 中的路由概述

Gin 框架中的路由机制十分灵活,支持以下几种特性:

  1. 路径参数:路径中可以带有动态的部分,例如 /users/:id:id 会被识别为动态参数。
  2. 查询参数:通常在 URL 中 ? 后面指定,用于传递额外信息,例如 /search?query=gin
  3. 分组路由:将具有相同前缀的路由分组,便于管理,例如 /v1/users/v1/products 等。

2. 创建简单路由

2.1 基本路由定义

在 Gin 中,可以使用 r.GETr.POST 等方法为不同的 HTTP 请求类型创建路由。下面是一个简单的示例代码,创建一个 GET 请求路由来响应根路径:

package main

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

func main() {
    // 使用 gin.Default() 创建带有默认中间件(日志和恢复中间件)的路由
    r := gin.Default()

    // 创建一个 GET 路由,匹配根路径 "/"
    r.GET("/", func(c *gin.Context) {
        // 使用 c.String() 返回纯文本内容,状态码为 200
        c.String(200, "欢迎使用 Gin 框架!")
    })

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

解释:

  • r := gin.Default():使用 gin.Default() 方法初始化一个 Gin 引擎实例,包含了日志和崩溃恢复中间件。
  • r.GET("/", func(c *gin.Context) {...}):定义一个 GET 请求路由,匹配根路径 /
  • c.String(200, "..."):返回状态码为 200 的纯文本响应。

2.2 不同请求方法的路由

Gin 提供了多种路由方法,分别对应不同的 HTTP 请求方法:

  • GET:用于请求资源,例如获取用户数据。
  • POST:用于提交新数据,例如新建用户。
  • PUT:用于更新已有数据,例如修改用户信息。
  • DELETE:用于删除数据,例如删除用户。

以下代码展示了如何使用不同的请求方法:

r.GET("/users", func(c *gin.Context) {
    c.String(200, "获取用户列表")
})

r.POST("/users", func(c *gin.Context) {
    c.String(200, "创建新用户")
})

r.PUT("/users/:id", func(c *gin.Context) {
    id := c.Param("id")
    c.String(200, "更新用户 %s 的信息", id)
})

r.DELETE("/users/:id", func(c *gin.Context) {
    id := c.Param("id")
    c.String(200, "删除用户 %s", id)
})

3. 路由参数

3.1 路径参数

路径参数是一种在路径中传递动态数据的方式。例如 /users/:id,其中 :id 是一个动态参数,可以捕获并在处理函数中使用:

r.GET("/users/:id", func(c *gin.Context) {
    // 使用 c.Param("id") 获取路径参数 id 的值
    id := c.Param("id")
    c.String(200, "用户 ID 是 %s", id)
})

示例说明:

  • 当用户访问 /users/123 时,c.Param("id") 将会返回 "123"
  • 可以通过 id := c.Param("id") 获取到路径参数的值,进行进一步操作。

3.2 查询参数

查询参数用于在 URL 中传递额外数据,通常在路径后加上 ?。例如 /search?query=ginquery 为查询参数名,值为 "gin"。Gin 可以通过 c.Query("参数名") 获取查询参数。

r.GET("/search", func(c *gin.Context) {
    query := c.Query("query")
    page := c.DefaultQuery("page", "1") // 设置默认值为 "1"
    c.String(200, "查询内容:%s,页码:%s", query, page)
})

示例说明:

  • 使用 c.Query("query") 获取 query 参数的值。
  • c.DefaultQuery("page", "1") 如果没有提供 page 参数,则使用默认值 "1"

4. 路由分组

4.1 为什么使用路由分组?

路由分组用于将具有相同前缀的路由划分为一个组,便于管理。比如一个 API 可能会有不同版本 /v1/v2,在不同版本中定义相似的路由,可以简化代码。

4.2 路由分组示例

以下代码展示了如何创建带有 /v1/v2 前缀的路由分组:

v1 := r.Group("/v1")
{
    v1.GET("/users", func(c *gin.Context) {
        c.String(200, "获取 v1 版本的用户列表")
    })
    v1.POST("/users", func(c *gin.Context) {
        c.String(200, "在 v1 中创建新用户")
    })
}

v2 := r.Group("/v2")
{
    v2.GET("/users", func(c *gin.Context) {
        c.String(200, "获取 v2 版本的用户列表")
    })
}

示例说明:

  • /v1 组内定义了用户列表的 GET 和 POST 路由。
  • /v2 组内定义了用户列表的 GET 路由。
  • 这样便于管理不同 API 版本的路由。

5. 请求处理与响应

5.1 Gin 中的 Context 对象

Gin 中的 Context 对象封装了请求和响应。我们可以通过 Context 来获取请求信息并设置响应内容。Context 包含的常用方法有:

  • c.Param("参数名"):获取路径参数。
  • c.Query("参数名"):获取查询参数。
  • c.PostForm("参数名"):获取 POST 请求的表单参数。
  • c.JSON()c.XML()c.String():设置不同类型的响应内容。

5.2 JSON 响应

Gin 的 c.JSON() 方法可以用来返回 JSON 格式的数据:

r.GET("/json", func(c *gin.Context) {
    data := map[string]string{"message": "Hello, JSON"}
    c.JSON(200, data)
})

5.3 常见的响应方法

  • 纯文本响应c.String(),适用于返回简单的文本。
  • JSON 响应c.JSON(),用于返回结构化的 JSON 数据。
  • XML 响应c.XML(),用于返回 XML 格式的数据。
  • 文件响应c.File(),用于返回文件内容。

6. 实践示例:创建用户管理 API

6.1 API 功能需求

我们将实现一个简单的用户管理 API,包含以下功能:

  1. GET /user/:id - 获取用户信息。
  2. POST /user - 创建新用户。
  3. PUT /user/:id - 更新用户信息。
  4. DELETE /user/:id - 删除用户。

6.2 完整代码

以下是完整的代码示例:

package main

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

type User struct {
    ID   string `json:"id"`
    Name string `json:"name"`
    Age  int    `json:"age"`
}

var users = make(map[string]User)

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

    r.GET("/user/:id", func(c *gin.Context) {
        id := c.Param("id")
        if user, exists := users[id]; exists {
            c.JSON(200, user)
        } else {
            c.JSON(404, gin.H{"error": "User not found"})
        }
    })

    r.POST("/user", func(c *gin.Context)
    var newUser User
    if err := c.ShouldBindJSON(&newUser); err == nil {
        users[newUser.ID] = newUser
        c.JSON(201, gin.H{"message": "User created successfully", "user": newUser})
    } else {
        c.JSON(400, gin.H{"error": err.Error()})
    }
})

r.PUT("/user/:id", func(c *gin.Context) {
    id := c.Param("id")
    if user, exists := users[id]; exists {
        var updatedUser User
        if err := c.ShouldBindJSON(&updatedUser); err == nil {
            user.Name = updatedUser.Name
            user.Age = updatedUser.Age
            users[id] = user
            c.JSON(200, gin.H{"message": "User updated successfully", "user": user})
        } else {
            c.JSON(400, gin.H{"error": err.Error()})
        }
    } else {
        c.JSON(404, gin.H{"error": "User not found"})
    }
})

r.DELETE("/user/:id", func(c *gin.Context) {
    id := c.Param("id")
    if _, exists := users[id]; exists {
        delete(users, id)
        c.JSON(200, gin.H{"message": "User deleted successfully"})
    } else {
        c.JSON(404, gin.H{"error": "User not found"})
    }
})

r.Run(":8080")
}

6.3 代码解释

  • 结构体定义User 结构体表示用户信息,包含 IDNameAge
  • 全局变量users 是一个用于存储用户信息的 map,键是用户的 ID
  • GET 请求r.GET("/user/:id") 获取特定用户的详细信息。
  • POST 请求r.POST("/user") 使用 c.ShouldBindJSON(&newUser) 解析 JSON 请求体数据。
  • PUT 请求r.PUT("/user/:id") 更新现有用户的信息。
  • DELETE 请求r.DELETE("/user/:id") 删除指定的用户。

6.4 运行与测试

  1. 启动服务器:运行 go run main.go
  2. 使用 Postman 或 curl 进行请求测试:
    • 创建用户POST /user 请求体为 { "id": "1", "name": "Alice", "age": 25 }
    • 获取用户GET /user/1
    • 更新用户PUT /user/1 请求体为 { "name": "Alice Updated", "age": 26 }
    • 删除用户DELETE /user/1

7. 总结

在本篇博客中,我们详细介绍了 Gin 框架中路由与请求处理的基础知识,并通过代码示例展示了如何实现一个用户管理 API。希望这些内容能帮助你掌握 Gin 路由的基本操作。下一篇将进一步探讨 Gin 的中间件使用,带你构建更加灵活、强大的 API 服务。


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

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

相关文章

【生物服务器】数据分析//论文润色/组学技术服务 、表观组分析、互作组分析、遗传转化实验、生物医学

DNA亲和纯化测序(DAP-seq)和组蛋白甲基化修饰是表观遗传学研究中两个重要的技术手段,它们在揭示基因表达调控机制和染色质结构动态变化中发挥着关键作用。然而,在实践过程中,这两种技术也存在一些痛点和挑战。 DNA亲和…

丹摩征文活动| 摩智云端深度解析:Faster R-CNN模型的训练与测试实战指南

目录 丹摩简介 文章前言Faster R-CNN的简介Faster RCNN的训练与测试提前准备1.1 mobaxterm(远程连接服务器)1.2 本文的源码下载 目标检测模型 Faster-Rcnn2.1云服务器平台 数据上传内置JupyterLab的使用本地连接使用DAMODEL实例获取实例的SSH访问信息通过…

二叉搜索树介绍

⼆叉搜索树 二叉搜索树的概念二叉搜索树的性能分析查找性能插入性能删除性能 二叉搜索树的插入二叉搜索树的查找二叉搜索树的删除⼆叉搜索树的实现代码测试代码 二叉搜索树key和key/value使⽤场景key搜索场景key/value搜索场景key/value⼆叉搜索树代码实现测试代码 二叉搜索树的…

7.揭秘C语言输入输出内幕:printf与scanf的深度剖析

揭秘C语言输入输出内幕:printf与scanf的深度剖析 C语言往期系列文章目录 往期回顾: VS 2022 社区版C语言的安装教程,不要再卡在下载0B/s啦C语言入门:解锁基础概念,动手实现首个C程序C语言概念之旅:解锁关…

5.4.2-1 编写Java程序在HDFS上创建文件

本次实战涉及使用Java操作Hadoop HDFS,包括创建文件、判断文件存在性及异常处理。通过手动添加依赖、启动HDFS服务,成功在HDFS上创建和检查文件。进一步探索了文件操作的最佳实践,如检查文件存在性以避免重复创建,以及处理HDFS安全…

RabbitMQ教程:路由(Routing)(四)

文章目录 RabbitMQ教程:路由(Routing)(四)一、引言二、基本概念2.1 路由与绑定2.2 Direct交换机2.3 多绑定2.4 发送日志2.5 订阅 三、整合代码3.1 EmitLogDirectApp.cs3.2 ReceiveLogsDirectApp.cs3.3 推送所有和接收e…

智云-一个抓取web流量的轻量级蜜罐v1.5

智云-一个抓取web流量的轻量级蜜罐v1.5 github地址 https://github.com/xiaoxiaoranxxx/POT-ZHIYUN 新增功能-自定义漏洞信息 可通过正则来添加相关路由以及响应来伪造 nacos的版本响应如下 日流量态势 月流量态势 抓取流量效果

21.UE5游戏存档,读档,函数库

2-23 游戏存档、读档、函数库_哔哩哔哩_bilibili 目录 1.存档蓝图 2.函数库 2.1保存存档 2.2读取存档: 3.加载游戏,保存游戏 3.1游戏实例对象 3.2 加载游戏 3.3保存游戏 这一节的内容较为错综复杂,中间没有运行程序进行阶段性成果的验…

实验5:网络设备发现、管理和维护

实验5:网络设备发现、管理和维护 实验目的及要求: 通过实验,掌握Cisco 路由器和交换机的IOS配置管理。自动从NTP服务器获取时间信息。能够利用TFTP服务器实现路由器和交换机配置文件的备份和恢复。同时验证CDP协议和LLDP协议的网络参数。完…

vue 项目使用 nginx 部署

前言 记录下使用element-admin-template 改造项目踩过的坑及打包部署过程 一、根据权限增加动态路由不生效 原因是Sidebar中路由取的 this.$router.options.routes,需要在计算路由 permission.js 增加如下代码 // generate accessible routes map based on roles const acce…

DataWorks on EMR StarRocks,打造标准湖仓新范式

在大数据领域,数据仓库和实时分析系统扮演着至关重要的角色。DataWorks 基于大数据引擎,为数据仓库/数据湖/湖仓一体等解决方案提供统一的全链路大数据开发治理平台,为用户带来智能化的数据开发和分析体验。而阿里云提供的 EMR Serverless St…

七、利用CSS和多媒体美化页面的习题

题目一&#xff1a; 利用CSS技术&#xff0c;结合表格和列表&#xff0c;制作并美化 “ 翡翠阁 ”页面。运行效果如下 运行效果&#xff1a; 代码 <!DOCTYPE html> <html><head><meta charset"utf-8" /><title>翡翠阁</title>&…

游戏引擎学习第15天

视频参考:https://www.bilibili.com/video/BV1mbUBY7E24 关于游戏中文件输入输出&#xff08;IO&#xff09;操作的讨论。主要分为两类&#xff1a; 只读资产的加载 这部分主要涉及游戏中用于展示和运行的只读资源&#xff0c;例如音乐、音效、美术资源&#xff08;如 3D 模型和…

【动手学深度学习Pytorch】2. Softmax回归代码

零实现 导入所需要的包&#xff1a; import torch from IPython import display from d2l import torch as d2l定义数据集参数、模型参数&#xff1a; batch_size 256 # 每次随机读取256张图片 train_iter, test_iter d2l.load_data_fashion_mnist(batch_size) # 将展平每个…

51单片机基础05 实时时钟-思路及代码参考2、3

目录 一、思路二 1、原理图 2、代码 二、思路三 1、原理图 2、代码 一、思路二 所有设定功能相关的操作均在矩阵键盘进行实现&#xff0c;并在定时器中扫描、计数等 1、原理图 2、代码 #include <AT89X52.h> //调用51单片机的头文件 //------------------…

Notepad++的完美替代

由于Notepad的作者曾发表过可能在开发者代码中植入恶意软件的言论&#xff0c;他备受指责。在此&#xff0c;我向大家推荐一个Notepad的完美替代品——NotepadNext和Notepad--。 1、NotepadNext NotepadNext的特点&#xff1a; 1、跨平台兼容性 NotepadNext基于Electron或Qt…

Python | Leetcode Python题解之第564题数组嵌套

题目&#xff1a; 题解&#xff1a; class Solution:def arrayNesting(self, nums: List[int]) -> int:ans, n 0, len(nums)for i in range(n):cnt 0while nums[i] < n:num nums[i]nums[i] ni numcnt 1ans max(ans, cnt)return ans

面试经典 150 题:20、2、228、122

20. 有效的括号 参考代码 #include <stack>class Solution { public:bool isValid(string s) {if(s.size() < 2){ //特判&#xff1a;空字符串和一个字符的情况return false;}bool flag true;stack<char> st; //栈for(int i0; i<s.size(); i){if(s[i] ( |…

使用vscode+expo+Android夜神模拟器运行react-native项目

1.进入夜神模拟器安装路径下的bin目录 2.输入命令&#xff0c;连接Android Studio 启动夜神模拟器后&#xff0c; 打开安装目录的bin文件夹执行下面的命令&#xff0c;只需执行一次&#xff09; nox_adb.exe connect 127.0.0.1:62001adb connect 127.0.0.1:62001 3.运行项目…

【STM32】USB 简要驱动软件架构图

STM32 USB 软件架构比较复杂&#xff0c;建议去看 UM 1734 或者 st wiki STM32 USB call graph STM32 USB Device Library files organization Reference [1]: https://wiki.stmicroelectronics.cn/stm32mcu/wiki/Introduction_to_USB_with_STM32 [2]: UM1734