避免用动态语言的思维写 Go 代码

た入场券 2022-09-12 02:51 6阅读 0赞

由于招聘市场上`Go`工程师的供给量不足，所以在招人的时候我们招了不少愿意转型用`Go`语言进行开发的`PHP`工程师，不过虽说换了个语言，在他们代码的时候还是能发现很多`PHP`的影子。`if`语句后面非要带括号这种问题就不说了，这属于不懂事，`gofmt`就会强行把你掰过来。最大的问题还是因为以前用惯了`PHP`的数组，到写`Go`代码时还是不习惯先定义类型后使用这种习惯。还有就是以前写`PHP`的时候可能没养成使用异常的习惯，在返回值里约定特殊值来代表错误。所以后面我在团队内部做过一次培训，专门分享了怎么建立正确的Go编码习惯，以下是节选了当时演讲稿的一部分。其实不是专门针对`PHP`程序员，可能写动态语言的程序员在开始用`Go`写代码时都容易犯的一些错误。

## Go编程的注意事项及建议 ##

接下来我们会说几个`PHP`程序员在刚开始用`Go`写程序时几个需要改变的编码习惯和要注意的地方。

### 尽量使用结构体切片代替字典 ###

我们有的新同学特别爱使用`Go`里面的`Map`，有的时候还是切片里边套`Map`，比如我看一开始有的同学把一些配置信息放在`map[string]string`类型的`Map`里，多个的话再把`Map`放进切片里，比如这样。

var configMap = []map[string]string{
     {
      "stockNum": "100",
      "name":     "芒果TV周卡",
      "type":     "virtual",
        },
    }

后面程序使用的时候再去用键去取值，这么做程序当然能实现，但你会发现`Go`里面因为是强类型，你在用上面字典里面的数值时还得对他们做类型转换。很多同学马上会说，那我把`Map`的类型换成`map[string]interface{}`，我只能说你试试，看你用的时候`Go`让不让你做类型断言。

这其实是涉及一个思维的转变，那么在像`Go`这样的强类型语言里针对这种情况该怎么办呢？这就需要让我们养成先定义结构体类型后使用的习惯了，比如像上面的情况我就可以先定义一个类型。

type Product struct {
     StockNum  int64
     Name      string
     Type      string
    }
    
    var configs = []*Product {
     {
      StockNum: 100,
      Name: "芒果TV周卡",
      Type: "virtual",
     },
      ......
    }

**这么做就能避免像上面那样使用`StockNum`前还得把它转成整型的问题了，而且编辑器还能做类型提示，不需要你刻意记得Map里的键，还能避免你一时疏忽把键拼错导致BUG的尴尬。**

除了上面说的还有人喜欢在返回值里返回`Map`，这种写法除了会导致上面说的那样问题，让别人使用起来也特别不方便。比如我要用你的方法我还得进去看看你的代码里这个`Map`到底有哪些键。

所以我们写`Go`代码时，其实`Map`的使用率要比在`PHP`里使用数组低很多，很多时候都是用结构体以及结构体切片的，对于那种key为数据ID，值为数据`Map`的这种映射，也是改成`Key`为数据`ID`，值为数据自己定义的类型才对。比如下面这个`Map`类型的变量，它的`Key`是产品的ID，值的类型是我们上面定义的`Product`结构体

var productMap = map[int64]*Product {
     123:  {
      StockNum: 100,
      Name: "芒果TV周卡",
      Type: "virtual",
     },
    }

针对这部分说的这个问题我觉得记住：\*\*"根据数据先定类型再使用"\*\*这个原则就行了。

说完这个在代码里出现率最高的问题后，下面我们再说几个写`Go`代码时的要注意的细节。

### 零值陷阱 ###

未进行初始化的变量默认值为其类型的零值，需要注意的是`slice`，`map`，`chan`和`*T`类型对应的零值是`nil`。

这些类型的变量在未初始化前是无法在程序里直接使用的，有些情况下会导致运行时错误。

常见的两种运行时错误是：

*  panic: assignment to entry in nil map
 *  panic: invalid memory address or nil pointer dereference

第一个错误是因为对一个未初始化的`map`进行赋值导致的，所以使用`map`类型的变量前要记得用`make`函数对变量进行初始化，与`map`类似的切片在使用`append`函数 向`nil slice`追加新元素就可以，原因是`append`函数会生成新的切片，在底层为切片分配了底层数组。

