Gin框架操作指南08：日志与安全

news2024/12/25 15:57:23

官方文档地址（中文）：https://gin-gonic.com/zh-cn/docs/
注：本教程采用工作区机制，所以一个项目下载了Gin框架，其余项目就无需重复下载，想了解的读者可阅读第一节：Gin操作指南：开山篇。
本节演示日志与安全相关的API，包括定义路由日志的格式；如何记录日志；安全页眉；使用BasicAuth中间件；使用HTTP方法。其中控制日志输出颜色就是将gin.DisableConsoleColor()替换为gin.ForceConsoleColor()，读者可自行尝试，本文不做演示。在开始之前，我们需要在”04日志与安全“目录下打开命令行，执行如下命令来创建子目录：

mkdir 定义路由日志的格式 如何记录日志 安全页眉 使用BasicAuth中间件 使用HTTP方法

目录

    • 一、定义路由日志的格式
    • 二、如何记录日志
    • 三、安全页眉
    • 四、使用BasicAuth中间件
    • 五、使用HTTP方法

一、定义路由日志的格式

默认的路由日志格式：

[GIN-debug] POST   /foo                      --> main.main.func1 (3 handlers)
[GIN-debug] GET    /bar                      --> main.main.func2 (3 handlers)
[GIN-debug] GET    /status                   --> main.main.func3 (3 handlers)

如果你想要以指定的格式（例如 JSON，key values 或其他格式）记录信息，则可以使用 gin.DebugPrintRouteFunc 指定格式。 在下面的示例中，我们使用标准日志包记录所有路由，但你可以使用其他满足你需求的日志工具。

package main

import (
	"log"      // 导入标准日志包，用于记录日志信息
	"net/http" // 导入 net/http 包，用于 HTTP 状态码和相关类型

	"github.com/gin-gonic/gin" // 导入 Gin 框架
)

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

	// 自定义路由打印函数，以指定的格式记录路由信息
	gin.DebugPrintRouteFunc = func(httpMethod, absolutePath, handlerName string, nuHandlers int) {
		// 使用标准日志包打印每个路由的 HTTP 方法、绝对路径、处理函数名称和处理函数数量
		log.Printf("endpoint %v %v %v %v\n", httpMethod, absolutePath, handlerName, nuHandlers)
	}

	// 定义 POST 路由 /foo
	r.POST("/foo", func(c *gin.Context) {
		// 返回 JSON 响应，内容为 "foo" 和 HTTP 状态码 200
		c.JSON(http.StatusOK, "foo")
	})

	// 定义 GET 路由 /bar
	r.GET("/bar", func(c *gin.Context) {
		// 返回 JSON 响应，内容为 "bar" 和 HTTP 状态码 200
		c.JSON(http.StatusOK, "bar")
	})

	// 定义 GET 路由 /status
	r.GET("/status", func(c *gin.Context) {
		// 返回 JSON 响应，内容为 "ok" 和 HTTP 状态码 200
		c.JSON(http.StatusOK, "ok")
	})

	// 监听并在 0.0.0.0:8080 上启动服务
	r.Run() // 启动 Gin 路由引擎
}

效果
GET测试
在这里插入图片描述

POST测试
在这里插入图片描述

二、如何记录日志

package main

import (
	"io" // 导入 io 包，用于多路写入
	"os" // 导入 os 包，用于文件操作

	"github.com/gin-gonic/gin" // 导入 Gin 框架
)

func main() {
	// 禁用控制台颜色，将日志写入文件时不需要控制台颜色。
	gin.DisableConsoleColor()

	// 创建一个文件用于保存日志，文件名为 "gin.log"
	f, err := os.Create("gin.log")
	if err != nil {
		panic(err) // 如果文件创建失败，抛出错误
	}

	// 设置 Gin 的默认写入器，将日志写入到刚创建的文件中
	gin.DefaultWriter = io.MultiWriter(f)

	// 如果需要同时将日志写入文件和控制台，请使用以下代码。
	// gin.DefaultWriter = io.MultiWriter(f, os.Stdout)

	// 创建默认的 Gin 路由引擎
	router := gin.Default()

	// 定义 GET 路由 /ping
	router.GET("/ping", func(c *gin.Context) {
		// 返回字符串 "pong" 和 HTTP 状态码 200
		c.String(200, "pong")
	})

	// 监听并在 0.0.0.0:8080 上启动服务
	router.Run(":8080") // 启动 Gin 路由引擎
}

