登录注册

当前位置：首页 > 文章列表 > Golang > Go问答 > 编写高效的函数需遵循先决条件

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

来源：stackoverflow 2024-03-24 22:48:51 0浏览 收藏

**编写高效函数的先决条件** 为了编写高效的函数，建议遵循以下先决条件： 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学习网公众号，带你了解更多关于的知识点！

版本声明
本文转载于：stackoverflow 如有侵犯，请联系study_golang@163.com删除
依赖管理：Golang 子项目或子模块依赖管理：Golang 子项目或子模块
上一篇
依赖管理：Golang 子项目或子模块
在 Docker 容器中无法通过 Google API 获取 AccessToken
下一篇
在 Docker 容器中无法通过 Google API 获取 AccessToken
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案，代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景，打造一站式知识长龙服务，适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例，全面具体可落地，从理论到实践，一步一步将GO核心编程技术、编程思想、底层实现融会贯通，使学习者贴近时代脉搏，做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信：Le-studyg；在课程中，我们将首先介绍MySQL8的新特性，包括性能优化、安全增强、新数据类型等，帮助学生快速熟悉MySQL8的最新功能。接着，我们将深入解析MySQL的网络通信机制，包括协议、连接管理、数据传输等，让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网，分为导航，轮播，关于我们，成功案例，服务流程，团队介绍，数据部分，公司动态，底部信息等内容区块。网站整体采用CSSGrid布局，支持响应式，有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ljg-skills -
    ljg-skills
    ljg-skills 是李继刚开源的 AI 技能与提示词集合，面向大模型使用者整理了一批可复用的 prompt、角色设定和任务技能模板，适合用于学习提示词设计、搭建个人 AI 工作流和沉淀团队常用智能体能力。
    1784次使用
  • MELO音乐 - AI 音乐生成平台，支持多模态创作能力
    MELO音乐
    MELO音乐是一站式AI视频与音乐制作助手，对标suno, udio的高品质体验。提供伴奏生成、原创写词、无损导出、哼唱识曲、混音变声等全套音频与短视频编辑工具。无论是流行Kpop、电音说唱、民谣古风、摇滚儿歌还是商用轻音乐，MELO为你免费谱曲，轻松做同款！
    1716次使用
  • UniScribe - AI 免费在线音视频转文字平台
    UniScribe
    UniScribe 是一款 AI 音视频转文字与内容整理工具，支持上传音频、视频文件或粘贴 YouTube 链接，自动生成转写文本、摘要、思维导图和关键问题，并支持多格式导出，适合会议记录、课程学习、访谈整理和内容创作复盘。
    1659次使用
  • 剧云 - 免费 AI 智能中文剧本创作平台
    剧云
    剧云是专业中文剧本创作平台，安全稳定运行十余年，集成AI编剧、剧本医生审核、人物小传、剧情关系图、大纲编写、多人协作、Word导入导出、版权管控功能，数据安全防护，轻松高效创作剧本。
    1858次使用
  • 万象有声 - AI 一站式有声内容创作平台
    万象有声
    万象有声，一个专为有声创作者打造的新一代智能有声内容创作平台。平台提供专业的智能拆章、智能画本编辑、AI配音、AI生成音效、后期制作、智能对轨、智能审听等有声创作全流程工具，可以帮助创作者高效、低成本创作出引人入胜的有声作品。立即体验，让有声书制作更简单！
    1843次使用
查看更多
相关文章
关于我们 免责声明 意见反馈 联系我们 内容提交 手册
Golang学习网：公益在线Go学习平台，帮助Go学习者快速成长！
技术交流群
Copyright 2023 http://www.17golang.com/ All Rights Reserved ｜ 苏ICP备2023003363号-1
  • Golang学习网
    关注公众号
    Golang学习网
微信登录更方便
  • 密码登录
  • 注册账号
忘记密码
登录即同意 用户协议 和 隐私政策
返回登录
  • 重置密码
发送验证码