百度360必应搜狗淘宝本站头条
mqtt服务器xftp6mybatiscollectionkeyerrorc#var
当前位置：网站首页 > 热门文章 > 正文

golang常用库:gorilla/mux-http路由库使用

bigegpt 2024-08-24 23:11 2 浏览

golang自带路由介绍#

golang自带路由库 http.ServerMux ，实际上是一个 map[string]Handler，是请求的url路径和该url路径对于的一个处理函数的映射关系。这个实现比较简单，有一些缺点：

  1. 不支持参数设定，例如/user/:uid 这种泛型类型匹配
  2. 无法很友好的支持REST模式，无法限制访问方法（POST，GET等）
  3. 也不支持正则

二：gorilla/mux路由#

github地址：https://github.com/gorilla/mux
http://www.gorillatoolkit.org/pkg/mux
https://github.com/gorilla/mux#examples


上面所指出来的glang自带路由的缺点，gorilla/mux 都具备，而且还兼容 http.ServerMux。除了支持路径正则，命名路由，还支持中间件等等功能。所以mux是一个短小精悍，功能很全的路由。

1. 普通路由#

示例 demo1.go

Copypackage main

import (
	"fmt"
	"github.com/gorilla/mux"
	"net/http"
)

func main() {
	r := mux.NewRouter()
	//普通路由
	r.HandleFunc("/", IndexHandler)
	r.HandleFunc("/products", ProductsHandler)

	http.ListenAndServe(":8080", r)
}

func IndexHandler(w http.ResponseWriter, r *http.Request) {
	w.WriteHeader(http.StatusOK)
	fmt.Fprintf(w, "hello world")
}

func ProductsHandler(w http.ResponseWriter, r *http.Request) {
	w.WriteHeader(http.StatusOK)
	fmt.Fprintf(w, "hello, Products")
}

上面mux的普通路由是不是似曾相识，跟golang标准库用法一样

在浏览器访问：http://localhost:8080/products
输出：hello, Products

2. 参数路由#

参数路由，可以是普通路由，还可以是正则匹配
示例 demo2.go：

Copypackage main

import (
	"net/http"

	"fmt"

	"github.com/gorilla/mux"
)

//路由参数
func main() {
	r := mux.NewRouter()
	//1. 普通路由参数
	// r.HandleFunc("/articles/{title}", TitleHandler)

	//2. 正则路由参数，下面例子中限制为英文字母
	r.HandleFunc("/articles/{title:[a-z]+}", TitleHandler)

	http.ListenAndServe(":8080", r)
}

//https://github.com/gorilla/mux#examples
func TitleHandler(w http.ResponseWriter, r *http.Request) {
	vars := mux.Vars(r) // 获取参数
	w.WriteHeader(http.StatusOK)
	fmt.Fprintf(w, "title: %v\n", vars["title"])
}


第1个普通路由参数，就是啥参数都可以，不管是字母，数字，还是中文等
第2个正则路由参数，限制了只能是英文字母，否则会报 404 page not found

3. 路由匹配 Matching Routes#

https://github.com/gorilla/mux#matching-routes
我们也可以限制路由或者子路由。

3.1 匹配host#

Copyr := mux.NewRouter()
//只匹配 www.example.com
r.Host("www.example.com")
// 动态匹配子路由
r.Host("{subdomain:[a-z]+}.example.com")

3.2 更多的一些其他匹配#

见下面的更多匹配的例子：

Copyr := mux.NewRouter()

r.PathPrefix("/products/")    //前缀匹配
r.Methods("GET", "POST")      //请求方法匹配
r.Schemes("https")            //schemes
r.Headers("X-Requested-With", "XMLHttpRequest")  //header 匹配
r.Queries("key", "value")  //query的值匹配

// 用户自定义方法 匹配
r.MatcherFunc(func(r *http.Request, rm *RouteMatch) bool { 
    return r.ProtoMajor == 0
})


把上面的联合起来在一个单独的route里

