Uber Go 语言编程规范:功能选项

Uber Go 语言编程规范 Uber Go 语言编程规范 相信很多人前两天都看到 Uber 在 github 上面开源的 Go 语言编程规范了,原文在这里:https://github.com/uber-go/guide/blob/master/style.md 。我们今天就来简单了解一下国外大厂都是如何来写代码的。行文仓促,错误之处,多多指正。另外如果觉得还不错,也欢迎分享给更多的人。 文章目录Uber Go 语言编程规范... 阅读详情

函数选项是一种模式,在这种模式中,您声明一个不透明的 Option 类型,该类型在某些内部结构中记录信息。您接受这些选项的可变数量,并根据内部结构上的选项记录的完整信息进行操作。

在构造函数和其他您认为需要扩展的公共api中,使用此模式的可选参数,特别是当您已经在这些函数上有三个或更多的参数时。

Bad

// package db

func Open(
  addr string,
  cache bool,
  logger *zap.Logger
) (*Connection, error) {
  // ...
}


//cache和logger 参数必须始终提供,即使用户希望使用默认值

db.Open(addr, db.DefaultCache, zap.NewNop())
db.Open(addr, db.DefaultCache, log)
db.Open(addr, false /* cache */, zap.NewNop())
db.Open(addr, false /* cache */, log)

Good

// package db
//定义一个选项接口
type Option interface {
  // ...
}

//返回Cache选项
func WithCache(c bool) Option {
  // ...
}

//返回Logger选项
func WithLogger(log *zap.Logger) Option {
  // ...
}

// Open creates a connection.
func Open(
  addr string,
  opts ...Option, //使用选项参数,可变参数
) (*Connection, error) {
  // ...
}

//只有在需要时才提供选项

db.Open(addr)
db.Open(addr, db.WithLogger(log))
db.Open(addr, db.WithCache(false))
db.Open(
  addr,
  db.WithCache(false),
  db.WithLogger(log),
)

我们建议的实现此模式的方法是:使用一个Option 接口,并且该接口持有一个未导出的方法,在一个未导出的options 结构体上记录相关选项:

//在未导出的 结构体 options 上记录相关选项
type options struct {
  cache  bool
  logger *zap.Logger
}

//提供一个Option接口
type Option interface {
  //提供一个未导出的方法操作相关选项
  apply(*options)
}

type cacheOption bool

func (c cacheOption) apply(opts *options) {
  opts.cache = bool(c)
}

func WithCache(c bool) Option {
  return cacheOption(c)
}

type loggerOption struct {
  Log *zap.Logger
}

func (l loggerOption) apply(opts *options) {
  opts.logger = l.Log
}

func WithLogger(log *zap.Logger) Option {
  return loggerOption{Log: log}
}

// Open creates a connection.
func Open(
  addr string,
  opts ...Option,
) (*Connection, error) {
  options := options{
    cache:  defaultCache,
    logger: zap.NewNop(),
  }

  for _, o := range opts {
    o.apply(&options)
  }

  // ...
}

注意,有一种方法可以用闭包实现这个模式,但是我们相信上面的模式为作者提供了更多的灵活性,并且更容易为用户调试和测试。它允许在测试和模拟中相互比较选项,而在闭包中则不可能这样做。而且,它允许选项options 实现其他接口,包括fmt.Stringer

允许用户以可读的字符串形式来表示选项options。

另外,请参阅:

 

Uber 公司推出的 GoLang 编程规范 如果不是lib库,就需要增加所需的上下文信息,不然就会出现 "connection refused" 这样非常 模糊的错误,理论上应该添加上下文,来得到这样的报错信息:"call service foo: connection refused"。最好的情况下,编译器会直接报错,最糟糕的情况下,这样的代码会引入难以排查的bug。如果结构体中包含mutex,在使用结构体的指针时,mutex应该是结构体的非指针字段,也不要把mutex内嵌到结构体中,即使结构体是非导出类型。尽管编写内嵌类型已实现的方法是乏味的。 阅读详情

相关推荐

用Keil5给CH552G编程:手把手配置8051开发环境+LED闪烁实战

本文详细介绍了如何使用Keil5为CH552G单片机配置8051开发环境,并完成LED闪烁实战。从获取必要软件、安装WCH器件库到创建工程、编写程序及烧录,手把手指导开发者避开常见陷阱,特别适合从STC转向CH552G的开发者。

weixin_30733003的博客 539

Uber 《Go语言编程规范》学习笔记(一)

Interface 合理性验证 在编译时验证接口的符合性。这包括: 将实现特定接口的导出类型作为接口API 的一部分进行检查 实现同一接口的(导出和非导出)类型属于实现类型的集合 任何违反接口合理性检查的场景,都会终止编译,并通知给用户

Eric's Blog 312

避开模板匹配的坑:OpenCVSharp中边缘梯度算法的优化实践

