基于gin的golang web开发:路由示例详解

 更新时间:2020年10月21日 14:42:42   作者:陈宏博  
这篇文章主要介绍了基于gin的golang web开发:路由示例详解,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

Gin是一个用Golang编写的HTTP网络框架。它的特点是类似于Martini的API,性能更好。在golang web开发领域是一个非常热门的web框架。

启动一个Gin web服务器

使用下面的命令安装Gin

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

在代码里添加依赖

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

快速启动一个Gin服务器的代码如下

package main

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

func main() {
	r := gin.Default()
	r.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})
	r.Run()
}

核心api gin.Default()返回一个Engine对象,调用Engine对象的Run方法会在本机8080端口启动web服务器。如果不想绑定8080端口或者8080端口已被占用的话,可以给Run方法传递你要绑定的端口r.Run(":8081")。代码中的r.GET就是本文要讲解核心内容:路由。

路由

Gin支持http方法: GET, POST, PUT, PATCH, DELETE,HEAD, OPTIONS。分别对应了不同的方法。

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

	router.GET("/someGet", getting)
	router.POST("/somePost", posting)
	router.PUT("/somePut", putting)
	router.DELETE("/someDelete", deleting)
	router.PATCH("/somePatch", patching)
	router.HEAD("/someHead", head)
	router.OPTIONS("/someOptions", options)

	router.Run()
}

这些路由方法的第一个参数设置相对地址,第二个方法是访问该地址时执行的方法。在Gin中叫做handler。handler方法的原型如下。

type HandlerFunc func(*Context)

Gin还可以设置路由前缀。例如有v1/login,v1/logout两个地址可以使用Gin的Grouping routes功能设置路由前缀。

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

	v1 := router.Group("/v1")
	{
		v1.POST("/login", loginEndpoint)
		v1.POST("/logout", logoutEndpoint)
	}

	router.Run()
}

获取参数

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

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

	router.GET("/user/:name/*action", func(c *gin.Context) {
		name := c.Param("name")
		action := c.Param("action")
		message := name + " is " + action
		c.String(http.StatusOK, message)
	})

	router.GET("/welcome", func(c *gin.Context) {
		firstname := c.DefaultQuery("firstname", "Guest")
		lastname := c.Query("lastname")

		c.String(http.StatusOK, "Hello %s %s", firstname, lastname)
	})
	
	router.POST("/form_post", func(c *gin.Context) {
		message := c.PostForm("message")
		nick := c.DefaultPostForm("nick", "anonymous")

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

	router.Run(":8080")
}

可以看到获取参数的方法可以分为路由参数、查询字符串和表单。

路由参数使用c.Param("name")取值。访问/user/john时会调用/user/:name对应的handler,根据规则当访问/user/或者/user并不会调用这个hanlder。

访问/user/john/或者/user/john/send时会调用/user/:name/*action对应的handler。如果没有对/user/john设置过路由的话,访问/user/john会重定向到/user/john/。

使用DefaultQuery或者Query获取查询字符串中的参数,DefaultQuery在没有获取到参数时可以设置一个默认值。在本例中访问/welcome?firstname=Jane&lastname=Doe会调用/welcome对应的handler。

获取表单参数Gin同样也为我们提供了两种方法PostForm和DefaultPostForm。和获取查询字符串的方法一样,DefaultPostForm也可以在没有获取到参数时设置一个默认值。

Gin的Api总体来说还是很直观的,例如上文中没有提到的c.JSON从命名就可以看出会输出一段JSON。c.String直接输出字符串。http.StatusOK定义在http包中,这是一个值为200的常量。gin.H不太一样,这是一个自定义的数据类型map[string]interface{}可以用于返回JSON。

文章出处:基于gin的golang web开发:路由

到此这篇关于基于gin的golang web开发:路由示例详解的文章就介绍到这了,更多相关gin golang开发路由内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • golang使用信号量热更新的实现示例

    golang使用信号量热更新的实现示例

    这篇文章主要介绍了golang使用信号量热更新的实现示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-04-04
  • 浅析go逆向符号恢复

    浅析go逆向符号恢复

    这篇文章主要介绍了go逆向符号恢复的相关知识,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-08-08
  • 使用Golang的gomail库实现邮件发送功能

    使用Golang的gomail库实现邮件发送功能

    本篇博客详细介绍了如何使用Golang语言中的gomail库来实现邮件发送的功能,首先,需要准备工作,包括安装Golang环境、gomail库,以及申请126邮箱的SMTP服务和获取授权码,其次,介绍了在config文件中配置SMTP服务器信息的步骤
    2024-10-10
  • Go语言LeetCode500键盘行题解示例详解

    Go语言LeetCode500键盘行题解示例详解

    这篇文章主要为大家介绍了Go语言LeetCode500键盘行题解示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-12-12
  • 基于Go语言实现一个压测工具

    基于Go语言实现一个压测工具

    这篇文章主要为大家详细介绍了基于Go语言实现一个简单的压测工具,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2025-01-01
  • 详解go基于viper实现配置文件热更新及其源码分析

    详解go基于viper实现配置文件热更新及其源码分析

    这篇文章主要介绍了详解go基于viper实现配置文件热更新及其源码分析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-06-06
  • 一文带你了解Go语言中的指针和结构体

    一文带你了解Go语言中的指针和结构体

    前面的两篇文章对 Go 语言的基础语法和基本数据类型以及几个复合数据类型进行介绍,本文将对 Go 里面的指针和结构体进行介绍,也为后续文章做铺垫,感兴趣的可以了解一下
    2022-11-11
  • Go数组与切片轻松掌握

    Go数组与切片轻松掌握

    在Java的核心库中,集合框架可谓鼎鼎大名:Array、List、Set等等,随便拎一个出来都值得开发者好好学习如何使用甚至是背后的设计源码。虽然Go语言没有如此丰富的容器类型,但也有一些基本的容器供开发者使用,接下来让我们认识一下这些容器类型吧
    2022-11-11
  • go读取request.Body内容踩坑实战记录

    go读取request.Body内容踩坑实战记录

    很多初学者在使用Go语言进行Web开发时,都会遇到读取 request.Body内容的问题,这篇文章主要给大家介绍了关于go读取request.Body内容踩坑实战记录的相关资料,需要的朋友可以参考下
    2023-11-11
  • go build和go install的区别介绍

    go build和go install的区别介绍

    这篇文章主要介绍了go build和go install的区别介绍,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12

最新评论