Makefile工程文件

Make工具简介

在Linux C/C++的开发过程中，当源代码文件较少时，我们可以手动使用gcc或g++进行编译链接，但是当源代码文件较多且依赖变得复杂时，我们就需要一种简单好用的工具来帮助我们管理。于是，make应运而生。

make主要用来管理C/C++项目，通过Makefile书写的规则来对项目中的源代码文件进行编译，生成可执行的程序。

make流程

make执行的主要过程如下：当在shell中使用make命令时，make会寻找当前目录下的Makefile文件，根据该文件中的规则来确定依赖关系，如果一个文件所依赖的文件比这个文件要新，或者说修改时间更晚，那么make会根据Makefile中指明的命令来重新编译生成该文件。

另外，make除了自动寻找定义了编译规则的Makefile文件外，还可以手动指明定义了规则的文件。比如：

$ make -f rule.txt  # rule.txt中为make规则

Makefile的写法

1 规则

Makefile由一系列的规则构成，一条规则的基本格式如下：

目标 : 依赖文件集合
[tab]  命令

其中，需要在命令之前加一个Tab制表符，并且条件和命令都是可以省略的，但是只能省略其一，条件省略时一般做一些编译以外的其他工作，当命令省略时其实也可以对目标进行编译生成，这涉及到了Makefile中的隐式规则，这里不过多赘述，我们只讨论显式规则。

如make流程所述，当条件中的文件比目标要新时，会执行tab后的命令。

Makefile中有很多规则时，当在shell中执行make命令，默认会将第一条规则的目标作为最终生成的目标。

比如下面这个Makefile例子：

main: main.o sub.o
	gcc -o main main.o sub.o
 
sub.o: sub.c sub.h
	gcc -c -o sub.o sub.c
 
main.o: main.c sub.h
	gcc -c -o main.o main.c
 
clean:
	rm sub.o main.o
 
.PHONY: clean

当我们在shell中执行make时，会最终生成main这个最终目标。 

但是如果我们只想生成某个中间的目标也是可以的，比如只生成sub.o，只需要采用make 最终目标的形式就可以了，即make sub.o

注意到示例中省略了条件的那条规则（目标为clean的那条规则），正规上把它叫做伪目标，用来执行一些其他的任务，如本例中清除编译中生成的.o文件。当然，伪目标下的命令可以是多种多样的，比如将clean下的命令改为ls，当执行make clean时，会列出当前目录下的所有文件。但是有一点需要注意的是，如果我们的目录下已经有了一个叫做clean的文件，当我们执行make clean时，make就分不清这个clean到底是那个了，为了避免这种情况，需要用.PHONY: 伪目标1，伪目标2..的方式来显式的声明伪目标。

2 变量

当我们Makefile中的规则变得非常多时，为了方便，也为了可维护性，我们一般使用变量来代替某些信息。

Makefile中定义变量的格式如下：

变量名 := 变量值

其中:=也该以使用=，依个人喜好。用$(变量名)的形式来使用变量。

先前示例中便可精简如下：

CC := gcc
LD := gcc
CFLAGS := -c
OBJS := main.o \
	sub.o
 
main: $(OBJS)
	$(LD) -o  main $(OBJS)
 
sub.o: sub.c sub.h
	$(CC) $(CFLAGS) -o sub.o sub.c
 
main.o: main.c sub.h
	$(CC) $(CFLAGS) -o main.o main.c
 
clean:
	rm $(OBJS)
.PHONY: clean

 Tip: 有时候我们的规则可能太长，写在一行又不好看，可以使用\来进行换行。

内置变量

Makefile中还提供了一些内置变量，比如$(CC)代表默认的C编译器，$(CXX)代表默认的C++编译器。更多内置变量请参考Implicit Variables (GNU make)

自动变量

Makefile中还提供了一些特殊的变量，不用定义且会根据所在的规则而改变，减少一些目标文件名和条件文件名的输入。以下是六个常用的自动变量：

