编写高效的函数需遵循先决条件

**编写高效函数的先决条件** 为了编写高效的函数，建议遵循以下先决条件： 1. **创建解析指针类型结构体值的方法：**解析指针类型结构体值，该值将存储指针指向的结构体中的值。 2. **创建方法接收所有所需值的方法：**创建方法接收您想要从中获取结构内应用程序或服务的值的所有方法。 3. **在所有方法中使用指针接收器：**在所有方法中使用指针接收器，您将能够访问解析 yaml 时更新的原始结构。 4. **创建一个指向空实例的指针并将其作为方法接收器传递：**创建一个指向该结构的空实例的指针并将其作为方法接收器传递。 5. **在 unmarshal 中访问该结构以更新原始结构中的 yaml 数据：**在 unmarshal 中访问该结构以更新原始结构中的 yaml 数据。 6. **通过使用指向方法的指针接收器访问原始结构的值来访问每个函数中更新的结构：**通过使用指向方法的指针接收器访问原始结构的值来访问每个函数中更新的结构。

我有以下 yaml 文件，我需要对其进行 parse （解析按预期工作），并且需要从 yaml 文件内容中提供 data，该文件内容应由以下解耦函数公开

我需要提供以下功能（这是其中一些功能的示例，需要更多具有相同模式的功能...）

获取应用程序（） 获取服务() 获取应用程序（应用程序名称） getserviceforapp（应用程序名称）

这是代码（可以工作......）

var dmz = []byte(`
applications:
  - name: app1
    type: php
    src: /app1
    host: us
    use: 
      - redis
      - mysql

  - name: app2
    type: rust
    src: /app2
    host: eu
    use: 
      - mongo
      - mysql

  - name: app3
    type: golang
    src: /app3
    host: us
    use: 
      - postgress
      - mysql


services:
  - name: mongo
    type: db
    host: us

  - name: mysql
    type: db
    host: eu

  - name: postgress
    type: db
    host: us

  - name: redis
    type: db
    host: us   
`)

这是结构

type dmz struct {
  applications       []*applications   `yaml:"applications,omitempty"`
  services           []*services       `yaml:"services,omitempty"`
}

type applications struct {
  name        string
  type        string
  src        string            `yaml:"src,omitempty"`
  use        []use             `yaml:"use,omitempty"`
}
type services struct {
  name        string
  type        string
  host        string            `yaml:"host,omitempty"`
}
type use struct {
  name       string     `yaml:"name,omitempty"`
  host       string     `yaml:"host,omitempty"`
  type       string     `yaml:"type,omitempty"`
}



// parse file
func parse(yamlcontent []byte) (out dmz, err error) {
  dmz := dmz{}
  err = yaml.unmarshal([]byte(yamlcontent), &dmz)
  if err != nil {
    logs.error("yaml file is not valid, error: " + err.error())
  }
  return dmz, err
}

由于 parse 函数是按要求所有需要的函数（我在上面列出的），我想知道最好如何要创建它们，创建每次调用 parse 函数的简单函数，然后执行逻辑（不是问题），但我想知道是否有更好的方法遵循golang 的干净代码原则，带有“接口/依赖注入”？

更新：

我想避免执行以下操作，假设我需要从不同的包或甚至不同的 github 存储库调用这些函数如何最好地使用 golang 干净的代码。

func getApps(){

 dmz := Parse()
....
}


func getServices(){

 dmz := Parse()
....

}


func getApp(appname string){

 dmz := Parse()
....

}


func GetServiceForApp(appname string){

 dmz := Parse()
....

}

我需要更多具有相同模式的功能......

我需要一些使用接口/依赖注入的干净代码解决方案，例如golang中的最佳实践代码示例

如果有不清楚的地方请告诉我:)

解决方案

解析指针类型结构体值中的值，该值将存储指针指向的结构体中的值。然后 create 方法接收您想要从中获取结构内应用程序或服务的值的所有方法。

在所有方法中使用指针接收器，您将能够访问解析 yaml 时更新的原始结构。

创建一个指向该结构的空实例的指针并将其作为方法接收器传递。然后在 unmarshal 中访问该结构以更新原始结构中的 yaml 数据。通过使用指向方法的指针接收器访问原始结构的值来访问每个函数中更新的结构。

package main

import (
    "fmt"
    "log"

    yaml "gopkg.in/yaml.v2"
)

var dmz = []byte(`
applications:
  - name: app1
    type: php
    src: /app1
    host: us
    use: 
      - redis
      - mysql

  - name: app2
    type: rust
    src: /app2
    host: eu
    use: 
      - mongo
      - mysql

  - name: app3
    type: golang
    src: /app3
    host: us
    use: 
      - postgress
      - mysql


services:
  - name: mongo
    type: db
    host: us

  - name: mysql
    type: db
    host: eu

  - name: postgress
    type: db
    host: us

  - name: redis
    type: db
    host: us   
`)

