Golang项目架构测试与分析工具插件arch-go的使用

Arch-Go简介

Arch-Go是一个用于Go项目的架构检查工具，可以帮助开发者定义和执行项目架构规则。

支持的规则

依赖检查

支持定义导入规则：

• 允许的依赖
  • 内部依赖（同一模块）
  • 标准库依赖
  • 外部依赖（第三方包）
• 不允许的依赖
  • 内部依赖（同一模块）
  • 标准库依赖
  • 外部依赖（第三方包）

包内容检查

允许定义一组包的内容，例如可以定义某个包应仅包含接口定义。支持的检查包括：

• shouldNotContainInterfaces
• shouldNotContainStructs
• shouldNotContainFunctions
• shouldNotContainMethods
• shouldOnlyContainInterfaces
• shouldOnlyContainStructs
• shouldOnlyContainFunctions
• shouldOnlyContainMethods

函数检查

检查一些函数属性，如：

• 最大参数数量
• 最大返回值数量
• 每个文件的最大公共函数数量
• 函数体的最大行数

命名规则检查

检查一些命名规则，例如：

• 如果一个结构体实现了匹配某些名称模式的接口，则其名称应以特定模式开头或结尾

配置

arch-go.yml文件

version: 1
threshold:
  compliance: 100
  coverage: 100
dependenciesRules:
  - package: "**.impl.*"
    shouldOnlyDependsOn:
      internal:
          - "**.foo.*"
          - "*.bar.*"
    shouldNotDependsOn: 
      internal: ["**.model.**"]
  - package: "**.utils.**"
    shouldOnlyDependsOn:
      - "**.model.**"
  - package: "**.foobar.**"
    shouldOnlyDependsOn:
      external:
        - "gopkg.in/yaml.v3"
  - package: "**.example.**"
    shouldNotDependsOn:
      external:
        - "github.com/foobar/example-module"
contentsRules:
  - package: "**.impl.model"
    shouldNotContainInterfaces: true
  - package: "**.impl.configuration"
    shouldOnlyContainFunctions: true
  - package: "**.impl.dependencies"
    shouldNotContainStructs: true
    shouldNotContainInterfaces: true
    shouldNotContainMethods: true
    shouldNotContainFunctions: true
functionsRules:
  - package: "**.impl.**"
    maxParameters: 3
    maxReturnValues: 2
    maxPublicFunctionPerFile: 1
    maxLines: 50
namingRules:
  - package: "**.arch-go.**"
    interfaceImplementationNamingRule:
      structsThatImplement: "*Connection"
      shouldHaveSimpleNameEndingWith: "Connection"

包名模式

包名可以定义为固定值或使用*特殊字符创建简单模式。

阈值配置

当前版本支持合规率和覆盖率阈值的配置。默认情况下，两个限制都设置为100%。

使用方式

在命令行中使用Arch-Go

安装Arch-Go：

$ go install -v github.com/arch-go/arch-go@latest

进入模块路径：

$ cd [path-to-your-module]

执行Arch-Go工具：

$ arch-go [flags]

描述架构指南

Arch-Go包含一个命令来描述arch-go.yml文件中的架构规则：

$ arch-go describe

输出示例：

Dependency Rules
        * Packages that match pattern '**.cmd.*',
                * Should only depends on packages that matches:
                        - '**.arch-go.**'
Function Rules
        * Packages that match pattern '**.arch-go.**' should comply with the following rules:
                * Functions should not have more than 50 lines
                * Functions should not have more than 4 parameters
                * Functions should not have more than 2 return values
                * Files should not have more than 5 public functions
Content Rules
        * Packages that match pattern '**.impl.model' should not contain functions or methods
        * Packages that match pattern '**.impl.config' should only contain functions
Naming Rules
        * Packages that match pattern '**.arch-go.**' should comply with:
                * Structs that implement interfaces matching name '*Verification' should have simple name ending with 'Verification'
Threshold Rules
        * The module must comply with at least 100% of the rules described above.
        * The rules described above must cover at least 100% of the packages in this module.

Time: 0.000 seconds

支持的标志

示例

$ arch-go 
$ arch-go -v
$ arch-go --verbose
$ arch-go --html
$ arch-go --json
$ arch-go --color
$ arch-go describe

以编程方式使用Arch-Go

当前版本的Arch-Go允许我们将架构检查作为go test工具运行的测试的一部分。

将Arch-Go添加为项目依赖：

go get github.com/arch-go/arch-go@latest

创建一个架构测试示例：

package architecture_test

import (
	"testing"

	archgo "github.com/arch-go/arch-go/api"
	config "github.com/arch-go/arch-go/api/configuration"
)

func TestArchitecture(t *testing.T) {
	configuration := config.Config{
		DependenciesRules: []*config.DependenciesRule{
			{
				Package: "**.cmd.**",
				ShouldOnlyDependsOn: &config.Dependencies{
					Internal: []string{
						"**.cmd.**",
						"**.internal.**",
					},
				},
			},
		},
	}
	moduleInfo := config.Load("github.com/arch-go/my-go-project")

	result := archgo.CheckArchitecture(moduleInfo, configuration)

	if !result.Pass {
		t.Fatal("Project doesn't pass architecture tests")
	}
}

result变量将存储比验证结果更多的信息，包括每种规则类型和分析包的详细信息，因此您可以访问所有这些数据以根据需要创建断言。

贡献

欢迎贡献。