效果
注意，启动后控制台是没有输出的，因为屏蔽了颜色，但go.mod旁边会出现gin.log文件，打开即可看到控制台的输出
在这里插入图片描述
打开浏览器，测试，log文件会变化
在这里插入图片描述

三、安全页眉

使用安全标头保护网络应用程序免受常见安全漏洞的攻击非常重要。本示例将向您展示如何在 Gin 应用程序中添加安全标头，以及如何避免与主机标头注入相关的攻击（SSRF、开放重定向）。

package main

import (
	"net/http" // 导入 net/http 包，用于 HTTP 相关的功能

	"github.com/gin-gonic/gin" // 导入 Gin 框架
)

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

	// 设置期望的主机头部（Host Header）
	expectedHost := "localhost:8080"

	// 设置安全标头的中间件
	r.Use(func(c *gin.Context) {
		// 检查请求中的 Host 是否符合预期
		if c.Request.Host != expectedHost {
			// 如果 Host 不正确，返回 400 错误并结束请求
			c.AbortWithStatusJSON(http.StatusBadRequest, gin.H{"error": "Invalid host header"})
			return
		}
		// 设置安全标头以保护应用程序
		c.Header("X-Frame-Options", "DENY")                                                                                                                                    // 防止点击劫持
		c.Header("Content-Security-Policy", "default-src 'self'; connect-src *; font-src *; script-src-elem * 'unsafe-inline'; img-src * data:; style-src * 'unsafe-inline';") // 防止跨站脚本攻击
		c.Header("X-XSS-Protection", "1; mode=block")                                                                                                                          // 启用 XSS 保护
		c.Header("Strict-Transport-Security", "max-age=31536000; includeSubDomains; preload")                                                                                  // 强制使用 HTTPS
		c.Header("Referrer-Policy", "strict-origin")                                                                                                                           // 控制引用来源
		c.Header("X-Content-Type-Options", "nosniff")                                                                                                                          // 防止 MIME 类型嗅探
		c.Header("Permissions-Policy", "geolocation=(),midi=(),sync-xhr=(),microphone=(),camera=(),magnetometer=(),gyroscope=(),fullscreen=(self),payment=()")                 // 控制特定功能的权限
		c.Next()                                                                                                                                                               // 继续处理请求
	})

	// 定义 GET 路由 /ping
	r.GET("/ping", func(c *gin.Context) {
		// 返回 JSON 响应，包含 "pong" 消息
		c.JSON(200, gin.H{
			"message": "pong", // 消息内容
		})
	})

	// 启动服务，监听 0.0.0.0:8080
	r.Run() // listen and serve on 0.0.0.0:8080
}

打开postman，输入http://localhost:8080/ping，此时直接点send，或者随意设置headers中的key和value，只要key不是host（不区分大小写），均能正常输出。但如果在headers中设置了key为host（不区分大小写），那么value就必须是代码中设置好的值，这里是localhost:8080，否则出错，如图：
在这里插入图片描述

四、使用BasicAuth中间件

package main

