一文带你进行Go语言工程实践

Posted C+G

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了一文带你进行Go语言工程实践相关的知识,希望对你有一定的参考价值。

文章目录

并发和Goroutine

并发和并行的区别

并发可能更多的是精确到语言的逻辑,也就是直接的多线程,或者多进程。

而并行则是一种表述程序运行的方式,就如同异步和同步的描述。

并发程序不一定是并行的,这个看操作系统的调度。

线程与协程的区别

线程:是比进程更小粒度的运行单位,存在于内核态,需要操作系统来调度,内存消耗是MB级别。

协程:是比线程更小的粒度,通过m:n的比例在一个线程中再细分出来的单位,存在于用户态,用户可以自由调度,内存消耗是KB级别。

协程对比线程的优势:

  1. 存在于用户态,可操作性强,调度可由自己控制。
  2. 更轻量,所需资源更少。

Goroutine

go语言的go关键字跑的就是协程,我们称为goroutine。

关于协程背后更多的故事,可以看这个视频 go协程实现原理 ,我们这里只讲简单使用。

用法

简单用法如下:

package main

import (
	"fmt"
	"sync"
)

func hello(i int) 
	println("hello world : " + fmt.Sprint(i))


func main() 
    //go的风格来说一般都喜欢运行一个闭包
    go func(j int) 
        hello(j)
    (i)

并发的通信

并发程序之间的通信,一般都是通过共享内存的形式实现通信,临界区一般需要加锁保护。

而go语言采取的是通过通信来实现共享内存,这个过程是反过来的,但用起来更为直观。

Channel

通过内置函数 make 可以得到两种类型的 channel 。

注意:channel是类似于引用的一个类型,如果直接通过var声明定义是没法初始化得到内部内存的,故记得通过make创建channel。还有就是记得不用的时候关闭。

channel的使用

channel的简单使用如下:

func main() 
	var src chan int
	src = make(chan int)//不带缓冲
	dest := make(chan int, 3)//带缓冲
	go func() 
		defer close(src)
		for i := 0; i < 10; i++ 
			src <- i//生产
		
	()
	go func() 
		defer close(dest)
		for i := range src //消费者1
			dest <- i * i
		
	()
	for i := range dest //消费者2
		println(i)
	

使用带缓冲channel的好处

在一个生产者消费者模型中,生产者的生产效率远高于消费者,那么可以使用带缓冲的channel,防止生产者因为等待消费者消费过程而产生阻塞。反之对消费者来说也是受用的。

并发安全

互斥锁

go语言并没有对加锁机制的弃用,标准库里面仍然有sync.Mutex。

以下为简单加锁实现并发安全:

package main

import (
	"fmt"
	"sync"
	"time"
)
var(
	x int
	mut sync.Mutex
)
func AddWithLock() 
	mut.Lock()
	for i:=0;i<2000;i++ 
		x++
	
	mut.Unlock()


func AddWithoutLock()  
	for i:=0;i<2000;i++ 
		x++
	


func main() 
	//开五个协程的锁版本,再打印最终结果
	for i := 0; i < 5; i++ 
		go AddWithoutLock()
	
	//等待上面的协程执行结束
	time.Sleep(time.Second)
	fmt.Println(x)

	//有锁版本
	x = 0
	for i:=0;i<5;i++
		go AddWithLock()
	
	time.Sleep(time.Second)
	fmt.Println(x)


计数器

WaitGroup,通过Add(a)计时器+a,通过Done()计数器-1,通过Wait()阻塞直到计数器为0。这个东西我觉得有些类似于操作系统的信号量。

以下为实例:

package main

import (
	"fmt"
	"sync"
)

func hello()
	fmt.Println("hello")

func main() 
	var wg sync.WaitGroup
	wg.Add(5)
	for i := 0; i < 5; i++ 
		go func() 
			defer wg.Done()
			hello()
		()
	
	wg.Wait()



依赖管理

Go依赖管理的演进:

GOPATH Go Vendor Go Module

GOPATH

go语言有一个内置的全局环境变量GOPATH,指定了GOPATH文件夹后,他会在这个文件夹内创建以下三个文件夹:

|——bin:项目编译的二进制文件

