参考博客:https://blog.csdn.net/qq_51753728/article/details/142262405
Makefile 是用于管理项目构建过程的工具,广泛用于 C/C++ 等语言的编译。它通过定义规则和指令,自动化编译、链接等步骤,大大简化了开发者的工作。下面将详细介绍 Makefile 的基本概念、语法规则以及一些高级用法。
一、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
三、 Makefile 的工作原理
make 会根据 Makefile 中的规则,依次检查目标文件的时间戳和依赖文件的时间戳。如果依赖文件的时间戳比目标文件新,或者目标文件不存在,make 就会执行对应的命令来更新目标文件。make 会递归检查依赖关系,直到所有目标都更新完成。
四、变量的使用
Makefile 支持定义变量,可以简化重复的命令。变量的定义格式为:
VARIABLE_NAME = value
在引用变量时使用 $(VARIABLE_NAME)
,如:
CC = g++
CFLAGS = -Wall -g
main.o: main.cpp
$(CC) $(CFLAGS) -c main.cpp -o main.o
注意这里的括号,变量需要使用()
五、常用的内置变量
- $@:表示目标文件。
- $^:表示所有的依赖文件。
- $<:表示第一个依赖文件。
示例:
main: main.o utils.o
$(CC) -o $@ $^
这里,$@
表示目标文件 main
,$^
表示所有的依赖文件 main.o
和 utils.o
。
六、伪目标
伪目标(phony targets)并不是文件,而是一种命令名称,可以用于执行一些常见的操作,如清理构建文件。它们通常定义为:
.PHONY: clean
clean:
rm -f *.o main
clean
是一个伪目标,用于删除中间文件和可执行文件。- 伪目标不会检查文件是否会存在,直接执行对应的命令,比如这里不会检查
clean
文件是否存在,而是直接执行对应的命令
七、Makefile编写实例
7.1 代码文件
假设我们有以下的C++
代码文件:
main.cpp
add.cpp
sub.cpp
multi.cpp
div.cpp
operator.h
目录结构如下:
project/
├── Makefile
├── add.c
├── div.c
├── sub.c
├── operations.h
├── main.c
7.1.2 operator.h
- 该头文件用于定义我们的算术函数
pragma once
确保该文件不会被重复包含
#pragma once
int add(int x,int y);
int subtract(int x,int y);
int multiply(int x,int y);
int divide(int x,int y);
7.1.3 sub.cpp
- 实现减法运算函数的文件
#include"operator.h"
int subtract(int x,int y){
return x - y;
}
7.1.4 mul.cpp
- 实现乘法运算函数的文件
#include"operator.h"
int multiply(int x,int y){
return x * y;
}
7.1.5 div.cpp
- 实现减法运算函数的文件
#include"operator.h"
#include<cassert>
int divide(int x,int y){
assert(y == 0);
return x / y;
}
7.1.6 add.cpp
- 实现加法运算函数的文件
#include"operator.h"
int add(int x,int y){
return x + y;
}
7.1.7 main.cpp
#include<iostream>
#include"operator.h"
int main(){
int x = 100, y = 200;
std::cout << "x + y = " << add(x,y) << std::endl;
std::cout << "x - y = " << subtract(x,y) << std::endl;
std::cout << "x * y = " << multiply(x,y) << std::endl;
std::cout << "x / y = " << subtract(x,y) << std::endl;
return 0;
}
7.2 直接编译链接
下面的方式是最简单的的方式,直接执行编译链接操作
app:add.cpp div.cpp sub.cpp multi.cpp main.cpp
g++ add.cpp div.cpp multi.cpp sub.cpp main.cpp -o app
编译
make
结果如下
7.3 编译+链接
- 这种方式对每个独立的
.cpp
文件进行编译,得到.o
文件 - 最后将所有
.o
文件链接在一起,得到可执行文件app
app:add.o div.o multi.o sub.o main.o
g++ add.o div.o multi.o sub.o main.o -o app
add.o: add.cpp
g++ -c add.cpp -o add.o
div.o: div.cpp
g++ -c div.cpp -o div.o
multi.o: multi.cpp
g++ -c multi.cpp -o multi.o
sub.o:sub.cpp
g++ -c sub.cpp -o sub.o
main.o:main.cpp
g++ -c main.cpp -o main.o
编译结果
7.4 使用变量
定义一些变量,可以增加可读性,同时方便修改:
- 自定义变量:变量名=变量值,如
var=hello
- 预定义变量
AR
: 归档维护程序的名称,默认值为 arCC
: C 编译器的名称,默认值为 ccCXX
: C++ 编译器的名称,默认值为 g++$@
: 目标的完整名称$<
: 第一个依赖文件的名称$^
: 所有的依赖文件
Makefile
内容如下
src=add.o sub.o div.o multi.o main.o
target=app
$(target):$(src)
$(CXX) $^ -o $@
add.o:add.cpp
$(CXX) -c $^ -o $@
sub.o:sub.cpp
$(CXX) -c $^ -o $@
multi.o:multi.cpp
$(CXX) -c $^ -o $@
div.o:div.cpp
$(CXX) -c $^ -o $@
main.o:main.cpp
$(CXX) -c $^ -o $@
编译结果如下
7.5 使用模版匹配
当所要编译的文件过多时,使用模式匹配能够简化操作
模式匹配规则
%.o: %.c
$(CC) -c $< -o $@
%.o: %.c:
- 这是一个通用规则(模式匹配规则),表示如何将任意 .c 文件编译为对应的 .o 文件。% 是一个通配符,表示任意文件的前缀,例如,add.c 编译为 add.o。
$(CC) -c $< -o $@:
- -c:告诉编译器只编译,不链接。
- $<:自动变量,表示第一个依赖文件(在这里是匹配的 .c 文件,如 add.c、div.c 等)。
-o $@:$@
是目标文件(这里是 .o 文件),例如,将 add.c 编译为 add.o。
Makefile文件内容如下:
src=add.o sub.o multi.o div.o main.o
target=app
$(target):$(src)
$(CXX) $^ -o $@
%.o:%.cpp
$(CXX) -c $< -o $@
编译结果如下
make
7.6 完整的Makefile文件
下面的MakeFile
文件为完整的文件,用于构建上述项目
CXX = g++
CXXFLAGS = -Wall -std=c++14
SRCS = main.cpp add.cpp sub.cpp multi.cpp div.cpp
OBJS = $(SRCS:.cpp=.o)
TARGET = app
all:$(TARGET)
$(TARGET):$(OBJS)
$(CXX) $(CXXFLAGS) -o $(TARGET) $(OBJS)
%.o:%.cpp
$(CXX) $(CXXFLAGS) -c $< -o $@
clean:
rm -f $(OBJS) $(TARGET)
.PHONY:all clean
代码详解
CXX = g++
CXXFLAGS = -Wall -std=c++17
CXX = g++
: 定义了编译器使用g++
。CXXFLAGS = -Wall -std=c++14:
设置编译选项:-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)
lean:
: 定义一个名为clean
的规则,用于删除编译生成的文件。rm -f $(OBJS) $(TARGET)
: 删除对象文件($(OBJS)
)和可执行文件($(TARGET)
)。-f
选项用于强制删除并忽略不存在的文件。
.PHONY: all clean
- PHONY: all clean:声明all和clean为目标,以避免与同名文件发生冲突。即使当前目录中存在名为all或clean的文件,make也不会将它们作为目标文件来处理。
编译结果
make
执行clean
命令
make clean