Makefile(超详细一文读懂)

Makefile 是用于管理项目构建过程的工具，广泛用于 C/C++ 等语言的编译。它通过定义规则和指令，自动化编译、链接等步骤，大大简化了开发者的工作。下面将详细介绍 Makefile 的基本概念、语法规则以及一些高级用法。

1. Makefile 的基本概念

Makefile 是 make 命令所读取的配置文件，包含了构建项目的规则。其主要作用是检查项目文件的依赖关系，自动执行必要的命令，从而更新目标文件。一般来说，Makefile 主要包括以下三部分内容：

• 目标（Target）：需要生成的文件，例如可执行文件。
• 依赖（Dependencies）：生成目标所依赖的文件或目标。
• 命令（Commands）：构建目标时需要执行的命令。

2. Makefile 的基本语法

Makefile 的基本语法由规则（rule）组成，基本格式如下：

target: dependencies
    command

• target：目标文件，可以是一个目标文件或一个动作名称（例如：all, clean）。
• dependencies：生成目标所依赖的文件或其他目标。
• command：构建目标的命令，必须以 Tab 键开头。

示例：

main.o: main.cpp
    g++ -c main.cpp -o main.o

上述规则表示，当 main.o 文件不存在或 main.cpp 被修改后，执行命令 g++ -c main.cpp -o main.o 来生成 main.o。

3. Makefile 的工作原理

make 会根据 Makefile 中的规则，依次检查目标文件的时间戳和依赖文件的时间戳。如果依赖文件的时间戳比目标文件新，或者目标文件不存在，make 就会执行对应的命令来更新目标文件。make 会递归检查依赖关系，直到所有目标都更新完成。

4. 变量的使用

Makefile 支持定义变量，可以简化重复的命令。变量的定义格式为：

VARIABLE_NAME = value

在引用变量时使用 $(VARIABLE_NAME)，如：

CC = g++
CFLAGS = -Wall -g

main.o: main.cpp
    $(CC) $(CFLAGS) -c main.cpp -o main.o

上述例子中，使用变量 $(CC) 和 $(CFLAGS) 来替代具体的编译器(g++)和编译选项(-wall -g)。

5. 常用的内置变量

• $@：表示目标文件。
• $^：表示所有的依赖文件。
• $<：表示第一个依赖文件。

示例：

main: main.o utils.o
    $(CC) -o $@ $^

在这里，$@ 表示目标文件 main，$^ 表示所有的依赖文件 main.o 和 utils.o。

6. 伪目标

伪目标（phony targets）并不是文件，而是一种命令名称，可以用于执行一些常见的操作，如清理构建文件。它们通常定义为：

.PHONY: clean
clean:
    rm -f *.o main

clean 是一个伪目标，用于删除中间文件和可执行文件。

代码示例：

以下是一个简单的 Makefile 示例，适用于一个包含多个源文件的 C++ 项目。假设项目目录结构如下：

project/
├── Makefile
├── main.cpp
├── utils.cpp
├── utils.h

Makefile 内容如下：

# Compiler
CXX = g++

# Compiler flags
CXXFLAGS = -Wall -std=c++17

# Source files
SRCS = main.cpp utils.cpp

# Object files (replace .cpp with .o)
OBJS = $(SRCS:.cpp=.o)

# Output executable name
TARGET = app

# Default rule to build the target
all: $(TARGET)

# Rule to link object files into the executable
$(TARGET): $(OBJS)
	$(CXX) $(CXXFLAGS) -o $(TARGET) $(OBJS)

# Rule to compile source files into object files
%.o: %.cpp
	$(CXX) $(CXXFLAGS) -c $< -o $@

# Clean rule to remove object files and executable
clean:
	rm -f $(OBJS) $(TARGET)

# Phony targets to avoid conflicts with file names
.PHONY: all clean

代码详解：

CXX = g++
CXXFLAGS = -Wall -std=c++17

• CXX = g++: 定义了编译器使用 g++。
• CXXFLAGS = -Wall -std=c++17: 设置编译选项：
  • -Wall: 启用所有常见的编译警告，有助于发现潜在的错误。
  • -std=c++17: 指定使用 C++17 标准。

SRCS = main.cpp utils.cpp
OBJS = $(SRCS:.cpp=.o)

• SRCS = main.cpp utils.cpp: 定义了项目中所有的源文件。
• OBJS = $(SRCS:.cpp=.o): 使用 Makefile 的模式替换功能，将 .cpp 文件名替换为 .o，生成对象文件列表。$(SRCS:.cpp=.o) 表示将 SRCS 中的所有 .cpp 文件转换为 .o 文件。

TARGET = app

TARGET = app: 指定编译生成的可执行文件的名称为 app。

all: $(TARGET)

all: $(TARGET): 这是默认目标。当你在命令行中运行 make 时，默认执行 all 规则。它会依赖于 $(TARGET)，即生成指定的目标可执行文件。

$(TARGET): $(OBJS)
	$(CXX) $(CXXFLAGS) -o $(TARGET) $(OBJS)

• $(TARGET): $(OBJS): 定义如何生成目标文件（app）。它依赖于所有的对象文件 $(OBJS)。
• $(CXX) $(CXXFLAGS) -o $(TARGET) $(OBJS): 使用指定的编译器和编译选项，将对象文件 $(OBJS) 链接成可执行文件 app。

%.o: %.cpp
	$(CXX) $(CXXFLAGS) -c $< -o $@

• %.o: %.cpp: 定义一个通用规则，表示如何将任意 .cpp 文件编译为对应的 .o 文件。
• $(CXX) $(CXXFLAGS) -c $< -o $@: 使用编译器选项 $(CXXFLAGS)，将源文件（$< 表示依赖文件，即 .cpp 文件）编译成目标文件（$@ 表示目标文件，即 .o 文件）。

clean:
	rm -f $(OBJS) $(TARGET)

• clean:: 定义一个名为 clean 的规则，用于删除编译生成的文件。
• rm -f $(OBJS) $(TARGET): 删除对象文件（$(OBJS)）和可执行文件（$(TARGET)）。-f 选项用于强制删除并忽略不存在的文件。

.PHONY: all clean

>PHONY: all clean:声明all和clean为目标，以避免与同名文件发生冲突。即使当前目录中存在名为all或clean的文件，make也不会将它们作为目标文件来处理。

main.cpp内容如下：

#include <iostream>
#include "utils.h"

int main() {
    std::string name = "World";
    printGreeting(name);
    return 0;
}

utils.cpp内容如下：

#include <iostream>
#include "utils.h"

void printGreeting(const std::string& name) {
    std::cout << "Hello, " << name << "!" << std::endl;
}

utils.h内容如下：

#ifndef UTILS_H
#define UTILS_H

#include <string>

// Function declaration
void printGreeting(const std::string& name);

#endif // UTILS_H

如何编译和运行

1.使用前面提供的 Makefile，在项目根目录下执行 make。

make

2.生成的可执行文件名为 app，运行它：

./app

这将输出：

\Hello, World!