Go 项目中Makefile的使用方法

Makefile 是一个强大且灵活的构建工具，具备自动化构建、处理依赖关系、任务管理和跨平台支持等优点。通过编写和使用 Makefile，开发者可以简化项目的构建过程，提高开发效率，并实现自动化的构建和发布流程。

在许多开源项目和工具中，Makefile 被广泛选择作为构建工具。它的灵活性主要体现在其具有 target（目标）的概念，相比于仅使用 Shell 脚本，Makefile 可以更好地组织和管理构建过程。

此外，Makefile 还能够与其他工具和语言进行集成，例如与 C/C++ 编译器、Go 工具链等配合使用。通过定义适当的规则和命令，可以实现与其他构建工具的无缝集成，进一步提高构建过程的灵活性和效率。

本文旨在帮助读者了解如何使用 Makefile 工具来构建你的 Go 项目。

基本介绍

Makefile 是由 GNU Make 工具解析执行的配置文件。要调用 Makefile，需要在命令行中使用 make 命令，并指定要执行的目标或规则。下面是 Makefile 的基本语法和调用方式的介绍。

创建 Makefile 文件

定义规则和目标

语法格式：

target: prerequisites
    commands

示例：

hello: main.o utils.o
    gcc main.o utils.o -o hello

main.o: main.c
    gcc -c main.c

utils.o: utils.c
    gcc -c utils.c

调用 Makefile

语法格式：

make [target]

示例：

make hello

其他常用选项

Makefile 的优势

Makefile 的发展历史

Makefile 与 Shell 对比

Makefile 的数据类型

正式开始

字符串输出

# 请确保在每一行命令前面使用实际的 Tab 键而不是空格。这是 Makefile 的语法要求。
# 如果在创建 Makefile 时使用了空格而不是 Tab 键，将会导致语法错误。
hello:
    @echo "Hello, World!"

使用变量

在 Makefile 中，变量的定义需要使用 := 进行赋值操作。在使用变量时，使用 $(VAR_NAME) 的语法来引用变量。

# 定义变量
GREETING := "Hello, World!"

# 输出变量
variable:
    @echo "$(GREETING)"

具体来说，这个符号用于设置一个变量的默认值，只有当该变量没有被显式设置时才会使用默认值。如果变量已经被设置了，那么 ?= 将不会起作用，而是保留原来的值。

# 设置编译器
GO ?= go

访问数组

# 定义一个包含多个值的变量
FRUITS := apple orange banana

# 访问列表中的元素
first := $(firstword $(FRUITS))
second := $(word 2, $(FRUITS))
third := $(word 3, $(FRUITS))
last := $(lastword $(FRUITS))

# 输出列表中的元素
array:
    @echo "First: $(first)"
    @echo "Second: $(second)"
    @echo "Third: $(third)"
    @echo "Last: $(last)"

遍历数组

# 定义一个包含多个值的变量
FRUITS := apple orange banana

# 打印数组的每个元素
print:
    @for fruit in $(FRUITS); do \
        echo "$$fruit"; \
    done

遍历+条件

# 定义一个包含多个值的变量
FRUITS := apple orange banana

# 打印数组的每个元素
filter:
    @for fruit in $(FRUITS); do \
        if [ "$$fruit" = "orange" ]; then \
            echo "$$fruit is my favorite fruit!"; \
        elif [ "$$fruit" = "apple" ]; then \
            echo "$$fruit is my secondary fruit of choice!"; \
        else \
            echo "The fruit I hate the most - $$fruit!"; \
        fi \
    done

判断是否等于

# 定义变量
FRUIT := apple

# 注意：ifeq 是定义在 Makefile 文件的顶层范围，而不是定义在目标规则中，也就是说，写在 fruit 内是不被允许的
ifeq ($(FRUIT), apple)
    favorite := "It's an apple!"
else ifeq ($(FRUIT), orange)
    favorite := "It's an orange!"
else ifeq ($(FRUIT), banana)
    favorite := "It's a banana!"
else
    favorite := "Unknown fruit!"
endif

# 判断变量的值
fruit:
    @echo $(favorite)

判断是否定义

# 检查变量是否已定义
DEBUG :=

ifdef DEBUG
    MESSAGE := "Debug is defined"
else
    MESSAGE := "Debug is undefined"
endif

# 打印消息
print_message:
    @echo $(MESSAGE)

嵌入 Python

hello_world := Hello World

python:
    $(eval WORDS := $(shell python3 -c 'import sys; print(sys.argv[1].split())' "$(hello_world)"))
    @echo $(WORDS)" !"

伪目标

通常情况下，使用 .PHONY 是为了避免与同名文件产生冲突，或者为了在构建时强制重新执行某些操作。例如，在以下示例中：