Copyr.HandleFunc("/products", ProductsHandler).
  Host("www.example.com").
  Methods("GET").
  Schemes("http")

3.3 子路由匹配#

Subrouter() 可以设置子路由

Copyr := mux.NewRouter()
s := r.Host("www.example.com").Subrouter()

s.HandleFunc("/products/", ProductsHandler)
s.HandleFunc("/products/{key}", ProductHandler)
s.HandleFunc("/articles/{category}/{id:[0-9]+}", ArticleHandler)

3.4 多个路由匹配的顺序#

如果有多个路由添加到路由器里面，那么匹配顺序是怎么样？按照添加的先后顺序匹配。比如有2个路由都匹配了，那么优先匹配第一个路由。

Copyr := mux.NewRouter()
r.HandleFunc("/specific", specificHandler)
r.PathPrefix("/").Handler(catchAllHandler)

4. 设置路由前缀#

PathPrefix() 设置路由前缀

Copyr := mux.NewRouter()

//PathPrefix() 可以设置路由前缀
product := r.PathPrefix("/products").HandleFunc("/", ProductsHandler)

路由前缀一般情况下不会单独使用，而是和子路由结合起来用，实现路由分组

5. 分组路由#

可以根据前面的子路由和路由前缀的功能，综合运用就可以设置分组路由了
实例：grouprouter.go

Copypackage main

import (
	"fmt"
	"github.com/gorilla/mux"
	"net/http"
)

//子路由, 分组路由
func main() {
	r := mux.NewRouter()

	//PathPrefix() 可以设置路由前缀，设置路由前缀为products
	products := r.PathPrefix("/products").Subrouter()
	//"http://localhost:8080/products/", 最后面的斜线一定要，不然路由不正确，页面出现404
	products.HandleFunc("/", ProductsHandler)
	//"http://localhost:8080/products/{key}"
	products.HandleFunc("/{key}", ProductHandler)

	users := r.PathPrefix("/users").Subrouter()
	// "/users"
	users.HandleFunc("/", UsersHandler)
	// "/users/id/参数/name/参数"
	users.HandleFunc("/id/{id}/name/{name}", UserHandler)

	http.ListenAndServe(":8080", r)
}

func ProductsHandler(w http.ResponseWriter, r *http.Request) {
	w.WriteHeader(http.StatusOK)
	fmt.Fprintf(w, "%s", "products")
}

func ProductHandler(w http.ResponseWriter, r *http.Request) {
	vars := mux.Vars(r) //获取路由的值
	fmt.Fprintf(w, "key: %s", vars["key"])
}

func UsersHandler(w http.ResponseWriter, r *http.Request) {
	fmt.Fprintf(w, " %s \r\n", "users handler")
}

func UserHandler(w http.ResponseWriter, r *http.Request) {
	vars := mux.Vars(r) //获取值
	id := vars["id"]
	name := vars["name"]
	fmt.Fprintf(w, "id: %s, name: %s \r\n", id, name)
}

6. 路由中间件#

https://github.com/gorilla/mux#middleware
Mux middlewares are defined using the de facto standard type: 在mux中路由中间件的定义

type MiddlewareFunc func(http.Handler) http.Handler

示例1：middleware1.go#

Copypackage main

import (
	"fmt"
	"net/http"

	"github.com/gorilla/mux"
)

func main() {
	r := mux.NewRouter()
	r.HandleFunc("/", handler)

	r.Use(loggingMiddleware)

	http.ListenAndServe(":8080", r)
}

func loggingMiddleware(next http.Handler) http.Handler {
	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		//Do stuff here
		fmt.Println(r.RequestURI)
		fmt.Fprintf(w, "%s\r\n", r.URL)
		// Call the next handler, which can be another middleware in the chain, or the final handler.
		next.ServeHTTP(w, r)
	})
}

func handler(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("handle middleware"))
	fmt.Println("print handler")
}

示例2：middleware2.go#

在来看一个复杂点的例子：

Copypackage main

