Golang中HttpRouter路由的使用详解

更新时间：2023年05月26日 14:40:39 作者：技术颜良

httprouter 是一个高性能、可扩展的HTTP路由，本文将通过一些简单的示例为大家讲讲httprouter 这个强大的 HTTP 路由是如何使用的，感兴趣的小伙伴可以了解一下

httprouter

httprouter 是一个高性能、可扩展的HTTP路由，上面我们列举的net/http默认路由的不足，都被httprouter 实现，我们先用一个例子，认识下 httprouter 这个强大的 HTTP 路由。

安装：

go get -u github.com/julienschmidt/httprouter

在这个例子中，首先通过httprouter.New()生成了一个*Router路由指针,然后使用GET方法注册一个适配/路径的Index函数，最后*Router作为参数传给ListenAndServe函数启动HTTP服务即可。

package main
 
import (
    "log"
    "net/http"
 
    "github.com/julienschmidt/httprouter"
)
 
func Index(w http.ResponseWriter, r *http.Request, _ httprouter.Params) {
    w.Write([]byte("Index"))
}
 
func main() {
    router := httprouter.New()
    router.GET("/", Index)
    log.Fatal(http.ListenAndServe(":8080", router))
}

httprouter 为所有的HTTP Method 提供了快捷的使用方式，只需要调用对应的方法即可。

func (r *Router) GET(path string, handle Handle) {
    r.Handle("GET", path, handle)
}
func (r *Router) HEAD(path string, handle Handle) {
    r.Handle("HEAD", path, handle)
}
func (r *Router) OPTIONS(path string, handle Handle) {
    r.Handle("OPTIONS", path, handle)
}
func (r *Router) POST(path string, handle Handle) {
    r.Handle("POST", path, handle)
}
func (r *Router) PUT(path string, handle Handle) {
    r.Handle("PUT", path, handle)
}
func (r *Router) PATCH(path string, handle Handle) {
    r.Handle("PATCH", path, handle)
}
func (r *Router) DELETE(path string, handle Handle) {
    r.Handle("DELETE", path, handle)
}

现代的API，基本上都是Restful API，httprouter提供的命名参数的支持，可以很方便的帮助我们开发Restful API。比如我们设计的API/user/flysnow，这这样一个URL，可以查看flysnow这个用户的信息，如果要查看其他用户的，比如zhangsan,我们只需要访问API/user/zhangsan即可。

