Golang语法规范和风格指南(一)——简单指南

news2025/2/24 8:59:51

1. 前引

在这里插入图片描述

一个语言的规范的学习是重要的,直接关系到你的代码是否易于维护和理解,同时学习好对应的语言规范可以在前期学习阶段有效规避该语言语法和未知编程风格的冲突。

这里是 Google 提供的规范,有助于大家在开始学习阶段对 Golang 进行一个简单的理解和项目的创建。

https://google.github.io/styleguide/go/guide(英文版)
https://gocn.github.io/styleguide/docs/01-overview(中文版)

2. 整体原则

整体上需要遵循:清晰,简约,简洁,可维护性,一致性

我们将在下列例子中体现上面原则,帮助大家理解这些抽象原则

1. 包名称 package

我们希望使用纯小写字母去建立包名称,这时候可能有同学要问,如果这个功能隶属于某个功能下的功能不需要在功能后缀名,冲突怎么办?

  1. Java 写法
    我们在 java 中很容易就想在命名后面加类别比如UserService, 这个其实是毫无意义的后缀
  2. Golang 规范
    我们可以直接 /service/user 我们直接通过路径定位,service,同时 user 又都是小写。

这体现了 golang 的清晰和简洁

2. 常、变量命名

  1. Java 写法:
    我们在 Java 中通常使用下划线,全大写来定义常量,使用小驼峰定义变量,首单词使用大写。
  2. Golang 规范:
    我们在 golang 中同样使用驼峰进行命名,不过权限使用首字母大写来控制函数、变量是否对外部开放,在 golang 中拒绝使用不通用的缩写,通用缩写如‘api’,使用全大写命名 API

在 golang 中 变量命名长度通常和使用范围成正比,比如简单一个计数变量仅仅5行内使用,使用 count 即可,反之,如果使用更大范围的计算器,接口流量计数器,可能就需要更长的命名,如 interfaceTrafficCount,可以避免冲突和歧义。

这体现了 golang 的清晰和简约

3. 导包分组

在这里插入图片描述

导入的包最好分为两组,一组为标准库,一组为项目(其他)包

这体现了 golang 的清晰和简约、可维护性

4. 下划线导包

这个功能只建议导入初始化包的方法,因为这种导入是不可知的,维护性差的,不过下划线导包会默认执行 init()前缀的方法,主要用于一些不需要明示的初始化操作。

package main

import (
    _ "fmt" // 副作用导入,仅触发 fmt 包的初始化过程
)

func main() {
    // 这里不会直接使用 fmt 包,但 fmt 包的 init() 函数会被执行
}

像 spring 的初始化过程,包括一些核心的对象,引用的创建是不需要对外展示的,因为并不能帮助维护者理解代码,只会增加系统的复杂性。

像 . 别名导入功能,在google 推荐规范中就直接不建议使用了,没有特例

这体现了 golang 的清晰和可维护性

5. 错误处理

由于 golang 中 ,处理处理错误更为灵活,我们可以对总是成功的错误函数,不去处理错误,但是绝大多数情况,golang 还是建议去处理错误或者把错误返回给上一级
在这里插入图片描述
错误字符串通常开头小写,而日志记录通常首字母大写

这体现了 golang 的简约和可维护性

6. 字面格式化

对于在当前包之外定义的类型,结构体字面量通常应该指定字段名

// Good:
good := otherpkg.Type{A: 42}

如果能使代码更清晰,还是应该使用字段名,而且这样做是很常见的。例如,一个有大量字段的结构几乎都应该用字段名来初始化。

// Good:
okay := StructWithLotsOfFields{
  field1: 1,
  field2: "two",
  field3: 3.14,
  field4: true,
}

这体现了 golang 的简约、清晰和可维护性

7. if,for 的判断式不应该换行

// Good:
inTransaction := db.CurrentStatusIs(db.InTransaction)
keysMatch := db.ValuesEqual(db.TransactionKey(), row.Key())
if inTransaction && keysMatch {
    return db.Error(db.TransactionError, "query failed: row (%v): key does not match transaction key", row)
}
// Good:
for i, max := 0, collection.Size(); i < max && !collection.HasPendingWriters(); i++ {
    // ...
}

即使你的布尔判断式较长,也不建议换行,换行不能增加代码的美观性,且会增加阅读障碍。
这体现了 golang 的清晰和可维护性

8. switch 的 break 优化

