golang类似make/rake的构建工具插件mage的使用

Golang类似Make/Rake的构建工具插件Mage的使用

关于Mage

Mage是一个使用Go编写的类似make的构建工具。你可以编写普通的Go函数，Mage会自动将它们作为类似Makefile的可运行目标使用。

Built with Mage

安装

Mage除了Go标准库外没有其他依赖，支持Go 1.7及以上版本(可能支持更低版本，但没有定期测试)。

使用GOPATH安装(Go版本<1.17)

go get -u -d github.com/magefile/mage
cd $GOPATH/src/github.com/magefile/mage
go run bootstrap.go

使用Go Install安装(Go版本>=1.18)

go install github.com/magefile/mage@latest
mage -init

你也可以指定版本号安装：

go install github.com/magefile/mage@v1.15.0

使用Go Modules安装

git clone https://github.com/magefile/mage
cd mage
go run bootstrap.go

Mage二进制文件将被创建在你的$GOPATH/bin目录中。

示例Demo

下面是一个完整的Mage使用示例：

// +build mage

package main

import (
	"fmt"
	"os"
	"os/exec"
)

// 默认目标，当运行mage时不指定目标时执行
var Default = Build

// 构建项目
func Build() error {
	fmt.Println("Building...")
	cmd := exec.Command("go", "build", "-o", "myapp", ".")
	return cmd.Run()
}

// 运行测试
func Test() error {
	fmt.Println("Running tests...")
	cmd := exec.Command("go", "test", "./...")
	cmd.Stdout = os.Stdout
	cmd.Stderr = os.Stderr
	return cmd.Run()
}

// 清理构建文件
func Clean() {
	fmt.Println("Cleaning...")
	os.Remove("myapp")
}

// 安装依赖
func InstallDeps() error {
	fmt.Println("Installing dependencies...")
	cmd := exec.Command("go", "mod", "download")
	return cmd.Run()
}

使用示例：

# 列出所有可用目标
mage -l

# 运行默认目标(Build)
mage

# 运行测试
mage test

# 清理构建文件
mage clean

# 安装依赖
mage installDeps

为什么选择Mage?

Makefile难以阅读和编写。主要是因为makefile本质上是带有重要空白和额外make相关语法的花式bash脚本。

Mage允许你有多个mage文件，可以随意命名你的mage文件，并且它们很容易为多个操作系统定制。Mage没有依赖(除了go)，在所有主要操作系统上都运行良好，而make通常使用bash，在Windows上支持不好。对于任何涉及分支、循环或不仅仅是直线执行命令的非平凡任务，Go都比bash更优秀。如果你的项目是用Go编写的，为什么要引入像bash这样特殊的另一种语言？为什么不使用你的贡献者已经熟悉的语言？


更多关于golang类似make/rake的构建工具插件mage的使用的实战教程也可以访问 https://www.itying.com/category-94-b0.html

1 回复

更多关于golang类似make/rake的构建工具插件mage的使用的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html


Golang构建工具Mage使用指南

Mage是一个类似Make/Rake的构建工具，专为Go语言设计。它允许你使用Go语言编写构建脚本，而不是传统的Makefile语法。以下是Mage的详细介绍和使用示例。

Mage的特点

  1. 使用Go语言编写构建脚本
  2. 自动发现构建目标
  3. 支持并行执行
  4. 内置文件系统操作
  5. 良好的错误处理
  6. 自动依赖管理

安装Mage

go install github.com/magefile/mage@latest

基本使用

1. 创建Magefile

创建一个名为magefile.go的文件：

//go:build mage

package main

import (
	"fmt"
	"github.com/magefile/mage/mg"
)

// 默认构建目标
var Default = Build

// 清理构建产物
func Clean() {
	fmt.Println("Cleaning...")
	// 这里添加清理逻辑
}

// 构建项目
func Build() {
	mg.Deps(Clean)
	fmt.Println("Building...")
	// 这里添加构建逻辑
}

// 运行测试
func Test() error {
	fmt.Println("Testing...")
	// 这里添加测试逻辑
	return nil
}

2. 运行Mage目标

# 列出所有可用目标
mage -l

# 运行默认目标
mage

# 运行特定目标
mage build

# 并行运行目标
mage -parallel clean build

高级功能

命名空间

type Docker mg.Namespace

// 构建Docker镜像
func (Docker) Build() {
	fmt.Println("Building docker image...")
}

// 推送Docker镜像
func (Docker) Push() {
	fmt.Println("Pushing docker image...")
}

使用方式：

mage docker:build
mage docker:push

依赖管理

func Build() {
	mg.Deps(Generate, Test)
	fmt.Println("Building...")
}

func Generate() {
	fmt.Println("Generating code...")
}

文件操作

import (
	"github.com/magefile/mage/sh"
)

func Build() error {
	// 执行go build
	return sh.Run("go", "build", "-o", "myapp", "./cmd/myapp")
}

完整示例

//go:build mage

package main

import (
	"fmt"
	"os"
	"path/filepath"

	"github.com/magefile/mage/mg"
	"github.com/magefile/mage/sh"
)

var (
	// 构建目标名称
	appName = "myapp"
	// 构建输出目录
	buildDir = "bin"
)

// 默认目标
var Default = Build

// 清理构建产物
func Clean() error {
	fmt.Println("Cleaning...")
	return os.RemoveAll(buildDir)
}

// 构建项目
func Build() {
	mg.Deps(Test, Clean)
	fmt.Println("Building...")

	// 创建构建目录
	if err := os.MkdirAll(buildDir, 0755); err != nil {
		panic(err)
	}

	// 构建主程序
	output := filepath.Join(buildDir, appName)
	if err := sh.Run("go", "build", "-o", output, "./cmd/myapp"); err != nil {
		panic(err)
	}
}

// 运行测试
func Test() error {
	fmt.Println("Running tests...")
	return sh.Run("go", "test", "./...")
}

// 运行程序
func Run() error {
	mg.Deps(Build)
	fmt.Println("Running application...")
	return sh.Run(filepath.Join(buildDir, appName))
}

// Docker相关操作
type Docker mg.Namespace

// 构建Docker镜像
func (Docker) Build() error {
	mg.Deps(Build)
	fmt.Println("Building docker image...")
	return sh.Run("docker", "build", "-t", appName, ".")
}

// 推送Docker镜像
func (Docker) Push() error {
	mg.Deps(Docker.Build)
	fmt.Println("Pushing docker image...")
	return sh.Run("docker", "push", appName)
}

使用技巧

  1. 环境变量：可以在Magefile中使用os.Getenv读取环境变量
  2. 参数传递：可以通过os.Args获取命令行参数
  3. 错误处理：函数返回error时，Mage会正确处理错误状态
  4. 并行执行：使用mg.Ctx和mg.SerialCtx控制并行度

与Make/Rake对比的优势

  1. 使用Go语言语法，对Go开发者更友好
  2. 类型安全，减少语法错误
  3. 可以直接使用Go生态系统的所有库
  4. 更好的跨平台支持
  5. 更强大的依赖管理

Mage是一个强大的构建工具，特别适合Go项目的构建自动化。它结合了Make的灵活性和Go语言的强大功能，为Go开发者提供了现代化的构建体验。

回到顶部