GoPlantUML V2

GoPlantUML 是一个开源的 Go 语言工具，用于从 Go 源代码自动生成 PlantUML 类图和接口关系图。它可以帮助开发者可视化 Go 项目中的结构和关系，提高代码理解和文档编写的效率。

安装

前提条件:

• Go 1.17 或更高版本

安装命令:

go get github.com/jfeliu007/goplantuml/parser
go install github.com/jfeliu007/goplantuml/cmd/goplantuml@latest

这将在你的 GOPATH bin 文件夹中安装 goplantuml 命令。

使用

基本用法:

goplantuml [-recursive] path/to/gofiles path/to/gofiles2

将输出保存到文件:

goplantuml [-recursive] path/to/gofiles path/to/gofiles2 > diagram_file_name.puml

可用选项:

- aggregate-private-members
       Show aggregations for private members. Ignored if -show-aggregations is not used.
- hide-connections
       hides all connections in the diagram
- hide-fields
       hides fields
- hide-methods
       hides methods
- ignore string
       comma separated list of folders to ignore
- notes string
       Comma separated list of notes to be added to the diagram
- output string
       output file path. If omitted, then this will default to standard output
- recursive
       walk all directories recursively
- show-aggregations
       renders public aggregations even when -hide-connections is used (do not render by default)
- show-aliases
       Shows aliases even when -hide-connections is used
- show-compositions
       Shows compositions even when -hide-connections is used
- show-connection-labels
       Shows labels in the connections to identify the connections types (e.g. extends, implements, aggregates, alias of
- show-implementations
       Shows implementations even when -hide-connections is used
- show-options-as-note
       Show a note in the diagram with the none evident options ran with this CLI
- title string
       Title of the generated diagram
- hide-private-members
       Hides all private members (fields and methods)

示例

生成示例图:

goplantuml $GOPATH/src/github.com/jfeliu007/goplantuml/parser

这将输出类似下面的 PlantUML 代码:

@startuml
namespace parser {
    class Struct {
        + Functions []*Function
        + Fields []*Parameter
        + Type string
        + Composition []string
        + Extends []string
    }
    class LineStringBuilder {
        + WriteLineWithDepth(depth int, str string) 
    }
    class ClassParser {
        - structure map[string]map[string]*Struct
        - currentPackageName string
        - allInterfaces map[string]struct{}
        - allStructs map[string]struct{}

        - structImplementsInterface(st *Struct, inter *Struct) 
        - parsePackage(node ast.Node) 
        - parseFileDeclarations(node ast.Decl) 
        - addMethodToStruct(s *Struct, method *ast.Field) 
        - getFunction(f *ast.FuncType, name string) 
        - addFieldToStruct(s *Struct, field *ast.Field) 
        - addToComposition(s *Struct, fType string) 
        - addToExtends(s *Struct, fType string) 
        - getOrCreateStruct(name string) 
        - getStruct(structName string) 
        - getFieldType(exp ast.Expr, includePackageName bool) 

        + Render() 
    }
    class Parameter {
        + Name string
        + Type string
    }
    class Function {
        + Name string
        + Parameters []*Parameter
        + ReturnValues []string
    }
}
strings.Builder *-- parser.LineStringBuilder
@enduml

保存到文件:

goplantuml $GOPATH/src/github.com/jfeliu007/goplantuml/parser > ClassDiagram.puml

关系类型

GoPlantUML 识别两种主要关系:

1. 接口实现关系
2. 类型组合关系

示例代码:

package testingsupport

//MyInterface only has one method, notice the signature return value
type MyInterface interface {
	foo() bool
}

//MyStruct1 will implement the foo() bool function so it will have an "extends" association with MyInterface
type MyStruct1 struct {
}

func (s1 *MyStruct1) foo() bool {
	return true
}

//MyStruct2 will be directly composed of MyStruct1 so it will have a composition relationship with it
type MyStruct2 struct {
	MyStruct1
}

//MyStruct3 will have a foo() function but the return value is not a bool, so it will not have any relationship with MyInterface
type MyStruct3 struct {
    Foo MyStruct1
}

func (s3 *MyStruct3) foo() {
}

生成的 PlantUML:

@startuml
namespace testingsupport {
    interface MyInterface  {
        - foo() bool
    }
    class MyStruct1 << (S,Aquamarine) >> {
        - foo() bool
    }
    class MyStruct2 << (S,Aquamarine) >> {
    }
    class MyStruct3 << (S,Aquamarine) >> {
        - foo() 
        + Foo MyStruct1
    }
}
testingsupport.MyStruct1 *-- testingsupport.MyStruct2
testingsupport.MyInterface <|-- testingsupport.MyStruct1
testingsupport.MyStruct3 o-- testingsupport.MyStruct1
@enduml

渲染图表示例

要渲染这些图，你可以使用 PlantUML 的在线服务器或本地安装的 PlantUML。