// Good:
switch x {
case "A", "B":
    buf.WriteString(x)
case "C":
    // handled outside of the switch statement
default:
    return fmt.Errorf("unknown value: %q", x)
}
// Bad:
switch x {
case "A", "B":
    buf.WriteString(x)
    break // this break is redundant
case "C":
    break // this break is redundant
default:
    return fmt.Errorf("unknown value: %q", x)
}

其实刚学 Java 的时候 就感觉 case 是有点不好用的,有点反直觉,明明已经case 到值了,为什么还要向下进行, go
的字句会自动中断,说人话就是默认每个case后加了一个break,不需要我们手动加了

这体现了 golang 的清晰 主要是对 c 和 go 不明晰语意的优化

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

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

相关文章

【IT领域新生必看】深入了解Java中的静态成员变量和实例成员变量:初学者的全方位指南

文章目录 引言什么是静态成员变量&#xff1f;定义和使用静态成员变量示例&#xff1a; 静态成员变量的特点示例&#xff1a; 什么是实例成员变量&#xff1f;定义和使用实例成员变量示例&#xff1a; 实例成员变量的特点示例&#xff1a; 静态成员变量与实例成员变量的区别作用…

lodash-es 基本使用

中文文档&#xff1a;https://www.lodashjs.com/ cloneDeep方法文档&#xff1a;https://www.lodashjs.com/docs/lodash.cloneDeep#_clonedeepvalue 参考掘金文章&#xff1a;https://juejin.cn/post/7354940462061715497 安装&#xff1a; pnpm install lodash-esnpm地址&a…

关于用户咨询华为擎云L410笔记本安装Windows系统的说明

同样也是单位购买的华为擎云L410 KLVU-WDU0笔记本电脑&#xff0c;国产UOS系统某些软件用着不是很方便&#xff0c;用户咨询是否能够安装Windows10或者Windows7&#xff1f; 带着种种疑问也做了一些查询&#xff0c;之前也给一些国产设备更改过操作系统&#xff0c;之前的国产设…

G9 - ACGAN理论与实战

&#x1f368; 本文为&#x1f517;365天深度学习训练营 中的学习记录博客&#x1f356; 原作者&#xff1a;K同学啊 目录 环境步骤环境设置数据准备工具方法模型设计模型训练模型效果展示 总结与心得体会 上周已经简单的了解了ACGAN的原理&#xff0c;并且不经实践的编写了部分…

git pull拉取显示Already up-to-date,但文件并没有更新

1、问题&#xff1a; 使用git pull拉取远程仓库代码&#xff0c;显示更新成功&#xff08;Already up-to-date&#xff09;&#xff0c;但是本地代码没有更新 这是因为本地有尚未提交的更改&#xff0c;和远程代码有冲突导致无法更新 2、解决方法&#xff1a; 可以使用git s…

MySQL架构和工作流程

引言&#xff1a;MySQL执行一条sql语句期间发生了什么&#xff1f; 想要搞清楚这个问题&#xff0c;我们必须了解MySQL的体系结构和工作流程 一、MySQL体系结构 MySQL由以下几个部分组成 一、server层 1.MySQL Connnectors连接器&#xff0c;MySQL的连接池组件&#xff0c;…

BlazorHybrid 通过Blazor简单调用本机功能

简单调用本机功能,例如打印,获取硬件信息,获取本机用户名,拦截JS功能,拦截错误信息等等… 废话不多说先来截图 使用 JsBridge JsBridge不科普了,同学们自行百度一下 BlazorWebView.cs using Microsoft.AspNetCore.Components.WebView; using Microsoft.AspNetCore.Componen…

easyx图形库

目录 1、绘制简单的图形化窗口 2、设置窗口属性 2.1 颜色设置 2.2 刷新 3、基本绘图函数 3.1 绘制直线 3.2 绘制圆 3.3 绘制矩形 4、贴图 4.1 原样贴图 4.1.1 IMAGE变量去表示图片 4.1.2 加载图片 4.1.3 显示图片 4.2 透明贴图 4.2.1 认识素材 4.3 png贴图 5…

辣子简报芬芳喜事特辑

【辣子简报芬芳喜事特辑】&#x1f389;在这个季节的尾声&#xff0c;当一缕阳光温柔地洒在打包好的行囊上&#xff0c;我们不约而同地停下了忙碌的脚步&#xff0c;回望那段共同编织的璀璨时光——79天的并肩作战&#xff0c;如同一段精彩绝伦的旅程&#xff0c;如今已缓缓驶向…

