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”) : https://www.jb51.net/article/145536.htm
  • golang解决import cycle not allowed的一种思路 : https://www.jb51.net/article/145539.htm

总结

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

(0)

相关推荐

  • Golang巧用defer进行错误处理的方法

    本文主要跟大家介绍了Golang巧用defer进行错误处理的相关内容,分享出来供大家参考学习,下面来看看详细的介绍: 问题引入 毫无疑问,错误处理是程序的重要组成部分,有效且优雅的处理错误是大多数程序员的追求.很多程序员都有C/C++的编程背景,Golang的程序员也不例外,他们处理错误有意无意的带着C/C++的烙印. 我们看看下面的例子,就有一种似曾相识的赶脚,代码如下: func deferDemo() error { err := createResource1() if err != n

  • golang log4go的日志输出优化详解

    前言 在go语言中,自身已经集成了一定log模块,开发者可以使用go语言自身的log包(import "log") .也有不少对自身log的开源封装.对于一些简单的开发,自身的log模块就已经足够应付.但是对一些大型,复杂的开发,log需要分门别类的输出,或者通过网络进行输出,自身log模块将难以应对. 当前也有一些比较重量级的log模块,比如logrus,可以实现比较复杂的功能.这里介绍一个轻量级的log模块--log4go 最近又看了一些golang的日志包和相关的文章,仔细阅读了

  • golang新手们容易犯的3个错误总结

    前言 从golang小白到成为golang工程师快两个月了,我要分享一下新手在开发中常犯的错误,都是我亲自踩过的坑.这些错误中有些会导致无法通过编译,这种错容易发现,而有些错误在编译时不会抛出,甚至在运行时也不会panic,如果缺少相关的知识,挠破头皮都搞不清楚bug出在哪. 1.对nil map.nil slice 添加数据 请考虑一下这段代码是否有错,然后运行一遍: package main func main() { var m map[string]string m["name"

  • Golang常见错误之值拷贝和for循环中的单一变量详解

    前言 golang(中文名:go语言)是谷歌2009发布的第二款开源编程语言.Go语言专门针对多处理器系统应用程序的编程进行了优化,使用Go编译的程序可以媲美C或C++代码的速度,而且更加安全.支持并行进程..如果你想知道得更多,请移步至官网golang官网 在 Go 中函数的调用是值拷贝 copy value,而且在 for 循环中 v 的变量始终是一个变量.如果 v 是 pointer,print 这个 method 接收的是指针的拷贝,for 循环体中每次迭代 v 的 pointer va

  • Golang中重复错误处理的优化方法

    Golang 错误处理最让人头疼的问题就是代码里充斥着「if err != nil」,它们破坏了代码的可读性,本文收集了几个例子,让大家明白如何优化此类问题. 让我们看看 Errors are values中提到的一个 io.Writer 例子: _, err = fd.Write(p0[a:b]) if err != nil { return err } _, err = fd.Write(p1[c:d]) if err != nil { return err } _, err = fd.Wr

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

    前言 相信不少 Gopher 在写 Golang 程序都遇到过 import cycle not allowed 问题,本人最近研读 go-ethereum 源码时,发现定义 interface 也能解决此问题, 还能解决连分包都不能解决的情况, 并且比分包更加简单快捷.下面逐个讲解 分包 和 定义接口 这两种方法. 1. 应用场景 假设有如下使用场景: A 是应用程序的框架级结构体,在 A 包含子模块 B 和 C 的指针: B 为了方便的使用应用的其他子模块(比如 C )功能,所以在其结构体包

  • Golang中 import cycle not allowed 问题的解决方法

    目录 1.问题现象 2.问题分析 3.解决问题思路 4.如何破除依赖 5.问题回顾 1.问题现象 go编译的时候报错import cycle not allowed cycle意思很简单就是循环的意思.代表的就是一个包被循环的导入. 2.问题分析 这个错是在container_cloud/pkg/service这里出现的,说明这个包被循环导入. 可是service这个包文件太多怎么检查呢? 可以看到这个service包下面的文件特别多. 3.解决问题思路 虽然文件很多,但是看自己最近修改过的文件

  • golang中import cycle not allowed解决的一种思路

    发现问题 项目中碰到了一些问题,使用了指针函数的思路来解决相应问题 在实际项目中,因为两个项目互相引了对方的一些方法,导致了循环引用的错误,原本可以使用http的请求来解决,经过其他人指导,发现了可以使用指针函数来解决 这里通过一个简单的例子来说明,首先是例子的结构,我们仅仅用到了这两个文件:ciconnector.go和rockettest.go 例子结构 原本设定的方法是这两个包里的函数互相调用,那么我们通过代码来看下怎么解决相应的问题. 首先是rockettest.go,这里调用了cico

  • nginx加php-fpm出现502 bad gateway错误的5种解决方法

    nginx出现502有很多原因,但大部分原因可以归结为资源数量不够用,也就是说后端php-fpm处理有问题,nginx将正确的客户端请求发给了后端的php-fpm进程,但是因为php-fpm进程的问题导致不能正确解析php代码,最终返回给了客户端502错误. 服务器出现502的原因是连接超时 我们向服务器发送请求 由于服务器当前链接太多,导致服务器方面无法给于正常的响应,产生此类报错 因此如果你服务器并发量非常大,那只能先增加机器,然后按以下方式优化会取得更好效果;但如果你并发不大却出现502,

  • 详解golang避免循环import问题(“import cycle not allowed”)

    前言 golang不允许循环import package ,如果检测到 import cycle ,会在编译时报错,通常import cycle是因为设计错误或包的规划问题. 以下面的例子为例,package a依赖package b,同事package b依赖package a package a import ( "fmt" "github.com/mantishK/dep/b" ) type A struct { } func (a A) PrintA() {

  • "Method Not Allowed"405问题分析以及解决方法

    目录 背景: 现象: 排查解决过程: 总结: 首先,明确一点405问题就是浏览器端(或客户端)请求方法和服务端处理该路径的请求的处理方法不一致造成的. 背景: SpringBoot2.70整合JPA,测试单表的增删改查 现象: 在用postman测试delete方法的时候遇到的 图1: postman测试截图 图2:后端代码块 package com.xxxx.salesforecast.Controller; import com.xxxx.salesforecast.pojo.User; i

  • Mysql 报Row size too large 65535 的原因及解决方法

    报错信息:Row size too large. The maximum row size for the used table type, not counting BLOBs, is 65535 向mysql的表插件一个字段 类型为text时,或修改一个字段类型为text时,报出上面的错误.其实我对这个错误的原因理解也不是很深,给出一些我查到的解释吧 大意是数据表中有一个设定长度为64K的字段索引,当表中字段(不知道是字段名字还是什么)不能超过这个长度,65,535所说明的是针对的是整个表的

  • PHP正则替换函数preg_replace()报错:Notice Use of undefined constant的解决方法分析

    本文实例讲述了PHP正则替换函数preg_replace()报错:Notice Use of undefined constant的解决方法.分享给大家供大家参考,具体如下: 环境错误级别:error_reporting =E_ALL 某天我在研究一下php下的正则替换函数perg_replace(), 示例: 代码: $subject="2222<b>a</b>2222fff222222222A22222"; $pattern = "/(a)/e&q

  • Nginx 403 forbidden错误的原因以及解决方法

    目录 一.由于启动用户和nginx工作用户不一致所致 1.1查看nginx的启动用户,发现是nginx,而为是用root启动的 1.2将nginx.config的user改为和启动用户一致, 1.3 也可以使用如下命令直接查看 二.缺少index.html,就是配置文件中index index.html index.htm这行中的指定的文件. 三.权限问题,如果nginx没有web目录的操作权限,也会出现403错误. 总结 一.由于启动用户和nginx工作用户不一致所致 1.1查看nginx的启

  • 关于报错IDEA Terminated with exit code 1的解决方法

    本人亲测,在使用IDEA使用Maven模板创建项目或者在当前项目中New Project,Maven的以下三个配置参数会重置使用C:\Users\ZSAndroid\.m2的默认maven下载方式. Maven home path(Maven安装路径) User settings file(Maven下载使用的settings.xml) Local repository(Maven本地仓库,settings.xml下载存放资源的目录) 如果在IDEA构建项目时遇到下面这样的报错IDEA Term

随机推荐