前言

最近在寫底層C程式碼需要用到makefile來簡化編譯流程並優化檔案目錄結構，一直沒找到很好的makefile教程（一個通俗易懂的漸進式的教程），通過+c同學終於是找到了他在之前在學校實訓的時候寫的一篇文章，由於網站只能通過校內網查閱，在此決定分享一下，並留作個人往後學習查閱使用。

正文

原文名字：Makefile的使用
原文作者：DaddyTrap

Makefile簡介

Makefile是一個檔名為Makefile的文字檔案，用於定義專案的編譯規則，以便於整個專案的編譯。

（建立方法：touch Makefile 編輯方法：gedit Makefile vim Makefile

如果不使用Makefile，可能我們就需要跟之前一樣手打一大串編譯命令來編譯程式碼——大一時便是深有體會。g++ main.cpp support1.cpp support2.cpp support3.cpp ...這樣的命令每次都要打一遍，如果是在平時的題目倒還好，如果遇到有數十個cpp和hpp的專案那就不好玩了，而且這樣編譯，有些依賴關係不清楚也是一個麻煩。

Makefile中就可以定義好各個檔案的依賴關係，在之後再需要編譯時，只需要執行make命令就可以自動編譯了。

在一次make之後，一般 會生成很多 目標檔案(*.o) 和一個可執行檔案，當這些檔案和原始碼都沒有被修改時，再次執行make

編譯過程

關於編譯過程，本文就不再贅述，僅提供一篇部落格(←這是超連結)吧。

Makefile初級教程

規則 的基本語法：

target ... : prerequisites ...  
    command
    ...
    ...

• target 是下面的命令的 目標 ，即下面命令是為了target而生的。這個 目標 可以是*.o檔案，也可以是可執行檔案
• prerequisites 則是生成該目標所 依賴 的檔案，如果找不到依賴的檔案，下面的命令就不會執行且會中斷 make
• command 就是生成目標檔案的命令，一般就是編譯命令了，如g++ main.cpp等等(注意：命令前面必須有 Tab (‘\t’) 真正 的Tab，這樣make才會認為它是指令)

直接看一個例子會更加直觀。

假設有下列三個檔案和下述的目錄結構

// main.cpp
#include <iostream>
#include <string>
#include "support1.hpp"

int main() {  
  std::string s = "Testing";
  support1::PrintItself(s);
  return 0;
}

// support1.cpp
#include "support1.hpp"
void support1::PrintItself(std::string s) {  
  std::cout << s << std::endl;
}

// support.hpp
#include <iostream>
namespace support1 {  
  void PrintItself(std::string);
}

# 目錄結構
user@computer:~/learnmake$ tree  
.
├── main.cpp
├── Makefile
├── support1.cpp
└── support1.hpp

main.cpp中include了support1，我們的 目的 是編譯出一個可執行檔案main

毫無疑問可以使用g++ main.cpp support1.cpp -o main這樣的命令，於是就寫成了下面的Makefile

# Makefile version 1
main: main.cpp support1.cpp support1.hpp  
  g++ main.cpp support1.cpp -o main

• main就是上文說到的target
• 生成它依賴於所有的程式碼檔案(main.cpp support1.cpp support1.hpp)
• 生成它的命令是g++ main.cpp support1.cpp -o main

這個Makefile簡單易懂，但是不行，這不程式設計師。這樣的關係還是不太清晰。我們一般讓各個cpp檔案生成.o檔案，再將它們連結起來。也就是需要下面的命令

g++ support1.cpp -c             # 生成support1.o  
g++ main.cpp -c                 # 生成main.o  
g++ main.o support1.o -o main   # 連結生成可執行檔案main  

那就按這個改吧

# Makefile version 2
main: main.o support1.o  
    g++ main.o support1.o -o main

support1.o: support1.hpp support1.cpp  
    g++ -c support1.cpp

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

這裡就可以再說說 依賴關係 怎麼體現了。按順序來讀：