taoCMS v3.0.2 任意文件读取漏洞(CVE-2022-23316)

前言 CVE-2022-23316 是一个影响 taoCMS v3.0.2 的漏洞。这个漏洞允许攻击者通过 admin.php?actionfile&ctrldownload&path../../1.txt 的路径读取任意文件。攻击者可以利用该漏洞读取服务器上的任何文件&#xff0c;只要他们知道文件的路径​ (OpenCVE)​​ (Tenabl…

Java多语言跨境电商外贸商城源码 tiktok商城系统源码 跨境电商源码

Java多语言跨境电商外贸商城源码 tiktok商城系统源码 跨境电商源码 技术栈 PC端使用&#xff1a;vueelementui 用户端使用&#xff1a;uniapp 管理端使用&#xff1a;vueelementui 后台服务使用&#xff1a;springbootmybatisplusmysql 功能描述&#xff1a; 对接PayPal…

IDEA配Git

目录 前言 1.创建Git仓库&#xff0c;获得可提交渠道 2.选择本地提交的项目名 3.配置远程仓库的地址 4.新增远程仓库地址 5.开始进行commit操作 6.push由于邮箱问题被拒绝的解决方法&#xff1a; 后记 前言 以下操作都是基于你已经下载了Git的前提下进行的&#xff0c…

源码航行阅读目录

&#x1f3c0; 前言 在准备面试和学习的过程中&#xff0c;我阅读了比较多的源码&#xff0c;比如 JUC、Spring、MyBatis&#xff0c;收获了很多代码的设计思想&#xff0c;也对平时调用的 API 有了更深入的理解&#xff1b;但过多散乱的笔记给我的整理复习带来了比较大的麻烦…

前端vue后端java使用easyexcel框架下载表格xls数据工具类

一 使用alibaba开源的 easyexcel框架&#xff0c;后台只需一个工具类即可实现下载 后端下载实现 依赖 pom.xml <dependency><groupId>org.apache.poi</groupId><artifactId>poi</artifactId><version>4.1.2</version></dependen…

第三方商城对接重构(HF202407)

文章目录 项目背景一、模块范围二、问题方案1. 商品模块整体来说这块对接的不是太顺利,梳理了几条大概的思路:2. 订单模块3. 售后4. 发票5. 结算单经验总结项目背景 作为供应商入围第三方商城成功,然后运营了一段时间,第三方通知要重构, 需要重新对接打通接口完成系统对接…

树型结构数据存储实践

很多业务场景会遇到树形结构的数据&#xff0c;如公司的人员职级树、行政区划树等。 使用类似MySQL的数据库进行存储&#xff0c;需要将树形结构&#xff08;二维&#xff09;存储到行格式&#xff08;一维&#xff09;的db中。 本文介绍了树型结构数据存储的三种方式&#xf…

ShardingSphere实战

ShardingSphere实战 文章目录 ShardingSphere实战分库分表实战建表建表sql利用存储过程建表Sharding-jdbc分库分表配置 基于业务的Sharding-key考虑订单id用户id分片策略订单id的设计与实现**设计思想**&#xff1a;设计思路&#xff1a; 具体分片策略实现测试数据插入商户商品…

计算机提示由于找不到concrt140.dll怎么办,7种解决方法可以对比

在电脑中打开游戏或许软件出现找不到concrt140.dll无法继续执行代码怎么办&#xff1f;concrt140.dll是什么&#xff1f;丢失要怎么解决&#xff1f;下面给大家分析一下concrt140.dll文件是什么与concrt140.dll丢失的多种解决方法&#xff01;相信对你有帮助&#xff01; 一、c…

SpringSecurity6.x使用教程

SpringSecurity6.x使用 SpringSecurity版本 SpringSecurity目前支持的版本如下图所示&#xff0c;可以看到5.x的版本过几年就不会再维护了&#xff0c;6.x将成为主流。 入门 引入依赖 <dependency><groupId>org.springframework.boot</groupId><arti…

法国工程师IMT联盟 密码学及其应用 2022年期末考试

1 密码学 1.1 问题1 对称加密&#xff08;密钥加密) 1.1.1 问题 对称密钥la cryptographie symtrique和公开密钥有哪些优缺点&#xff1f; 1.1.1.1 对称加密&#xff08;密钥加密)的优缺点 1.1.1.1.1 优点 加解密速度快encrypt and decrypt&#xff1a;对称加密算法通常基于…