# Gin Web 框架

Gin 是一个用 Go 编写的 Web 框架。它拥有类似 Martini 的简洁 API，由于采用了 httprouter，性能可达到比同类框架快至 40 倍的速度。如果您需要高性能和高生产力，您将会喜欢上 Gin。

Gin 的主要特性包括：

• 零分配路由器
• 快速响应
• 中间件支持
• 稳定运行，避免崩溃
• JSON 数据验证
• 路由分组功能
• 错误管理机制
• 内置渲染功能
• 易于扩展

Getting started

# 先决条件

• Go: 最近 三个主要版本 中的任意一个 发布版本（我们使用这些版本进行测试）。

# 获取 Gin

随着对 Go module 的支持，只需在您的代码中添加以下导入语句：

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

然后，执行 go [build|run|test] 将会自动获取所需的依赖包。

如果没有 Go module 支持，可以通过运行以下 Go 命令来安装 gin 包：

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

# 运行 Gin

首先，你需要为使用 Gin 导入 Gin 包，一个最简单的例子如下所示的 example.go：

package main

import (
  "net/http"

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

func main() {
  r := gin.Default()
  r.GET("/ping", func(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{
      "message": "pong",
    })
  })
  r.Run() // 在 0.0.0.0:8080 上监听并提供服务（对于 Windows 是 "localhost:8080"）
}

然后使用 Go 命令来运行这个示例：

# # 运行example.go并在浏览器中访问0.0.0.0:8080/ping

命令行操作：
```shell
$ go run example.go

（请注意，由于您提供的内容不完整，以上翻译可能在上下文中有所缺失。完整的命令应该是指示用户通过Go语言运行名为“example.go”的程序，并在运行后在浏览器中打开地址“0.0.0.0:8080/ping”来查看或测试结果。）

Learn more examples

# 快速开始

为了学习和实践更多示例，请阅读包含API示例和构建标签的Gin快速开始文档。

# 示例

在Gin examples仓库中，我们提供了一系列即用型示例，展示了Gin在各种应用场景下的使用方法。

Documentation

See API documentation and descriptions for package.

All documentation is available on the Gin website.

• English
• 简体中文
• 繁體中文
• 日本語
• Español
• 한국어
• Turkish
• Persian

# 关于Gin的文章

精选的优秀Gin框架文章列表：

• 教程：使用Go和Gin开发RESTful API

Benchmarks

Gin uses a custom version of HttpRouter, see all benchmarks details.

Benchmark name	(1)	(2)	(3)	(4)
BenchmarkGin_GithubAll	43550	27364 ns/op	0 B/op	0 allocs/op
BenchmarkAce_GithubAll	40543	29670 ns/op	0 B/op	0 allocs/op
BenchmarkAero_GithubAll	57632	20648 ns/op	0 B/op	0 allocs/op
BenchmarkBear_GithubAll	9234	216179 ns/op	86448 B/op	943 allocs/op
BenchmarkBeego_GithubAll	7407	243496 ns/op	71456 B/op	609 allocs/op
BenchmarkBone_GithubAll	420	2922835 ns/op	720160 B/op	8620 allocs/op
BenchmarkChi_GithubAll	7620	238331 ns/op	87696 B/op	609 allocs/op
BenchmarkDenco_GithubAll	18355	64494 ns/op	20224 B/op	167 allocs/op
BenchmarkEcho_GithubAll	31251	38479 ns/op	0 B/op	0 allocs/op
BenchmarkGocraftWeb_GithubAll	4117	300062 ns/op	131656 B/op	1686 allocs/op
BenchmarkGoji_GithubAll	3274	416158 ns/op	56112 B/op	334 allocs/op
BenchmarkGojiv2_GithubAll	1402	870518 ns/op	352720 B/op	4321 allocs/op
BenchmarkGoJsonRest_GithubAll	2976	401507 ns/op	134371 B/op	2737 allocs/op
BenchmarkGoRestful_GithubAll	410	2913158 ns/op	910144 B/op	2938 allocs/op
BenchmarkGorillaMux_GithubAll	346	3384987 ns/op	251650 B/op	1994 allocs/op
BenchmarkGowwwRouter_GithubAll	10000	143025 ns/op	72144 B/op	501 allocs/op
BenchmarkHttpRouter_GithubAll	55938	21360 ns/op	0 B/op	0 allocs/op
BenchmarkHttpTreeMux_GithubAll	10000	153944 ns/op	65856 B/op	671 allocs/op
BenchmarkKocha_GithubAll	10000	106315 ns/op	23304 B/op	843 allocs/op
BenchmarkLARS_GithubAll	47779	25084 ns/op	0 B/op	0 allocs/op
BenchmarkMacaron_GithubAll	3266	371907 ns/op	149409 B/op	1624 allocs/op
BenchmarkMartini_GithubAll	331	3444706 ns/op	226551 B/op	2325 allocs/op
BenchmarkPat_GithubAll	273	4381818 ns/op	1483152 B/op	26963 allocs/op
BenchmarkPossum_GithubAll	10000	164367 ns/op	84448 B/op	609 allocs/op
BenchmarkR2router_GithubAll	10000	160220 ns/op	77328 B/op	979 allocs/op
BenchmarkRivet_GithubAll	14625	82453 ns/op	16272 B/op	167 allocs/op
BenchmarkTango_GithubAll	6255	279611 ns/op	63826 B/op	1618 allocs/op
BenchmarkTigerTonic_GithubAll	2008	687874 ns/op	193856 B/op	4474 allocs/op
BenchmarkTraffic_GithubAll	355	3478508 ns/op	820744 B/op	14114 allocs/op
BenchmarkVulcan_GithubAll	6885	193333 ns/op	19894 B/op	609 allocs/op

• (1): Total Repetitions achieved in constant time, higher means more confident result
• (2): Single Repetition Duration (ns/op), lower is better
• (3): Heap Memory (B/op), lower is better
• (4): Average Allocations per Repetition (allocs/op), lower is better

# 中间件

你可以在gin-contrib找到许多有用的Gin中间件。

# 用户

使用Gin web框架的优秀项目列表：

• gorush：一款用Go编写的推送通知服务器。
• fnproject：容器原生、云平台无关的无服务器平台。
• photoprism：基于Go和Google TensorFlow的照片管理工具。
• lura：具有中间件功能的超高性能API网关。
• picfit：一款用Go编写的图片缩放服务器。
• dkron：分布式、容错的工作调度系统。

# 贡献

Gin 由数百名贡献者共同完成。我们非常感谢您的帮助！

请参阅 CONTRIBUTING 以了解提交补丁和贡献工作流程的详细信息。