Go：如何创建可以提供配置文件中描述的 url 的服务器

Question

我是 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
}

更新：如果我运行这个服务器那么无论我点击哪个端点，它总是 return 我 500 和 test2 在 body

Answer 1

如果您在 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.

Answer 2

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

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 这样的语言中，经典的方法是将代码包装在 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 是正确的 block-scoped，你可以这样做：

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"`

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

Go：如何创建可以提供配置文件中描述的 url 的服务器

Go: How to create a server which can serve urls described in config file

http

go