在一些大型的項目中，它的結(jié)構(gòu)是很復(fù)雜的。比如下面這個
堅守“ 做人真誠 · 做事靠譜 · 口碑至上 · 高效敬業(yè) ”的價值觀，專業(yè)網(wǎng)站建設(shè)服務(wù)10余年為成都PE包裝袋小微創(chuàng)業(yè)公司專業(yè)提供成都定制網(wǎng)站營銷網(wǎng)站建設(shè)商城網(wǎng)站建設(shè)手機網(wǎng)站建設(shè)小程序網(wǎng)站建設(shè)網(wǎng)站改版，從內(nèi)容策劃、視覺設(shè)計、底層架構(gòu)、網(wǎng)頁布局、功能開發(fā)迭代于一體的高端網(wǎng)站建設(shè)服務(wù)。
我們來分析下這個項目的架構(gòu)，項目被劃分為多個不同模塊。每個模塊的代碼用一個文件夾進行管理，文件夾由 inc，src，makefile 組成；每個模塊的對外函數(shù)聲明統(tǒng)一放置于 common/inc 中，如：common.h xxxfunc.h。
那么我們需要打造的編譯環(huán)境是：1、源碼文件夾在編譯時不能被改動（只讀文件夾）；2、在編譯時自動創(chuàng)建文件夾（build）用于存放編譯結(jié)果；3、編譯過程中自動生成依賴關(guān)系，自動搜索需要的文件；4、每個模塊可以擁有自己獨立的編譯方式；5、支持調(diào)試版本的編譯選項。
我們看看解決方案是怎樣設(shè)計的
第 1 階段：將每個模塊中的代碼編譯成靜態(tài)庫文件，如下
第 2 階段：將每個模塊的靜態(tài)庫文件鏈接成最終可執(zhí)行程序，如下
那么第一階段完成的任務(wù)就是完成可用于各個模塊編譯的 makefile 文件，每個模塊的編譯結(jié)果為靜態(tài)庫文件（.a 文件）。那么關(guān)鍵的實現(xiàn)要點就是：a> 自動生成依賴關(guān)系（gcc -MM）；b> 自動搜索需要的文件（vpath）；c> 將目標文件打包為靜態(tài)庫文件（ar crs）。我們來看看模塊的 makefile 的構(gòu)成，如下
我們來看看這個 makefile 是怎樣編寫的
.PHONY : all DIR_BUILD := /mnt/hgfs/winshare/mentu/make1/14/build DIR_COMMON_INC := /mnt/hgfs/winshare/mentu/make1/14/common/inc DIR_SRC := src DIR_INC := inc TYPE_SRC := .c TYPE_INC := .h TYPE_OBJ := .o TYPE_DEP := .dep AR := ar ARFLAGS := crs CC := gcc CFLAGS := -I$(DIR_INC) -I$(DIR_COMMON_INC) ifeq ($(DEBUG),true) CFLAGS += -g endif MODULE := $(realpath .) MODULE := $(notdir $(MODULE)) DIR_OUTPUT := $(addprefix $(DIR_BUILD)/, $(MODULE)) OUTPUT := $(MODULE).a OUTPUT := $(addprefix $(DIR_BUILD)/, $(OUTPUT)) SRCS := $(wildcard $(DIR_SRC)/*$(TYPE_SRC)) OBJS := $(SRCS:$(TYPE_SRC)=$(TYPE_OBJ)) OBJS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(OBJS)) DEPS := $(SRCS:$(TYPE_SRC)=$(TYPE_DEP)) DEPS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(DEPS)) vpath %$(TYPE_INC) $(DIR_INC) vpath %$(TYPE_INC) $(DIR_COMMON_INC) vpath %$(TYPE_SRC) $(DIR_SRC) -include $(DEPS) all : $(OUTPUT) @echo "Success! Target ==> $(OUTPUT)" $(OUTPUT) : $(OBJS) $(AR) $(ARFLAGS) $@ $^ $(DIR_OUTPUT)/%$(TYPE_OBJ) : %$(TYPE_SRC) $(CC) $(CFLAGS) -o $@ -c $(filter %$(TYPE_SRC), $^) $(DIR_OUTPUT)/%$(TYPE_DEP) : %$(TYPE_SRC) @echo "Creating $@ ..." @set -e; \ $(CC) $(CFLAGS) -MM -E $(filter %$(TYPE_SRC), $^) | sed 's,\(.*\)\.o[ :]*,$(DIR_OUTPUT)/\1$(TYPE_OBJ) $@ : ,g' > $@
在 14 文件夾下創(chuàng)建 build 文件夾用于存放生成的文件，在里面繼續(xù)創(chuàng)建 common 文件夾用于存放 common 相關(guān)的編譯產(chǎn)生的文件，我們來看看編譯結(jié)果是怎樣的
我們看到已經(jīng)產(chǎn)生自動依賴的 .dep 文件，和打包生成的 .a 文件了。下來我們將此 makefile 文件直接復(fù)制到 main 和 module 文件夾下，看看是否也可以生成相關(guān)文件呢（在 build 文件夾下創(chuàng)建 main 文件夾）
我們看到已經(jīng)產(chǎn)生自動依賴的 .dep 文件，和打包生成的 .a 文件了。下來我們看看復(fù)制到 module 文件夾是否也可以生成相關(guān)文件呢（在 build 文件夾下創(chuàng)建 module 文件夾）
現(xiàn)在我們的第一階段的模塊自動編譯的 makefile 已經(jīng)編寫完成，功能也都實現(xiàn)了。下來我們看看第二階段的編寫，那么第二階段的任務(wù)如下：1、完成編譯整個工程的 makefile 文件；2、調(diào)用模塊 makefile 編譯生成靜態(tài)庫文件；3、鏈接所有模塊的靜態(tài)庫文件，最終得到可執(zhí)行程序。格式如下
那么其實現(xiàn)的關(guān)鍵要點有哪些呢？1、如何自動創(chuàng)建 build 文件夾以及子文件夾？我們是通過 mkdir 命令來實現(xiàn)的；2、如何進入每一個模塊文件夾進行編譯？通過 cd 命令來實現(xiàn)；3、編譯成功后如何鏈接所有模塊靜態(tài)庫？通過 gcc 命令來實現(xiàn)。那么現(xiàn)在最大的問題就是我們?nèi)绾未_定這個項目中有幾個模塊？在一般的項目中的各個模塊在設(shè)計階段就已經(jīng)基本確定，因此，在之后的開發(fā)過程中不會頻繁隨意的增加或減少。
下來我們來看看解決方案是怎樣的？1、定義變量保存模塊名列表（模塊名變量）；2、利用 Shell 中的 for 循環(huán)遍歷模塊名變量；3、在 for 循環(huán)中進入模塊文件夾進行編譯；4、循環(huán)結(jié)束后鏈接所有的模塊靜態(tài)庫文件。下來我們看看在 makefile 中是如何 嵌入 Shell 的 for 循環(huán)呢，如下
我們先來試試 Shell 中的 for 循環(huán)，代碼如下
MODULES="common main module" for dir in $MODULES; do echo $dir done
編譯結(jié)果如下
我們看到已經(jīng)正確的輸出三個變量名了。下來我們來看看在 makefile 中它是如何執(zhí)行的，代碼如下
MODULES := common \ main \ module test : @set -e; \ for dir in $(MODULES); \ do \ echo $$dir;\ done
我們來看看編譯結(jié)果，是否如我們所期望的那樣正確輸出三個變量名呢？
我們看到在 makefile 中已經(jīng)正確輸出 Shell 中的 for 循環(huán)了。在 makefile 中嵌入 Shell 代碼時，如果需要使用 Shell 變量的值，必須在變量名前加上 $$（例：$$dir）！我們來看看工程 makefile 中的構(gòu)成都有哪些呢？如下
下來我們來看看 compile 的代碼應(yīng)該怎么寫
.PHONY : all compile MODULES := common \ main \ module MKDIR := mkdir RM := rm -rf DIR_PROJECT := $(realpath .) DIR_BUILD := build DIR_BUILD_SUB := $(addprefix $(DIR_BUILD)/, $(MODULES)) all : @echo "Success!" compile : $(DIR_BUILD) $(DIR_BUILD_SUB) @echo "Begin to compile ..." @set -e; \ for dir in $(MODULES); \ do \ cd $$dir && $(MAKE) all DEBUG:=$(DEBUG) && cd .. ; \ done @echo "Compile Success!" $(DIR_BUILD) $(DIR_BUILD_SUB) : $(MKDIR) $@
我們來看看編譯結(jié)果
我們看到已經(jīng)正確編譯出 .a 文件了，如下
下來我們看看怎么實現(xiàn)鏈接的，鏈接時應(yīng)注意：a> gcc 在進行靜態(tài)庫鏈接時必須遵循嚴格的依賴關(guān)系，如 gcc -o app.out x.a y.a z.a。其中的依賴關(guān)系必須為：x.a->y.a，y.a->z.a，默認情況下遵循自左向右的依賴關(guān)系；b> 如果不清楚庫間的依賴，可以使用 -Xlinker 自動確定依賴關(guān)系，如 gcc -o app.out -Xlinker "-(" z.a y.a x.a -Xlinker "-)"。下來我們來看看最后的 makefile 的代碼是怎樣編寫的
重慶分公司
重慶分公司
.PHONY : all compile link clean rebuild
MODULES := common \
main \
module
MKDIR := mkdir
RM := rm -rf
CC := gcc
LFLAGS :=
DIR_PROJECT := $(realpath .)
DIR_BUILD := build
DIR_BUILD_SUB := $(addprefix $(DIR_BUILD)/, $(MODULES))
MODULE_LIB := $(addsuffix .a, $(MODULES))
MODULE_LIB := $(addprefix $(DIR_BUILD)/, $(MODULE_LIB))
APP := app.out
APP := $(addprefix $(DIR_BUILD)/, $(APP))
all : compile $(APP)
@echo "Success! Target ==> $(APP)"
compile : $(DIR_BUILD) $(DIR_BUILD_SUB)
@echo "Begin to compile ..."
@set -e; \
for dir in $(MODULES); \
do \
cd $$dir && $(MAKE) all DEBUG:=$(DEBUG) && cd .. ; \
done
@echo "Compile Success!"
link $(APP) : $(MODULE_LIB)
@echo "Begin to link ..."
$(CC) -o $(APP) -Xlinker "-(" $^ -Xlinker "-)" $(LFLAGS)
@echo "Link Success!"
$(DIR_BUILD) $(DIR_BUILD_SUB) :
$(MKDIR) $@
clean :
$(RM) $(DIR_BUILD)
rebuild : clean all我們來看看鏈接的效果
我們看到已經(jīng)鏈接成功了，并且可以正確的運行可執(zhí)行程序 app.out。我們來直接 make 試試是否可以生成可執(zhí)行程序。
我們看到已經(jīng)生成可執(zhí)行程序 app.out，并且能夠成功運行。我們的 makefile 算是編寫完成了，那么當前整個項目的 makefile 是否存在潛在的問題？是否需要重構(gòu)呢？問題一：我們在之前的模塊中的 makefile 路徑都是寫死的，一旦項目文件夾移動，編譯必將失敗！如下
解決方案：a> 便是在工程 makefile 中獲取項目的源碼路徑；b> 根據(jù)項目源碼路徑，拼接得到編譯文件夾的路徑（DIR_BUILD），拼接得到全局包含路徑（DIR_COMMON_INC）；c> 通過命令行變量將路徑傳遞給模塊 makefile。下來我們看看改過后的代碼
.PHONY : all compile link clean rebuild
MODULES := common \
main \
module
MKDIR := mkdir
RM := rm -rf
CC := gcc
LFLAGS :=
DIR_PROJECT := $(realpath .)
DIR_BUILD := build
DIR_COMMON_INC := common/inc
DIR_BUILD_SUB := $(addprefix $(DIR_BUILD)/, $(MODULES))
MODULE_LIB := $(addsuffix .a, $(MODULES))
MODULE_LIB := $(addprefix $(DIR_BUILD)/, $(MODULE_LIB))
APP := app.out
APP := $(addprefix $(DIR_BUILD)/, $(APP))
all : compile $(APP)
@echo "Success! Target ==> $(APP)"
compile : $(DIR_BUILD) $(DIR_BUILD_SUB)
@echo "Begin to compile ..."
@set -e; \
for dir in $(MODULES); \
do \
cd $$dir && \
$(MAKE) all \
DEBUG:=$(DEBUG) \
DIR_BUILD:=$(addprefix $(DIR_PROJECT)/, $(DIR_BUILD)) \
DIR_COMMON_INC:=$(addprefix $(DIR_PROJECT)/, $(DIR_COMMON_INC)) && \
cd .. ; \
done
@echo "Compile Success!"
link $(APP) : $(MODULE_LIB)
@echo "Begin to link ..."
$(CC) -o $(APP) -Xlinker "-(" $^ -Xlinker "-)" $(LFLAGS)
@echo "Link Success!"
$(DIR_BUILD) $(DIR_BUILD_SUB) :
$(MKDIR) $@
clean :
$(RM) $(DIR_BUILD)
rebuild : clean all我們直接刪除掉三個模塊中的絕對路徑，看看編譯結(jié)果是否和之前一樣
我們看到編譯是成功的。問題二：所有模塊 makefile 都是相同的（復(fù)制粘貼），當模塊 makefile 需要改動時，將涉及多處相同的改動！解決方案：a> 將模塊 makefile 拆分為兩個模板文件，mod-cfg.mk 用于定義可能改變的變量，mod-rule.mk 用于定義相對穩(wěn)定的變量和規(guī)則，mod-cmd.mk 用于定義命令行相關(guān)的變量；b> 默認情況下，模塊 makefile 復(fù)用模板文件實現(xiàn)功能（include）。關(guān)鍵問題是模塊 makefile 如何知道模板文件的具體位置？解決方案便是通過命令行變量進行模板文件位置的傳遞。
mod-cfg.mk 源碼
DIR_SRC := src DIR_INC := inc TYPE_SRC := .c TYPE_INC := .h TYPE_OBJ := .o TYPE_DEP := .dep
mod-rule.mk 源碼
.PHONY : all MODULE := $(realpath .) MODULE := $(notdir $(MODULE)) DIR_OUTPUT := $(addprefix $(DIR_BUILD)/, $(MODULE)) OUTPUT := $(MODULE).a OUTPUT := $(addprefix $(DIR_BUILD)/, $(OUTPUT)) SRCS := $(wildcard $(DIR_SRC)/*$(TYPE_SRC)) OBJS := $(SRCS:$(TYPE_SRC)=$(TYPE_OBJ)) OBJS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(OBJS)) DEPS := $(SRCS:$(TYPE_SRC)=$(TYPE_DEP)) DEPS := $(patsubst $(DIR_SRC)/%, $(DIR_OUTPUT)/%, $(DEPS)) vpath %$(TYPE_INC) $(DIR_INC) vpath %$(TYPE_INC) $(DIR_COMMON_INC) vpath %$(TYPE_SRC) $(DIR_SRC) -include $(DEPS) all : $(OUTPUT) @echo "Success! Target ==> $(OUTPUT)" $(OUTPUT) : $(OBJS) $(AR) $(ARFLAGS) $@ $^ $(DIR_OUTPUT)/%$(TYPE_OBJ) : %$(TYPE_SRC) $(CC) $(CFLAGS) -o $@ -c $(filter %$(TYPE_SRC), $^) $(DIR_OUTPUT)/%$(TYPE_DEP) : %$(TYPE_SRC) @echo "Creating $@ ..." @set -e; \ $(CC) $(CFLAGS) -MM -E $(filter %$(TYPE_SRC), $^) | sed 's,\(.*\)\.o[ :]*,$(DIR_OUTPUT)/\1$(TYPE_OBJ) $@ : ,g' > $@
cmd-cfg.mk 源碼
AR := ar ARFLAGS := crs CC := gcc LFLAGS := CFLAGS := -I$(DIR_INC) -I$(DIR_COMMON_INC) ifeq ($(DEBUG),true) CFLAGS += -g endif MKDIR := mkdir RM := rm -fr
模塊中的 makefile 此時便變成了這樣
include $(MOD_CFG) # Custmization Begin # # DIR_SRC := src # DIR_INC := inc # # TYPE_INC := .h # TYPE_SRC := .c # TYPE_OBJ := .o # TYPE_DEP := .dep # # Custmization End include $(CMD_CFG) include $(MOD_RULE)
我們來看看編譯結(jié)果
我們看到結(jié)果并沒有發(fā)生改變，因此現(xiàn)在的改動是正確的。但是我們在模塊中的 makefile 是采用注釋的方式而不是直接刪除的方式，這樣是為什么呢？是為了可以直接在模塊中的 makefile 可以改變 src 和 inc 文件夾，以便我們后面方便的進行開發(fā)。下來我們對工程 makefile 進行重構(gòu)，通過拆分命令變量以及其他變量和規(guī)則到不同文件。cmd-cfg.mk 文件是定義命令相關(guān)的變量，pro-cfg.mk是定義項目變量以及編譯路徑變量等，pro-rule.mk是定義其他變量和規(guī)則。最后的工程 makefile 通過包含拆分后的文件構(gòu)成（include）。
pro-cfg.mk 源碼
MODULES := common \ module \ main MOD_CFG := mod-cfg.mk MOD_RULE := mod-rule.mk CMD_CFG := cmd-cfg.mk DIR_BUILD := build DIR_COMMON_INC := common/inc APP := app.out
pro-rule.mk 源碼
.PHONY : all compile link clean rebuild
DIR_PROJECT := $(realpath .)
DIR_BUILD_SUB := $(addprefix $(DIR_BUILD)/, $(MODULES))
MODULE_LIB := $(addsuffix .a, $(MODULES))
MODULE_LIB := $(addprefix $(DIR_BUILD)/, $(MODULE_LIB))
APP := $(addprefix $(DIR_BUILD)/, $(APP))
all : compile $(APP)
@echo "Success! Target ==> $(APP)"
compile : $(DIR_BUILD) $(DIR_BUILD_SUB)
@echo "Begin to compile ..."
@set -e; \
for dir in $(MODULES); \
do \
cd $$dir && \
$(MAKE) all \
DEBUG:=$(DEBUG) \
DIR_BUILD:=$(addprefix $(DIR_PROJECT)/, $(DIR_BUILD)) \
DIR_COMMON_INC:=$(addprefix $(DIR_PROJECT)/, $(DIR_COMMON_INC)) \
CMD_CFG:=$(addprefix $(DIR_PROJECT)/, $(CMD_CFG)) \
MOD_CFG:=$(addprefix $(DIR_PROJECT)/, $(MOD_CFG)) \
MOD_RULE:=$(addprefix $(DIR_PROJECT)/, $(MOD_RULE)) && \
cd .. ; \
done
@echo "Compile Success!"
link $(APP) : $(MODULE_LIB)
@echo "Begin to link ..."
$(CC) -o $(APP) -Xlinker "-(" $^ -Xlinker "-)" $(LFLAGS)
@echo "Link Success!"
$(DIR_BUILD) $(DIR_BUILD_SUB) :
$(MKDIR) $@
clean :
@echo "Begin to clean ..."
$(RM) $(DIR_BUILD)
@echo "Clean Success!"
rebuild : clean all工程 makefile 源碼
include pro-cfg.mk include cmd-cfg.mk include pro-rule.mk
我們來看看編譯結(jié)果
我們看到編譯的結(jié)果是沒有發(fā)生改變的，也就是說，代碼的改變是正確的。通過對專業(yè)的編譯環(huán)境的打造，總結(jié)如下：1、大型項目的編譯環(huán)境是由不同 makefile 構(gòu)成的；2、編譯環(huán)境的設(shè)計需要依據(jù)項目的整體架構(gòu)設(shè)計；3、整個項目的編譯過程可以分解為不同階段；4、根據(jù)不同的階段有針對性的對 makefile 進行設(shè)計；5、makefile 也需要考慮復(fù)用性和維護性等基本程序特性。
歡迎大家一起來學(xué)習(xí) makefile 語言，可以加我QQ：243343083。
