在 Goji 中映射所有路由及其 http 方法答案

【问题标题】：Mapping all routes and its http methods in Goji在 Goji 中映射所有路由及其 http 方法
【发布时间】：2015-05-22 02:19:56
【问题描述】：

我想映射每条路由及其请求类型（GET、POST、PUT、...），以便为我的 restful API 生成类似于 JSON 格式的 sitemap.xml。

Goji 使用函数来创建新路线。我可以将路径和处理程序存储在地图中。

我的方法是这样的，除了编译器给出了以下初始化循环错误，因为sitemap 和routes 相互引用（路由图包含应该 marhsall 本身的处理程序站点地图）。

main.go:18: initialization loop:
    main.go:18 routes refers to
    main.go:41 sitemap refers to
    main.go:18 routes

这可以以更惯用的方式实现吗？

package main

import (
    "encoding/json"
    "net/http"

    "github.com/zenazn/goji"
    "github.com/zenazn/goji/web"
)

var routes = []Route{
    Route{"Get", "/index", hello},
    Route{"Get", "/sitemap", sitemap},
}

type Route struct {
    Method  string          `json:"method"`
    Pattern string          `json:"pattern"`
    Handler web.HandlerType `json:"-"`
}

func NewRoute(method, pattern string, handler web.HandlerType) {
    switch method {
    case "Get", "get":
        goji.DefaultMux.Get(pattern, handler)
    case "Post", "post":
        goji.DefaultMux.Post(pattern, handler)
        // and so on...
    }

}

func hello(c web.C, w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("Hello world"))
}

func sitemap(c web.C, w http.ResponseWriter, r *http.Request) {
    // BUG: sitemap tries to marshall itself recursively
    resp, _ := json.MarshalIndent(routes, "", "    ")
// some error handling...
    w.Write(resp)
}

func main() {

    for _, r := range routes {
        NewRoute(r.Method, r.Pattern, r.Handler)
    }

    goji.Serve()
}

【问题讨论】：

通常我会这样做，但我不想让示例尽可能简单。感谢init() 的提示
wrt 错误，没关系；只是我在“真实”代码中经常看到这种情况，可能来自天真的人剪切-粘贴，这就是为什么我有时会指出它，我更喜欢将示例简化为不亚于检查错误的评论（即@ 987654327@ 或类似的）
我添加了一个注解。
你会坚持使用 switch-case 方法吗？
我不知道/使用goji，所以我不熟悉它。但是，您的两种情况调用具有相同签名的函数，因此也许您可以考虑使用接口或type x func(string, web.Handler)，作为参数或映射条目（或Route 的字段）或其他。由于这可能与问题无关或太健谈，如果您愿意，我们可以将其发送至 Stack Overflow Chat。

标签： go routes goji

【解决方案1】：

避免初始化循环的最简单方法是通过延迟其中一项初始化来中断循环。

例如：

var routes []Route

func init() {
    routes = []Route{
        Route{"Get", "/index", hello},
        Route{"Get", "/sitemap", sitemap},
    }
}

通过此更改，您的代码可以编译。

[在chat之后编辑：]

下面是一个完全编辑且可运行的示例，它还解决了您关于switch 的问题：

package main

import (
    "encoding/json"
    "net/http"

    "github.com/zenazn/goji"
    "github.com/zenazn/goji/web"
)

var routes []Route

func init() {
    // Initialzed in init() to avoid an initialization loop
    // since `routes` refers to `sitemap` refers to `routes`.
    routes = []Route{
        Route{"Get", "/index", hello},
        Route{"Get", "/sitemap", sitemap},
        //Route{"Post", "/somewhereElse", postHandlerExample},
    }
}

type Route struct {
    Method  string          `json:"method"`
    Pattern string          `json:"pattern"`
    Handler web.HandlerType `json:"-"`
}

var methods = map[string]func(web.PatternType, web.HandlerType){
    "Get":  goji.Get,
    "Post": goji.Post,
    // … others?
}

func (r Route) Add() {
    //log.Println("adding", r)
    methods[r.Method](r.Pattern, r.Handler)
}

func hello(c web.C, w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("Hello world"))
}

func sitemap(c web.C, w http.ResponseWriter, r *http.Request) {
    resp, err := json.MarshalIndent(routes, "", "    ")
    if err != nil {
        http.Error(w, "Can't generate response properly.", 500)
        return
    }

    w.Write(resp)
}

func main() {
    for _, r := range routes {
        r.Add()
    }
    goji.Serve()
}

以gist 的形式提供。

我会注意到像你这样的开关没有任何问题，在这种情况下，如果只有两种方法，则地图可能会矫枉过正。一个previous version of the example 没有使用映射并明确指定函数和方法名称（预期匹配）。

此外，此版本不检查无效的方法名称（如果 routes 始终是硬编码并且在运行时从不更改是合理的）。如果需要，如果/当!ok 时，可以直接做fn, ok := methods[r.Method] 并做其他事情。

【讨论】：