輕鬆玩轉Makefile | 企業項目級Makefile實例

来源:https://www.cnblogs.com/Wayne123/archive/2023/03/04/17178278.html
-Advertisement-
Play Games

前言 本文展示了一個比較完整的企業項目級別的Makefile文件，包括了：文件調用，源文件、頭文件、庫文件指定，軟體版本號、巨集定義，編譯時間，自動目錄等內容。 1、目錄架構 本文中所採用的目錄架構，在企業項目開發中十分常見：源文件都放在src目錄中，頭文件都放在inc目錄中，並且這兩個目錄都可以有對 ...


前言

本文展示了一個比較完整的企業項目級別的Makefile文件，包括了：文件調用，源文件、頭文件、庫文件指定，軟體版本號、巨集定義，編譯時間，自動目錄等內容。

1、目錄架構

本文中所採用的目錄架構，在企業項目開發中十分常見：源文件都放在src目錄中，頭文件都放在inc目錄中，並且這兩個目錄都可以有對應的子目錄。庫文件放在lib目錄中，makefile相關文件放在build目錄中，編程生成的程式放在自動生成的output目錄中。目錄結構展示如下：

.
├── build
│   ├── Makefile
│   └── srcpathconfig.mk
├── code
│   ├── inc
│   │   ├── com
│   │   └── func
│   │       └── fun.h
│   └── src
│       ├── com
│       │   └── main.c
│       └── func
│           └── fun.c
└── lib
    ├── inc
    │   └── mylib.h
    └── libs
        └── libmylib.so

2、源文件及Makefile內容

本文所用到的所有文件，也可以直接到我的公眾號，後臺回覆“ mk ”獲取。

源文件

/* fun.h */
#ifndef __FUN_H__
#define __FUN_H__

void fun();

#endif


/* fun.c */
#include <stdio.h>

void fun()
{

#ifdef MACRO_DEF
    printf("macro definition enable!\n");
#endif


#ifdef COMPILER_IS_ARM_LINUX_GCC
    printf("The compilation target is arm!\n");
#endif

#ifdef COMPILER_IS_LINUX_GCC
    printf("The compilation target is linux!\n");
#endif

	printf("This is fun()!\n");
}

/* mylib.h */
void mylib();


/* libmylib.so */
// mylib()函數,列印This is mylib()！

/* main.c */
#include "fun.h"
#include "mylib.h"

int main()
{ 
    fun();
	mylib();
    return 0; 
}

srcpathconfig.mk

這個文件的內容，其實也可以放在Makefile中，本案例單獨用一個文件來配置路徑，是為了後期好管理

#源文件目錄
SRCCODEDIRS   :=../code/src/func \
                ../code/src/com \
	

#頭文件目錄
SRCHEADDIRS   :=../code/inc/func \
				../code/inc/com \

#lib文件目錄
LIBFILEDIRS := ../lib/libs

#lib頭文件目錄
LIBHEADDIRS := ../lib/inc/

#lib文件
LIBFILE := -lmylib

Makefile

#引用其他文件
include srcpathconfig.mk

#時間信息
tmpbuildtm := `date |sed 's/ /_/g'`
TMPBUILDTM = $(tmpbuildtm)

#軟體版本
APPVERSION = 1.0.0.0


#不同的目標採用不同的巨集定義
ifeq ($(MAKECMDGOALS),arm)
COMPILEMACRO += COMPILER_IS_ARM_LINUX_GCC
else
COMPILEMACRO += COMPILER_IS_LINUX_GCC MACRO_DEF
endif