第二个错误是对`nil`指针进行了解引用导致的，指针的零值`nil`与`*T{}`并不相等。所以指针类型的变量在使用前要注意使用`new`函数进行初始化。

还有就是前端同学们非常不喜欢接口返回值的字段有数据的时候是个列表，没数据的时候是`Null`，这也是切片未初始化导致的，如果数据库里没查到数据，那么在代码逻辑里就执行不到给切片`append`数据的循环里，所以就会出现这个问题。这是一个保持接口字段类型一致性的一个很重要的细节。

### 使用error返回函数错误 ###

在使用`PHP`时，函数的错误是通过抛出异常，甚至是通过返回`0`，`false`之类的值来表示函数遇到的错误（这种，即使写`PHP`也不推荐这种做法）

比如好的写法，可这样写：

public function updateUserFavorites(User $user, $favoriteData)
    {
        try {
            // database execution
        ......
        } catch (QueryException $queryException) {
            throw new UserManageException(func_get_args(), 'Error Message', '501' , $queryException);
        }
    
        return true;
    }

但很多的人会这么写：

public function updateUserFavorites(User $user, $favoriteData)
    {
        // database execution
      if ($conn.AffectedRows <= 0) {
            return false
        }
    
        return true;
    }

在`Go`语言里虽然没有异常机制，但是可以让函数返回`error`明确遇到的错误。所以除非确定函数不需要返回`error`，多数情况下我们的函数都是需要返回`error`的，所以在定义函数时要明确，返回的数据和`error`的区别，两种返回值的职责范围不一样。要通过函数返回的`error`是否为空，而不是返回数据是`0`或者`false`之类的值判断函数是否执行成功。

### 谨慎使用`map[string]interface{}`做参数 ###

写过`PHP`的同学都知道，`PHP`里的数组近乎万能，可以用来当列表、字典，而且当字典用时还能保证字典`key`的遍历顺序，这点是很多语言的字典类型办不到的事情。

很多刚从`PHP`转到用`Go`开发的同学还是带着在`PHP`里使用数组参数的习惯，那么在`Go`语言里，最像`PHP`数组的可能就是`map[string]interface{}`了。

这种还是典型的动态语言编程的思维，在使用`Go`的时候，针对比较复杂的代表一类事物的参数，我们也是应该先定义结构体，然后使用结构体指针或者结构体指针切片作为参数。尽量不使用`map[string]interface{}`这种类型的参数，`IDE`也没法帮助提示这些参数的内部结构，这让其他人使用这个代码时就会很苦恼，还得先看看函数实现里具体用到了字典的哪些键。比如下面这两个函数的对比：

type UserInput struct{
      Name     string
      Age      int32
      Password string
    }
    func AuthenticateUser(input *UserInput) error {
        findUser(input.Name, input.Password)
        ...
    }
    
    func DummyAuthenticateUser(input map[string]interface{}) error {
        findUser(input["name"], input["password"])
        ...
    }

一般在业务级别的程序开发里，我们要传递存储在数据表里的额外信息的时候才会使用到`map[string]interface{}`类型的参数。写表前把这部分数据编码成`JSON`格式再写入，当然这个主要看使用场景，凡事没有绝对，这里只是强调一些在编码习惯上的问题。

## 总结 ##

最近两年在学习中我写了不少Go语言的文章，其中Web编程入门和Go并发编程这两个系列我自认为还是对新手很有帮助的。

### Go Web编程入门 ###

[深入学习用 Go 编写 HTTP 服务器][Go _ HTTP]

[使用 gorilla/mux 增强 Go HTTP 服务器的路由能力][gorilla_mux _ Go HTTP]

[十分钟学会用Go编写Web中间件][Go_Web]

[Go Web编程--应用数据库][Go Web_--]

[Go Web 编程--应用ORM][Go Web _--_ORM]

[Go Web编程--深入学习解析HTTP请求][Go Web_--_HTTP]

[Go Web 编程--超详细的模板库应用指南][Go Web _--]

### Go语言并发编程 ###

[学会使用context取消goroutine执行的方法][context_goroutine]

[Go语言sync包的应用详解][Go_sync]

[详解Go语言的计时器][Go]

[并发编程的数据竞争问题以及解决之道][Link 1]

