go-arch-lint 项目使用教程

go-arch-lint 项目使用教程

go-arch-lintGoLang architecture linter (checker) tool. Will check all project import path and compare with arch rules defined in yml file. Useful for hexagonal / onion / ddd / mvc and other architectural patterns. Tool can by used in your CI项目地址:https://gitcode.com/gh_mirrors/go/go-arch-lint

1. 项目的目录结构及介绍

go-arch-lint 是一个用于检查 Go 项目架构的工具，它可以帮助开发者确保项目遵循特定的架构模式，如六边形架构、洋葱架构、DDD 和 MVC 等。项目的目录结构如下：

go-arch-lint/
├── cmd/
│   └── go-arch-lint/
│       └── main.go
├── internal/
│   ├── checker/
│   ├── config/
│   ├── graph/
│   └── utils/
├── pkg/
│   └── archlint/
├── .gitignore
├── go.mod
├── go.sum
├── LICENSE
├── README.md
└── go-arch-lint.yml

• cmd/: 包含应用程序的入口点。
• internal/: 包含项目的内部逻辑，如检查器、配置解析、依赖图构建等。
• pkg/: 包含可以被其他项目导入的公共包。
• .gitignore: 指定 Git 忽略的文件和目录。
• go.mod 和 go.sum: Go 模块文件，用于管理依赖。
• LICENSE: 项目的许可证。
• README.md: 项目的说明文档。
• go-arch-lint.yml: 项目的配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/go-arch-lint/main.go。这个文件是整个应用程序的入口点，负责初始化配置、解析命令行参数并启动架构检查。

package main

import (
    "github.com/fe3dback/go-arch-lint/cmd"
)

func main() {
    cmd.Execute()
}

cmd.Execute() 函数会处理所有的命令行参数并执行相应的检查逻辑。

3. 项目的配置文件介绍

go-arch-lint.yml 是项目的配置文件，它定义了项目的理想架构规则。以下是一个示例配置文件的内容：

arch:
  components:
    - name: service
      mayDependOn:
        - repository

  rules:
    - from: service
      to: repository
      allowed: true

• arch: 定义架构规则的根节点。
• components: 定义项目中的组件及其依赖关系。
• rules: 定义具体的依赖规则，哪些组件可以依赖哪些其他组件。

通过这个配置文件，go-arch-lint 可以检查项目中的导入路径是否符合定义的架构规则，并在发现问题时提供警告。

使用方法

1. 安装：

   go install github.com/fe3dback/go-arch-lint@latest
   

2. 运行检查：

   go-arch-lint check
   

3. 使用 Docker：

   docker run --rm -v ${PWD}:/app fe3dback/go-arch-lint:latest-stable-release check --project-path /app
   

通过以上步骤，您可以轻松地将 go-arch-lint 集成到您的 Go 项目中，确保项目遵循预定义的架构规则。

go-arch-lintGoLang architecture linter (checker) tool. Will check all project import path and compare with arch rules defined in yml file. Useful for hexagonal / onion / ddd / mvc and other architectural patterns. Tool can by used in your CI项目地址:https://gitcode.com/gh_mirrors/go/go-arch-lint