如何写出好的Go项目

西直门三太子

已于 2023-04-26 14:27:57 修改

阅读量558

点赞数

分类专栏：规范 # go从入门到精通文章标签： golang 规范

于 2023-04-25 23:12:24 首次发布

本文链接：https://blog.csdn.net/qq_29744347/article/details/130376244

版权

go从入门到精通同时被 2 个专栏收录

55 篇文章 1 订阅

订阅专栏

规范

8 篇文章 0 订阅

订阅专栏

文章讨论了Go应用的代码结构，推荐按功能拆分模块以降低循环引用风险。强调编码规范的重要性，通过CI确保代码质量。提到使用接口和设计模式以实现更好的解耦和测试，并介绍了SOLID原则。此外，文章还涵盖了项目管理工具，如Makefile，自动化代码生成，以及CI/CD流程。最后，强调了详细项目文档的价值。

摘要由CSDN通过智能技术生成

前言

老生常谈，还是从三个方面讲

Go应用
项目管理
项目文档

Go应用

代码结构

目录结构

Go 项目目录结构设计

模块拆分

按层拆分，如经典的MVC三层结构，缺点是容易循环引用

按功能拆分，功能单一，出现循环引用的概率小。按功能拆分，后期拆微服务更方便些。

代码规范

编码规范

Uber Go 规范
开发者很难靠自觉遵循规范，所以，我们在CI上触发代码规范检查，符合规范的才能通过合并到主分支上去，不合格就打回去，你不改的符合规范，就让你提交不上去，我看谁还偷懒

最佳实践

用Go最早的一批人总结的符合Go语言特色的经验和共识
https://go.dev/doc/effective_go
https://github.com/golang/go/wiki/CodeReviewComments
https://rakyll.org/style-packages/

代码质量

代码质量主要元测试去保证，要达到一定指标的覆盖率。有些经常改动的模块，甚至要求覆盖率达到100%(根据业务去决定), 可以借助gotests 工具生成测试代码，来减轻工作量

由于项目中一般都会依赖三方组件，需要去模拟三方组件，所以测试函数的依赖项越少越好测试

模拟三方组件，不要直接使用实体类型(struct)，应该使用抽象接口

package test

import (
	"errors"
	"time"
)

/*
*
1.假设 AlySendMessage 是三方的短信发送服务，间歇性抽风，你的测试还用跑吗
*/
type AlySendMessage struct{}

func (aly AlySendMessage) Send() error {
	if time.Now().Unix()%2 == 0 {
		return errors.New("AlySendMessage 就是报错")
	}
	return nil
}

func Send(s AlySendMessage) error {
	return s.Send()
}

/**
1. Send 只接受 AlySendMessage struct，导致不可模拟
2. SendNew 接受的是抽象接口，非常容易模拟
*/

type SendMessage interface {
	Send() error
}

func SendNew(s SendMessage) error {
	return s.Send()
}

type MockAlySendMessage struct{}

func (m MockAlySendMessage) Send() error {
	return nil
}