Linux | 项目自动化构建工具 - make/Makefile

Posted 2023-03-14 烽起黎明

make / Makefile

• 一、前言
• 二、make/Makefile背景介绍
• • 1、Makefile是干什么的？
  • 2、make又是什么？
• 三、demo实现【见见猪跑🐖】
• 三、依赖关系与依赖方法
• • 1、概念理清
  • 2、感性理解【父与子】
  • 3、深层理解【程序的翻译环境 + 栈的原理】
• 四、多学一招：项目清理
• • 1、演示与原理讲解
  • 2、.PHONY伪目标的作用
  • 3、.PHONY伪目标的原理
• 五、make的工作原理分析
• • 1、再谈make与Makefile
  • 2、探究make的判断机制🔍
  • 拓展：VS下可执行文件生成问题
• 六、总结与提炼

一、前言

在上一讲中，我们介绍了Linux下的编译器 - gcc/g++的使用，本节我们来介绍一下如何使用make/Makefile实现项目的自动化构建

• 知道了如何在Linux上编译C语言代码，而且清楚了可执行文件a.out的由来，是从
  • test.c经过预编译到test.i
  • test.i经过编译到test.s
  • test.s经过汇编到test.o
  • test.o经过链接到a.out
• 可是看着上面的这些编译 + 链接的过程，是不是觉得很冗余复杂，我们平常做做练习还好，但若是到了那些大型工程中，可是具有上千、上万条代码，若是一次编译完成之后又修改了源代码，接着又想进行编译，此时便需要重新敲入指令，那会使得工作量变得很大。可是在VS中，我们可以无限地修改自己的代码，然后随时编译运行，不需要考虑这些复杂的原理
• 那Linux中有没有这样的一站式操作呢，那就是【make/Makefile】👈

二、make/Makefile背景介绍

首先我们来介绍一下什么是make/Makefile，以及它们之间的关系

1、Makefile是干什么的？

• Makefile 是一个文件。它是一个工程文件的编译规则，它记录了原始码如何编译的详细信息、描述了整个工程的编译链接等规则。
• Makefile 带来的好处就是——“自动化编译"。一旦写好，只需要一个make命令，整个工程完全自动编译，极大的提高了软件开发的效率🚀

🎯先来看一下Makefile的【语法】：

target（目标文件)：文件1 文件2（依赖文件列表）		//依赖关系

<Tab>gcc -o 欲建立的执行文件 目标文件1 目标文件2		///依赖方法
	 command
	 ...
	 ...

• target就是我们想要建立的信息，一般称作目标文件。而后面的依赖文件列表就是具有相关性的 object files，也就是目标文件所依赖的文件（可以是一个或多个，也可以没有）

🎯然后看一下Makefile的【规则】：

• 目标文件与依赖文件列表文件之间要使用冒号隔开目标文件：依赖文件列表
• target可以是一个目标文件、执行文件，甚至可以是一个标签【后面会提到的伪目标】
• 依赖方法前面必须加Tab空格键
• 依赖方法以gcc为例，也可以是其他的shell指令【command】

会不会写Makefile ，从一个侧面说明了一个人是否具备完成大型工程的能力💪

2、make又是什么？

• make是一个命令工具，是一个解释makefile中指令的命令工具，一般来说，大多数的IDE都有这个命令，比如：Delphi的make，Visual C++的nmake，Linux下GNU的make。可见，Makefile都成为了一种在工程方面的编译方法

---

【总结一下】：make是一条命令，makefile是一个文件，两个搭配使用，完成项目自动化构建👈

三、demo实现【见见猪跑🐖】

了解可什么是make/Makefile之后，我们就来用一用它们

• 刚才说到make命令是用来解释Makefile中指令的，所以我们需要创建一个。我喜欢用大写的Makefile，当然你写成makefile也是可以的
• 这里直接vim Makefile即可，进入编辑界面，如果有不懂vim的，可以看看我的文章 —— 人生苦短，我用Vim

• 此时我们可以再创建一个test.c，作为源文件，然后开始往里面写内容
• 现在我要通过gcc去编译这个test.c的文件，然后生成一个我自己命名的【mytest】这个可执行文件，此时我们只需要在Makefile写上这两行即可

mytest:test.c
	gcc -o mytest test.c