1. 需要得到目標main，先看看它所依賴的檔案在不在——並沒有
2. 於是先生成所依賴的檔案main.o和support1.o
3. main.o依賴main.cpp，在目錄中尋找，有則執行命令，無則報錯
4. support1.o同上
5. 依賴檔案已經都存在了，生成目標out
6. 結束

這樣，一個簡單的Makefile就完成了，然而它還有很多可以改進的地方

先看下面這一個Makefile

# Makefile version 3
CC := g++  
FLAGS := -std=c++11 -w

main: support1.o main.o  
    $(CC) $(FLAGS) main.o support1.o -o [email protected]

support1.o: support1.hpp support1.cpp  
    $(CC) $(FLAGS) -c support1.cpp

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

clean:  
    @rm -f *.o
    @rm -f *.gch
    @rm -f main

突然出現的這些語法，下面我們逐個說說

• 變數（如CC := g++、$(CC)）
• 在Makefile中可以使用"<name> := <content>"宣告變數，並在此後使用$(<name>)可以使用，類似C/C++中的巨集，它是字串的直接替換。如$(CC) $(FLAGS) -c support1.cpp會變成g++ -std=c++11 -w -c support1.cpp。
• 字首是$符號，後面帶個括號()的都是變數，如[email protected]也是變數，稱為 自動化變數，它是目標檔案的名字。如目標為main的這一段的命令會變成g++ -std=c++ -w main.o support1.o -o main
• 偽目標(沒有依賴檔案的目標clean
• clean一段中，target後面沒有依賴檔案，這稱為 偽目標，作用是寫了之後就可以使用make clean來執行它的命令集了
• 這裡的命令集可以使用許多shell命令，但似乎並不是所有都能用
• 命令前面的@表示 不顯示這條命令 ，和Windows下的.bat類似(下面分別是不使用@和使用@的對比)

在Makefile中加入
foo:  
  echo "Testing"
# 同樣地，這是偽目標，可以使用make foo來執行其命令集

user@computer:~/learnmake$ make foo  
echo "Testing"  
Testing

Makefile中改為  
foo:  
  @echo "Testing"

user@computer:~/learnmake$ make foo  
Testing

複雜一點的情況

有時候一個專案的目錄並沒有如此簡單，例如：

.
├── bin
├── build
├── include
├── lib
│   ├── mysql
│   └── mysql++
└── src

• bin是編譯生成的可執行檔案
• build是編譯的中間檔案如*.o檔案
• include是各種.h或.hpp檔案
• lib是一些必要的庫檔案
• src是.cpp檔案

這個時候，事情並不簡單。因為現在的程式碼“身首異處”，所以要把它們的路徑告訴編譯器才行，我們使用 相對路徑 來達到效果。

.表示當前目錄，..表示上一級目錄，用類似這樣的相對路徑來找到需要的檔案，當然./經常可以省略……(於是本文並沒有者兩個的使用)

以下面的目錄結構為目標(假設原本不存在bin目錄和build目錄)：

.
├── bin
│   └── main
├── build
│   ├── main.o
│   └── support1.o
├── include
│   └── support1.hpp
├── Makefile
└── src
    ├── main.cpp
    └── support1.cpp

因為最後的目標 main 在 bin 目錄中，所以 target 也應該是 bin/main，而其依賴的兩個檔案也要寫清楚目錄了 build/main.o build/support1.o。

而在編譯前，應該確認 bin 和 build 都是存在的目錄，因此需要在編譯前多一條命令 mkdir -p bin。因為要指明檔案目錄，於是編譯命令變成g++ -std=c++11 -w build/main.o build/support1.o -o bin/main

那麼編譯生成support1.o的時候命令就是g++ -std=c++11 -w src/support1.cpp -c -o build/support1.o

:-)騙你的

由於在support1.cpp中我們寫了#include "support1.hpp"，按以前的經驗，這樣寫是隻能找到同一個資料夾下的檔案的，所以需要加一個編譯器的引數-I./include，讓它去其他地方找標頭檔案。這樣編譯命令就完成了，生成.o檔案的也類似。那麼Makefile就可以寫出來了

CC := g++  
FLAGS := -std=c++11 -w  
bin/main: build/support1.o build/main.o  
    @mkdir -p bin
    $(CC) $(FLAGS) -I./include build/support1.o build/main.o -o [email protected]

