Go语言的100个错误使用场景（40-47）｜字符串函数方法

前言

大家好，这里是白泽。 《Go语言的100个错误以及如何避免》 是最近朋友推荐我阅读的书籍，我初步浏览之后，大为惊喜。就像这书中第一章的标题说到的：“Go: Simple to learn but hard to master”，整本书通过分析100个错误使用 Go 语言的场景，带你深入理解 Go 语言。

我的愿景是以这套文章，在保持权威性的基础上，脱离对原文的依赖，对这100个场景进行篇幅合适的中文讲解。所涉内容较多，总计约 8w 字，这是该系列的第五篇文章，对应书中第40-47个错误场景。

🌟 当然，如果您是一位 Go 学习的新手，您可以在我开源的学习仓库中，找到针对 《Go 程序设计语言》 英文书籍的配套笔记，其他所有文章也会整理收集在其中。

📺 B站：白泽talk，公众号【白泽talk】，聊天交流群：622383022，原书电子版可以加群获取。

前文链接：

  • 《Go语言的100个错误使用场景（1-10）｜代码和项目组织》
  • 《Go语言的100个错误使用场景（11-20）｜项目组织和数据类型》
  • 《Go语言的100个错误使用场景（21-29）｜数据类型》
  • 《Go语言的100个错误使用场景（30-40）｜数据类型与字符串使用》

5. 字符串

🌟 章节概述：

  • 了解 rune 的概念
  • 避免常见的字符串遍历和截取造成的错误
  • 避免由于字符串拼接和转换造成的低效代码
  • 避免获取子字符串造成的内存泄漏

5.5 无用的字符串转换（#40）

错误示例：

func getBytes(reader io.Reader) ([]byte, error) {
    b, err := io.ReadAll(reader)
    if err != nil {
        return nil, err
    }
    // 去除首尾空格
    return []byte(sanitize(string(b))), nil
}
​
func sanitize(s string) string {
    return strings.TrimSpace(s)
}

正确示例：

func getBytes(reader io.Reader) ([]byte, error) {
    b, err := io.ReadAll(reader)
    if err != nil {
        return nil, err
    }
    // 去除首尾空格
    return sanitize(b), nil
}
​
func sanitize(b []byte) []byte {
    return bytes.TrimSpace(b)
}

通常来说 bytes 库提供了与 strings 库相同功能的方法，而且大多数 IO 相关的函数的输入输出都是 []byte，而不是 string，错误示例中，将字符切片转换成字符串，再转换成字符切片，需要额外承担两次内存分配的开销。

5.6 获取子字符串操作和内存泄漏（#41）

假设有许多个 string 类型的 log 需要存储（假设一个log有1000字节），但是只需要存放 log 的前36字节，不恰当的子字符串截取函数，会导致内存泄漏。

示例代码：

// 方式一
func (s store) handleLog(log string) error {
    if len(log) < 36 {
        return errors.New("log is not correctly formatted")
    }
    uuid := log[:36]
    s.store(uuid)
    // Do something
}
// 方式二
func (s store) handleLog(log string) error {
    if len(log) < 36 {
        return errors.New("log is not correctly formatted")
    }
    uuid := string([]byte(log[:36]))
    s.store(uuid)
    // Do something
}
// 方式三
func (s store) handleLog(log string) error {
    if len(log) < 36 {
        return errors.New("log is not correctly formatted")
    }
    uuid := strings.Clone(log[:36])
    s.store(uuid)
    // Do something
}
  1. 和（#26）提到的子切片获取造成的内存泄漏一样，获取子字符串操作执行后，其底层依旧依赖原来的整个字符数组，因此1000个字节内存依旧占用，不会只有36个。
  2. 通过将字符串转换为字节数组，再转换为字符串，虽然消耗了2次长度为36字节的内存分配，但是释放了底层1000字节的原字节数组的依赖。有些 IDE 如 Goland 会提示语法错误，因为本质来说，将 string 转 []byte 再转 string 是一个累赘的操作。
  3. go1.18之后，提供了一步到位的 strings.Clone 方法，可以避免内存泄漏。