变量名	作用
$@	目标的文件名
$<	第一个条件的文件名
$?	时间戳在目标之后的所有条件，并以空格隔开这些条件
$^	所有条件的文件名，并以空格隔开，且排除了重复的条件
$+	与$^类似，只是没有排除重复条件
$*	目标的主文件名，不包含扩展名

根据以上自动变量，我们可以将上面的示例改成更简便的形式：

CC := gcc
LD := gcc
CFLAGS := -c
OBJS := main.o \
	sub.o
 
main: $(OBJS)
	$(LD) -o $@ $^
 
sub.o: sub.c sub.h
	$(CC) $(CFLAGS) -o $@ $<
 
main.o: main.c sub.h
	$(CC) $(CFLAGS) -o $@ $<
 
clean:
	rm $(OBJS)
.PHONY: clean

后记

另外，尽管make工具常常用来管理C/C++项目，但是用来管理其他项目也是可以的，比如汇编项目，Pascal项目，甚至是node.js的项目，make就是一个工具，来帮我们管理一些构建的规则，只要规则写的得当，怎么用就随你了。

最后，make虽然可以很好来管理项目了，但是还是不够方便。试想一下，当Makefile中的规则越来越多，又臭又长的时候，make就又显得很难用了，这也就是为什么cmake诞生的原因。通过编写Cmakelist，来指导cmake生成各种Makefile文件和project文件，从而减轻管理Makefile的负担。

Makefile在Menu项目中的应用

作为一个可重用的子系统，其他程序员在重用这个软件子系统时应该不需要了解这个子系统内部代码的组织方式，只需要了解调用接口和生成的目标文件，就可以方便的将子系统集成到自己的软件中。因此，menu子系统还需要有自带的构建系统。我们这里简单介绍Makefile工程文件。

Makefile工程文件是在Unix类操作系统环境下非常常见，是用于工程项目组织的一种方式。很多IDE集成开发环境一般会自动生成一个类似的工程文件。Makefile使用起来非常灵活，可以像写Shell脚本一样手写，也可以使用autoconf和automake自动生成。我们这里简要介绍一下。

Makefile一般从第一个目标开始执行，第一个目标一般定义为all，如下即是一个最简单的Makefile。在项目目录下执行make命令即会自动从Makefile的目标all开始执行，即是执行gcc这一条命令。

all:
  gcc menu.c linktable.c -o menu

Makefile也是源代码的一部分，也要维护，所以提高Makefile代码的可维护性，规范的写法大致像下面的Makefile这样。

#
# Makefile for Menu Program
#

CC_PTHREAD_FLAGS			 = -lpthread
CC_FLAGS                     = -c 
CC_OUTPUT_FLAGS				 = -o
CC                           = gcc
RM                           = rm
RM_FLAGS                     = -f

TARGET  =   test
OBJS    =   linktable.o  menu.o test.o

all:	$(OBJS)
	$(CC) $(CC_OUTPUT_FLAGS) $(TARGET) $(OBJS)

.c.o:
	$(CC) $(CC_FLAGS) $<

clean:
	$(RM) $(RM_FLAGS)  $(OBJS) $(TARGET) *.bak

其中一个特殊的目标.c.o，表示所有的 .o文件都是依赖于相应的.c文件的。

另外Makefile有三个非常有用的变量，分别是$@、$^和$<，代表的意义分别是：

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

目标.c.o和$<结合起来就是一个很精简的写法，表示要生成一个.o目标文件就自动使用对应的.c文件来编译生成。

整个Makefile工程文件在执行make命令或者make all命令时首先找到第一个目标文件all，通过深度优先遍历的方式先去执行目标all所依赖的其他目标，以上代码中all目标依赖$(OBJS)，其中包括linktable.o，menu.o和test.o三个目标，这三个目标都可以通过.c.o来执行，执行完这三个目标得到对应的.o文件后，就可以执行all目标下面的脚本命令得到$(TARGET)，即test。

执行make clean命令，因为clean目标不依赖任何其他目标，直接执行clean目标下的脚本命令。