Golang報(bào)“import cycle not allowed”錯(cuò)誤的2種解決方法

2020-04-01 18:54:55

字體：大中小

供稿：網(wǎng)友

前言

相信不少 Gopher 在寫(xiě) Golang 程序都遇到過(guò) import cycle not allowed 問(wèn)題，本人最近研讀 go-ethereum 源碼時(shí)，發(fā)現(xiàn)定義 interface 也能解決此問(wèn)題，還能解決連分包都不能解決的情況，并且比分包更加簡(jiǎn)單快捷。下面逐個(gè)講解分包和定義接口這兩種方法。

1. 應(yīng)用場(chǎng)景

假設(shè)有如下使用場(chǎng)景：

A 是應(yīng)用程序的框架級(jí)結(jié)構(gòu)體，在 A 包含子模塊 B 和 C 的指針；

B 為了方便的使用應(yīng)用的其他子模塊（比如 C ）功能，所以在其結(jié)構(gòu)體包含了 A 的指針；

C 要調(diào)用 A 包中的某個(gè)方法；

2. 代碼實(shí)現(xiàn)

其程序大致如下：

package a 代碼如下：

package aimport ( "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 bimport ( "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 cimport "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 依賴(lài) package b 和 package c，同時(shí) package b 依賴(lài) package a 、 package c 也依賴(lài) package a 。

main 函數(shù)代碼如下：

package mainimport "github.com/ggq89/mutualdep/a"func main() { a := a.New(3) a.Pb.DisplayC()}

編譯時(shí)就會(huì)報(bào)錯(cuò)如下：

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. 定義接口

現(xiàn)在的問(wèn)題是：

A depends on B
B depends on A

對(duì)于 A struct 和 B struct 有彼此的指針這種相互依賴(lài)問(wèn)題，可以使用定義接口的方法解決，具體步驟如下：

在 package b 中定義 a interface ；將 b 所有使用到結(jié)構(gòu)體 a 的變量和方法的地方全部轉(zhuǎn)化成使用接口 a 的方法；在 a interface 中補(bǔ)充缺少的方法；

經(jīng)過(guò)上面的步驟處理后， package b 代碼如下：

package bimport ( "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 中補(bǔ)充可能缺少的方法；

處理后， package a 中的代碼如下：

package aimport ( "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

現(xiàn)在是另一個(gè)相互依賴(lài)問(wèn)題：

A depends on C
C depends on A

與前面的相互依賴(lài)不同，前面的依賴(lài)是由于 A struct 和 B struct 有彼此的指針導(dǎo)致的，屬于硬相互依賴(lài)；

而這里是由于 package c 中的方法調(diào)用 package a 中的方法引起的，屬于軟相互依賴(lài)；

這種相互依賴(lài)可以通過(guò)將方法拆分到另一個(gè)包的方式來(lái)解決；在拆分包的過(guò)程中，可能會(huì)將結(jié)構(gòu)體的方法轉(zhuǎn)化為普通的函數(shù)；

引入 package f ，將方法遷移到 f 中 :

package fimport "fmt"func Printf(v int) { fmt.Printf("%v", v)}

方法移動(dòng)到 package f 后， package a 的代碼如下：

package aimport ( "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隨之改成調(diào)用package f，其代碼如下：

package cimport ( "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)}

現(xiàn)在依賴(lài)關(guān)系如下：