本文深入探讨了OpenCVSharp中边缘梯度算法在模板匹配中的优化实践,解决了传统方法在尺度变化、角度旋转和光照差异下的局限性。通过Sobel算子提取边缘梯度特征,结合轮廓检测和多尺度匹配策略,显著提升了匹配的鲁棒性和准确性。文章还分享了并行计算、内存访问优化等实战技巧,适用于工业检测和自动化识别场景。

http9protocoller的博客 199

Python峰值检测库对比:py-findpeaks中peakutils与scipy性能评测

在数据处理和信号分析领域,峰值检测是一项基础且关键的任务。py-findpeaks项目作为Python中峰值检测算法的集成平台,提供了多种实现方案。本文将深入对比py-findpeaks中两种常用峰值检测工具——peakutils和scipy.signal.find_peaks的性能表现,帮助开发者选择最适合自己需求的工具。 ## 核心功能解析:peakutils与scipy的实现差异 pea

gitblog_00687的博客 947

EEGLAB+ERPLAB实战:从.cnt文件到情绪ERP差异波,一份避坑指南

本文详细介绍了使用EEGLAB和ERPLAB处理Neuroscan的.cnt格式脑电数据的全流程,从数据导入、预处理到情绪ERP差异波生成。重点解决了采样率验证、事件标记检查、重参考选择、滤波策略与ICA组合等实操难题,并提供了情绪图片ERP研究中P1、EPN和LPP成分的分析技巧,帮助研究者避免常见错误,提升数据处理效率。

weixin_26795617的博客 266

flowable工作流源码解析-DB访问

Flowable用了mybatis组件,又实现了自己的command和interceptor机制。具体是怎么实现的呢? 我们以Deployment操作为例,来看看它的调用链 调用端是Service接口, 它委托自己的commandExecutor去执行具体的Command. Command最终会调用到EntityManager,然后委托给ibatis的sqlsession来完成操作。 其中CommandExcutor调用command的地方有些复杂,我们展开看: CommandExecutor会维护一系

coobee的博客 2490

选项模式(Options Pattern)

在Python语言中,创建一个对象时,可以给参数设置默认值,这样在不传入任何参数时,可以返回携带默认值的对象,并在需要时修改对象的属性。在Go语言中,我们经常会遇到一个结构体中有很多字段,我们只想设置其中的一部分字段,其他字段都使用默认值的情况,这时可以通过选项模式来解决。选项模式是指定义一个函数,这个函数的参数是一个结构体指针,这个结构体中包含了所有可选参数,函数根据参数的需求来设置结构体的字段值。第一种方法,我们要分别开发两个用来创建实例的函数,一个可以创建带默认值的实例,一个可以定制化创建实例。

LK-T.O.P的博客 940

STM32F4用FSMC驱动AX58100 EtherCAT从站芯片,保姆级配置流程与避坑指南

本文详细介绍了STM32F4通过FSMC接口驱动AX58100 EtherCAT从站芯片的完整配置流程,包括硬件连接、时序优化、协议栈移植及TwinCAT主站集成。针对工业自动化场景,提供高性价比的实时控制解决方案,特别适合机械臂、CNC机床等精确同步应用,并分享关键调试技巧与性能优化方法。

weixin_27869497的博客 308

两种 Option 编程模式的实现,Uber推荐这一种

