登录
首页 >  Golang >  Go教程

在 Golang 中安全使用 Map:声明和初始化的差异

来源:dev.to

时间:2024-09-01 09:46:00 257浏览 收藏

珍惜时间,勤奋学习!今天给大家带来《在 Golang 中安全使用 Map:声明和初始化的差异》,正文内容主要涉及到等等,如果你正在学习Golang,或者是对Golang有疑问,欢迎大家关注我!后面我会持续更新相关内容的,希望都能帮到正在学习的大家!

在 Golang 中安全使用 Map:声明和初始化的差异

介绍

本周,我正在为 golang 开发一个 api 包装器包,它处理发送带有 url 编码值的 post 请求、设置 cookie 以及所有有趣的东西。但是,当我构建主体时,我使用 url.value 类型来构建主体,并使用它来添加和设置键值对。然而,我在某些部分遇到了有线零指针引用错误,我认为这是因为我手动设置的一些变量造成的。然而,通过仔细调试,我发现了一个常见的陷阱或不好的做法,即仅声明类型但初始化它,从而导致零引用错误。

在这篇文章中,我将介绍什么是映射、如何创建映射,特别是如何正确声明和初始化它们。在 golang 中的映射或任何类似数据类型的声明和初始化之间创建适当的区别。

golang 中的地图是什么?

golang中的map或hashmap是一种基本数据类型,允许我们存储键值对。在底层,它是一个类似标头映射的数据结构,用于保存存储桶,这些存储桶基本上是指向存储桶数组(连续内存)的指针。它具有存储实际键值对的哈希码,以及在当前键数量溢出时指向新存储桶的指针。这是一个非常智能的数据结构,提供几乎恒定的时间访问。

如何在 golang 中创建地图

要在 golang 中创建一个简单的映射,您可以使用字符串和整数的映射作为字母频率计数器的示例。地图会将字母存储为键,将它们的频率存储为值。

package main

import "fmt"

func main() {
    words := "hello how are you"
    letters := map[string]int{}

    for _, word := range words {
        wordcount[word]++
    }

    fmt.println("word counts:")
    for word, count := range wordcount {
        fmt.printf("%s: %d\n", word, count)
    }
}
$ go run main.go

word counts:
e: 2
 : 3
w: 1
r: 1
y: 1
u: 1
h: 2
l: 2
o: 3
a: 1

因此,通过将地图初始化为map[string]int{},您将得到一个空地图。然后,这可以用于填充键和值,我们迭代字符串,对于每个字符(符文),我们将该字符字节转换为字符串并递增值,int 的零值为 0,因此默认情况下如果密钥不存在,则其值为零,但这是一把双刃剑,我们永远不知道地图中存在值为 0 的密钥,或者密钥不存在但默认值为 0。为此,您需要检查该密钥是否存在于地图中。

更多详情,您可以查看我的 golang maps 帖子详细内容。

声明和初始化之间的区别

在编程语言中声明和初始化任何变量都是不同的,并且必须在底层类型的实现上做更多的事情。对于 int、string、float 等主要数据类型,有默认值/零值,因此这与变量的声明和初始化相同。然而,在映射和切片的情况下,声明只是确保变量可用于程序的范围,但是对于初始化来说,是将其设置为其默认值/零值或应分配的实际值。

因此,声明只是使变量在程序范围内可用。对于映射和切片,声明变量而不初始化会将其设置为 nil,这意味着它指向没有分配的内存,并且不能直接使用。

而初始化会分配内存并将变量设置为可用状态。对于映射和切片,您需要使用 mymap = make(map[keytype]valuetype) 或 slice = []type{} 等语法显式初始化它们。如果没有此初始化,尝试使用映射或切片将导致运行时错误,例如访问或修改 nil 映射或切片时出现恐慌。

让我们看看声明/初始化/未初始化时映射的值。

假设您正在构建一个从地图读取设置的配置管理器。地图将在全局声明,但仅在加载配置时初始化。

  1. 已声明但未初始化

下面的代码演示了未初始化的地图访问。

package main

import (
    "fmt"
    "log"
)

// global map to store configuration settings
var configsettings map[string]string // declared but not initialized

func main() {
    // attempt to get a configuration setting before initializing the map
    serverport := getconfigsetting("server_port")
    fmt.printf("server port: %s\n", serverport)
}

func getconfigsetting(key string) string {
    if configsettings == nil {
        log.fatal("configuration settings map is not initialized")
    }
    value, exists := configsettings[key]
    if !exists {
        return "setting not found"
    }
    return value
}
$ go run main.go
server port: setting not found
  1. 同时声明和初始化

