Golang中的包和模块设计

在这里插入图片描述

Go,也被称为Golang,是一种静态类型、编译型语言,因其简洁性和对并发编程的强大支持而受到开发者们的喜爱。Go编程的一个关键方面是其包和模块系统,它允许创建可重用、可维护和高效的代码。本博客文章将深入探讨在Go中设计包和模块的最佳实践,重点是创建内聚且可重用的包、精心考虑API设计以及管理版本和依赖关系。

设计内聚且可重用的包

在Go中,使代码可重用的最基本构建块是函数,包则是代码重用的后续发展。Go中的包是一组Go源文件,它们被组织成一个单一单元,使代码具有模块化、可重用和可维护性。每个Go包都位于一个单独的目录中,并且旨在处理与该包的目标相关的一组问题。

在设计包时,遵循DRY(不要重复自己)原则非常重要,该原则规定您不应该再次编写相同的代码。相反,您应该尽可能地重用和扩展现有的代码。

Go包提供了几个设计特性,有助于在程序中创建“防火墙”,允许将各个部分完全隔离,仅暴露最小且清晰的API所需内容。这些特性包括:

1. 命名空间:

这允许您为包中的类型和函数选择简短而清晰的名称,而无需担心常见名称是否已在其他包中使用,因为包是自包含的。示例:

package userimport "fmt"type User struct {ID   intName string
}func CreateUser(id int, name string) User {return User{ID: id, Name: name}
}func PrintUser(u User) {fmt.Printf("User ID: %d, Name: %s\n", u.ID, u.Name)
}

2. 封装:

通过使用导出的变量和函数,您可以控制包外部可访问的内容。这种受限制的可见性允许在包级别具有非常有意义的API。示例:

package mainimport ("fmt"
)type Employee struct {ID        intName      stringSalary    float64isManager bool
}func NewEmployee(id int, name string, salary float64, isManager bool) Employee {return Employee{ID:        id,Name:      name,Salary:    salary,isManager: isManager,}
}func (e *Employee) SetManagerStatus(isManager bool) {e.isManager = isManager
}func (e Employee) PrintDetails() {fmt.Printf("ID: %d\nName: %s\nSalary: %.2f\nManager: %v\n", e.ID, e.Name, e.Salary, e.isManager)
}func main() {emp := NewEmployee(1, "Alice", 50000.0, false)emp.PrintDetails()// Try to change manager status directly (encapsulation prevents this)// emp.isManager = true // Uncommenting this will result in a compilation erroremp.SetManagerStatus(true)emp.PrintDetails()
}

在这个示例中:

  1. 我们定义了一个名为Employeestruct,包含诸如IDNameSalary等字段,以及一个未导出的isManager字段。
  2. NewEmployee函数是一个构造函数,用于创建一个新的Employee实例。
  3. SetManagerStatus方法允许受控地修改isManager字段。
  4. PrintDetails方法封装了打印员工详细信息的逻辑,包括未导出的isManager字段。
  5. main函数中,我们创建了一个Employee实例,打印了其详细信息,然后使用SetManagerStatus方法更改了经理状态。

请注意,通过将isManager字段设置为未导出,并提供一个方法来修改它,我们封装了Employee对象的内部状态并控制了对其的访问。这防止了从Employee类型外部直接修改isManager字段。

请记住,Go没有像其他一些语言那样的传统访问修饰符,因此封装依赖于命名约定以及标识符的导出或未导出。

3. 内部包:

这些禁止从内部目录的父目录树之外导入包含“internal”元素的代码。

慎重设计API

在创建API时,仔细考虑要暴露给外部世界的内容至关重要。在Go中,通过导出变量和函数来实现这一点。通过控制包外部可访问的内容,您可以在包级别提供一个非常有意义的API,并且具备更改未导出代码的灵活性,而无需担心破坏该API。

此外,慎重考虑API设计还有助于确保软件的可维护性和耐用性。正如Dave Cheney在他的Golang UK 2016主题演讲中所说:“Go程序的维护,以及它们可以发生的容易程度,将是他们决策的关键因素。”

版本控制和依赖管理

Go模块是Go包的集合,每个项目都是一个模块。模块中使用的包由Go通过go.mod文件进行管理。

