Uber Go 语言编程规范:避免在公共结构体中嵌入类型

Go包可见性本质:导出与未导出的编译期规则 在Go语言中,标识符的可见性并非面向对象语境下的‘私有/公有’访问控制,而是一套编译期强制执行的符号导出机制——首字母大小写决定是否能被其他包通过包名引用。该机制直接影响API稳定性、模块封装边界与依赖隔离,是理解Go模块化设计、internal目录约束、vendor行为及go mod版本管理的基础。它不依赖运行时检查,而是在词法分析阶段即剔除未导出符号,从而保障构建确定性与文档自洽性。掌握exported/unexported规则,是写出可维护、可演进、符合云原生工程规范的Go代码的前提。 阅读详情

这些嵌入的类型会 泄露实现细节,阻止类型演变,并模糊文档。

假设您已经使用一个共享的AbstractList,实现了各种列表类型,避免在具体的列表实现中嵌入AbstractList,相反的,只手写那些将会委托给抽象列表的具体列表中的方法。

type AbstractList struct {}

//以下是定义公共结构体的方法

// Add adds an entity to the list.
func (l *AbstractList) Add(e Entity) {
  // ...
}

// Remove removes an entity from the list.
func (l *AbstractList) Remove(e Entity) {
  // ...
}

Bad

// ConcreteList 是一个列表实体.
type ConcreteList struct {
  *AbstractList
}

Good

// ConcreteList 是一个实体列表.
type ConcreteList struct {
  list *AbstractList
}

//以下方法都是委托给抽象列表实现

// Add adds an entity to the list.
func (l *ConcreteList) Add(e Entity) {
  l.list.Add(e)
}

// Remove removes an entity from the list.
func (l *ConcreteList) Remove(e Entity) {
  l.list.Remove(e)
}

GO语言允许type embedding ,作为在继承和组合之间的一种折衷方案。外部类型 会获取嵌入类型方法的隐式的副本,默认情况下,这些方法会委托给嵌入实例的相同的方法去实现。

该结构体还会获得一个与类型同名的字段。因此,如果的嵌入的类型是Public的,那么这个字段也是Public的,为了保持向后兼容性,外部类型的每一个未来版本都必须保持这个嵌入的类型。

嵌入的类型很少是必需的。但是,它可以帮助您避免编写冗长的委托方法。

即使是嵌入一个兼容的AbstractList接口,而不是一个结构体,也会为开发人员提供更多的灵活性,以便在将来进行改变。但是,此种方式,仍然泄露了具体列表使用抽象实现的细节。

Bad

// AbstractList 是一个通用的实现针对各种类型的实体列表
type AbstractList interface {
  Add(Entity)
  Remove(Entity)
}

// 具体实现的List
type ConcreteList struct {
  AbstractList
}

Good

// ConcreteList 具体列表的实现.
type ConcreteList struct {
  list AbstractList
}

//只实现委托给AbstractList中的方法
// Add adds an entity to the list.
func (l *ConcreteList) Add(e Entity) {
  l.list.Add(e)
}

// Remove removes an entity from the list.
func (l *ConcreteList) Remove(e Entity) {
  l.list.Remove(e)
}

无论是使用嵌入结构体还是嵌入接口,嵌入的类型都限制了类型的发展演化。

  • 向嵌入的接口添加方法,是一个破坏性的更改。
  • 从嵌入的结构体中删除方法,是一个破坏性的更改。
  • 移除嵌入的类型是一个破坏性的更改。
  • 即使使用用满足相同接口的替代方案去替换嵌入的类型,也是一个破坏性的更改。

尽管编写这些委托的方法很繁琐,但额外的工作却隐藏了实现细节,留下了更多的更改机会,并且消除了在文档中发现完整列表接口的间接途径。

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

相关推荐

PyCharm中Pyvips配置避坑指南:为什么pip安装后import还是报错?

本文详细解析了在PyCharm中配置Pyvips时,即使pip安装成功,import仍报错的根本原因。核心在于Pyvips依赖的libvips原生库未正确配置环境变量。文章提供了从下载libvips、配置Windows系统PATH到PyCharm项目级设置的完整避坑指南,并对比了三种配置策略,帮助开发者彻底解决DLL加载失败问题。

bush的博客 210

Go 语言编程规范建议(下)