下面的代码演示了同时初始化的地图访问。

package main

import (
    "fmt"
    "log"
)

// global map to store configuration settings
var configsettings = map[string]string{
    "server_port":  "8080",
    "database_url": "localhost:5432",
}

func main() {
    serverport := getconfigsetting("server_port")
    fmt.printf("server port: %s\n", serverport)
}

func getconfigsetting(key string) string {
    value, exists := configsettings[key]
    if !exists {
        return "setting not found"
    }
    return value
}
$ go run main.go
server port: 8080
  1. 声明并稍后初始化

下面的代码演示了稍后初始化的地图访问。

package main

import (
    "fmt"
    "log"
)

// global map to store configuration settings
var configsettings map[string]string // declared but not initialized

func main() {
    // initialize configuration settings
    initializeconfigsettings()
    // if the function is not called, the map will be nil

    // get a configuration setting safely
    serverport := getconfigsetting("server_port")
    fmt.printf("server port: %s\n", serverport)
}

func initializeconfigsettings() {
    if configsettings == nil {
        configsettings = make(map[string]string) // properly initialize the map
        configsettings["server_port"] = "8080"
        configsettings["database_url"] = "localhost:5432"
        fmt.println("configuration settings initialized")
    }
}

func getconfigsetting(key string) string {
    if configsettings == nil {
        log.fatal("configuration settings map is not initialized")
    }
    value, exists := configsettings[key]
    if !exists {
        return "setting not found"
    }
    return value
}
$ go run main.go
configuration settings initialized
server port: 8080

在上面的代码中,我们声明了全局地图configsettings,但当时并没有初始化它,直到我们想要访问地图。我们在main函数中初始化map,这个main函数可以是代码的其他特定部分,而全局变量configsettings是代码其他部分的map,通过在所需的范围内初始化它,我们可以防止它导致nil指针访问错误。我们仅在映射为零时才初始化映射,即它尚未在代码中的其他地方初始化。这可以防止覆盖映射/从范围的其他部分清除配置集。

访问未初始化地图的陷阱

但是由于它处理的是指针,所以它也有自己的陷阱,比如在映射未初始化时访问 nil 指针。

让我们看一个例子,一个可能发生这种情况的真实案例。

package main

import (
    "fmt"
    "net/url"
)

func main() {
        var vals url.values
        vals.add("foo", "bar")
        fmt.println(vals)
}

这将导致运行时恐慌。

$ go run main.go
panic: assignment to entry in nil map

goroutine 1 [running]:
net/url.values.add(...)
        /usr/local/go/src/net/url/url.go:902
main.main()
        /home/meet/code/playground/go/main.go:10 +0x2d
exit status 2

这是因为 url.values 是字符串的映射和字符串值的列表。由于底层类型是 values 的映射,并且在示例中,我们仅使用 url.values 类型声明了变量 vals,因此它将指向 nil 引用,因此会出现将值添加到类型的消息。因此,在声明或初始化映射数据类型时使用 make 是一个很好的做法。如果您不确定底层类型是映射,那么您可以使用 type{} 来初始化该类型的空值。

package main

import (
    "fmt"
    "net/url"
)

func main() {
        vals := make(url.values)
        // or
        // vals := url.values{}
        vals.add("foo", "bar")
        fmt.println(vals)
}
$ go run urlvals.go
map[foo:[bar]]
foo=bar

golang团队还建议在初始化地图时使用make函数。因此,要么对映射、切片和通道使用 make,要么使用 type{} 初始化空值变量。它们的工作原理相似,但后者也更普遍适用于结构。

结论

理解 golang 中声明和初始化映射之间的区别对于任何开发人员来说都是至关重要的,不仅在 golang 中,而且在一般情况下也是如此。正如我们所探索的,简单地声明映射变量而不初始化它可能会导致运行时错误,例如尝试访问或修改 nil 映射时出现恐慌。初始化映射可确保它在内存中正确分配并可供使用,从而避免这些陷阱。

通过遵循最佳实践(例如使用 make 函数或使用 type{} 进行初始化),您可以防止与未初始化映射相关的常见问题。始终确保映射和切片在使用前已显式初始化,以防止意外的 nil 指针取消引用

感谢您阅读这篇文章,如果您有任何问题、反馈和建议,请随时在评论中提出。

快乐编码:)

好了,本文到此结束,带大家了解了《在 Golang 中安全使用 Map:声明和初始化的差异》,希望本文对你有所帮助!关注golang学习网公众号,给大家分享更多Golang知识!

声明:本文转载于:dev.to 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>