前言哈喽,大家好。option编程模式大家一定熟知,但是其写法不唯一,主要是形成了两个版本的option设计,本文就探讨一下其中的优缺点。option编程模式的引出在我们日常开发中,经常在初始化一个对象时需要进行属性配置,比如我们现在要写一个本地缓存库,设计本地缓存结构如下:typecachestruct{ //hashFuncrepresentsusedhashfunc Ha...

kevin_tech的博客,微信搜「网管叨bi叨」 232

IDM更改下载路径的详细指南

Internet Download Manager(IDM)是一款功能全面的下载加速工具,它支持多种浏览器和协议,能够显著提升下载速度,同时提供断点续传、多线程下载等实用功能。IDM的用户界面简洁明了,操作便捷,使得用户能够轻松管理下载任务。此外,IDM还支持自动分类下载文件、定时下载等高级功能,进一步提升了用户的下载体验。通过本文的介绍,相信用户已经掌握了如何在IDM中更改下载路径的方法。这一功能不仅提升了下载效率和文件管理便捷性,还满足了用户的个性化需求。

nntxthml的博客 1763

Solidworks钣金设计:折弯系数、K因子与折弯扣除的实战应用解析

本文深入解析Solidworks钣金设计中折弯系数、K因子与折弯扣除的核心概念与实战应用。通过厘清三者间的逻辑关系与换算方法,并结合材料特性、工艺参数及车间实测,指导工程师精准确定展开长度,确保设计图纸与加工实物的一致性,有效提升钣金件设计精度与生产效率。

weixin_29268267的博客 927

选项模式-Golang设计模式

选项模式-Golang设计模式 tips:对结构体中的字段,会频繁变化、需要灵活配置、有默认值的场景,可能会用到 Option 模式。 1.场景 往简单来说,有下面这一个需求: 如果创造了一个英雄,我想修改它的属性,怎么才能方便的去修改,包括之后新增的字段,如果不直接用结构体.字段的形式,保证了修改英雄属性的安全性, 2021/12/30 09:30:52 英雄创造后属性为: &{1001 Default 1 1 map[]} 2021/12/30 09:30:52 英雄魔改后属性为: &{

jiohfgj的博客 693

cesium单向流动线效果

在学材质的路上一去不复返了属实是,难也难在这。还请各位大佬多多指教~

就zhei? 690

Uber Go语言编写规范

样式 (style) 是支配我们代码的惯例。术语样式有点用词不当,因为这些约定涵盖的范围不限于由 gofmt 替我们处理的源文件格式。本指南的目的是通过详细描述在 Uber 编写 Go 代码的注意事项来管理这种复杂性。这些规则的存在是为了使代码库易于管理,同时仍然允许工程师更有效地使用 Go 语言功能。该指南最初由 [Prashant Varanasi] 和 [Simon Newton] 编写,目的是使一些同事能快速使用 Go。多年来,该指南已根据其他人的反馈进行了修改。

OuterCyrex的博客 115

jre9下载 jdk9

(Java SE Runtime Environment 9.0) 9.0u175 官方最新版 【x86|x64】

LinePhone3.2.7(android端最新版本) sip客户端

SIP客户端For android:LinePhone3.2.7(最新版本),官网地址:http://www.linphone.org/

终极指南:如何在Go语言中实现面向切面编程实践

面向切面编程(AOP)是Go语言中提升代码质量和可维护性的强大技术。Uber Go编码规范提供了完整的面向切面编程实践指南,帮助开发者编写更优雅、更健壮的Go代码。本文将深入解析Go语言中的面向切面编程核心概念和最佳实践。🚀 ## 什么是面向切面编程? 面向切面编程(Aspect-Oriented Programming)是一种编程范式,它允许开发者将横切关注点(如日志记录、性能监控、事务管

gitblog_00991的博客 621

WINCC7.3破解文件

WINCC7.3硬件够破解文件,有需要的下载!WINCC7.3硬件够破解文件,有需要的下载!

Uber Go 语言编码规范

Uber Go 语言编码规范 中文版

J_Lee 2214

锂电池充电器电路设计 里面有电路

锂电池充电器电路设计 里面有电路 3.7V升压到5V电路设计。

掌握Uber Go语言规范:函数选项模式与高级设计技巧

Uber Go语言规范中文版是Go开发者必备的权威指南,其中函数选项模式作为一种优雅处理可选参数的设计技巧,在提升API灵活性和可维护性方面发挥着重要作用。本文将深入解析这一模式的实现方式、应用场景及最佳实践,帮助开发者写出符合Uber标准的高质量Go代码。 ## 为什么选择函数选项模式? 在Go语言开发中,我们经常需要处理具有多个可选参数的函数或结构体构造器。传统的参数列表方式在参数数量增多

gitblog_00946的博客 1051

【转载】Uber Go语言编码规范

文章目录Uber Go语言编码规范一. 介绍二. 指导原则指向interface的指针接收器(receiver)与接口零值Mutex是有效的在边界处拷贝Slices和Maps接收Slices和Maps返回slices或maps使用defer做清理Channel的size要么是1,要么是无缓冲的枚举从1开始错误类型错误包装(Error Wrapping)处理类型断言失败不要panic使用go.ube...

问题不大 2197

值得参考的golang语言开发规范:Uber Go 语言编码规范,一些优秀的技巧可以提升代码的质量、避免代码缺陷和bug漏洞

值得参考的golang语言开发规范:Uber Go 语言编码规范,一些优秀的技巧可以提升代码的质量、避免代码缺陷和bug漏洞。

代码讲故事 1113

uber_go_guide_tw:Uber Go 语言编写规范繁体中文翻译

uber_go_guide_tw:Uber Go 语言编写规范繁体中文翻译 项目介绍 Uber Go 语言编写规范是由Uber公司开源的一套用于指导Go语言编写的最佳实践。这些规范旨在帮助开发者编写易于管理、高效且安全的Go代码。该项目在GitHub上开源,已经吸引了众多开发者的关注和贡献。 项目技术分析 uber_go_guide_tw项目包含了Uber公司内部使用的Go语言编写规范,这些规范不...

gitblog_00243的博客 890

Uber 公司Golang编程规范【翻译】

引言 样式是支配我们代码的惯例。 术语“样式”有点用词不当,因为这些约定不仅仅涵盖那些可以由gofmt替我们处理的源文件格式。 本指南的目的是通过详细描述在Uber编写Go代码的注意事项来管理这种复杂性。 这些规则的存在是为了使代码库易于管理,同时仍然允许工程师有效地使用Go语言功能。 该指南最初由Prashant Varanasi和Simon Newton编写,目的是使一些同事快速使用Go。 多...

后端开发 1740
上一篇: Uber Go 语言编程规范:表格驱动测试
下一篇: Uber Go 语言编程规范:Linting
DreamCatcher
博客等级 码龄20年 23粉丝 151原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

DreamCatcher

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值