URL包括两种匹配模式：/user/:name精确匹配、/user/*name匹配所有的模式。

package main
 
import (
  "github.com/julienschmidt/httprouter"
  "net/http"
  "log"
  "fmt"
)
 
 
func main()  {
  router:=httprouter.New()
  router.GET("/MainData", func (w http.ResponseWriter,r *http.Request,_ httprouter.Params)  {
    w.Write([]byte("default get"))
  })
  router.POST("/MainData",func (w http.ResponseWriter,r *http.Request,_ httprouter.Params)  {
    w.Write([]byte("default post"))
  })
  //精确匹配
  router.GET("/user/name",func (w http.ResponseWriter,r *http.Request,p httprouter.Params)  {
    w.Write([]byte("user name:"+p.ByName("name")))
  })
  //匹配所有
  router.GET("/employee/*name",func (w http.ResponseWriter,r *http.Request,p httprouter.Params)  {
    w.Write([]byte("employee name:"+p.ByName("name")))
  })
  http.ListenAndServe(":8081", router)
}

Handler处理链处理不同二级域名

package main
 
import (
    "fmt"
    "log"
    "net/http"
 
    "github.com/julienschmidt/httprouter"
)
 
type HostMap map[string]http.Handler
 
func (hs HostMap) ServeHTTP(w http.ResponseWriter, r *http.Request) {
    fmt.Println("222")
    //根据域名获取对应的Handler路由，然后调用处理（分发机制）
    if handler := hs[r.Host]; handler != nil {
        handler.ServeHTTP(w, r)
    } else {
        http.Error(w, "Forbidden", 403)
    }
}
 
func main() {
    userRouter := httprouter.New()
    userRouter.GET("/", func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
        w.Write([]byte("play"))
    })
 
    dataRouter := httprouter.New()
    dataRouter.GET("/", func(w http.ResponseWriter, r *http.Request, _ httprouter.Params) {
        w.Write([]byte("tool"))
    })
 
    //分别用于处理不同的二级域名
    hs := make(HostMap)
    hs["user.localhost:12345"] = userRouter
    hs["data.localhost:12345"] = dataRouter
 
    log.Fatal(http.ListenAndServe(":12345", hs))
}

httprouter提供了很方便的静态文件服务，可以把一个目录托管在服务器上，以供访问。

router.ServeFiles("/static/*filepath",http.Dir("./"))

使用ServeFiles需要注意的是，第一个参数路径，必须要以/*filepath，因为要获取我们要访问的路径信息。

func (r *Router) ServeFiles(path string, root http.FileSystem) {
    if len(path) < 10 || path[len(path)-10:] != "/*filepath" {
        panic("path must end with /*filepath in path '" + path + "'")
    }
    fileServer := http.FileServer(root)
    r.GET(path, func(w http.ResponseWriter, req *http.Request, ps Params) {
        req.URL.Path = ps.ByName("filepath")
        fileServer.ServeHTTP(w, req)
    })
}

例子：

package main
import (
    "log"
    "net/http"
    "github.com/julienschmidt/httprouter"
)
func main() {
    router := httprouter.New()
  //访问静态文件
    router.ServeFiles("/static/*filepath", http.Dir("./files"))
    log.Fatal(http.ListenAndServe(":8080", router))
}

httprouter 异常捕获，httprouter允许使用者，设置PanicHandler用于处理HTTP请求中发生的panic。

package main
import (
    "fmt"
    "log"
    "net/http"
    "github.com/julienschmidt/httprouter"
)
func Index(w http.ResponseWriter, r *http.Request, _ httprouter.Params) {
    panic("error")
}
func main() {
    router := httprouter.New()
    router.GET("/", Index)
  //捕获异常
    router.PanicHandler = func(w http.ResponseWriter, r *http.Request, v interface{}) {
        w.WriteHeader(http.StatusInternalServerError)
        fmt.Fprintf(w, "error:%s", v)
    }
    log.Fatal(http.ListenAndServe(":8080", router))
}

httprouter还有不少有用的小功能，比如对404进行处理，我们通过设置Router.NotFound来实现，我们看看Router这个结构体的配置，可以发现更多有用的功能。

type Router struct {
    //是否通过重定向，给路径自定加斜杠
    RedirectTrailingSlash bool
    //是否通过重定向，自动修复路径，比如双斜杠等自动修复为单斜杠
    RedirectFixedPath bool
    //是否检测当前请求的方法被允许
    HandleMethodNotAllowed bool
    //是否自定答复OPTION请求
    HandleOPTIONS bool
    //404默认处理
    NotFound http.Handler
    //不被允许的方法默认处理
    MethodNotAllowed http.Handler
    //异常统一处理
    PanicHandler func(http.ResponseWriter, *http.Request, interface{})
}

到此这篇关于Golang中HttpRouter路由的使用详解的文章就介绍到这了,更多相关Golang HttpRouter路由内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Golang内存管理之内存逃逸分析
逃逸分析是指由编译器决定内存分配的位置，不需要程序员指定，这篇文章主要为大家详细介绍了Golang中内存逃逸分析的几种方法，需要的可以参考一下
2023-07-07
golang flag介绍和使用示例
本文主要介绍了Go语言中flag包的使用方法,详细阐述了基本概念及常用函数,并通过示例代码进行了具体演示,总结中指出,flag包提供了一种方便的方式来处理命令行参数,可定义不同类型的标志,并在解析后使用这些参数
2024-10-10
Golang中实现简单的Http Middleware
本文主要针对Golang的内置库 net/http 做了简单的扩展，实现简单的Http Middleware，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-07-07
golang配置文件解析器之goconfig框架的使用详解
goconfig是一个易于使用,支持注释的 Go 语言配置文件解析器,该文件的书写格式和 Windows 下的 INI 文件一样,本文主要为大家介绍了goconfig框架的具体使用,需要的可以参考下
2023-11-11
Go get命令使用socket代理的方法
由于某些不可描述的原因，国内使用 go get 命令安装某些包的时候会超时导致失败，比如 net 包、 sys 包、 tools 包等。这篇文章给大家介绍go get 命令使用socket 代理的方法，感兴趣的朋友一起看看吧
2018-10-10
使用golang引入外部包的三种方式:go get, go module, ve
这篇文章主要介绍了使用golang引入外部包的三种方式:go get, go module, vendor目录,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2024-01-01
Go并发编程中的错误恢复机制与代码持续执行实例探索
这篇文章主要为大家介绍了Go并发编程中的错误恢复机制与代码持续执行实例探索,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2024-01-01
golang协程关闭踩坑实战记录
协程(coroutine)是Go语言中的轻量级线程实现,下面这篇文章主要给大家介绍了关于golang协程关闭踩坑的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2023-03-03
Go语言操作redis数据库的方法
这篇文章主要介绍了Go语言操作redis数据库的方法,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-07-07
go语言中的template使用示例详解
在Go语言中,可以通过text/template和html/template包来处理模板,本文提供了一个使用Go模板的基本示例,包括导入包、创建数据结构、定义模板、执行模板及运行程序,通过这些步骤,可以输出一个格式化的YAML配置
2024-10-10

Golang中HttpRouter路由的使用详解

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具