文章目录1. 指导性原则1.1 指向 interface 的指针1.2 interface 合理性验证1.3 接收器(receiver)与接口1.4 零值 Mutex 是有效的1.5 在边界处拷贝 Slices 和 MapsSlices 和 Maps 做为入参1.6 使用 defer 释放资源1.7 Channel 的 size 要么是 1,要么是无缓冲的1.8 枚举从 1 开始1.9 使用 time 处理时间1.9.1 使用 time.Time 表达瞬时时间1.9.2 使用 time.Duration.

phantom_111的博客 1167

泛微OA与金蝶云星空深度集成实战:审批与表单双场景解析

本文深入解析泛微OA与金蝶云星空的深度集成实战,聚焦审批流程与表单对接两大核心场景。通过具体案例,详细阐述了如何实现业务数据与审批流程的自动联动,打破数据孤岛,提升企业运营效率与数据一致性,并分享了接口设计、安全策略及实战避坑指南。

4k5l6j7h8的博客 469

Go 语言编程规范建议(上)

文章目录1. 代码总体原则1.1 清晰第一1.2 简洁为美1.3 风格一致2. 规范2.1 命名规范2.1.1 驼峰命名2.1.2 常量2.1.3 变量2.1.4 URL2.1.5 Error2.1.6 接口名2.1.7 文件名2.1.8 包名2.1.9 函数名/方法名2.1.10 导入别名2.1.11 变量声明2.1.12 其他2.2 结构规范2.2.1 避免过长的行2.2.2 一致性2.2.3 相似的声明放在一组2.2.4 import 分组2.2.5 函数分组与顺序2.2.6 减少嵌套2.2.7 不必

phantom_111的博客 746

硬全桥副边钳位管Vds电压凸台揭秘——寄生参数引发的导通异常

本文深入分析了硬全桥副边钳位管Vds电压凸台现象,揭示了寄生参数如何引发导通异常。通过波形分析和工程实践,详细解析了走线电感的蓄能效应和体二极管的接力作用,并提供了PCB布局优化、元件选型和驱动电路调整等解决方案,帮助工程师有效应对这一常见问题。

weixin_30825581的博客 430

C#跨平台制图新纪元:Mapsui,一库在手,地图我有

深入学习Mapsui的渲染机制,定制属于你的地图样式,无论是颜色、图标还是文字,都可以随心所欲。

java专栏 1458

Go 语言中结构体(Struct)的使用

Go 语言是一门典型的面向对象编程语言,同时也支持复杂的数据结构,其中最常用的就是结构体。结构体(Struct)是一组不同类型的变量的集合,可以像一个单一的变量一样使用,可以包含其他结构体或嵌套的结构体。在 Go 语言中,结构体是一种自定义类型,可以定义在函数外部,并且可以定义方法。上面的语法就定义了一个名为 Person 的结构体,其包含四个字段:Name、Age、Gender 和 Address,这四个字段分别是 string、int、string 和 string 类型。

qq_21047625的博客 2260

从零搭建:C#+YOLOv8质检系统(从相机选型到上位机部署,附完整开发流程与源码)

后来换成45°斜射的条形光源,光线从侧面打在引脚上,弯曲处会形成暗区,缺陷边缘立刻清晰——光源预算别省,我这套光源+支架才600块,比换相机划算多了。前阵子帮一家电子厂做连接器引脚缺陷检测,他们原来靠2个师傅用放大镜看,每天8小时最多检5000个,0.2mm的针脚弯曲还经常漏检,不良品流到客户那里,单月罚款就超5万。做质检第一步不是挑设备,是先明确“要检测多大的缺陷”——比如我要检的连接器引脚,直径0.5mm,允许的最大弯曲是0.2mm,这直接决定相机分辨率。,后面C#就用这个模型推理。

这里只有干货:从 Modbus 通信到 MES 对接,从 YOLO 训练到工控机部署,带你搞定工业软件开发全流程。 1273

uber关于go语言规范

本文老子github上的Uber对于go语言的规范,从中我们可以避免在开发过程中的坑. 地址:https://github.com/xxjwxc/uber_go_guide_cn Go 语言编码规范 Uber是一家美国硅谷的科技公司,也是 Go 语言的早期 adopter。其开源了很多 golang 项目,诸如被 Gopher 圈熟知的zap、jaeger等。2018 年年末 Uber 将内部的Go 风格规范开源到 GitHub,经过一年的积累和更新,该规范已经初具规模,并受到广大 ...

FindHuni的博客 658

计算机网络基础:揭开网络世界的神秘面纱