6. 函数和方法

🌟 章节概述：

  • 什么时候使用值或者指针类型的接受者
  • 什么时候命名的返回值，以及其副作用
  • 避免返回 nil 接受者时的常见错误
  • 函数接受一个文件名，并不是最佳实践
  • 处理 defer 的参数

6.1 不知道选择哪种类型的方法接受者（#42）

值接受者：

type customer struct {
    balance float64
}
​
func (c customer) add(operation float64) {
    c.balance += operation
}
​
func main() {
    c := customer{balance: 100.0}
    c.add(50.0)
    fmt.Printf("%.2f\n", c.balance) // 结果为 100.00
}

指针接受者：

type customer struct {
    balance float64
}
​
func (c *customer) add(operation float64) {
    c.balance += operation
}
​
func main() {
    c := customer{balance: 100.0}
    c.add(50.0)
    fmt.Printf("%.2f\n", c.balance) // 结果为 150.00
}

值接受者在方法内修改自身结构的值，不会对调用方造成实际影响。

🌟 一些实践的建议：

  • 必须使用指针接受者的场景：

    • 如果方法需要修改原始的接受者。
    • 如果方法的接受者包含不可以被拷贝的字段。

  • 建议使用指针接受者的场景：

    • 如果接受者是一个巨大的对象，使用指针接受者可以更加高效，避免了拷贝内存。

  • 必须使用值接受者的场景：

    • 如果我们必须确保接受者是不变的。
    • 如果接受者是一个 map, function, channel，否则会出现编译错误。

  • 建议使用值接受者的场景：

    • 如果接受者是一个切片，且不会被修改。
    • 如果接受者是一个小的数组或者结构体，不含有易变的字段。
    • 如果接受者是基本类型如：int, float64, string。

特殊情况：

type customer struct {
    data *data
}
​
type data struct {
    balance float64
}
​
func (c customer) add(operation float64) {
    c.data.balance += operation
}
​
func main() {
    c := customer{data: &data {
        balance: 100.0
    }}
    c.add(50.0)
    fmt.Printf("%.2f\n", c.data.balance) // 150.00
}

在这种情况下，即使方法接受者 c 不是指针类型，但是修改依旧可以生效。

但是为了清楚起见，通常还是将 c 声明成指针类型，如果它是可操作的。

6.2 从来不使用命名的返回值（#43）

如果使用命名返回值：

func f(a int) (b int) {
    b = a
    return
}

推荐使用命名返回值的场景举例：

// 场景一
type locator interface {
    getCoordinates(address string) (lat, lng float32, err error)
}
// 场景二
func ReadFull(r io.Reader, buf []byte) (n int, err error) {
    // 两个返回值被初始化为对应类型的零值：0和nil
    for len(buf) > 0 && err == nil {
        var nr int
        nr, err = r.Read(buf)
        n += nr
        buf = buf[nr:]
    }
    return
}

场景一：通过命名返回值提高接口的可读性

场景二：通过命名返回值节省编码量

🌟 最佳实践：需要权衡使用命名返回值是否能带来收益，如果可以就果断使用吧！

6.3 使用命名返回值造成的意外副作用（#44）

🌟 注意：使用命名返回值的方法，并不意味着必须返回单个 return，有时可以只为了函数签名清晰而使用命名返回值。

错误场景：

func (l loc) getCoordinates(ctx content.Content, address string) (lat, lng float32, err error) {
    isValid := l.validateAddress(address)
    if !isValid {
        return 0, 0, errors.New("invalid address")
    }
    if ctx.Err() != nil {
        return 0, 0, err
    }
    // Do something and return
}

此时，由于 ctx.Err() != nil 成立时，并没有为 err 赋值，因此返回的 err 永远都是 nil。

修正方案：