• 然后回到命令行，我们来执行一下这个make指令，它就是自动在当前源文件的所在路径下搜寻Makefile，并解释里面命令。之后若是我们需要去编译任何文件，只需要在Makefile里面做一个添加即可，怎么样，是不是很方便

三、依赖关系与依赖方法

通过小小的demo，想必你已经感受到了【自动化构建工具】的强大，我们来仔细看看Makefile中的指令为何要如此书写✍

1、概念理清

• 对于mytest:test.c，冒号左侧是目标文件，右侧是它的依赖文件，所以就可以说它们之间存在一种【依赖关系】，只有test.c存在才可以有mytest
• 那要如何通过test.c去生成mytest呢❓ 此时就需要使用到下面的这句gcc指令gcc -o mytest test.c 👉它叫做【依赖方法】

2、感性理解【父与子】

就这么说还是不太好理解，我们举个父与子的生活小案例来帮助理解

今天呢，是这个月的28号的了，家里面在月初给你的2000块钱差不多也花完了，于是这两天只能吃土，此时你打开微信后看到和老爸的聊天框，于是就想着和老爸要点钱【毕竟儿子向父亲要钱天经地义😀】

• 这里的老爸和儿子指的就是[依赖关系]
• 儿子向老爸要钱指的就是[依赖方法]

---

下面辨析几种依赖关系与依赖方法

❌错误的依赖方法

• 此时你打电话和你老爸说：“我是你儿子，你帮我写作业。”
• 以上这句话就是依赖关系正确，但是依赖方法不正确。老爸帮儿子写作业无法执行

所以只有依赖关系不行，还得有正确的依赖方法

❌错误的依赖关系

• 此时你拿起室友的手机和他爸爸打电话说：“我是你儿子，你给我点零花钱。”
• 以上这句话就是依赖方法正确，但是依赖关系不正确。因为别人的老爸没义务给你钱

依赖方法对了，但是依赖关系不对也不行

✔ 正确的依赖关系与依赖方法

• 经历了种种挫折后，你重新拿起手机说：“老爸，我是你儿子，可以给我点零花钱吗？”
• 上面这种说法就是完全正确的依赖关系与依赖方法

完成一件事，必须得有正确的依赖关系 + 正确的依赖方法

3、深层理解【程序的翻译环境 + 栈的原理】

看完了【依赖关系】与【依赖方法】的感性理解，相信你对它们有了一定程度的认识，接下去深入地来了解一下它们之间的关系

  1 mytest:test.o
  2     gcc test.o -o mytest

• 开头提到过源程序是如何经过一步步的编译来形成可执行文件的吗，因为可执行文件mytest是依赖于汇编后的目标文件test.o的，但是现在我们没有这个文件，因此就要去倒推一下如何获取这个test.o
• 对于test.o来说，它依赖于test.s这个经过编译之后文件，可是【test.s】不存在，所以跳转到下一条依赖关系

  3 test.o:test.s
  4     gcc -c test.s -o test.o

• 对于test.s来说，它依赖于test.i这个经过预编译之后的文件，可是【test.i】不存在，所以跳转到下一条依赖关系

  5 test.s:test.i
  6     gcc -S test.i -o test.s

• 对于test.i来说，它依赖于test.c这个源文件，查找后发现源文件存在，于是开始执行gcc命令

  7 test.i:test.c
  8     gcc -E test.c -o test.i

以下就是我们需要在Makefile中修改的【依赖关系】与【依赖方法】

• 最后来到命令行中执行一下【make】命令，便完成了所有的编译，对于之前一步步地写这个编译的过程，真的是来得方便很多

• 因为只有当执行完了最后一条命令后生成了【test.i】的文件之后才可以一一往上继续执行，这种反着来的执行逻辑就相当于是我们在数据结构中学过的栈，有一个先进后出的逻辑
• 而这种匹配的过程又更像是我们之前所讲到过的一道题有效的括号，若是左括号就入栈，若是碰到右括号就进行一个出栈匹配

【总结一下】：在[依赖关系]中，若是目标文件所依赖的文件不存在，就将这个依赖方法入栈，转到下一组[依赖关系]，依次循环往复，直到当前目标文件所依赖的文件存在时，就进行出栈，开始执行依赖方法。最后获取的便是那个我们最初想要的目标文件

四、多学一招：项目清理

1、演示与原理讲解

平时我们在进行各种操作之后目录中都会出现很多文件，此时当我们不想要这些文件的时候，就得去一一删除，显得尤为麻烦，如果编译可以使用Makefile来自动化构建，那清理项目中的文件可不可以呢，我们来看看