计算机网络基础:揭开网络世界的神秘面纱,计算机网络已深度融入现代生活,这篇文章对其基础内容展开全面阐述。开篇介绍计算机网络的定义,说明其由计算机设备、网络设备和传输介质构成。接着从地域范围和拓扑结构两个维度对计算机网络进行分类,并详细讲解 OSI 和 TCP/IP 参考模型,明晰各层功能与联系。随后阐述网络通信协议的定义及常见协议,如 TCP/IP、HTTP 等。最后聚焦网络安全,涵盖定义、重要性以及防火墙、加密技术等常用安全技术。文章旨在帮助读者构建计算机网络基础知识体系,理解其在生活和工作中的应用与价值

不踩坑,不知道坑有多深;不总结,踩过的坑白踩。 6万+

YOLOv11改进 | 主干/Backbone篇 | 轻量化目标检测网络MobileViTv1改进yolov11有效涨点

本文给大家带来的改进机制是MobileViT系列的V1版本,其作为MobileNet网络的挑战者,其效果自然不用多说,MobileViT模型是为移动设备设计的轻量级、通用目的视觉变换器。它融合了卷积神经网络(CNN)和视觉变换器(ViT)的优势,旨在在保持高效性能的同时减少模型参数和降低延迟。通过其创新的MobileViT Block和多尺度训练方法,MobileViT在多个视觉任务上取得了优异的结果,欢迎大家订阅本专栏,本专栏每周更新3-5篇最新机制,更有包含我所有改进的文件和交流群提供给大家。

Snu77的博客 2338

Uber Go 语言编程规范:结构体中的嵌入