func (l loc) getCoordinates(ctx content.Content, address string) (lat, lng float32, err error) {
    isValid := l.validateAddress(address)
    if !isValid {
        return 0, 0, errors.New("invalid address")
    }
    if err = ctx.Err(); err != nil {
        // 这里原则上可以返回单个return，但是最好保持风格统一
        return 0, 0, err
    }
    // Do something and return
}

6.4 返回一个 nil 接受者（#45）

🔔 提示：在 Go 语言当中，方法就像是函数的语法糖一样，相当于函数的第一个参数是方法的接受者，nil 可以作为参数，因此 nil 接受者可以触发方法，因此不同于纯粹的 nil interface。

type Foo struct {}
​
func (foo *Foo) Bar() string {
    return "bar"
}
​
func main() {
    var foo *Foo
    fmt.Println(foo.Bar()) // 虽然 foo 动态值是 nil，但动态类型不是nil，是可以打印出 bar
}

错误示例：

type MultiError struct {
    errs []string
}
​
func (m *MultiError) Add(err error) {
    m.errs = append(m.errs, err.Error())
}
​
func (m *MultiError) Error() string {
    return stirngs.Join(m.errs, ";")
}
​
func (c Customer) Validate() error {
    var m *MultiError
    
    if c.Age < 0 {
        m = &MultiError{}
        m.Add(errors.New("age is negative"))
    }
    
    if c.Name == "" {
        if m == nil {
            m = &MultiError{}
        }
        m.Add(errors.New("age is nil"))
    }
    return m
}
​
func main() {
    // 传入的两个参数都不会触发 Validate 的 err 校验
    customer := Customer{Age: 33, Name: "John"}
    if err := customer.Validate(); err != nil {
        // 但是无论如何都会打印这行语句，err != nil 永远成立！
        log.Fatalf("customer is invalid: %v", err)
    }
}

🔔 提示：Go 语言的接口，有动态类型和动态值两个概念，

image-20240214163507390

上述错误示例中，即使通过了两个验证，Validate 返回了 m，此时这个接口承载的动态类型是 *MultiError，它的动态值是 nil，但是通过 == 判断一个 err 为 nil，或者说一个接口为 nil，要求其底层类型和值都是 nil 才会成立。

正确方案：

func (c Customer) Validate() error {
    var m *MultiError
    
    if c.Age < 0 {
        m = &MultiError{}
        m.Add(errors.New("age is negative"))
    }
    
    if c.Name == "" {
        if m == nil {
            m = &MultiError{}
        }
        m.Add(errors.New("age is nil"))
    }
    if m != nil {
        return m
    }
    return nil
}

此时返回的是一个 nil interface，是存粹的。而不是一个非 nil 动态类型的 interfere 返回值。

6.5 使用文件名作为函数的输入（#46）

编写一个从文件中按行读取内容的函数。

错误示例：

func countEmptyLinesInFile(filename string) (int, error) {
    file, err := os.Open(filename)
    if err != nil {
        return 0, err
    }
    
    scanner := bufio.NewScanner(file)
    for scanner.Scan() {
        // ...
    }
}

弊端：

  1. 每当需要做不同功能的单元测试，需要单独创建一个文件。
  2. 这个函数将无法被复用，因为它依赖于一个具体的文件名，如果是从其他输入源读取将需要重新编写函数。

🌟 修正方案：

func countEmptyLines(reader io.Reader) (int, error) {
    scanner := bufio.NewScanner(reader)
    for scanner.Scan() {
        // ...
    }
}
​
func TestCountEmptyLines(t *testing.T) {
    emptyLines, err := countEmptyLines(strings.NewReader(
    `foo
        bar
        baz
        `))
    // 测试逻辑
}

通过这种方式，可以将输入源进行抽象，从而满足来自任何输入的读取（文件，字符串，HTTP Request，gRPC Request等），编写单元测试也十分便利。

6.6 不理解 defer 参数和接收者是如何确定的（#47）

  • defer 声明的函数的参数值，在声明时确定：
