讲师中心 微信公众号
AI工具推荐 视频效率加速

golang如何使用go-cleanarch检查架构_golang go-cleanarch检查架构使用详解

陌涛大大_6019

陌涛大大_6019

发布时间:2026-04-12 19:38:34

|

924人浏览过

|

来源于php中文网

原创

go-cleanarch是静态检查CLI工具,非Go包,不参与编译;安装后需确保$GOBIN在$PATH中,于项目根目录显式执行,严格校验标准层名与路径格式,支持命令行参数自定义映射但无配置文件。

golang如何使用go-cleanarch检查架构_golang go-cleanarch检查架构使用详解

go-cleanarch 不是用来“运行”或“集成”的库,它是个静态检查 CLI 工具——直接执行就能发现 import 路径越界、层间依赖倒置等硬伤。

go-cleanarch 安装后为什么 run 不起?

它不是 Go 包,不参与编译,也不 import 到你的代码里。安装后生成的是可执行文件,必须在项目根目录下显式调用:

  • 安装命令是 go install github.com/roblaszczak/go-cleanarch@latest,成功后会在 $GOBIN(通常是 $HOME/go/bin)生成 go-cleanarch 二进制
  • 确保 $GOBIN 在 $PATH 中,否则会提示 command not found
  • 不要在代码里写 import "github.com/roblaszczak/go-cleanarch" —— 这会导致 go mod tidy 错误引入,污染生产依赖
  • Windows 用户注意:官方明确说明未测试,常见报错如 fork/exec: operation not supported,建议改用 WSL2 或跳过该工具

检查失败但项目结构看起来没问题?重点看这三处

go-cleanarch 对目录命名和层级非常敏感,不是“大概像就行”,而是严格匹配预设规则:

  • 它默认只识别标准层名:domain、application、interfaces、infrastructure(以及别名如 usecases、adapters),如果你用了 internal/model 或 pkg/repo 这类非标准路径,它直接无视,不会报错,但也不会检查
  • 路径必须是 [MODULE_NAME]/[LAYER_NAME] 形式,比如 github.com/your/app/domain ✅,但 github.com/your/app/internal/domain ❌(多了一层 internal 就失效)
  • 如果项目用了 Go Module 的子模块(如 github.com/your/app/auth 和 github.com/your/app/content),每个子模块都得有独立的 domain 等层,不能只在根模块放一层

如何让 go-cleanarch 适配你已有的 Clean 架构目录?

它支持自定义层名映射,但必须通过命令行参数显式传入,没有配置文件:

Alibabacloud Sdk Client Initialization For Golang
Alibabacloud Sdk Client Initialization For Golang

初始化并管理阿里云SDK Go 客户端,涵盖 sync.Once 单例、goroutine 安全、endpoint 与 region 配置、VPC 端点及调试。

下载

立即学习“go语言免费学习笔记(深入)”;

  • 例如你实际用的是 internal/core 代替 domain,就加参数:go-cleanarch -domain=internal/core
  • 多个层需全部指定:go-cleanarch -domain=internal/model -application=internal/service -interfaces=internal/api -infrastructure=internal/infrastructure
  • 参数名必须是它内置的 key(-domain、-application 等),不能写成 -layer-domain 或其他变体
  • 每次运行都要带全参数;它不缓存、不读 .cleanarch.yaml 类配置——这点容易被误以为“没生效”

检查结果为 0 代表架构干净?别太早放心

它只验证 import 方向是否符合同心圆规则(外层可 import 内层,反之不行),但不管具体实现质量:

  • 它不会发现 internal/service 里直接用了 sql.NullString —— 这属于 domain 层污染,得靠人工或 linter(如 revive 规则)
  • 它不会拦截 cmd/main.go 里调了 viper.ReadInConfig() —— 只要 import 没跨层,就认为合法
  • 它不检查 interface 是否真被实现、mock 是否覆盖、error 处理是否统一——这些仍是单元测试和 code review 的责任

真正难的从来不是路径合规,而是把数据库类型、HTTP 上下文、第三方 SDK 响应结构从 domain 和 service 里彻底刨干净。go-cleanarch 只帮你守住第一道门,门后的活还得自己干。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3149

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2308

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1240

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1198

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1356

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2138

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3440

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

15635

2023.09.22

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

0

2026.10.15

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn