开源 Go 中的循环依赖检测工具 —— go-cyclic

go-cyclic 循环依赖解决工具

问题描述

      作为一个 Go 开发者，经常会在大型项目中遇到包的循环依赖问题。
      如果 Golang 出现循环依赖，那么会在编译时抛出异常。

什么时候会出现循环依赖？

      如果有两个包：package a 和 package b。当在包a依赖包b，包b依赖包a时，就会产生循环依赖。真实情况可能会更复杂一些。例如，如包a依赖包b，包b依赖包c，包c又依赖包a时，形成一个环。

import cycle not allowed

      而且如果项目很大的时候，一个包下面有很多 .go 文件，只提示包与包的循环引用（如上图），是很难定位到哪个 .go 文件和哪个 .go 文件直接进行了循环引用，难以排查。

go-cyclic 简单用法

      github地址：github.com/elza2/go-cyclic （欢迎各位大佬提 pr）

       go-cyclic 可以用来检查项目是否存在循环依赖，并且可以定位到具体的 .go 文件。帮助快速定位循环问题。

快速开始

go install github.com/elza2/go-cyclic@latest
# path 路径要设置为 go.mod 文件所在的路径.
go-cyclic gocyclic --dir .path

# success output.
Success. Not circular dependence.

# failed output.
Failed. 1 circular dependence chains were found.

┌---→    app.go
┆          ↓
┆       routes.go
┆          ↓
└---    handler.go

本作品采用《CC 协议》，转载必须注明作者和本文链接