Go模块使用语义化版本(Semver)系统进行版本控制,版本号由三部分组成:主版本、次版本和修订版本。例如,版本号为1.2.3的包中,1是主版本,2是次版本,3是修订版本。

开发者将自己的模块发布到自己的存储库,供其他开发者使用,并附带一个版本号。Go工具使您更轻松地管理依赖关系,包括获取模块的源代码、升级等等。

当您准备发布模块的新版本时,您可以使用go mod tidy命令来确保您的go.mod文件包含所有必要的依赖项。然后,您可以在版本控制系统中标记新版本。

总之,在Go中设计包和模块是Go编程的重要方面。通过设计内聚且可重用的包、慎重考虑API设计,以及有效管理版本和依赖关系,您可以编写干净、可维护且高效的Go代码。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.xdnf.cn/news/145770.html

如若内容造成侵权/违法违规/事实不符,请联系一条长河网进行投诉反馈,一经查实,立即删除!

相关文章

Servlet操作与用法(保姆式教学)

Servlet介绍 什么是servlet Servlet(Servlet Applet的缩写,全称 Java Servlet):适用于Java编写的服务器程序,其主要功能是在于交互式的浏览和修改数据,生成动态Web内容。狭义的Servlet是指Java语言实现的…

MySQL学习笔记27

MySQL主从复制的核心思路: 1、slave必须安装相同版本的mysql数据库软件。 2、master端必须开启二进制日志,slave端必须开启relay log 日志。 3、master主服务器和slave从服务器的server-id号不能一致。 4、slave端配置向master端来同步数据。 master…

云安全之访问控制的常见攻击及防御