• 此时我们在Makefile中增加一个【清理】功能

• 来看一下是否可以达到清理的目的

• 当我想使用清理功能的时候，并没有像自动化编译那样直接make，而是在make后面加上了一个clean，这是为什么呢？
• 新加上的.PHONY是什么？它对clean而言意味着什么？

我们带着这些问题一起进入【伪目标】的学习📖

2、.PHONY伪目标的作用

• PHONY是一个伪目标，Makefile中将.PHONY放在一个目标前就是指明这个目标是伪文件目标。其作用就是防止在Makefile中定义的执行命令的目标和工作目录下的实际文件出现名字冲突

• 也就是下面这句，此时的clean被.PHONY修饰了，那么它就可以反复执行它的依赖方法

.PHONY:clean

• 可以看到对于目标文件clean来说，它的依赖文件列表为空，上面我们也有提到过它可以为空

 11 clean:
 12     rm -f test.o test.s test.i

• 所以只要你一直使用【make clean】，它便会反复地执行rm -f test.o test.s test.i
• .PHONY配置项的目标clean并不是其他文件生成的实际文件，使make命令会自动绕过隐含规则搜索过程，也就是说执行命令make clean会自动忽略名为"clean"文件的存在，因此声明.PHONY配置项会改善性能，并且不需要担心实际同名文件存在与否😮
• 【通俗一点说】：.PHONY修饰的目标clean并不是某个依赖项生成的实际文件，因此make命令不再去搜寻当前文件夹下是否有clean文件，这样少去做一些事，自然会改善性能，并且不用担心当前文件夹下是否有同名的文件

我们到命令行中来验证一下⌨️

• 可以看到，我进行了三次make clean，不过其实在第一次执行的时候，就已经达成了我们清理的目的，可是后面还可以继续执行，这其实就是.PHONY修饰起的作用
• 其实对于【clean】来说，不加修饰其实也是可以辺反复执行的，这点我们在本模块开头的时候有说到过。我现在将这个修饰去掉，来试试看

• 可以看到，即使是去掉了.PHONY做修饰之后一样是可以反复执行

那就有同学问：这是为什么呢？为何clean不加.PHONY修饰也可以多次执行

• 原因就在于它的依赖对象为空，当我们需要生成这个【clean】目标文件的时候就不需一些文件必须要存在，因此就可以一直[clean]

---

3、.PHONY伪目标的原理

• 可是呢，对于其他的指令就不行了，例如我们上面说到过的gcc去编译一个文件的过程

• 我们试着在【mytest】前面加上一个.PHONY的修饰试试

• 然后再去试试能不能进行反复使用【这里给读者详细解释一下.PHONY修饰的原理】
• 我们来详细分析一下，首先可以清楚的是加上.PHONY修饰之后便可以多次make，但是可以看到在编译的过程中进行make的时候所执行的指令不太相同，只有gcc test.o -o mytest这一句，却少了如何产生【test.o】的过程，这是为何呢❓
• 因为在经过一次make之后，gcc对【test.c】进行了预编译、编译、汇编，最后生成了【test.o】，那它就已经在那里了，在此中间我们没有再对源文件进行再度修改，在编译的时候，其实会去查看目标对象和依赖对象的生成时间，若是依赖对象的生成时间要早于目标对象，说明它还没有被重新修改过，所以无需再度去重新编译生成（这一块在后面make的工作原理中细讲）
• 因此我们再去make的话gcc是不会重新编译的，可以当我去修改了一下【test.c】这个源文件之后，再度去make一下的话gcc又会对这个源文件进行一个重新的全过程编译。
  ❗编译这一块比较复杂，需要重点理解❗

• 不过其实可以看出，每次去修改一下就重新编译全部的文件，也是挺繁琐的。所以我们在开发的时候一般不给编译生成的目标文件带.PHONY的修饰，就防止其被多次重复编译

【总结一下】：

📚 .PHONY修饰的是伪目标，对于伪目标来说，它可以被反复执行

📚 .PHONY修饰的一定能被反复执行，但是能被反复执行的不一定被.PHONY修饰

以上就是有关伪目标的叙述，如果还不太清楚可以看看这篇文章 ——> 链接

五、make的工作原理分析

1、再谈make与Makefile