import (
	"fmt"
	"net/http"
	"strings"

	"github.com/gorilla/mux"
)

type authMiddleware struct {
	tokenUsers map[string]string
}

func (amw *authMiddleware) Populate() {
	amw.tokenUsers = make(map[string]string)
	amw.tokenUsers["000"] = "user0"
	amw.tokenUsers["aaa"] = "userA"
	amw.tokenUsers["05ft"] = "randomUser"
	amw.tokenUsers["deadbeef"] = "user0"
}

func (amw *authMiddleware) Middleware(next http.Handler) http.Handler {
	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		token := strings.Trim(r.Header.Get("X-Session-Token"), " ")
		if token == "" {
			fmt.Fprintf(w, "token is error \r\n")
		}

		if user, found := amw.tokenUsers[token]; found {
			//we found the token in out map
			fmt.Printf("Authenticated user: %s\n", user)
			fmt.Fprintf(w, "Authenticated user: %s\n", user)
			// Pass down the request to the next middleware (or final handler)
			next.ServeHTTP(w, r)
		} else {
			// Write an error and stop the handler chain
			http.Error(w, "Forbidden", http.StatusForbidden)
		}
	})
}

func main() {
	r := mux.NewRouter()
	r.HandleFunc("/", handler)

	amw := authMiddleware{}
	amw.Populate()

	r.Use(amw.Middleware)

	http.ListenAndServe(":8080", r)
}

func handler(w http.ResponseWriter, r *http.Request) {
	w.Write([]byte("handler"))
}

用 insomnia 软件测试，如下图：


X-Session-Token=aaa 返回时正确


那 -Session-Token=aaaa 呢


返回 403 了

7. Walking Routes 遍历注册的所有路由#

Copypackage main

import (
	"fmt"
	"net/http"
	"strings"

	"github.com/gorilla/mux"
)

func handler(w http.ResponseWriter, r *http.Request) {
	return
}

//https://github.com/gorilla/mux#walking-routes
func main() {
	r := mux.NewRouter()
	r.HandleFunc("/", handler)
	r.HandleFunc("/products", handler).Methods("POST")
	r.HandleFunc("/articles", handler).Methods("GET")
	r.HandleFunc("/articles/{id}", handler).Methods("GET", "PUT")
	r.HandleFunc("/authors", handler).Queries("surname", "{surname}")
	err := r.Walk(func(route *mux.Route, router *mux.Router, ancestors []*mux.Route) error {
		pathTemplate, err := route.GetPathTemplate()
		if err == nil {
			fmt.Println("ROUTE:", pathTemplate)
		}
		pathRegexp, err := route.GetPathRegexp()
		if err == nil {
			fmt.Println("Path regexp:", pathRegexp)
		}
		queriesTemplates, err := route.GetQueriesTemplates()
		if err == nil {
			fmt.Println("Queries templates:", strings.Join(queriesTemplates, ","))
		}
		queriesRegexps, err := route.GetQueriesRegexp()
		if err == nil {
			fmt.Println("Queries regexps:", strings.Join(queriesRegexps, ","))
		}
		methods, err := route.GetMethods()
		if err == nil {
			fmt.Println("Methods:", strings.Join(methods, ","))
		}
		fmt.Println()
		return nil
	})

	if err != nil {
		fmt.Println(err)
	}

	http.Handle("/", r)
	http.ListenAndServe(":8080", nil)
}

8. 其他示例#

请求方法限制#

demo3.go:

Copypackage main

import (
	"fmt"
	"github.com/gorilla/mux"
	"net/http"
)

// 请求方法的限制, Methods()
func main() {
	r := mux.NewRouter()

	r.HandleFunc("/products", ProductsHandler).Methods("GET", "POST")

	r.Handle("/products/{id}", &ProductsIdHandler{}).Methods("GET")
	http.ListenAndServe(":8080", r)
}

func ProductsHandler(w http.ResponseWriter, r *http.Request) {
	w.WriteHeader(http.StatusOK)
	fmt.Fprintf(w, "hello, products! ")
}

