Go项目编写 Makefile 文件

Go项目编写 Makefile 文件

GOROOT := $(shell go env GOROOT)
GOCMD := $(GOROOT)/bin/go
GOCTLCMD := $(shell which goctl)

OUTPUT_DIR = ./output

APP_NAME := app

# 显示帮助信息
.PHONY: help
help:
    @echo "可用命令:"
    @echo "  make        	- 编译程序（默认目标）"
    @echo "  make help   	- 显示帮助信息"
    @echo "  make generate	- API定义生成"
    @echo "  make clean  	- 清理编译可执行文件"
    @echo "  make run    	- 编译并运行程序"
    @echo "  make test  	- 执行单元测试"
    @echo "  make bench  	- 执行基准测试"
    @echo "  make tidy    	- 安装/清理依赖"
    @echo "  make build  	- 编译程序包"
    @echo "  make build-on-windows - 编译程序包(windows)"

# 默认目标
all: help

# 根据 api 定义生成 go-zero 接口
.PHONY: generate
generate:
    @echo "Running generate ...."
    @$(GOCTLCMD) api go --api app.api --dir . --style=goZero
    @echo "Success!"

# 编译程序二进制包
.PHONY: build
build:
    @echo "Running build ...."
    @GOOS=linux GOARCH=amd64 $(GOCMD) build -o $(OUTPUT_DIR)/$(APP_NAME) app.go
    @echo "Success!"

# 编译程序二进制包(windows)平台
.PHONY: build-on-windows
build-on-windows:
    @echo "Running build ...."
    @CGO_ENABLED=0 GOOS=windows GOARCH=amd64 $(GOCMD) build -o $(OUTPUT_DIR)/$(APP_NAME) app.go
    @echo "Success!"

# 运行 Go 程序
.PHONY: run
run:
    @$(GOCMD) run app.go

# 清除 Go 程序二进制包文件
.PHONY: clean
clean:
    @echo "Running clean ...."
    @$(GOCMD) clean
    @$(RM) $(OUTPUT_DIR)/*
    @echo "Success!"

# 执行单元测试
.PHONY: test
test:
    @echo "Running tests ...."
    @$(GOCMD) test ./...

# 执行基准测试
.PHONY: bench
bench:
    @$(GOCMD) test -benchmem -run=^$$ -bench . tests

# 安装/清理依赖包依赖
.PHONY: tidy
tidy:
    @echo "Running tidy ...."
    @$(GOCMD) mod tidy
    @echo "Success!"