[并发问题的解决思路以及Go语言调度器工作原理][Go 1]

[Go语言的原子操作和互斥锁的区别][Go 2]

除了`Go`语言相关的还有一些`Docker`和`Kubernetes`相关的文章，这些文章都是跟我的工作中的学习过程相关的，在普及基础的时候也会带一些实践。感兴趣的自己去个人主页和我公众号里看吧，主要是黏贴这些链接太费事了.......

\- END -

关注公众号，获取更多精选技术原创文章

[Go _ HTTP]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484112&idx=1&sn=79d0d3167d0d962fe41ec00cdafffbb0&chksm=fa80d347cdf75a51183182f14622af766538ca0c5335012e5e1cc50b100e78f2954fa3943770&scene=21#wechat_redirect
[gorilla_mux _ Go HTTP]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484127&idx=1&sn=f5286405728b2d4f657e16cfdb6f07cc&chksm=fa80d348cdf75a5e1f95fdfb3a0d703cee59d6560e5b377f3a0bfe6770ca7bf236eadb0a7e44&scene=21#wechat_redirect
[Go_Web]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484180&idx=1&sn=b66497c5428c25577068f18132b2d59d&chksm=fa80d283cdf75b95cc49d08c56d0fa9b00c47d0457c894be3ca3ea02bd3c404cfb5312fa1d93&scene=21#wechat_redirect
[Go Web_--]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484200&idx=1&sn=a6d41c6aa4b3e22eac313966fb7eac57&chksm=fa80d2bfcdf75ba9faadd03100fc22688afb77cdbaa3f18d915dd8832121a0ac69d40bffe6e4&scene=21#wechat_redirect
[Go Web _--_ORM]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484212&idx=1&sn=fc64a905c8f32acab908cc7d3d848680&chksm=fa80d2a3cdf75bb5f47244145b965e9be3ee002270154f53a1c16802a375001cd7822490986d&scene=21#wechat_redirect
[Go Web_--_HTTP]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484246&idx=1&sn=6de3644dcb1877a3e205745aaf9fed71&chksm=fa80d2c1cdf75bd78fbedbfc28931b213986bc861c757c8d0a1ad3efa088726a7e176bde2f61&scene=21#wechat_redirect
[Go Web _--]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484271&idx=1&sn=6dfef42f172b6a177fd372e619796991&chksm=fa80d2f8cdf75bee931b7516f41e0aa4ba48b38d41ecce1fec055c255aaa51a5a828f7450f4e&scene=21#wechat_redirect
[context_goroutine]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484375&idx=1&sn=a05843cb73c64103eec21e68fc5ca956&chksm=fa80d240cdf75b5689e1ad2ea279ff02a97b585a83869e237cb4e436a858d48ab50bf48cde84&token=1710328921&lang=zh_CN&scene=21#wechat_redirect
[Go_sync]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484390&idx=1&sn=82c35d4e64df533a039b823efcbbb7c6&chksm=fa80d271cdf75b67091218b5c70a5da2836822a3784c4739118b87e4890242cf8dfb37f64227&scene=21#wechat_redirect
[Go]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484420&idx=1&sn=03b7d91df22567d958b33b2e6d4a9b73&chksm=fa80d593cdf75c85a734cde660cedb21f5a22b39deaf84dd1cd1f0ec0a7b7a91e3f289b173a1&scene=21#wechat_redirect
[Link 1]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484521&idx=1&sn=85bf9b325170c6f8daba67664b0d41ba&chksm=fa80d5fecdf75ce8d1ee435e54eecfa789a68cc6ce7c140ce4b26f0f5037a64b7500cea5ad45&scene=21#wechat_redirect
[Go 1]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484559&idx=1&sn=d639ce831d514c0f73f195f207c0583d&chksm=fa80d518cdf75c0e224697bd9f6f97ad94082f09591d2b9141974baf8a1054e9de0d895fb603&scene=21#wechat_redirect
[Go 2]: https://mp.weixin.qq.com/s?__biz=MzUzNTY5MzU2MA==&mid=2247484580&idx=1&sn=3eebc40219870a9e95d1f818bb22e2b5&chksm=fa80d533cdf75c25e01dfd1d8dc287f826ba24cbc8918a7af8c9233d1d632a0cf45886584e9d&scene=21#wechat_redirect