type ProductsIdHandler struct{}

func (handler *ProductsIdHandler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	vars := mux.Vars(r)
	w.WriteHeader(http.StatusOK)
	fmt.Fprintf(w, "products id: %s", vars["id"])
}

请求头限制#

在路由定义中可以通过Headers() 方法来限制设置请求头的匹配。
demo4.go

Copypackage main

import (
	"fmt"
	"net/http"

	"github.com/gorilla/mux"
)

// 请求头的限制，用Headers() 来限制
func main() {
	r := mux.NewRouter()

	r.HandleFunc("/products", func(w http.ResponseWriter, r *http.Request) {
		header := "Request-Limit-Test"
		fmt.Fprintf(w, "contain headers: %s = %s \n", header, r.Header[header])
	}).Headers("Request-Limit-Test", "RequestLimitTest").Methods("POST")

	http.ListenAndServe(":8080", r)
}

自定义匹配规#

用 MatcherFunc() 来自定义规则
示例 demo5.go：**

Copypackage main

import (
	"fmt"
	"net/http"

	"github.com/gorilla/mux"
)

//自定义匹配 MatcherFunc()
func main() {
	r := mux.NewRouter()

	r.HandleFunc("/products/matcher", func(w http.ResponseWriter, r *http.Request) {
		fmt.Fprintf(w, "FormValue: %s ", r.FormValue("func"))
	}).MatcherFunc(func(req *http.Request, match *mux.RouteMatch) bool {
		b := false
		if req.FormValue("func") == "matcherfunc" {
			b = true
		}
		return b
	})

	http.ListenAndServe(":8080", r)
}


在浏览器中：http://127.0.0.1:8080/products/matcher?func=matcherfunc
输出：FormValue: matcherfunc

命名路由 Registered URLs#

namerouter.go

Copypackage main

import (
	"fmt"
	"github.com/gorilla/mux"
	// "log"
	"net/http"
)

// 命名路由 Name(), 获取路由URL， URL()
func main() {
	r := mux.NewRouter()
	r.HandleFunc("/products/{category}/{id:[0-9]+}", ProductHandler).Name("product")

	//获取路由的URL
	url1, err := r.Get("product").URL()
	fmt.Println(err) //error: mux: number of parameters must be multiple of 2, got [/]
	if err == nil {
		fmt.Println("get URL: \r\n", url1)
	}

	//获取路由的url后，也可以拼装你需要的URL
	url2, err := r.Get("product").URL("category", "tech", "id", "13")
	if err == nil {
		fmt.Println("new url: ", url2) //new url:  /products/tech/13
	}

	http.ListenAndServe(":8080", r)
}

func ProductHandler(w http.ResponseWriter, r *http.Request) {
	w.WriteHeader(http.StatusOK)
	vars := mux.Vars(r)

	fmt.Fprintf(w, "url: %s, category: %s, id: %s", r.URL, vars["category"], vars["id"])
	//浏览器： http://localhost:8080/products/id/23

	//output
	//url: /products/id/23, category: id, id: 23
}

根据命名的路由来获取路由URL r.Get("product").URL()

相关推荐

AI「自我复制」能力曝光，RepliBench警示:大模型正在学会伪造身份

科幻中AI自我复制失控场景，正成为现实世界严肃的研究课题。英国AISI推出RepliBench基准，分解并评估AI自主复制所需的四大核心能力。测试显示，当前AI尚不具备完全自主复制能力，但在获取资源...

【Python第三方库安装】介绍8种情况，这里最全看这里就够了!

**本图文作品主要解决CMD或pycharm终端下载安装第三方库可能出错的问题**本作品介绍了8种安装方法，这里最全的python第三方库安装教程，简单易上手，满满干货！希望大家能愉快地写代码，而不要...

pyvips，一个神奇的 Python 库!（pythonvip视频）