const (
    StatusSuccess = "success"
    StatusErrorFoo = "error_foo"
    StatusErrorBar = "error_bar"
)
​
func f() error {
    var status string
    defer notify(status)
    defer incrementCounter(status)
    
    if err := foo(); err != nil {
        status = StatusErrorFoo
        return err
    }
    if err := bar(); err != nil {
        status = StatusErrorBar
        return err
    }
    status = StatusSuccess
    return nil
}

🌟 上述示例中，无论是否会在 foo 和 bar 函数的调用后返回 err，status 的值传递给 notify 和 incrementCount 函数的都是空字符串，因为 defer 声明的函数的参数值，在声明时确定。

修正方案1：

func f() error {
    var status string
    // 修改为传递地址
    defer notify(&status)
    defer incrementCounter(&status)
    
    if err := foo(); err != nil {
        status = StatusErrorFoo
        return err
    }
    if err := bar(); err != nil {
        status = StatusErrorBar
        return err
    }
    status = StatusSuccess
    return nil
}

因为地址一开始确定，所以无论后续如何为 status 赋值，都可以通过地址获取到最新的值。这种方式的缺点是需要修改 notify 和 incrementCounter 两个函数的传参形式。

🌟 defer 声明一个闭包，则闭包内使用的外部变量的值，将在闭包执行的时候确定。

func main() {
    i := 0
    j := 0
    defer func(i int) {
        fmt.Println(i, j)
    }(i)
    i++
    j++
}

因为 i 作为匿名函数的参数传入，因此值在一开始确定，而 j 是闭包内使用外部的变量，因此在 return 之前确定值。最后打印结果 i = 0, j = 1。

修正方案2:

func f() error {
    var status string
    defer func() {
        notify(status)
        incrementCounter(status)
    }()
}

通过使用闭包将 notify 和 incrementCounter 函数包裹，则 status 的值使用闭包外侧的变量 status，因此 status 的值会在闭包执行的时候确定，这种修改方式也无需修改两个函数的签名，更为推荐。

  • 指针和值接收者：

值接收者：

func main() {
    s := Struct{id: "foo"}
    defer s.print()
    s.id = "bar"
}
​
type Struct struct {
    id string
}
​
func (s Struct) print() {
    fmt.Println(s.id)
}

打印的结果是 foo，因为 defer 后声明的 s.print() 的接收者 s 将在一开始获得一个拷贝，foo 作为 id 已经固定。

指针接收者：

func main() {
    s := &Struct{id: "foo"}
    defer s.print()
    s.id = "bar"
}
​
type Struct struct {
    id string
}
​
func (s *Struct) print() {
    fmt.Println(s.id)
}

打印结果是 bar，defer 后声明的 s.print() 的接收者 s 将在一开始获得一份拷贝，因为是地址的拷贝，所以对 return 之前的改动有感知。

小结

已完成《Go语言的100个错误》全书学习进度47%，欢迎追更。

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

ClickHouse--03--数据类型

ClickHouse--03--数据类型

提示&#xff1a;文章写完后&#xff0c;目录可以自动生成&#xff0c;如何生成可参考右边的帮助文档 文章目录 数据类型1. Int2.FloattoFloat32(...) 用来将字符串转换成 Float32 类型的函数toFloat64(...) 用来将字符串转换成 Float64 类型的函数 3.DecimaltoDecimal32(value…
阅读更多...
微服务中台架构的设计与实现

微服务中台架构的设计与实现

本文将探讨微服务中台架构的设计与实现&#xff0c;介绍如何通过微服务的方式进行系统拆分和组合&#xff0c;构建灵活、可扩展且易于维护的中台架构&#xff0c;以加速企业的数字化转型和提升竞争力。 ## 1. 引言 随着企业规模的不断扩大和业务的日益复杂化&#xff0c;传统…
阅读更多...
RabbitMQ配置消息转换器

RabbitMQ配置消息转换器