type dmz struct {
    applications []*applications `yaml:"applications,omitempty"`
    services     []*services     `yaml:"services,omitempty"`
}

type applications struct {
    name string
    type string
    src  string `yaml:"src,omitempty"`
    use  []use  `yaml:"use,omitempty"`
}
type services struct {
    name string
    type string
    host string `yaml:"host,omitempty"`
}
type use struct {
    name string `yaml:"name,omitempty"`
    host string `yaml:"host,omitempty"`
    type string `yaml:"type,omitempty"`
}

func main() {
    dm := &dmz{}
    result, err := dm.parse(dmz)
    dm.getapp("app1")
    if err != nil {
        fmt.println(err)
    }
    fmt.println(result)
    fmt.println(dm.getapp("app2"))
    fmt.println(dm.getserviceforapp("mongo"))
}

func (dmz *dmz) getapps() []*applications {
    return dmz.applications
}

func (dmz *dmz) getservices() []*services {
    return dmz.services
}

func (dmz *dmz) getapp(appname string) *applications {
    for _, value := range dmz.applications {
        if appname == value.name {
            fmt.println((*value).name)
            return value
        }
    }
    return nil
}

func (dmz *dmz) getserviceforapp(appname string) *services {
    for _, value := range dmz.services {
        if appname == value.name {
            return value
        }
    }
    return nil
}

// parse file
func (dmz *dmz) parse(yamlcontent []byte) (out *dmz, err error) {
    err = yaml.unmarshal([]byte(yamlcontent), &dmz)
    if err != nil {
        log.fatal("yaml file is not valid, error: " + err.error())
    }
    return dmz, err
}

Playground 上的工作代码

如果您希望代码更干净，那么您也可以跳过从解析函数返回的结构。由于我们传递指针类型接收器并将原始结构更新为：

package main

import (
    "fmt"
    "log"

    yaml "gopkg.in/yaml.v2"
)

var dmz = []byte(`
applications:
  - name: app1
    type: php
    src: /app1
    host: us
    use: 
      - redis
      - mysql

  - name: app2
    type: rust
    src: /app2
    host: eu
    use: 
      - mongo
      - mysql

  - name: app3
    type: golang
    src: /app3
    host: us
    use: 
      - postgress
      - mysql


services:
  - name: mongo
    type: db
    host: us

  - name: mysql
    type: db
    host: eu

  - name: postgress
    type: db
    host: us

  - name: redis
    type: db
    host: us   
`)

type dmz struct {
    applications []*applications `yaml:"applications,omitempty"`
    services     []*services     `yaml:"services,omitempty"`
}

type applications struct {
    name string
    type string
    src  string `yaml:"src,omitempty"`
    use  []use  `yaml:"use,omitempty"`
}
type services struct {
    name string
    type string
    host string `yaml:"host,omitempty"`
}
type use struct {
    name string `yaml:"name,omitempty"`
    host string `yaml:"host,omitempty"`
    type string `yaml:"type,omitempty"`
}

func main() {
    dm := &dmz{}
    dm.parse(dmz)
    fmt.println(dm.getapp("app2"))
    fmt.println(dm.getserviceforapp("mongo"))
}

func (dmz *dmz) getapps() []*applications {
    return dmz.applications
}

func (dmz *dmz) getservices() []*services {
    return dmz.services
}

func (dmz *dmz) getapp(appname string) *applications {
    for _, value := range dmz.applications {
        if appname == value.name {
            fmt.println((*value).name)
            return value
        }
    }
    return nil
}

func (dmz *dmz) getserviceforapp(appname string) *services {
    for _, value := range dmz.services {
        if appname == value.name {
            return value
        }
    }
    return nil
}

// parse file
func (dmz *dmz) parse(yamlcontent []byte) {
    if err := yaml.unmarshal([]byte(yamlcontent), &dmz); err != nil {
        log.fatal("yaml file is not valid, error: " + err.error())
    }
}

我们可以注意到，parse 函数将变得更加干净，因为我们不会从中返回任何内容，我们只是使用方法接收器更新原始结构，这是实现您一直试图实现的目标的更好方法。 p>

您还可以选择通过将 struct 中的方法定义为您要尝试实现接口的接收器来实现接口：

package main

import (
    "fmt"
    "log"

    yaml "gopkg.in/yaml.v2"
)

type di interface {
    getapps() []*applications
    getservices() *services
}

