Golang中的包和模块设计

news2024/11/26 13:55:54

在这里插入图片描述

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

设计内聚且可重用的包

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

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

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

1. 命名空间:

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

package user

import "fmt"

type User struct {
    ID   int
    Name 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 main

import (
	"fmt"
)

type Employee struct {
	ID        int
	Name      string
	Salary    float64
	isManager 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 error

	emp.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.coloradmin.cn/o/1053284.html

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

相关文章

数据结构 图 并查集 遍历方法 最短路径算法 最小生成树算法 简易代码实现

文章目录 前言并查集图遍历方法广度优先遍历深度优先遍历 最小生成树算法Kruskal算法Prim算法 最短路径算法Dijkstra算法BellmanFord算法FloydWarshall算法 全部代码链接 前言 图是真的难,即使这些我都学过一遍,再看还是要顺一下过程;说明方…

普通用户在Linux下免密执行sudo命令,真的可以吗?

主旨 在linux的日常运维中,我们会发现,使用root用户的权限太大了,很多时候一不小心就删错了,而且恢复不回来,我们应该怎么避免呢? 我们可以使用普通用户进行服务器的登录,如果有权限不够的情况&…

nodejs+vue 汽车销售系统elementui

第三章 系统分析 10 3.1需求分析 10 3.2可行性分析 10 3.2.1技术可行性:技术背景 10 3.2.2经济可行性 11 3.2.3操作可行性: 11 3.3性能分析 11 3.4系统操作流程 12 3.4.1管理员登录流程 12 3.4.2信息添加流程 12 3.4.3信息删除流程 13 第四章 系统设计与…

【Spring Cloud】深入理解 Eureka 注册中心的原理、服务的注册与发现

文章目录 前言一、微服务调用出现的问题1.1 服务消费者如何获取服务提供者的地址信息?1.2 如果有多个服务提供者,消费者该如何选择?1.3 消费者如何得知服务提供者的健康状态? 二、什么是 Eureka2.1 Eureka 的核心概念2.2 Eureka 的…

Python-Flask:编写自动化连接demo脚本:v1.0.0

主函数: # _*_ Coding : UTF-8 _*_ # Time : 13:14 # Author : YYZ # File : Flask # Project : Python_Project_爬虫 import jsonfrom flask import Flask,request,jsonify import sshapi Flask(__name__)# methods: 指定请求方式 接口解析参数host host_info[…

【已解决】 Expected linebreaks to be ‘LF‘ but found ‘CRLF‘.

问题描述 团队都是用mac,只有我自己是windows,启动项目一直报错 Expected linebreaks to be ‘LF‘ but found ‘CRLF‘. 但我不能因为自己的问题去改团队配置,也尝试过该vscode配置默认是LF还是报错 思路 看文章vscode如何替换所有文件的…

深度学习笔记_1、定义神经网络

1、使用了PyTorch的nn.Module类来定义神经网络模型;使用nn.Linear来创建全连接层。(CPU) import torch.nn as nn import torch.nn.functional as F from torchsummary import summary# 定义神经网络模型 class Net(nn.Module):def __init__(self):super(Net, self).__init__()…

yolov8 opencv模型部署(python版)

yolov8 opencv模型部署(python版) 使用opencv推理yolov8模型,以yolov8n为例子,一共几十行代码,没有废话,给出了注释,从今天起,少写一行代码,少掉一根头发。测试数据有需…

蓝桥等考Python组别九级001

第一部分:选择题 1、Python L9 (15分) 运行下面程序,可以输出几行“*”?( ) for i in range(0, 7): for j in range(0, 4): print(*, end ) print() 6374 正确答案:C 2、P…

自动驾驶:未来的道路上的挑战与机遇

自动驾驶:未来的道路上的挑战与机遇 文章目录 引言安全与道路事故的减少交通拥堵的缓解城市规划的变革技术和法律挑战结语 2023星火培训【专项营】Apollo开发者社区布道师倾力打造,包含PnC、新感知等的全新专项课程上线了。理论与实践相结合,…

Qt扩展-QCustomPlot绘图基础概述

QCustomPlot绘图基础概述 一、概述二、改变外观1. Graph 类型2. Axis 坐标轴3. 网格 三、案例1. 简单布局两个图2. 绘图与多个轴和更先进的样式3. 绘制日期和时间数据 四、其他Graph:曲线,条形图,统计框图,… 一、概述 本教程使用…

Selenium 浏览器坐标转桌面坐标

背景: 做图表自动化项目需要做拖拽操作,但是selenium提供的拖拽API无效,因此借用pyautogui实现拖拽,但是pyautogui的拖拽是基于Windows桌面坐标实现的,另外浏览器中的坐标与windows桌面坐标并不是一比一对应的关系&am…

【计算机网络】因特网中的电子邮件

文章目录 简单邮件传送协议SMTP邮件访问协议POP3IMAPHTTP 参考资料 电子邮件为异步通信媒介 因特网电子邮件系统 电子邮件系统的三个构件:用户代理、邮件服务器、邮件发送和读取协议 用户代理 User Agent 即UA 电子邮件客户端软件,用户与电子邮件系统的接…

【从入门到起飞】JavaSE—网络编程三要素,软件架构,UDP协议

文章目录 🎄什么是网络编程🌺常见的软件架构⭐BS架构的优缺点⭐CS架构的优缺点 🍔网络编程三要素🛸InetAddress类的使用⭐确定主机名称的IP地址✨查看主机名 ⭐获取此IP地址的主机名⭐返回文本显示中的IP地址字符串⭐IP&#x1f3…

Llama2-Chinese项目:3.1-全量参数微调

提供LoRA微调和全量参数微调代码&#xff0c;训练数据为data/train_sft.csv&#xff0c;验证数据为data/dev_sft.csv&#xff0c;数据格式如下所示&#xff1a; "<s>Human: "问题"\n</s><s>Assistant: "答案举个例子&#xff0c;如下所…

机器学习西瓜书+南瓜书吃瓜教程学习笔记第六章支持向量机

视频来源&#xff1a;b站直播 周志华老师机器学习西瓜树南瓜书 以下是我的学习笔记&#xff1a; 支持向量机&#xff08;support vector machines&#xff0c;SVM&#xff09;是一种二分类模型&#xff0c;它的目的是寻找一个超平面来对样本进行分割&#xff0c;分割的原则是间…

Java进阶必会JVM-深入浅出Java虚拟机

系列文章目录 送书第一期 《用户画像&#xff1a;平台构建与业务实践》 送书活动之抽奖工具的打造 《获取博客评论用户抽取幸运中奖者》 送书第二期 《Spring Cloud Alibaba核心技术与实战案例》 送书第三期 《深入浅出Java虚拟机》 文章目录 系列文章目录前言一、推荐书籍二…

LeetCode 周赛上分之旅 #48 一道简单的树上动态规划问题

⭐️ 本文已收录到 AndroidFamily&#xff0c;技术和职场问题&#xff0c;请关注公众号 [彭旭锐] 和 BaguTree Pro 知识星球提问。 学习数据结构与算法的关键在于掌握问题背后的算法思维框架&#xff0c;你的思考越抽象&#xff0c;它能覆盖的问题域就越广&#xff0c;理解难度…

软件测试/测试开发丨python 多态与super 学习笔记

本文为霍格沃兹测试开发学社学员学习笔记分享 原文链接&#xff1a;https://ceshiren.com/t/topic/26828 python 多态与super 多态的概念 多态&#xff1a;Polymorphism 同名方法呈现多种行为 多态的表现 号 加法&#xff1a;数字 数字拼接&#xff1a;字符串 字符串合…

2023年10月腾讯云优惠活动汇总:腾讯云最新优惠、代金券整理

腾讯云作为国内领先的云服务提供商&#xff0c;致力于为用户提供优质、稳定的云服务。为了更好地满足用户需求&#xff0c;腾讯云推出了各种优惠活动。本文将给大家分享腾讯云最新优惠活动&#xff0c;帮助用户充分利用腾讯云提供的优惠。 一、腾讯云优惠券领取【点此领取】 腾…