大家好，今天为大家分享一个神奇的Python库-pyvips。在图像处理领域，高效和快速的图像处理工具对于开发者来说至关重要。pyvips是一个强大的Python库，基于libvips...

mac 安装tesseract、pytesseract以及简单使用

一.tesseract-OCR的介绍1.tesseract-OCR是一个开源的OCR引擎，能识别100多种语言，专门用于对图片文字进行识别，并获取文本。但是它的缺点是对手写的识别能力比较差。2.用te...

实测o3/o4-mini:3分钟解决欧拉问题，OpenAI最强模型名副其实!

号称“OpenAI迄今为止最强模型”，o3/o4-mini真实能力究竟如何？就在发布后的几小时内，网友们的第一波实测已新鲜出炉。最强推理模型o3，即使遇上首位全职提示词工程师RileyGoodsid...

使用Python将图片转换为字符画并保存到文件

字符画（ASCIIArt）是将图片转换为由字符组成的艺术作品。利用Python，我们可以轻松实现图片转字符画的功能。本教程将带你一步步实现这个功能，并详细解释每一步的代码和实现原理。环境准备首先，你...

5分钟-python包管理器pip安装（python pip安装包）

pip是一个现代的，通用、普遍的Python包管理工具。提供了对Python包的查找、下载、安装、卸载的功能，是Python开发的基础。第一步：PC端打开网址：选择gz后缀的文件下载第二步：...

网络问题快速排查，你也能当好自己家的网络攻城狮

前面写了一篇关于网络基础和常见故障排查的，只列举了工具。没具体排查方式。这篇重点把几个常用工具的组合讲解一下。先有请今天的主角：nslookup及dig，traceroute，httping，teln...

终于把TCP/IP 协议讲的明明白白了，再也不怕被问三次握手了

文：涤生_Woo下周就开始和大家成体系的讲hadoop了，里面的每一个模块的技术细节我都会涉及到，希望大家会喜欢。当然了你也可以评论或者留言自己喜欢的技术，还是那句话，希望咱们一起进步。今天周五，讲讲...

记一次工控触摸屏故障的处理（工控触摸屏维修）

先说明一下，虽然我是自动化专业毕业，但已经很多年不从事现场一线的工控工作了。但自己在单位做的工作也牵涉到信息化与自动化的整合，所以平时也略有关注。上一周一个朋友接到一个活，一家光伏企业用于启动机组的触...

19、90秒快速“读懂”路由、交换命令行基础

命令行视图VRP分层的命令结构定义了很多命令行视图，每条命令只能在特定的视图中执行。本例介绍了常见的命令行视图。每个命令都注册在一个或多个命令视图下，用户只有先进入这个命令所在的视图，才能运行相应的命...

摄像头没图像的几个检查方法（摄像头没图像怎么修复）

背景描述：安防监控项目上，用户的摄像头运行了一段时间有部分摄像头不能进行预览，需要针对不能预览的摄像头进行排查，下面列出几个常见的排查方法。问题解决：一般情况为网络、供电、设备配置等情况。一，网络检查...

小谈:必需脂肪酸（必需脂肪酸主要包括）

必需脂肪酸是指机体生命活动必不可少，但机体自身又不能合成，必需由食物供给的多不饱和脂肪酸（PUFA）。必需脂肪酸主要包括两种，一种是ω-3系列的α-亚麻酸（18：3），一种是ω-6系列的亚油酸（18：...

期刊推荐:15本sci四区易发表的机械类期刊

　　虽然，Sci四区期刊相比收录在sci一区、二区、三区的期刊来说要求不是那么高，投稿起来也相对容易一些。但，sci四区所收录的期刊中每本期刊的投稿难易程度也是不一样的。为方便大家投稿，本文给大家推荐...

be sick of 用法考察（be in lack of的用法）

besick表示病了,做谓语.本身是形容词，有多种意思.最通常的是：生病,恶心，呕吐，不适，晕，厌烦，无法忍受asickchild生病的孩子Hermother'sverysi...

一周热门
最近发表
标签列表