var dmz = []byte(`
applications:
  - name: app1
    type: php
    src: /app1
    host: us
    use: 
      - redis
      - mysql

  - name: app2
    type: rust
    src: /app2
    host: eu
    use: 
      - mongo
      - mysql

  - name: app3
    type: golang
    src: /app3
    host: us
    use: 
      - postgress
      - mysql


services:
  - name: mongo
    type: db
    host: us

  - name: mysql
    type: db
    host: eu

  - name: postgress
    type: db
    host: us

  - name: redis
    type: db
    host: us   
`)

type dmz struct {
    applications []*applications `yaml:"applications,omitempty"`
    services     []*services     `yaml:"services,omitempty"`
}

type applications struct {
    name string
    type string
    src  string `yaml:"src,omitempty"`
    use  []use  `yaml:"use,omitempty"`
}
type services struct {
    name string
    type string
    host string `yaml:"host,omitempty"`
}
type use struct {
    name string `yaml:"name,omitempty"`
    host string `yaml:"host,omitempty"`
    type string `yaml:"type,omitempty"`
}

func main() {
    dm := &dmz{}
    dm.parse(dmz)
    fmt.println(dm.getapp("app2"))
    fmt.println(dm.getserviceforapp("mongo"))
}

func (dmz *dmz) getapps() []*applications {
    return dmz.applications
}

func (dmz *dmz) getservices() []*services {
    return dmz.services
}

func (dmz *dmz) getapp(appname string) *applications {
    for _, value := range dmz.applications {
        if appname == value.name {
            fmt.println((*value).name)
            return value
        }
    }
    return nil
}

func (dmz *dmz) getserviceforapp(appname string) *services {
    for _, value := range dmz.services {
        if appname == value.name {
            return value
        }
    }
    return nil
}

// parse file
func (dmz *dmz) parse(yamlcontent []byte) {
    if err := yaml.unmarshal([]byte(yamlcontent), &dmz); err != nil {
        log.fatal("yaml file is not valid, error: " + err.error())
    }
}

注意：

泛型很方便，但代价是复杂性 类型系统和运行时。我们还没有找到一种设计 价值与复杂性成正比，尽管我们仍然认为 关于它。同时，go 内置的映射和切片，以及 使用空接口来构造容器（使用显式 拆箱）意味着在很多情况下可以编写这样的代码 如果不太顺利的话，泛型可以实现什么。

您可以定义一个接口并在结构中提供实现

type dmzi interface {
    getapps() []application
    getservice() []service
    getapp(name string) (application, error)
    getserviceforapp(name string) ([]string, error)
}

type dmz struct {
    application []application `yaml:"applications,omitempty"`
    service     []service     `yaml:"services,omitempty"`
}

func (dmz dmz) getapps() []application {
    return dmz.application
}

func (dmz dmz) getservice() []service {
    return dmz.service
}

func (dmz dmz) getapp(name string) (application, error) {
    for _, app := range dmz.application {
        if app.name == name {
            return app, nil
        }
    }
    return application{}, fmt.errorf("did not find application with name %s", name)
}

func (dmz dmz) getserviceforapp(name string) ([]string, error) {
    app, err := dmz.getapp(name)
    if err != nil {
        return []string{}, err
    }
    return app.use, nil
}

type application struct {
    name string
    type string
    src  string   `yaml:"src,omitempty"`
    use  []string `yaml:"use,omitempty"`
}
type service struct {
    name string
    type string
    host string `yaml:"host,omitempty"`
}

// parse file
func parse(yamlcontent []byte) (out dmzi, err error) {
    dmz := dmz{}
    err = yaml.unmarshal([]byte(yamlcontent), &dmz)
    if err != nil {
        fmt.println("yaml file is not valid, error: " + err.error())
    }
    return dmz, err
}

因此，您可以调用返回接口上的方法，例如

fmt.printf("apps : %+v\n", dmz.getapps())
fmt.printf("service : %+v\n", dmz.getservice())

更新

评论中要求的主要方法

func main() {
    dmz, err := parse([]byte(ymlstr))
    if err != nil {
        panic(err)
    }
    fmt.printf("apps : %+v\n", dmz.getapps())
    fmt.printf("service : %+v\n", dmz.getservice())
}

将打印

Apps : [{Name:app1 Type:php Src:/app1 Use:[redis mysql]} {Name:app2 Type:rust Src:/app2 Use:[mongo mysql]} {Name:app3 Type:golang Src:/app3 Use:[postgress mysql]}]
Service : [{Name:mongo Type:db Host:us} {Name:mysql Type:db Host:eu} {Name:postgress Type:db Host:us} {Name:redis Type:db Host:us}]

到这里，我们也就讲完了《编写高效的函数需遵循先决条件》的内容了。个人认为，基础知识的学习和巩固，是为了更好的将其运用到项目中，欢迎关注golang学习网公众号，带你了解更多关于的知识点！