• 通过【ldd】去查看make指令的动态依赖关系，我们可以发现make指令也是依赖于标准的C库，而我们在Makefile中写得也都是一些指令，因此使用make指令才可以对Makefile中的内容做一个识别

因此我们可以得出一个结论

👉make是专门给【Makefile】写的一个命令，在执行make的时候，就会自动在你当前目录下去搜索Makefile这个文件，搜索之后打开，然后对它里面的内容做分析

那make是如何进行分析Makefile的呢，有什么规则吗❓

• make扫描Makefile文件时会默认执行第一组依赖关系和依赖方法
• 还记得我们
  • 在获取mytest这个目标对象的时候都是直接使用的【make】吗；
  • 而在获取clean这个目标对象时却用的是【make clean】
• 那你是否会感到疑惑为何不使用【make mytest】就可以获取到吗，就是因为默认执行的就是第一组的依赖关系和依赖方法
• 我们可以试着把【clean】和【mytest】调个位置

• 可以看到，在调换了位置之后我们直接【make】的话获取的就是clean对象了，想要去使用gcc编译源文件生成可执行文件就需要用到【make mytest】。
• 不过也并不是第一组依赖关系和依赖方法就一定要直接【make】，我们使用【make clean】也是可以用的

2、探究make的判断机制🔍

好，我们来深入探讨一下刚才遗留下的问题：make究竟是如何知道我们的可执行文件是否需要重新编译呢❓

• 再来回顾一下，当我们执行完一次【make】获取mytest这个目标文件后，第二次再去执行【make】指令就不会其效果了，这是为何呢？

• 我们可以将源文件和可执行文件当做是一条时间轴。对于可执行文件来收，它生成的时间一定是晚于源文件的【因为中间要经过一系列编译 + 链接的过程】

• 我们可以通过【stat】这个指令来查看源文件和可执行文件的所有属性，不过要观察的还是其中一个叫做ACM时间
  • Access: 最后一次访问该文件的时间
  • Change：最后一次改变该文件属性或状态的时间
  • Modify：最近一次修改文件内容的时间【比较的是这个时间】
• 可以很清晰地看出20:17:56是要晚于17:45:48的。所以【make】指令才会不起作用。所以它就是通过这个Modify时间来进行对比才能判断出是否需要重新编译

那我们能否钻个空子，来欺骗一下make呢😜

• 此处我们可以使用这个【touch】指令，它除了创建文件之外还有其他功能
  • 若是要创建的这个文件不存在，那就将其创建出来
  • 若是要创建的这个文件存在，那就修改它的ACM时间为最新的时间

我们来试试看。可以很清楚地看到源文件的Modify时间从17:45:48变到了20:17:56，那就比可执行文件要来得晚了，此时再去【make】的话就会重新编译了

拓展：VS下可执行文件生成问题

我们在VS下有时候经常会出现修改了源代码但是生成不了.exe可执行文件的问题，既然说到了【源文件】和【可执行文件】的关系，就顺带拓展一下

• 原因是你在编译的时候可能有的文件的时间被改了，但是可能那个时间的更改要么有BUG，要么VS在识别你的源代码时把它的时间依旧识别成老的源代码时间了，所以不会对源代码进行重新编译（👉is up to date）。
• 所以形成的新的源代码的.obj文件没有更新，最后再怎么去链接去形成.exe可执行文件都执行不了【清理一下项目的其余文件就可以了，只保留源文件然后重新编译一下】

六、总结与提炼

最后我们来总结一下本文所学习的内容📖

本文我们学习了Linux下的项目自动化构建工具 - make/Makefile

• 首先清楚了【Makefile】它是一个文件，我们可以在里面写入一些编译的规则。而【make】则是一个命令，它可以用来解析Makefile中的内容
• 接着，在通过初次写一个小案例去接触make/Makefile的时候我们了解到了【依赖关系】和【依赖方法】，不仅感性地去理解了它们，而且深入地清楚了它们的底层实现逻辑是基于数据结构中的栈
• 然后，不仅仅局限于一个目标文件，我们又学了一招，知道了如何去清理项目中的文件，知道了.PHONY修饰的文件叫做【伪目标文件】
• 最后，我们通过再度触及make/Makefile，真正搞清楚了它们之间的关系，也了解到make在判断一个文件是否需要重新编译的时候是基于比较源文件与目标文件的【Modify时间】

以上就是本文要讲解的所有内容，感谢您的观看