import (
	"net/http"

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

// 模拟一些私人数据，使用 map 结构存储用户的私人信息
var secrets = gin.H{
	"foo":    gin.H{"email": "foo@bar.com", "phone": "123433"},     // 用户 foo 的私人信息
	"austin": gin.H{"email": "austin@example.com", "phone": "666"}, // 用户 austin 的私人信息
	"lena":   gin.H{"email": "lena@guapa.com", "phone": "523443"},  // 用户 lena 的私人信息
}

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

	// 路由组使用 gin.BasicAuth() 中间件，保护 /admin 路径
	// gin.Accounts 是 map[string]string 的一种快捷方式，设置用户和密码
	authorized := r.Group("/admin", gin.BasicAuth(gin.Accounts{
		"foo":    "bar",    // 用户 foo 的密码
		"austin": "1234",   // 用户 austin 的密码
		"lena":   "hello2", // 用户 lena 的密码
		"manu":   "4321",   // 用户 manu 的密码
	}))

	// /admin/secrets 端点处理，只有经过 Basic Auth 验证的用户可以访问
	// 当用户访问 "localhost:8080/admin/secrets" 时，将触发此处理函数
	authorized.GET("/secrets", func(c *gin.Context) {
		// 获取当前用户的信息，它是由 BasicAuth 中间件设置的
		user := c.MustGet(gin.AuthUserKey).(string)
		if secret, ok := secrets[user]; ok {
			// 如果找到了用户的私人信息，返回该信息
			c.JSON(http.StatusOK, gin.H{"user": user, "secret": secret})
		} else {
			// 如果未找到用户的私人信息，返回默认信息
			c.JSON(http.StatusOK, gin.H{"user": user, "secret": "NO SECRET :("})
		}
	})

	// 监听并在 0.0.0.0:8080 上启动服务，等待请求
	r.Run(":8080")
}

效果
在这里插入图片描述

五、使用HTTP方法

package main