|——pkg:项目编译的中间产物,加速编译

|——src:项目源码

项目直接依赖src下的代码,go get命令下载的软件包都会在src目录下。

GOPATH弊端

当我们对某个依赖进行升级后,则项目A依赖的版本可能无法实现兼容,这就是GOPATH无法解决的多版本控制问题

Go Vendor

为了解决多版本控制问题,go又增加了Go Vendor的方式来管理依赖。

使用govendor init 在项目根目录会生成vendor文件夹,其中存放了当前项目依赖的副本。在Vendor机制下,如果当前项目存在Vendor目录,会优先使用该目录下的依赖,如果依赖不存在,会从GOPATH中寻找;这样解决了更新GOPATH依赖源码后之前的版本不兼容的问题。

Go Vendor弊端

弊端很明显,无法解决依赖的依赖。

同样还是无法解决依赖的冲突。

归根到底vendor不能很清晰的标识依赖的版本概念。

Go Module (最终解决方案

特点:

  • 通过 go.mod 管理依赖包版本。
  • 通过 go get/mod 工具管理依赖包。

最终目标:定义版本规则和管理项目的依赖关系。

依赖管理三要素

  1. 配置文件,描述依赖 (对应go.mod)
  2. 中心仓库管理依赖库 (GoProxy)
  3. 本地工具 go get/mod
配置文件

每个依赖单元用模块路径+版本来唯一标示。

版本规则

gopath和govendor都是源码副本方式依赖,没有版本规则概念,而gomod为了放方便管理则定义了版本规则。

对于语义化版本有如下规则:

  • MAJOR:表示是不兼容的 API,所以即使是同一个库,MAJOR 版本不同也会被认为是不同的模块。
  • MINOR:通常是新增函数或功能,向后(向下)兼容。
  • PATCH:修复 bug。
杂项

版本号后面添加 //indirect 表示间接依赖。

选择题

选择1.4,因为它向后兼容。

中心仓库管理依赖库

依赖的分发

如果直接向代码托管平台进行依赖的请求,很快会发现有以下这些问题:

  • 无法保证构建的稳定性(可能代码仓库的所有者更改删除了包版本
  • 无法保证可用性
  • 增加了平台压力

为了很好的解决以上依赖分发的问题,go采用Proxy进行代理分发。

Go Proxy 是一个服务站点,它会缓源站中的软件内容,缓存的软件版本不会改变,并且在源站软件删除之后依然可用。

较为神奇的地方

Go语言通过设置环境变量GOPROXY来设置具体的服务站点。可以通过逗号设置多个Proxy站点,最后如果这几个都没有找到,那么会通过direct进行回源,也就是回到本来的请求站点,而不是代理站。有意思的是,当你此时从源站下载好依赖后,你之前走过的Proxy站点也会将这个缓存下来。

有趣的实践

通过go mod init创建一个项目,写好后提交到GitHub仓库里,然后通过go get对你的代码进行请求,注意最后回源的direct要加上,否则肯定get不到,最后你会发现你的Proxy站上,也有了你的代码🥳

你会发现这样的过程,让go语言的代码仓库非常的繁荣,各种库都可以go get得到!

本地工具

go get命令

go mod命令


测试

为什么要测试?

测试是避免事故发生的最后一道关口!

测试类型

  • 回归测试:是指修改了旧代码后,重新测试以确认修改没有引入新的错误或导致其他代码产生错误。
  • 集成测试:集成测试的目的是在集成这些不同的软件模块时揭示它们之间交互中的缺陷。
  • 单元测试:单元测试测试开发阶段,开发者对单独的函数、模块做功能验证。

层级从上至下,测试成本逐渐减低,而测试覆盖率确逐步上升,所以单元测试的覆盖率一定程度上决定这代码的质量。

单元测试

go单测的规则

go单测实例

写了一个json解析的单测

json.go

package attention

import (
	"bytes"
	"encoding/json"
	"fmt"
)

func NumUnmarshal() 
	jsonStr := `"id":1,"name":"Jerry"`
	var res map[string]interface
	_ = json.Unmarshal([]byte(jsonStr), &res)
	fmt.Printf("%T\\n", res["id"])
	i := res["id"].(int64)
	fmt.Println(i)


func NumDecode() 
	jsonStr := `"id":1,"name":"Jerry"`
	var res map[string]interface
	decoder := json.NewDecoder(bytes.NewReader([]byte(jsonStr)))
	decoder.UseNumber()
	_ = decoder.Decode(&res)
	i, _ := res["id"].(json.Number).Int64()
	fmt.Println(i)

json_test.go

package attention

import "testing"

func TestNumUnmarshal(t *testing.T) 
	NumUnmarshal()


func TestNumDecode(t *testing.T) 
	NumDecode()

测试结果:通过 go test 会执行这个软件包里面所有的测试。如果需要执行特定的测试在后面跟上这个测试的go文件名以及对应的测试文件名。

单元测试框架

go语言常见的测试框架有testfy。在go mod文件里面的require部分填上以下代码便可通过go mod download进行下载。

github.com/stretchr/testify v1.7.1

或者直接 go get这个包也行。

这个包里包含测试常用的断言。

基础用法如下,更多用法请去查看官方文档。

衡量单元测试的标准

代码覆盖率

需要在测试时展示代码覆盖率可以通过添加–cover命令行参数。

下面是我的一次带代码覆盖率的单元测试结果:

我们可以看到百分比的覆盖率,也就是本次测试经过的代码块占比。

被测试到的代码都变成了绿色。

打桩测试

在打桩测试前,我们先了解单侧的稳定性和幂等性。

  • 稳定:稳定是指相互隔离,能在任何时间,任何环境,运行测试。
  • 幂等:幂等是指每一次测试运行都应该产生与之前一样的结果。

如果在有外部依赖的情况下进行单测,换一个测试环境,那么这个外部依赖信息可能会发生变化,比如需要打开某个文件,如果你把这个给别人测试,那么在他本地的文件路径肯定就不一致。这就完全没法符合稳定和幂等两个条件。

如下代码:

那么我们如何解决这样的问题呢?

我们通过打桩来解决这个问题。

所谓打桩就是通过你指定的行为来对原本的行为替换,到计算机语言里面来讲就是通过你定义的桩函数把原本的函数进行替换,这就是打桩。

那打桩有什么用呢?

  • 隔离:将测试任务从产品项目中分离出来,使之能够独立编译、链接,并独立运行。

  • 补齐:用桩来代替未实现的代码,例如,函数A调用了函数B,而函数B由其他程序员编写,且未实现,那么,可以用桩来代替函数B,使函数A能够运行并测试。

  • 控制:控制是指在测试时,人为设定相关代码的行为,使之符合测试需求。

go语言的打桩实现原理:

在运行时通过通过 Go 的 unsafe 包,将内存中函数的地址替换为运行时函数的地址。 将待打桩函数或方法的实现跳转到。

打桩更改后的测试:

基准测试(Benchmark)

很多时候我们需要清楚代码的运行效率,这个时候,我们就需要对代码进行基准测试了。

基准测试需要遵循以下语法规定:

  1. go语言中的基准测试也是基于单元测试,所以还是需要遵循 *_test.go 的命名规则。
  2. 用于基准测试的函数名必须以Benchmark开头。
  3. 函数的入参需要是 *testing.B

具体例子

代码分析

负载均衡中随机选择执行服务器。

server_select.go

package benchmark

import (
	"github.com/bytedance/gopkg/lang/fastrand"
	"math/rand"
)

var ServerIndex [10]int

// InitServerIndex 初始化服务器的描述符
func InitServerIndex() 
	for i:=0;i<10;i++
		ServerIndex[i] = i+100
	


// RandSelect 随机选择一个服务器
func RandSelect() int  
	return ServerIndex[rand.Intn(10)]


// FastRandSelect 用外部的fast包
func FastRandSelect()int
	return ServerIndex[fastrand.Intn(10)]

server_select_test.go

package benchmark

import "testing"

func BenchmarkSelect(b *testing.B)
	InitServerIndex()
	b.ResetTimer()
	for i:=0;i<b.N;i++
		RandSelect()
	


func BenchmarkSelectParallel(b *testing.B) 
	InitServerIndex()
	b.ResetTimer()
	b.RunParallel(func(pb *testing.PB) 
		for pb.Next()
			FastRandSelect()
		
	)

我们对Benchmark的代码进行以下讲解:

  1. 对一个测试用例的默认测试时间是 1 秒,当测试用例函数返回时还不到 1 秒,那么 testing.B 中的 N 值将按 1、2、5、10、20、50……递增,并以递增后的值重新进行用例函数测试。
  2. Resttimer重置计时器,我们在reset之前做了init或其他的准备操作,这些操作不应该作为基准测试的范围。
  3. runparallel是多协程并发测试。
代码效率分析

我们发现,多线程的测试反而效率更慢了!

主要原因是rand为了保证全局的随机性和并发安全,持有了一把全局锁。

这里贴了字节实现的较为快速的随机数实现库:fastrand

安装这个库也很简单,下面一行命令即可:

go get github.com/bytedance/gopkg/lang/fastrand

优化代码

通过把 rand 替换为 fastrand 后,重新测试结果如下:

我们发现多线程的效率与之前的效率相比,提升了百倍!

fastrand主要的实现思路是牺牲了一定的数列一致性,在大多数场景是适用的,同学在后面遇到随机的场景可以尝试用一下。


项目实战

需求描述

  • 展示话题(标题,文字描述)和回帖列表
  • 暂不考虑前端页面实现,仅实现一个本地的web服务
  • 话题和回帖数据用文件存储

用户浏览

实例图

项目分层结构

  • 数据层:Repository 数据Model封装外部数据的增删改查,并将数据初步反序列化,且需要直接与底层的数据存储形式打交道,比如存储形式是文件,还是数据库,还是微服务等等。
  • 逻辑层:Service 业务Entity,这里会利用数据层得到封装好的数据再次封装得到更贴近客户端请求的数据,同样也需要写好增删改查,但这里的增删改查并不会与真正的外部数据打交道,也就是说Service层不关心底层数据的存储形式,只关心核心业务输出
  • 视图层:Controller 视图View,处理和外部的交互逻辑,也就是说,这个层级也是依赖于上一个层级的数据,它负责真正和客户端交互的过程,只关心返回什么样的数据给客户端,而前面两个层级都是为这个层级做的铺垫。

代码实现

代码实现可以到TraningCamp查看lesson2源码(温馨提示github域名后加上1s可以有意想不到的源码阅读体验哦

Repository层实现

主要实现底层存储数据序列化到具体的结构体上,以及对应的增删改查。

一般经过以下过程:

初始化 底层存储的交互
  • 初始化:主要是对数据的准备,或者时数据库的连接的初始化。
  • 底层存储的交互:如果数据库,那么就是对数据库发起请求得到对应的Model,如果是文件存储,那么数据应该已经初始化到内存,直接进行取值即可。
数据映射

由于本次的存储实现采取的是文件存储,故需要每次一次性把文件读取好并完成数据的反序列化。这里用到的map进行映射数据方便查询。

如果是数据库,这时应该通过一些orm框架直接进行数据的增删改查映射,但在此之前还是得连接数据库(初始化过程

具体源码实现(我多加了一个记录最后一个Id的,方便完成id的不重复生成

数据的增删改查

topic.go

实现对话题的增删改查,这里用到了一个结构体+方法的方式去实现,且用sync.Once实现单例,我觉得好处在于:

  1. 防止重名。
  2. 方便记忆,方便调用时进行对应的语法补全(比如想要对Topic进行操作,只需要想到TopicDao这个即可补全后续的操作

post.go

和前面的实现类似,这里我完成了homework,添加了AddPost方法以及对应的将数据插入到文件的方法,由于可能出现多个客户端同时发起post请求,这时我们需要对数据进行并发安全的保护,这里我使用的Mutex加锁的方式。

Service层实现

主要是对Repository层的Modle进行进一步的封装成更上层需要的Entity。

一般经过以下流程:

一文读懂Go函数调用

一文带你彻底明白如何实现动态添加子节点及修改子节点属性

scala语言基础:一文带你熟悉六大数据结构

一文搞定Go语言开发环境的搭建

从实践到原理,带你参透 gRPC

万字长文 | 从实践到原理,带你参透 gRPC