1. 默认转换器 Test public void testSendMap() throws InterruptedException {// 准备消息Map<String, Object> msg new HashMap<>();msg.put("name", "harry");msg.put("age", 21);// 发送消息rabbitTemplate.convertAndSend(&q…
阅读更多...
问题：规范化过程主要为克服数据库逻辑结构中的插入异常、删除异常以及(??)的缺陷. #职场发展#职场发展#知识分享

问题：规范化过程主要为克服数据库逻辑结构中的插入异常、删除异常以及(??)的缺陷. #职场发展#职场发展#知识分享

问题&#xff1a;规范化过程主要为克服数据库逻辑结构中的插入异常、删除异常以及(??)的缺陷. 参考答案如图所示
阅读更多...
JVM内存模型深度剖析与优化

JVM内存模型深度剖析与优化

JDK体系结构 Java语言的跨平台特性 JVM整体结构及内存模型 补充一个问题&#xff1a; 在minor gc过程中对象挪动后&#xff0c;引用如何修改&#xff1f; 对象在堆内部挪动的过程其实是复制&#xff0c;原有区域对象还在&#xff0c;一般不直接清理&#xff0c;JVM内部清理过程…
阅读更多...
中国电子学会2023年12月份青少年软件编程Scratch图形化等级考试试卷四级真题(含答案)

中国电子学会2023年12月份青少年软件编程Scratch图形化等级考试试卷四级真题(含答案)

2023-12 Scratch四级真题 分数&#xff1a;100 题数&#xff1a;24 分数&#xff1a;60min 一、单选题(共10题&#xff0c;共30分) 1.运行下列程序&#xff0c;输入“abcdef”&#xff0c;程序结束后&#xff0c;变量“字符串”是&#xff1f;&#xff08;B&#xff09;(3…
阅读更多...
Vue 全组件 局部组件

Vue 全组件 局部组件

一、组件定义和使用 1、全局组件 定义 <template> <div> <h1>This is a global component</h1> </div> </template> <script lang"ts"> </script> <style></style> 导入 全局组件在main.ts&#xff…
阅读更多...
前端可能需要的一些安装

前端可能需要的一些安装

Node.js Node.js 官网 Node.js 中文网 Node.js is an open-source, cross-platform JavaScript runtime environment. Node.js是一个开源、跨平台的JavaScript运行时环境。Recommended for most users 推荐大多数用户使用哔哩哔哩安装视频 安装 node.js 的时候&#xff0c;会…
阅读更多...
Write operation failed: computed value is readonly问题解决

Write operation failed: computed value is readonly问题解决

源代码&#xff1a; // 封装倒计时逻辑函数 import { computed, ref } from vue import dayjs from dayjs export const useCountDown () > {// 1.响应式数据const time ref(0)// 格式化时间const formatTime computed(()>dayjs.unix(time.value).format(mm分ss秒))/…
阅读更多...
Python·turtle库编程之：怎么画一个五角星？

Python·turtle库编程之：怎么画一个五角星？

文章目录 前言源码附&#xff1a; 前言 大家好&#xff0c;我是BoBo仔&#xff0c;这节课我要带来一期turtle库的使用教程——画五角星。话不多说&#xff0c;我们直接上代码。 源码 import turtle as t t.pencolor(yellow) t.fillcolor("yellow") t.penup() t.go…
阅读更多...
算法刷题:和为s的两个数

算法刷题:和为s的两个数

和为s的两个数 .题目链接题目详情算法原理我的答案 . 题目链接 和为s的两个数 题目详情 算法原理 这里我们是利用单调性来使用双指针的对撞指针来解决问题 因为数组给的是有序递增的,因此我们设置两个指针left和right来解决问题,当nums[left]与nums[right]相加会有三种情况:…
阅读更多...
电脑监控屏幕软件有哪些(监控电脑屏幕的软件)

电脑监控屏幕软件有哪些(监控电脑屏幕的软件)

随着信息技术的迅猛发展&#xff0c;电脑屏幕监控软件已成为企业、家庭以及教育机构保护数据安全、提升工作效率以及进行行为分析的重要工具。本文将详细介绍几款主流的电脑屏幕监控软件&#xff0c;包括它们的功能、特点以及适用场景&#xff0c;帮助读者更好地了解并选择合适…
阅读更多...
【AIGC】Stable Diffusion之模型微调工具

【AIGC】Stable Diffusion之模型微调工具

推荐一款好用的模型微调工具&#xff0c;cybertron furnace 是一个lora训练整合包&#xff0c;提供训练 lora 模型的工具集或环境。集成环境包括必要的依赖项和配置文件、预训练脚本&#xff0c;支持人物、二次元、画风、自定义lora的训练&#xff0c;以简化用户训练 lora 模型…
阅读更多...
React - 分页插件默认是英文怎么办

React - 分页插件默认是英文怎么办

英文组件的通用解决方案 这里以分页插件为例&#xff1a; 大家可以看到&#xff0c;最后的这个页面跳转提示文字为Go to&#xff0c;不是中文&#xff0c;而官网里面的案例则是&#xff1a; 解决方案&#xff1a; import { ConfigProvider } from antd; import zhCN from an…
阅读更多...
基于JAVA,SpringBoot和Vue二手房屋销售系统设计

基于JAVA,SpringBoot和Vue二手房屋销售系统设计

摘要&#xff1a; 本研究旨在设计并实现一个基于JAVA, SpringBoot和Vue技术的二手房屋销售系统。该系统采用当前流行的前后端分离架构&#xff0c;后端使用SpringBoot框架快速搭建RESTful API&#xff0c;提供稳定且高效的服务端应用&#xff1b;前端则通过Vue.js框架构建动态…
阅读更多...
幻兽帕鲁在腾讯云服务器中怎么修改配置？游戏难度、经验倍率等等

幻兽帕鲁在腾讯云服务器中怎么修改配置？游戏难度、经验倍率等等

幻兽帕鲁的游戏配置文件应该是PalWorldSettings 找到这个文件&#xff0c;就可以修改里面的参数。 如果你是用腾讯云一键部署的幻兽帕鲁&#xff0c;则可以到轻量应用服务器管理界面&#xff0c;找到“应用管理”&#xff0c;里面有个可视化修改游戏参数的面板设置&#xff0…
阅读更多...
计网物理层

计网物理层

通信基础 基本概念 物理层解决如何在连接各种计算机的传输媒体上传输数据比特流&#xff0c;而不是指具体的传输媒体。 其主要任务是确定与传输媒体接口有关的一些特性&#xff0c;即定义标准。 机械特性&#xff1a;定义物理连接的特性&#xff0c;规定物理连接时所采用的…
阅读更多...
UI文件原理

UI文件原理

使用UI文件创建界面很轻松很便捷&#xff0c;他的原理就是每次我们保存UI文件的时候&#xff0c;QtCreator就自动帮我们将UI文件翻译成C的图形界面创建代码。可以通过以下步骤查看代码 到工程编译目录&#xff0c;一般就是工程同级目录下会生成另一个编译目录&#xff0c;会找到…
阅读更多...
Cohere For AI 推出了 Aya，这是一款覆盖超过 100 种语言的大型语言模型（LLM）

Cohere For AI 推出了 Aya，这是一款覆盖超过 100 种语言的大型语言模型（LLM）

每周跟踪AI热点新闻动向和震撼发展 想要探索生成式人工智能的前沿进展吗&#xff1f;订阅我们的简报&#xff0c;深入解析最新的技术突破、实际应用案例和未来的趋势。与全球数同行一同&#xff0c;从行业内部的深度分析和实用指南中受益。不要错过这个机会&#xff0c;成为AI领…
阅读更多...
安卓自定义画板

安卓自定义画板

包含功能&#xff1a; 包含 获取当前画板的截图、设置画笔样式、获取画笔样式、设置画笔宽度、获取画笔宽度、设置画笔颜色、获取画笔颜色、加载图片、获取图片位图对象、设置图片位图对象&#xff0c;并在画布上绘制图片、撤销上一步操作、重做上一步撤销的操作、清空所有绘图…
阅读更多...
最新文章

Copyright @ 2022~2023

友情链接： 我的编程经验分享 一条长河网 尧图网站开发 尧图建网站