import (
	"net/http"

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

// 获取请求的处理函数
func getting(c *gin.Context) {
	c.JSON(http.StatusOK, gin.H{"message": "GET request successful"})
}

// 处理 POST 请求的处理函数
func posting(c *gin.Context) {
	c.JSON(http.StatusOK, gin.H{"message": "POST request successful"})
}

// 处理 PUT 请求的处理函数
func putting(c *gin.Context) {
	c.JSON(http.StatusOK, gin.H{"message": "PUT request successful"})
}

// 处理 DELETE 请求的处理函数
func deleting(c *gin.Context) {
	c.JSON(http.StatusOK, gin.H{"message": "DELETE request successful"})
}

// 处理 PATCH 请求的处理函数
func patching(c *gin.Context) {
	c.JSON(http.StatusOK, gin.H{"message": "PATCH request successful"})
}

// 处理 HEAD 请求的处理函数
func head(c *gin.Context) {
	// HEAD 请求只返回状态和头部，不返回请求体
	c.Status(http.StatusOK) // 返回状态码 200
}

// 处理 OPTIONS 请求的处理函数
func options(c *gin.Context) {
	// OPTIONS 请求返回允许的 HTTP 方法
	c.JSON(http.StatusOK, gin.H{"methods": "GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS"})
}

func main() {
	// 禁用控制台颜色
	// gin.DisableConsoleColor()

	// 使用默认中间件（logger 和 recovery 中间件）创建 gin 路由
	router := gin.Default()

	// 定义各个 HTTP 方法的路由及其处理函数
	router.GET("/someGet", getting)         // 处理 GET 请求
	router.POST("/somePost", posting)       // 处理 POST 请求
	router.PUT("/somePut", putting)         // 处理 PUT 请求
	router.DELETE("/someDelete", deleting)  // 处理 DELETE 请求
	router.PATCH("/somePatch", patching)    // 处理 PATCH 请求
	router.HEAD("/someHead", head)          // 处理 HEAD 请求
	router.OPTIONS("/someOptions", options) // 处理 OPTIONS 请求

	// 默认在 8080 端口启动服务，除非定义了一个 PORT 的环境变量。
	router.Run() // 启动服务并监听端口
	// router.Run(":3000") // 如果需要硬编码端口号，可以取消注释这一行
}

效果
使用 Postman 进行测试：
GET 请求：
选择 GET 方法，输入 URL http://localhost:8080/someGet，点击 Send。
POST 请求：
选择 POST 方法，输入 URL http://localhost:8080/somePost，点击 Send。
PUT 请求：
选择 PUT 方法，输入 URL http://localhost:8080/somePut，点击 Send。
DELETE 请求：
选择 DELETE 方法，输入 URL http://localhost:8080/someDelete，点击 Send。
PATCH 请求：
选择 PATCH 方法，输入 URL http://localhost:8080/somePatch，点击 Send。
HEAD 请求：
选择 HEAD 方法，输入 URL http://localhost:8080/someHead，点击 Send。
OPTIONS 请求：
选择 OPTIONS 方法，输入 URL http://localhost:8080/someOptions，点击 Send。
这里只展示一个：
在这里插入图片描述

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

【C++】红黑树模拟实现map和set

【C++】红黑树模拟实现map和set

本篇基于上篇红黑树的代码来实现： 【C】红黑树-CSDN博客 关于map和set可以看：​​​​ 【C】map和set的介绍和使用-CSDN博客 改造红黑树 map底层是红黑树的KV模型，set是红黑树的K模型，按理来说，应该设计两种红黑树来…
阅读更多...
企业培训平台开发指南：基于在线教育系统源码的实现路径解析

企业培训平台开发指南：基于在线教育系统源码的实现路径解析

本篇文章，小编将通过对在线教育系统源码的解读，深入探讨企业培训平台的开发路径，帮助企业高效构建适合自身需求的培训系统。 一、企业培训平台的需求分析 在开发企业培训平台之前，首先要对企业的实际需求进行充分分析。每个企业…
阅读更多...
各种开发编程软件的下载方法--visio，navicat，pycharm，matlab等

各种开发编程软件的下载方法--visio，navicat，pycharm，matlab等

各类开发编程类软件的下载方法 一、需要付费的 之前在网络上有很多显示可以免费下载的软件，不是各种在解压时需要密码的，就是有各种病毒的，绕一圈可能还得收费。 最早之前用的是 “A软件安装管家” 这个公众号里的，后来停更了&…
阅读更多...
【优选算法篇】双指针的华丽探戈：深入C++算法殿堂的优雅追寻

【优选算法篇】双指针的华丽探戈：深入C++算法殿堂的优雅追寻

文章目录 C 双指针详解：进阶题解与思维分析前言第一章：有效三角形的个数1.1 有效三角形的个数示例 1：示例 2：解法一（暴力求解）解法二（排序 双指针）易错点提示代码解读 第二章&#…
阅读更多...
C++的魔法世界：类和对象的终章

C++的魔法世界：类和对象的终章

文章目录 一、再探构造函数二、类型转换2.1隐式类型转换2.2内置类型的类型转化2.3explicit关键字2.4多参数构造 三、static成员四、友元五、内部类内部类的特性 六、匿名对象 一、再探构造函数 类和对象(中)里介绍的构造函数，使用的是赋值实现成员变量的初始化。而…
阅读更多...
【word】文章里的表格边框是双杠

【word】文章里的表格边框是双杠

日常小伙伴们遇到word里插入的表格，边框是双杠的，直接在边框和底纹里修改边框的样式就可以，但我今天遇到的这个有点特殊，先看看表格在word里的样式是怎么样，然后我们聊聊如何解决。 这个双杠不是边框和底纹的设置原因…
阅读更多...
亚洲 Web3 市场：Q3 监管变化与市场驱动力探析

亚洲 Web3 市场：Q3 监管变化与市场驱动力探析

概述： 亚洲的 Web3 市场在2024年第三季度继续表现出强劲增长势头。得益于技术精通的人口基础、政府的积极政策导向和企业的大规模参与，韩国、日本、越南等国家已然走在行业前沿。此外，随着越来越多的监管框架落地，区块链创新不断…
阅读更多...
Ubuntu20.04下安装多CUDA版本，以及后续切换卸载

Ubuntu20.04下安装多CUDA版本，以及后续切换卸载

本方案的前提是假设机子上已经有一个版本的cuda，现在需要支持新的torch2.1.2和torchvision0.16.2，于是来安装新的cuda 一、选择版本 如果我想安装支持torch2.1.2的cuda版本，到官网（https://pytorch.org/get-started/previous-ve…
阅读更多...
【Python文件操作】掌握文件读写和目录管理的技巧！

【Python文件操作】掌握文件读写和目录管理的技巧！

【Python文件操作】掌握文件读写和目录管理的技巧！ 在现代编程中，文件操作是不可避免的一部分，尤其是在处理数据、日志、配置文件等场景下。Python 提供了强大而简洁的文件操作方法，可以轻松完成文件的读取、写入和目录管理等操作…
阅读更多...
005_django基于Python的乡村居民信息管理系统设计与实现2024_106f2qg9

005_django基于Python的乡村居民信息管理系统设计与实现2024_106f2qg9

目录 系统展示 开发背景 代码实现 项目案例 获取源码 博主介绍：CodeMentor毕业设计领航者、全网关注者30W群落，InfoQ特邀专栏作家、技术博客领航者、InfoQ新星培育计划导师、Web开发领域杰出贡献者，博客领航之星、开发者头条/腾讯云/AW…
阅读更多...
SpringMVC源码-异常处理机制

SpringMVC源码-异常处理机制

定义一个异常处理类TestErrorController: Controller public class TestErrorController {RequestMapping("/exception")public ModelAndView exception(ModelAndView view) throws ClassNotFoundException {view.setViewName("index");throw new ClassNot…
阅读更多...
Mysql主从集群搭建+分库分表+ShardingSphere（实战）

Mysql主从集群搭建+分库分表+ShardingSphere（实战）

什么是 ShardingSphere 介绍 Apache ShardingSphere 是一款分布式的数据库生态系统， 可以将任意数据库转换为分布式数据库，并通过数据分片、弹性伸缩、加密等能力对原有数据库进行增强。 Apache ShardingSphere 设计哲学为 Database Plus，…
阅读更多...
CRMEB标准版Mysql修改sql_mode

CRMEB标准版Mysql修改sql_mode

数据库配置 1.宝塔控制面板-软件商店-MySql-设置 2.点击配置修改，查找sql-mode或sql_mode （可使用CtrlF快捷查找） 3.复制 NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION 然后替换粘贴，保存 注：MySQL8.0版本的 第三步用…
阅读更多...
Redis --- 第四讲 --- 常用数据结构 --- string类型

Redis --- 第四讲 --- 常用数据结构 --- string类型

一、认识数据类型和编码方式 有序集合，相当于除了存储member之外，还需要存储一个score（权重，分数） Redis底层在实现上述数据结构的时候，会在源码层面，针对上述实现进行特定的优化，来…
阅读更多...
文生图：Stable Diffusion、Midjourny

文生图：Stable Diffusion、Midjourny

前言 Stable Diffusion（SD）和Midjourney（MJ）是当前流行的两款AI图像生成工具，它们各有特点和优势： **- Stable Diffusion是完全开源的，**这意味着用户可以免费使用，并且有技术能力…
阅读更多...
excel如何把年龄转换为日期

excel如何把年龄转换为日期

总体的思路 我们从一个核心的日期函数出发 我们首先需要年月日 我的数据大概是这样的。 获取年份 第一步：提取岁前面的数字 left(目标单元格，“从左到右获取第几个字符”)第二步:替换掉数字后面的岁 第三步:新增一个单元格 在里面填入年 第四步:用…
阅读更多...
Android系統Audio hal

Android系統Audio hal

一.Android系統Audio hal简介 Android系统的音频硬件抽象层（HAL）是系统与硬件之间的桥梁，允许音频应用和服务访问底层音频硬件，而无需直接与硬件交互。 主要组件： 音频 HAL 接口：定义了应用和服务如何调用音频硬件的规范。典型的音频操作包括播放、录制、音量控制等。 …
阅读更多...
N1060A 50/85GHz精密型波形分析模块

N1060A 50/85GHz精密型波形分析模块

N1060A 50/85GHz精密型波形分析模块 苏州新利通 概述 Keysight N1060A 精密型波形分析仪是一款数字通信分析仪（DCA）模块，可与 Keysight N1000A 主机兼容。 与是德科技的所有其他 DCA 模块一样，N1060A 提供了广泛的配置和性能选…
阅读更多...
【C语言】数组函数冒泡排序bubble sort

【C语言】数组函数冒泡排序bubble sort

数组：对于n个数字进行排序，就必须定义n个变量来存储。那么为了统一处理，选择数组就十分便捷了。 函数：将排序算法写到函数中，后续遇到所有的排序需求，都可以直接进行调用。 冒泡排序：受气泡在水…
阅读更多...
HDFS详细分析

HDFS详细分析

目录 一、HDFS架构 （1）Block - 数据块 （2）MetaData - 元数据 （3）NameNode - 主结点 （4）DataNode - 从结点 （5）SecondaryNameNode 二、HDFS的特点 &…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023