访问控制攻击概述 访问控制漏洞即应用程序允许攻击者执行或者访问某种攻击者不具备相应权限的功能或资源。 常见的访问控制可以分为垂直访问控制、水平访问控制及多阶段访问控制 (上下文相关访问控制),与其相应的访问控制漏洞为也垂直越权漏洞(普通用户可以访问或…

【QT】使用toBase64方法将.txt文件的明文变为非明文(类似加密)

目录 0.环境 1.背景 2.详细代码 2.1 .h主要代码 2.2 .cpp主要代码,主要实现上述的四个方法 0.环境 windows 11 64位 Qt Creator 4.13.1 1.背景 项目需求:我们项目中有配置文件(类似.txt,但不是这个格式,本文以…

计算机网络之传输层

计算机网络 - 传输层 计算机网络 - 传输层 UDP 和 TCP 的特点UDP 首部格式TCP 首部格式TCP 的三次握手TCP 的四次挥手TCP 可靠传输TCP 滑动窗口TCP 流量控制TCP 拥塞控制 1. 慢开始与拥塞避免2. 快重传与快恢复 网络层只把分组发送到目的主机,但是真正通信的并不是…

leetcode-----二叉树习题

目录 前言 1. 二叉树的中序遍历 2. 相同的树 3. 二叉树的最大深度 4. 二叉树的最小深度 5.二叉树的前序遍历 6. 二叉树的后序遍历 7. 对称二叉树 前言 前面我们学习过了二叉树的相关知识点,那么今天我们就做做练习,下面我会介绍几道关于二叉树的…

JUnit介绍

JUnit是用于编写和运行可重复的自动化测试的开源测试框架, 这样可以保证我们的代码按预期工作。JUnit可广泛用于工业和作为支架(从命令行)或IDE(如Eclipse)内单独的Java程序。 JUnit提供: 断言测试预期结果。 测试功能共享通用的测试数据。 测试套件轻…

Java实现word excel ppt模板渲染与导出及预览 LibreOffice jodconverter

Java Office 一、文档格式转换 文档格式转换是office操作中经常需要进行一个操作,例如将docx文档转换成pdf格式。 java在这方面有许多的操作方式,大致可以分为内部调用(无需要安装额外软件),外部调用(需…

STM32三种开发方式及标准库和HAL库的编程差异

三种开发方式 STM32基于标准库函数和HAL库编程差异_stm32库函数和hal库-CSDN博客本文目的是以串口通信来简要分析STM32使用标准库函数和HAL库函数编程的差异。目录(一)开发方式1.配置寄存器2.库函数3.HAL库(二)库函数与HAL库对比…

RDMA技术(解决主从数据库数据不一致问题)

优质博文:IT-BLOG-CN 一、简介 RDMA(remote direct memory access)即远端直接内存访问,是一种高性能网络通信技术,具有高带宽、低延迟、无CPU消耗等优点。 主要解决网络传输中服务器端数据处理的延迟问题。 Remote:数据通过网络…

Arduino PLC IDE

Arduino PLC IDE MCU单片机进入全新的PLC领域概述需要的硬件和软件下一步操作1. Arduino PLC IDE Tool Setup2. Arduino PLC IDE Setup3. Project Setup4. Download the Runtime5. Connect to the Device6. License Activation with Product Key (Portenta Machine Control) 结…

MySQL 索引介绍和最佳实践

目录 一、前言二、索引类型1.1 主键索引(PRIMARY KEY)1.2 唯一索引(UNIQUE)1.3 普通索引(NORMAL)1.3.1 单列普通索引1.3.2 单列前缀普通索引1.3.3 多列普通索引1.3.4 多列前缀普通索引 1.4 空间索引&#x…

力扣 -- 10. 正则表达式匹配

解题步骤&#xff1a; 参考代码&#xff1a; class Solution { public:bool isMatch(string s, string p) {int ms.size();int np.size();//处理后续映射关系s s;//处理后续映射关系p p;vector<vector<bool>> dp(m1,vector<bool>(n1));//初始化dp[0][0]true…

WPF 03

staticResource和dynamicResource的区别 首先看一个案例 MainWindow.xaml <Window x:Class"WpfDay03.MainWindow"xmlns"http://schemas.microsoft.com/winfx/2006/xaml/presentation"xmlns:x"http://schemas.microsoft.com/winfx/2006/xaml&quo…

led灯什么牌子的质量好?Led护眼台灯排行榜

现在我们很多家长对自己孩子的视力十分关心&#xff0c;生怕自己的孩子是近视、远视、弱视等等。对于父母而言&#xff0c;在孩子读书压力大课业重的关键时期&#xff0c;为孩子选择合适的桌椅&#xff0c;保护灯具从而保护孩子的眼睛是非常重要的事情!那么买给孩子读书做功课的…

驱动插入中断门示例代码

驱动插入中断描述符示例代码 最近做实验&#xff0c;每次在应用层代码写测试代码的时候都要手动挂一个中断描述符&#xff0c;很不方便所以就想着写个驱动挂一个中断门比较省事 驱动测试效果如下&#xff1a; 下面的代码是个架子&#xff0c;用的时候找个驱动历程传递你要插…

聊聊并发编程——并发容器和阻塞队列

目录 一.ConcurrentHashMap 1.为什么要使用ConcurrentHashMap&#xff1f; 2.ConcurrentHashMap的类图 3.ConcurrentHashMap的结构图 二.阻塞队列 Java中的7个阻塞队列 ArrayBlockingQueue&#xff1a;一个由数组结构组成的有界阻塞队列。 LinkedBlockingQueue&#xf…

如何快速搭建app自动化环境编写用例?

使用Airtest 作为测试开发工程师&#xff0c;快速搭建app自动化环境并编写用例可以使用Airtest解决方案来实现。Airtest是一款基于Python的全平台UI自动化测试框架&#xff0c;支持多种移动设备和模拟器&#xff0c;同时集成了丰富的图像识别和手势操作功能。 以下是使用Airt…

【0223】源码剖析smgr底层设计机制(3)

1. smgr设计机制 PG内核中smgr完整磁盘存储介质的管理是通过下面三部分实现的。 1.1 函数指针结构体 f_smgr 函数指针结构体 f_smgr。 通过该函数指针类型,可完成类似于UNIX系统中的VFD功能,上层只需要调用open()、read()、write()等系统函数,用户不必去关系底层的文件系统…

【我的创作纪念日】使用pix2pixgan实现barts2020数据集的处理(完整版本)

使用pix2pixgan &#xff08;pytorch)实现T1 -> T2的基本代码 使用 https://github.com/eriklindernoren/PyTorch-GAN/ 这里面的pix2pixgan代码进行实现。 进去之后我们需要重新处理数据集&#xff0c;并且源代码里面先训练的生成器&#xff0c;后训练鉴别器。 一般情况下…