build/support1.o: src/support1.cpp  
    @mkdir -p build
    $(CC) $(FLAGS) -I./include -c -o [email protected] src/support1.cpp

build/main.o: src/main.cpp  
    @mkdir -p build
    $(CC) $(FLAGS) -I./include -c -o [email protected] src/main.cpp

clean:  
    @rm -rf build
    @rm -rf bin

(可能有朋友注意到這裡的support1.hpp去掉了，因為編譯的時候就會找support1.hpp，找不到就會編譯錯誤，所以它是否寫在依賴規則裡並不影響結果，也就可有可無了 訂正：在這裡只是為了達到使用下文萬用字元%就包含兩個cpp的效果，實際上寫這個也是必要的，例如：support1.hpp 被修改後，再次使用make，如果不寫，那麼make就不會重新編譯了)

這樣就好了嗎？不，不可以。將來要是檔案結構有了偏差，寫這個Makefile的人是要負責的。如果目錄不同了，那麼改各個路徑要每個都改，而最好的做法應該是隻改一處就影響全域性。所以應該下面這樣會更好。

CC := g++  
FLAGS := -std=c++11 -w  
INC_DIR := include  
SRC_DIR := src  
BUILD_DIR := build  
BIN_DIR := bin  
INCLUDE := -I./$(INC_DIR)  
$(BIN_DIR)/main: $(BUILD_DIR)/support1.o $(BUILD_DIR)/main.o
    @mkdir -p $(BIN_DIR)
    $(CC) $(FLAGS) $(INCLUDE) $(BUILD_DIR)/support1.o $(BUILD_DIR)/main.o -o [email protected]

$(BUILD_DIR)/support1.o: $(SRC_DIR)/support1.cpp
    @mkdir -p $(BUILD_DIR)
    $(CC) $(FLAGS) $(INCLUDE) -c -o [email protected] $(SRC_DIR)/support1.cpp

$(BUILD_DIR)/main.o: $(SRC_DIR)/main.cpp
    @mkdir -p $(BUILD_DIR)
    $(CC) $(FLAGS) $(INCLUDE) -c -o [email protected] $(SRC_DIR)/main.cpp

clean:  
    @rm -rf $(BUILD_DIR)
    @rm -rf $(BIN_DIR)

對於不同的情況，只要一個一個目標、一個一個依賴來寫就好了

下面用的是萬用字元，並不適用於所有情況，還請各位謹慎使用

然而這個Makefile還可以更加簡短並更加完善，如下面程式碼(出現的新東西，後面細說)

CC := g++  
FLAGS := -std=c++11 -w  
INC_DIR := include  
SRC_DIR := src  
BUILD_DIR := build  
BIN_DIR := bin  
INCLUDE := -I./$(INC_DIR)

$(BIN_DIR)/main: $(BUILD_DIR)/support1.o $(BUILD_DIR)/main.o
    @mkdir -p $(BIN_DIR)
    $(CC) $(FLAGS) $(INCLUDE) $^ -o [email protected]

$(BUILD_DIR)/%.o: $(SRC_DIR)/%.cpp
    @mkdir -p $(BUILD_DIR)
    $(CC) $(FLAGS) $(INCLUDE) -c -o [email protected] $<

clean:  
    @rm -rf $(BUILD_DIR)
    @rm -rf $(BIN_DIR)

• 兩個自動化變數
• $^依賴檔案的集合，用空格分隔
• $<第一個依賴檔案
• 其實在%.o部分，也可以換成$^
• 還有上文已經提過的 [email protected]目標檔案
• 萬用字元%
• 作用是就是*的作用了……通配……

這裡的好處就是當src目錄下再多cpp檔案時，生成%.o檔案的這一部分不用更改，生成可執行檔案那裡只要加一個依賴就好了

實際上還有方法讓生成可執行檔案的規則也自動，但又會聊到更加深的內容了

或許這篇新手向的教程並不讓你盡興，因此如果你想了解更多的Makefile知識，可以參考下面兩篇文章