.PHONY: clean
clean:
    rm -rf *.o *.out

.PHONY: clean 表示 clean 是一个伪目标，不需要检查是否存在 clean 文件。如果没有这个声明，执行 make clean 命令时，可能会出现如下错误提示：

Makefile
make: 'clean' is up to date.

依赖构建

这种写法常用于定义 Makefile 的目标（Target），它可以确保所需的目录在执行后存在，并且不需要手动创建。例如：

.PHONY: build

BUILD_DIR := ./build/
OUTPUT_DIR := ./output/

build: $(BUILD_DIR)
    go build -o $(OUTPUT_DIR)/bin/app main.go

$(BUILD_DIR):
    mkdir -p $@

举个例子

脚本示例

忽略某些目录（或文件）后遍历项目目录

方式1

# 设置要排除的目录列表
EXCLUDE_DIRS := \
    ./vendor \
    ./.git \
    ./.idea \
    ./examples \
    ./test

# 添加匹配的子目录到排除的目录列表中
EXCLUDE_DIRS += $(foreach dir,$(EXCLUDE_DIRS),$(dir)/*)

# 查找所有非排除目录的目录
SRC_DIRS := $(shell find . -type d $(foreach dir,$(EXCLUDE_DIRS),! -path "$(dir)"))

# 在这里添加要执行的命令
print_dirs:
    @for dir in $(SRC_DIRS); do \
        echo "Processing directory: $$dir"; \
        (cd $$dir && pwd); \
    done

方式2

# 设置要排除的目录列表
EXCLUDE_DIRS := \
    ./vendor \
    ./.git \
    ./.idea \
    ./examples \
    ./test

# 添加匹配的子目录到排除的目录列表中
EXCLUDE_DIRS += $(foreach dir,$(EXCLUDE_DIRS),$(dir)/*)

# 查找所有非排除目录的目录（定义函数）
define find_src_dirs
    $(shell find . -type d $(foreach dir,$(EXCLUDE_DIRS),! -path "$(dir)"))
endef

# 打印非排除目录的目录
print_dirs:
    @$(foreach dir,$(call find_src_dirs), \
        (cd $(shell pwd)/$(dir) && pwd); \
    )

方式3

# 显示目录的序号
print_dirs:
    @count=0; \
    @for dir in $(SRC_DIRS); do \
        count=$$((count + 1)); \
        echo "· $$(printf "%02d" $$count) - Checking: $$dir"; \
    done

实际场景

项目目录结构

➜ tree
.
├── Makefile
└── scripts
    └── start.sh

start.sh 文件

#!/usr/bin/env bash

# 可在任意目录位置进行 sh 执行
curdir=`dirname $(readlink -f $0)`
basedir=`dirname $curdir`"/"

# 执行 make generate 命令时，使用 --no-builtin-rules 参数来禁用内置规则，这有时可以解决一些奇怪的行为。
make --directory ${basedir} --no-builtin-rules generate

#EOF

Makefile 文件

一个基础的示例：

# TBD...

# 设置变量
GOCMD := go
GOBUILD := $(GOCMD) build
GOCLEAN := $(GOCMD) clean
GOTEST := $(GOCMD) test
GODEPS := $(GOCMD) mod download
GOGENERATE := $(GOCMD) generate
GOLINTER := golangci-lint run
BINARY_NAME := yourprojectname
MAIN_FILE := main.go

# 设置要排除的目录列表（根据实际情况更改）
EXCLUDE_DIRS := ./vendor ./.git ./.idea ./examples ./test

# 查找所有非排除目录的目录
SRC_DIRS := $(shell find . -type d $(foreach dir,$(EXCLUDE_DIRS),-not -path "$(dir)*"))

# 构建目标：生成代码
generate:
    @for dir in $(SRC_DIRS); do \
        echo "Generating code in directory: $$dir"; \
        (cd $$dir && $(GOGENERATE) -v); \
    done

# 构建目标：代码格式检测
lint:
    $(GOLINTER) ./...

# 构建目标：运行测试
test:
    $(GOTEST) ./...

# 构建目标：编译代码
build:
    $(GOBUILD) -o $(BINARY_NAME) $(MAIN_FILE)

# 构建目标：清理项目
clean:
    $(GOCLEAN)
    rm -f $(BINARY_NAME)

# 构建目标：安装依赖
deps:
    $(GODEPS)

# 构建目标：执行所有构建步骤
all: generate lint test build

# 声明所有目标，确保它们被视为伪目标而不是实际的文件名
.PHONY: generate lint test build clean deps all

推荐阅读

• 上一篇： Debian 11系统下Node.js版本更新方法
• 下一篇： CentOS 7.9安装Node.js 16.11.1