Golang报“import cycle not allowed”错误的2种解决方法

前言

相信不少 gopher 在写 golang 程序都遇到过 import cycle not allowed 问题，本人最近研读 go-ethereum 源码时，发现定义 interface 也能解决此问题， 还能解决连分包都不能解决的情况， 并且比分包更加简单快捷。下面逐个讲解 分包 和 定义接口 这两种方法。

1. 应用场景

假设有如下使用场景：

a 是应用程序的框架级结构体，在 a 包含子模块 b 和 c 的指针；

b 为了方便的使用应用的其他子模块（比如 c ）功能，所以在其结构体包含了 a 的指针；

c 要调用 a 包中的某个方法；

2. 代码实现

其程序大致如下：

package a 代码如下：

package a

import (
 "fmt"

 "github.com/ggq89/mutualdep/b"
 "github.com/ggq89/mutualdep/c"
)

type a struct {
 pb *b.b
 pc *c.c
}

func new(ic int) *a {
 a := &a{
 pc: c.new(ic),
 }

 a.pb = b.new(a)

 return a
}

func printf(v int) {
 fmt.printf("%v", v)
}

package b 代码如下：

package b

import (
 "github.com/ggq89/mutualdep/a"
)

type b struct {
 pa *a.a
}

func new(a *a.a) *b {
 return &b{
 pa: a,
 }
}

func (b *b) displayc() {
 b.pa.pc.show()
}

package c 代码如下：

package c

import "github.com/ggq89/mutualdep/a"

type c struct {
 vc int
}

func new(i int) *c {
 return &c{
 vc: i,
 }
}

func (c *c) show() {
 a.printf(c.vc)
}

package a 依赖 package b 和 package c，同时 package b 依赖 package a 、 package c 也依赖 package a 。

main 函数代码如下：

package main

import "github.com/ggq89/mutualdep/a"

func main() {
 a := a.new(3)
 a.pb.displayc()
}

编译时就会报错如下：

import cycle not allowed
package main
    imports github.com/ggq89/mutualdep/a
    imports github.com/ggq89/mutualdep/b
    imports github.com/ggq89/mutualdep/a

3. 定义接口

现在的问题是：

a depends on b
b depends on a

对于 a struct 和 b struct 有彼此的指针这种相互依赖问题，可以使用定义接口的方法解决，具体步骤如下：

在 package b 中 定义 a interface ； 将 b 所有使用到结构体 a 的变量和方法的地方全部转化成 使用接口 a 的方法；在 a interface 中补充缺少的方法；

经过上面的步骤处理后， package b 代码如下：

package b

import (
 "github.com/ggq89/mutualdep/c"
)

type b struct {
 pa a
}

type a interface {
 getc() *c.c
}

func new(a a) *b {
 return &b{
 pa:a,
 }
}

func (b *b) displayc() {
 b.pa.getc().show()
}

在 package a 中补充可能缺少的方法；

处理后， package a 中的代码如下：

package a

import (
 "fmt"

 "github.com/ggq89/mutualdep/b"
 "github.com/ggq89/mutualdep/c"
)

type a struct {
 pb *b.b
 pc *c.c
}

func new(ic int) *a {
 a := &a{
 pc:c.new(ic),
 }

 a.pb = b.new(a)

 return a
}

func (a *a)getc() *c.c {
 return a.pc
}

func printf(v int) {
 fmt.printf("%v", v)
}

4. 拆分包

再次编译，提示如下：

import cycle not allowed
package main
    imports github.com/ggq89/mutualdep/a
    imports github.com/ggq89/mutualdep/b
    imports github.com/ggq89/mutualdep/c
    imports github.com/ggq89/mutualdep/a

现在是另一个相互依赖问题：

a depends on c
c depends on a

与前面的相互依赖不同，前面的依赖是由于 a struct 和 b struct 有彼此的指针导致的，属于硬相互依赖；

而这里是由于 package c 中的方法调用 package a 中的方法引起的，属于软相互依赖；

• 这种相互依赖可以通过将方法拆分到另一个包的方式来解决；在拆分包的过程中，可能会将结构体的方法转化为普通的函数；

引入 package f ， 将方法迁移到 f 中 :

package f

import "fmt"

func printf(v int) {
 fmt.printf("%v", v)
}

方法移动到 package f 后， package a 的代码如下：

package a

import (
 "github.com/ggq89/mutualdep/b"
 "github.com/ggq89/mutualdep/c"
)

type a struct {
 pb *b.b
 pc *c.c
}

func new(ic int) *a {
 a := &a{
 pc: c.new(ic),
 }

 a.pb = b.new(a)

 return a
}

func (a *a) getc() *c.c {
 return a.pc
}

package c随之改成调用package f，其代码如下：

package c

import (
 "github.com/ggq89/mutualdep/a/f"
)

type c struct {
 vc int
}

func new(i int) *c {
 return &c{
 vc: i,
 }
}

func (c *c) show() {
 f.printf(c.vc)
}

现在依赖关系如下：

a depends on b and c
b depends on c
c depends on f

至此，两种包相互依赖关系都得以解决。

5. 总结

对于软相互依赖，利用分包的方法就能解决，有些函数导致的相互依赖只能通过分包解决；分包能细化包的功能；

对于硬相互依赖只能通过定义接口的方法解决；定义接口能提高包的独立性，同时也提高了追踪代码调用关系的难度；

参考文章：

• golang不允许循环import问题(“import cycle not allowed”) :
• golang解决import cycle not allowed的一种思路 :

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对的支持。