#迴圈獲取源文件和中間件
SRCFILE := $(foreach d,$(SRCCODEDIRS),$(wildcard $(addprefix $(d)/*,.c)))
OBJFILE := $(patsubst %.c,%.o,$(SRCFILE))

#巨集定義,源文件路徑，頭文件路徑
CURCMPLMACRO   := $(addprefix -D ,$(COMPILEMACRO))
CURSRCHEADDIRS := $(addprefix -I ,$(SRCHEADDIRS))
CURLIBHEADDIRS := $(addprefix -I ,$(LIBHEADDIRS))

#程式輸出路徑
OUTPUTDIR := ../output

#編譯器及選項
CC := gcc
CFLAGS := -Wall -c

RM := rm
RMFLAGS := -rf

#目標文件	
TARGETNAME = app

$(TARGETNAME):$(OBJFILE)
	@mkdir -p $(OUTPUTDIR)
	@echo ""
	@echo "all files have been compiled , now begin to link every obj for excutable file"
	@echo ""
	@echo "linking............"
	@echo $(OBJFILE)
	@$(CC)  -o $(OUTPUTDIR)/$(TARGETNAME).$(APPVERSION) $(OBJFILE) -L$(LIBFILEDIRS) $(LIBFILE)
	@echo ""
	@echo "linked ok," $(TARGETNAME) "has been created"
	@echo ""
	@echo $(TMPBUILDTM)
	
%.o: %.c
	@echo ""
	@echo "start " $< "......compiling"
	@$(CC) $(CURCMPLMACRO) $(CFLAGS) $(CURSRCHEADDIRS) $(CURLIBHEADDIRS) $< -o $@
	@echo "created " $@
	@echo "end   " $< "......compiled ok"
	@echo ""

.PHONY: arm clean

arm:$(TARGETNAME)

clean:
	@-$(RM) $(RMFLAGS) $(TARGETNAME) $(OBJFILE) $(OUTPUTDIR)

3、效果演示

輸入make 或者 make arm ，列印如下

start  ../code/src/func/fun.c ......compiling
created  ../code/src/func/fun.o
end    ../code/src/func/fun.c ......compiled ok


start  ../code/src/com/main.c ......compiling
created  ../code/src/com/main.o
end    ../code/src/com/main.c ......compiled ok


all files have been compiled , now begin to link every obj for excutable file

linking............
../code/src/func/fun.o ../code/src/com/main.o

linked ok, app has been created

Fri_Mar__3_22:14:09_PST_2023

生成的文件架構如下

.
├── build
│   ├── Makefile
│   └── srcpathconfig.mk
├── code
│   ├── inc
│   │   ├── com
│   │   └── func
│   │       └── fun.h
│   └── src
│       ├── com
│       │   ├── main.c
│       │   └── main.o
│       └── func
│           ├── fun.c
│           └── fun.o
├── lib
│   ├── inc
│   │   └── mylib.h
│   └── libs
│       └── libmylib.so
└── output
    └── app.1.0.0.0

運行output中生成的app.1.0.0.0程式

/* 由make命令編譯生成的app.1.0.0.0 */

macro definition enable!
The compilation target is linux!
This is fun()!
This is mylib()

/* 由make arm命令編譯生成的app.1.0.0.0 */

The compilation target is arm!
This is fun()!
This is mylib()

4、Makefile內容解析

4.1 文件調用

include srcpathconfig.mk

相當於把srcpathconfig.mk的內容都拿過來，srcpathconfig.mk中的變數，在Makefile文件中都可以直接使用。

4.2 編譯時間

tmpbuildtm := `date |sed 's/ /_/g'`
TMPBUILDTM = $(tmpbuildtm)

@echo $(TMPBUILDTM)

這個是把當前的時間，保存到TMPBUILDTM變數中，可以運用到源碼中，本案例只是列印一下此變數。

4.3 軟體版本

APPVERSION = 1.0.0.0
@$(CC)  -o $(OUTPUTDIR)/$(TARGETNAME).$(APPVERSION) $(OBJFILE) -L$(LIBFILEDIRS) $(LIBFILE)

開發過程中，我們會有多個版本的程式，可以在程式加上版本號作為尾碼。

4.4 巨集定義

ifeq ($(MAKECMDGOALS),arm)
COMPILEMACRO += COMPILER_IS_ARM_LINUX_GCC
else
COMPILEMACRO += COMPILER_IS_LINUX_GCC MACRO_DEF
endif

CURCMPLMACRO   := $(addprefix -D ,$(COMPILEMACRO))

%.o: %.c
	@$(CC) $(CURCMPLMACRO) $(CFLAGS) $(CURSRCHEADDIRS) $(CURLIBHEADDIRS) $< -o $@

makefile中也可以使用條件判斷，具體用法這裡不多做介紹。

MAKECMDGOALS，是make命令後面跟的目標，比如make arm，那麼MAKECMDGOALS的值就為arm。

這裡利用MAKECMDGOALS的值來選擇使用哪些巨集定義，假如make 後面跟的是arm，巨集定義則是COMPILER_IS_ARM_LINUX_GCC，假如make後面跟的不是arm，巨集定義則是COMPILER_IS_LINUX_GCC和MACRO_DEF。

這些巨集定義在fun.c中有使用，對應的是列印不同的內容。在實際項目中，巨集定義的作用很廣，可以用來跨平臺開發，也可以用來調試列印。

4.5 源文件及中間件

SRCFILE := $(foreach d,$(SRCCODEDIRS),$(wildcard $(addprefix $(d)/*,.c)))
OBJFILE := $(patsubst %.c,%.o,$(SRCFILE))

由於我們的源文件是放在src目錄下的不同子目錄中，所以使用了foreach函數來迴圈獲取。簡單說明一下，foreach後面跟著的d，是中間變數，這一行的作用就是將SRCCODEDIRS的路徑下的.c文件，逐個逐個拿出來，加上對應的路徑首碼。

關於foreach的函數的具體使用方法，不做過多介紹。

4.6 頭文件

SRCHEADDIRS   :=../code/inc/func \
				../code/inc/com \
				
LIBHEADDIRS := ../lib/inc/				

CURSRCHEADDIRS := $(addprefix -I ,$(SRCHEADDIRS))
CURLIBHEADDIRS := $(addprefix -I ,$(LIBHEADDIRS))

%.o: %.c
	@$(CC) $(CURCMPLMACRO) $(CFLAGS) $(CURSRCHEADDIRS) $(CURLIBHEADDIRS) $< -o $@

將普通頭文件和庫頭文件的存放路徑單獨用變數表示

4.7 庫文件

LIBFILEDIRS := ../lib/libs
LIBFILE := -lmylib

$(TARGETNAME):$(OBJFILE)
	@$(CC)  -o $(OUTPUTDIR)/$(TARGETNAME).$(APPVERSION) $(OBJFILE) -L$(LIBFILEDIRS) $(LIBFILE)

將庫文件的名字和存放路徑單獨用變數表示

4.8 編譯選項

CC := gcc
CFLAGS := -Wall -c

RM := rm
RMFLAGS := -rf

CC := gcc，指定編譯器為gcc；CFLAGS 和RMFLAGS中的內容可以根據需求調整，所以單獨拿出來，-Wall是表示編譯的時候可以產生告警，便於分析。

4.9 自動目錄

OUTPUTDIR := ../output

@mkdir -p $(OUTPUTDIR)

@-$(RM) $(RMFLAGS) $(TARGETNAME) $(OBJFILE) $(OUTPUTDIR)

make命令會自動創建output目錄，用來存放生成的目標文件。

make clean會將此目錄及目錄中的所有內容都刪除

4.10 列印信息

TARGETNAME = app

$(TARGETNAME):$(OBJFILE)
	@mkdir -p $(OUTPUTDIR)
	@echo ""
	@echo "all files have been compiled , now begin to link every obj for excutable file"
	@echo ""
	@echo "linking............"
	@echo $(OBJFILE)
	@$(CC)  -o $(OUTPUTDIR)/$(TARGETNAME).$(APPVERSION) $(OBJFILE) -L$(LIBFILEDIRS) $(LIBFILE)
	@echo ""
	@echo "linked ok," $(TARGETNAME) "has been created"
	@echo ""
	@echo $(TMPBUILDTM)
	
%.o: %.c
	@echo ""
	@echo "start " $< "......compiling"
	@$(CC) $(CURCMPLMACRO) $(CFLAGS) $(CURSRCHEADDIRS) $(CURLIBHEADDIRS) $< -o $@
	@echo "created " $@
	@echo "end   " $< "......compiled ok"
	@echo ""

所有@echo的內容，都是為了編譯的時候，列印一些信息，方便查看才加上去的，實際上有真正有用的是下麵這些

TARGETNAME = app

$(TARGETNAME):$(OBJFILE)
	@mkdir -p $(OUTPUTDIR)
	@$(CC)  -o $(OUTPUTDIR)/$(TARGETNAME).$(APPVERSION) $(OBJFILE) -L$(LIBFILEDIRS) $(LIBFILE)

%.o: %.c
	@$(CC) $(CURCMPLMACRO) $(CFLAGS) $(CURSRCHEADDIRS) $(CURLIBHEADDIRS) $< -o $@

————————————————————————————————

碼字不易，點個贊再走吧！

歡迎關註我的同名公眾號，這裡有更多好料等著你哦！


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 《程式員的自我修養》學習筆記——揭秘源文件到可執行文件的編譯過程【第一彈】
    程式代碼到可執行程式編譯鏈接過程 預編譯 以c++/c 語言為例，預編譯階段的工作有以下幾點： 處理所有#define 及條件預編譯指令(如 #if,#ifdef.....),並展開所有巨集定義。 刪除所有註釋("//" ,"/**/")。 處理 "#include",將被包含文件插入該預編譯指令位置 ...
  • 乘風破浪，遇見最佳跨平臺跨終端框架.Net Core/.Net生態 - 深入OpenAI與馬斯克、微軟的秘密，通過API輕鬆接入ChatGPT
    什麼是OpenAI https://openai.com OpenAI是一家人工智慧公司，成立於2015年，總部位於美國舊金山。該公司的使命是研究和開發能夠產生廣泛影響的人工智慧技術，並將這些技術傳播到整個社會。OpenAI由一些著名的科學家和企業家共同創立，包括伊隆·馬斯克、Sam Altman等 ...
  • .net使用DispatchProxy
    實現動態aop並註入 創建一個DynamicDispatchProxy類繼承DispatchProxy, public class DynamicDispatchProxy<T> : DispatchProxy { /// <summary> /// 目標類 /// </summary> priva ...
  • 記錄用C#寫折半查找演算法實現
    折半查找演算法 前言 最近要考試了，重新回顧一下之前學的演算法，今天是折半查找，它的平均比較次數是Log2 n 思想 給定一個有序數組A[0..n-1],和查找值K，返回K在A中的下標。 折半查找需要指定3個指針，left、right、mid，分別是左指針指向下標0，右指針指向元素末尾，mid中間值指向 ...
  • 【Avalonia】【跨平臺】關於Prism項目模塊化在Linux下路徑問題
    背景 當我們在用Avalonia開發項目的時候會涉及到路徑的問題，在Linux下麵路徑的寫法和Window路徑的寫法有區別 問題描述 用Avalonia開發項目發現我們之前的路徑寫法在Linux下麵運行報錯，尤其是在結合Prism開發寫項目進行模塊化掃描的方式載入我們的模塊程式就會出現報錯 解決方案 ...
  • C#/VB.NET 如何在 Word 文檔中添加頁眉和頁腳
    頁眉位於文檔中每個頁面的頂部區域，常用於顯示文檔的附加信息，可以插入時間、圖形、公司微標、文檔標題、文件名或作者姓名等；頁腳位於文檔中每個頁面的底部的區域，常用於顯示文檔的附加信息，可以在頁腳中插入文本或圖形。今天這篇文章就將為大家展示如何以編程的方式在在 Word 文檔中添加頁眉和頁腳。下麵是我整 ...
  • CentOS7部署NFS
    實現背景 最近需要把大數據測試環境的虛擬機遷移到另一臺物理機上，其中資料庫文件過大，一般的上傳文件有大小限制不能超過4GB，可以通過NFS共用目錄解決文件上傳問題。 NFS介紹 NFS介紹NFS 即網路文件系統（Network File-System），可以通過網路讓不同機器、不同系統之間可以實現文 ...
  • # Shell 是什麼？
    原文：What is a Shell? 註意：本文是對原文的一個翻譯！ Shell是一個巨集處理器，用於執行命令。巨集處理器意味著，將文本和符號展開，創建一個更大的表達式。 Unix shell 既是一個命令解釋器，也是一門編程語言。作為一個命令解釋器，它提供了豐富的GUN工具集可以與用戶進行交互。作為 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類