嵌入类型(比如互斥锁)应该位于结构体的字段列表的顶部(第一个),并且嵌入字段和常规字段之间必须有一个空行予以区分。 Bad type Client struct { version int http.Client } Good type Client struct { //嵌入类型位于结构体字段列表的顶部 http.Client //空行分割 version int } 嵌入应该提供切实的好处,比如以语义合适的方式添加或扩充功能。这样做应该不会对用户产生不利影响(另外

hero_java的专栏 242

【报错】raise pickle.UnpicklingError(_get_wo_message(str(e))) from None_pickle.UnpicklingError: Weigh

File "/opt/conda/envs/py_3.12/lib/python3.12/site-packages/torch/serialization.py", line 1470, in load raise pickle.UnpicklingError(_get_wo_message(str(e))) from None _pickle.UnpicklingError: Weights only load failed.

静谧、淡雅 787

Uber Go 语言编码规范

Uber Go 语言编码规范 中文版

J_Lee 2214

jdk-8u144-linux-x64.tar.gz.

该资源为搭建Linux系统Java环境用,资源的后缀为tar.gz格式的压缩包

OV9734 DATASHEET,完整规格书

OV9734完整规格书,包括电气参数,尺寸规格,寄存器配置表等

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

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

代码讲故事 1113

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

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

Uber Go 风格指南:结构体嵌入(Embedding in Structs)的规范与实践

本文是 [Uber Go Style Guide](https://link.gitcode.com/i/734e87b1464a20d5bc8393d9c4537836) 中“结构体嵌入”章节(对应文档 [src/struct-embed.md](https://link.gitcode.com/i/a1c50ce61e6c83a9ac0315cf357df222))的深度解读,结合仓库内 [s

gitblog_00814的博客 856

lwip-2.0.3

lwip是瑞典计算机科学院(SICS)的Adam Dunkels 开发的一个小型开源的TCP/IP协议栈。实现的重点是在保持TCP协议主要功能的基础上减少对RAM 的占用。

Uber Go Style Guide:Go语言代码规范的终极指南

作为全球领先的科技公司,Uber在Go语言开发方面积累了丰富的实践经验。Uber Go Style Guide是该公司内部Go代码规范的权威指南,现已成为Go开发者社区广泛认可的最佳实践。本指南不仅规范了代码风格,更重要的是提升了代码的可读性、可维护性和团队协作效率。 ## 🔥 为什么需要代码规范? 在大型企业级项目中,代码规范至关重要。想象一下,一个项目由数十名开发者共同维护,如果没有统一

gitblog_00494的博客 930

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

规范 包名 当命名包时,请按下面规则选择一个名称: 全部小写。没有大写或下划线。 大多数使用命名导入的情况下,不需要重命名。 简短而简洁。适当使用缩写。 不用复数。例如net/url,而不是net/urls。 不要用“common”,“util”,“shared”或“lib”。这些是不好的,信息量不足的名称。 另请参阅 Package Names 和 Go 包样式指南. 对于未导出的顶层常量和变量,使用_作为前缀 在未导出的顶级vars和consts, 前面加上前缀_,以使它们在使用时明确表示它们是全局

Eric's Blog 394

Uber Go Style Guide 变更演进解读:从 CHANGELOG 回溯官方 Go 编码规范的二十年沉淀

Uber Go Style Guide([style.md](https://link.gitcode.com/i/16c29bdb3073d8d29e68c1067401dd16))是 Uber 内部维护并对外开源的一份 Go 编码规范文档,本仓库同时保留了它的完整变更记录 [CHANGELOG.md](https://link.gitcode.com/i/83d280f43d618a39e56

gitblog_00914的博客 721

Uber Go 风格指南:Error Types 错误类型声明与匹配策略全解

本篇指南以 [Uber Go Style Guide](https://link.gitcode.com/i/bc4114471fb4ce2a491f46bf8e889b79) 中 Errors 章节的 [Error Types](https://link.gitcode.com/i/e6d1e03d3c09be0fcd8eca70331c8177) 为核心,系统讲解 Go 中声明错误的四种方式:

gitblog_00313的博客 416

Go编程模式:详解函数式选项模式

阅读本文大概需要 8 分钟。Go 不是完全面向对象语言,有一些面向对象模式不太适合它。但经过这些年的发展,Go 有自己的一些模式。今天介绍一个常见的模式:函数式选项模式(Functional Options Pattern)。01 什么是函数式选项模式Go 语言没有构造函数,一般通过定义 New 函数来充当构造函数。然而,如果结构有较多字段,要初始化这些字段,有很多种方式...

Seekload 601

Uber Go 语言编程规范:错误类型

在Golang中有多种声明错误的方式: errors.New 对于简单的静态字符串的错误 fmt.Errorf 用于格式化的错误字符串 实现 Error() 方法的自定义错误类型 用 "pkg/errors".Wrap 的 包装错误 当返回错误时,请考虑以下内容以确定最佳选择: 如果是一个简单的错误并且不需要额外的信息,那么errors.New就可以满足。 如果客户端需要检测并且处理错误,那么你需要自定义一个错误类型,并且实现Error()方法。 如果你需要传播下游函数返回的错误,那么你需..

hero_java的专栏 264

Uber Go Style Guide 函数分组与排序规范:文件布局的可读性工程实战

> 本篇指南聚焦 Uber Go Style Guide 中"函数分组与排序(Function Grouping and Ordering)"这一核心风格规范,讲解如何在单个 Go 源文件中按"调用顺序、接收者(receiver)归属、导出层级"三个维度组织函数,让文件像一篇自顶向下的文章一样可顺读。读完本文,你将掌握一套可落地、可评审、可被工具辅助执行的 Go 文件布局方案,显著降低代码的认知负

gitblog_00430的博客 362

Uber Go 风格指南:使用原始字符串字面量(Raw String Literals)避免转义

本指南源于本仓库([README](https://link.gitcode.com/i/6b1e208c31daf618f575bb087fc17a89) 所载的 Uber Go Style Guide)中 [使用原始字符串字面量避免转义](https://link.gitcode.com/i/ad1911c7b23aad3694625a14d3afc5e1) 一节,它属于风格规范(Style)

gitblog_00966的博客 482

Go语言高效开发:从环境配置到性能优化的实用技巧

Go语言作为现代编程语言,其并发模型和垃圾回收机制为高性能应用开发提供了坚实基础。通过理解Go Modules依赖管理原理,开发者能够有效管理项目依赖,结合国内镜像配置显著提升下载效率。在工程实践中,合理运用结构体标签和数据绑定技术可以简化数据处理流程,而pprof性能分析工具则为代码优化提供了科学依据。空结构体的巧妙使用不仅节省内存资源,还能实现高效的集合操作和信号传递。这些技术在日常开发中具有广泛应用价值,特别是在微服务架构和分布式系统场景下,能够帮助开发者构建更稳定、高效的Go语言应用。本文围绕Go语

weixin_34302561的博客 332
上一篇: Uber Go 语言编程规范:避免可变的全局变量
下一篇: Uber Go 语言编程规范:避免使用内置的名称
DreamCatcher
博客等级 码龄20年 23粉丝 151原创
评论 2
成就一亿技术人!
拼手气红包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、付费专栏及课程。

余额充值