Go：构建一个可根据配置文件生成 URL 的服务器

来到golang学习网的大家，相信都是编程学习爱好者，希望在这里学习Golang相关编程知识。下面本篇文章就来带大家聊聊《Go：构建一个可根据配置文件生成 URL 的服务器》，介绍一下，希望对大家的知识积累有所帮助，助力实战开发！

由于我是 golang 新手，有人可以帮助我吗？我有一个 yaml 文件，如下所示：

port: 5000
handlers:
  - name: test1
    uri: /api/test1
    response:
      status: 200
      body: test1
  - name: test2
    uri: /api/test2
    response:
      status: 500
      body: test2

基于这个文件我想创建一个服务器。目前我正在尝试这样做，但看起来它没有按预期工作。 我做错了什么以及实现我需要的更好方法是什么？

package main

import (
    "fmt"
    "io/ioutil"
    "log"
    "net/http"

    "gopkg.in/yaml.v2"
)

func main() {
    config := parseYaml("conf.yaml")
    configHandlers := config.Handlers
    mux := http.NewServeMux()
    for _, handler := range *configHandlers {
        mux.HandleFunc(*handler.Uri, func(w http.ResponseWriter, r *http.Request) {
            w.WriteHeader(*handler.Response.Status)
            fmt.Fprintf(w, *handler.Response.Body)
        })
    }
    log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", *config.Port), mux))
}

type YamlConfig struct {
    Port     *string          `yaml:"port"`
    Handlers *[]HandlerConfig `yaml:"handlers"`
}

type HandlerConfig struct {
    Uri      *string   `yaml:"uri"`
    Name     *string   `yaml:"name"`
    Response *Response `yaml:"response"`
}

type Response struct {
    Status *int    `yaml:"status"`
    Body   *string `yaml:"body"`
}

func (c *YamlConfig) parseYaml(data []byte) error {
    return yaml.Unmarshal(data, c)
}

func parseYaml(path string) YamlConfig {
    data, err := ioutil.ReadFile(path)
    if err != nil {
        log.Fatal(err)
    }
    var config YamlConfig
    if err := config.parseYaml(data); err != nil {
        log.Fatal(err)
    }
    return config
}

更新： 如果我运行此服务器，那么无论我点击哪个端点，它总是会在正文中返回 500 和 test2

正确答案

您所看到的似乎是人们常见的陷阱：

confighandlers := config.handlers
mux := http.newservemux()
for _, handler := range *confighandlers {
    mux.handlefunc(*handler.uri, func(w http.responsewriter, r *http.request) {
        w.writeheader(*handler.response.status)
        fmt.fprintf(w, *handler.response.body)
    })
}

for 循环在每次迭代时都会重新分配 handler 变量。在循环体中，您创建一个新函数并将其传递给 mux.handlerfun。这些函数体继承外部作用域，并访问此 handler 变量。该变量在函数外部重新分配，因此每个处理函数可以访问的值也随之更改。解决此问题的方法是屏蔽循环使用的 handler 变量，并创建每个处理程序唯一的作用域。像 javascript 这样的语言中的经典方法（这在我编写一些 js 时曾经是一个常见问题）是将代码包装在 iife（立即调用函数表达式）中：

for _, handler := range *confighandlers {
    func (handler *handlerconfig) { // handler is now the argument passed to this function
        mux.handlefunc(*handler.uri, func(w http.responsewriter, r *http.request) {
            w.writeheader(*handler.response.status)
            fmt.fprintf(w, *handler.response.body)
        })
    }(handler) // call the function with the _current_ value of handler
}

这有点混乱，因为 golang 是正确的块作用域，所以你可以这样做：

for _, handler := range *confighandlers {
    h := handler // create a variable in the inner scope
    mux.handlefunc(*handler.uri, func(w http.responsewriter, r *http.request) {
        // now h will reference a copy unique to each iteration
        w.writeheader(*h.response.status)
        fmt.fprintf(w, *h.response.body)
    })
}

这应该可以解决问题。不过，我注意到您在添加到问题的类型中使用指针有一些奇怪的地方...像 port 这样的字段是 *string 类型？为什么不直接使用 string 呢？否 response 类型中的 body 和 status 字段相同。通过将它们更改为普通的 string 字段，您不必在处理程序函数中取消引用它们。看起来会干净很多。

更大的担忧是这个领域：

handlers *[]handlerconfig `yaml:"handlers"`

我不确定你是否真的知道这个字段的类型是什么，但这几乎没有意义。 handlers 现在是指向 handlerconfig 值切片的指针。我假设您希望这个字段是：

// handlers is a slice of handlerconfig values:
handlers []handlerconfig `yaml:"handlers"`
// or handlers is a slice of pointers to handlerconfig values
handlers []*handlerconfig `yaml:"handlers"`

一般来说，指向切片的指针，尤其是在配置类型中是糟糕的代码。

如果您定义了一个表示 yaml 文件中的配置的结构，您可以使用 yaml 包将 yaml 解组为该类型的实例化结构。从那里，您可以像引用任何其他结构一样引用该结构中的字段。

package main

import (
    "fmt"

    "gopkg.in/yaml.v2"
)

type YamlExample struct {
    FieldOne    string `yaml:"fieldOne"`
    NestedField struct {
        Name string `yaml:"name"`
    } `yaml:"nestedField"`
}

const YamlEx string = `
fieldOne: one
nestedField:
    name: nestedFieldName
`

func main() {
    var yamlE YamlExample

    err := yaml.Unmarshal([]byte(YamlEx), &yamlE)
    if err != nil {
        panic(err)
    }

    fmt.Printf("%+v\n", yamlE)
}

Link to example.

在您的情况下，您可能希望处理结构中的路由，然后引用结构中的字段以获取路由名称、如何处理请求正文等内容。如果您的 yaml 存储在一个文件，您必须使用类似 io 包的东西将文件读入 yaml 包可以解析的字节数组中。 See here for a reference.

理论要掌握，实操不能落！以上关于《Go：构建一个可根据配置文件生成 URL 的服务器》的详细介绍，大家都掌握了吧！如果想要继续提升自己的能力，那么就来关注golang学习网公众号吧！