巨集定義是什麼

巨集定義（macro definition）是 C/C++ 中的一種預處理指令，可以在編譯之前替換源代碼中的一些文本。簡單來說就是用巨集自定義了一些其它符號，這些符號在使用時全等於被替換的內容。

#define  DATE     "2023_01_20"
#define  FILE_NUM  250

上面兩個例子中表現的就是巨集定義的基本格式 #define+若幹空格+自定義符號+若幹空格+被替換內容，DATE在代碼的任何部分都可以直接當做"2023_01_20"這段字元串使用，同理FILE_NUM也可以直接用來當做250。不過這種替換是簡單粗暴，不帶任何修飾的，這種特性也帶來一定的問題，在下麵用好巨集定義板塊會提到這些問題，並教給你如何避免這種問題。

#define    WORKING_DIE  “/home/lcc/linux/nfs/rootfs/lib/modules/4.1.15/all_flile/c_text/for_text/”

我們有時候會巨集定義一些比較長的數據，像上面這樣，這樣會顯得代碼看起來特別的臃腫，可以使用\(續行符) 將巨集定義的內容分割開，當然分割前後的巨集替換內容是一致的。

#define  WORKING_DIE  “/home/lcc/linux/nfs/rootfs/lib/\
                  modules/4.1.15/all_flile/c_text/for_text/”

通過使用 \，可以讓代碼看起來更加的整潔，提高了代碼的可讀性，但是在使用時，一定不能讓 \ 右側出現任何字元，空格也不可以，否則會導致錯誤出現。

用好巨集定義

雖然說巨集定義看起來很簡單，不過合理的使用會給編程帶來極大的便利，能提高程式的可讀性和可維護性，而且通過與函數等的結合也具有很大的靈活性。

接下來主要從常量替換、整體、集合體幾個方面來談談巨集定義的應用，以及這些用法可能帶來的問題及解決方法，當然巨集的很多應用在C語言中都有替代的方案，這些方案在不同情況下使用會有優劣之分，明確了這些，在某一場景下做出正確的選擇，我們才能算真正意義上掌握了巨集。講完這些，希望各位保持好奇心，坐穩了，開始發車！

常量替換

int a = 2;
float b = 3;
if(4 > 5)
#define  MAX_LEN  22

代碼中能被我們直接觀察到的數據就是常量，所以常量又被稱為字面量，而且常量是在程式執行期間都不會發生改變的值。以上代碼塊中以數字形式出現的都是常量，它們在程式運行開始時會被載入入記憶體中的常量區里，塊中的第四行就是通過巨集實現對常量的替換。

int a = 22；
int a = MAX_LEN;

以上兩行代碼的效果是等效的，都實現了對a賦值22。這時有人可能會問了，不就賦個值嘛，為啥搞得這麼麻煩。誒，你還別說，巨集替換用到好處不僅不會使代碼顯得冗雜，還會提高代碼的可讀性，有利於程式的維護和開發， 不信，咱接著看。

常量替換的作用

• 賦予數據意義

在剛開始接觸編程的時候，我們是為了學習編程而編程。這個階段的編程脫離現實，或者說是對某些現實的抽象，我們們僅僅是重覆性的使用編程規則已達到熟悉編程規則的目的，很少會根據具體的現實情景進行編程。

在深入學習編程之後，我們編程的目的從學習編程本身變成了通過編程來解決現實問題。解決現實問題的過程中，就需要對一些事物的屬性進行抽象成數據，而有些數據總是不變的，我們這時候就可以以巨集定義的方式對這些常量數據進行命名，來使代碼更加的清晰、有條理。

#define  MON_DAY       1
#define  TUES_DAY      2
#define  WEDNES_DAY    3
#define  THURS_DAY     4
#define  FRI_DAY       5
#define  SATUR_DAY     6
#define  SUN_DAY       7

在某些情景中，需要用到每天的日期信息，如果直接使用1、2、3…來表示會另閱讀代碼的其他人頭疼不已，就連我們自己幾個月後檢查代碼時也可能會忍不住飆幾句髒話，如果使用巨集定義則會明朗許多。

總之，前期的學習我們很少會遇到賦予常量意義的情況，這時候我們也不用擔心，在後期面臨現實情景的時候我們再在去認真思考也不遲，不過現實情況總是千遍萬化，難有一個通法，需要實際問題，實際處理，上面用星期的舉例也就當是拋磚引玉了，如何靈活、恰當的使用巨集定義賦予數據意義，需要在閱讀他人優秀代碼與自己的實踐中慢慢體會。

• 替換重覆出現的固定常量

#define  PI    3.14159
double r = 3;
double area = PI * r * r;
double perimeter = 2 * PI * r;

在上面這個例子中，圓周率是重覆出現的，通過巨集定義進行替換可以提高代碼的可維護性，因為巨集定義可以方便地修改常量的值，而不需要在多個地方進行修改。

• 替換目前不能確定或未來有可能改變的數值

#define  MAX_LEN        20
char buf[MAX_LEN];

我以前在編程時，會習慣性的憑感覺設置數組大小，但是現實總是啪啪打臉，代碼編譯時沒有問題，一運行段錯誤就出現了，問題是代碼越棧了。如果碼量小一點還好，一旦碼量稍大，排查起來是真的痛苦。我們可以用巨集來限定靈活限定數組大小，減少這類問題給編程帶來的痛苦體驗。

對於這類問題需要替換的僅僅是目前不能確定大小的數組，有的數組大小我們完全在編程時就能夠明確，就完全沒有替換的必要，就害怕有些小伙伴看到這麼已用好像高大上的樣子，不管三七二十一，盲目的對代碼進行替換，需要記住我們使用的任何方法與技巧都是為了寫出更優秀、更高質量的代碼，而不是所謂花哨與高大上。

當然以上雖說是用數組進行舉例，不過不能僅僅拘泥於數組，更多場景需要在編程時根據具體情況去發現、去處理，但是萬變不離其宗是它們都有一個共同的特性——數值目前不能確定。

#define IP_DEER  "192.168.1.100"

編程時有些數據在當下是確認的，但在未來也可能會被修改，這種改變的原因並不來源於錯誤，而可能伴隨著代碼需求的改變。前幾天在進行網路編程時，需要確定被連接一端的IP地址，但是在剛開始編寫時肯定是用自己周邊的觸手可及的一些IP地址來測試程式，而不是一上來就用最終實現的IP地址，這樣做是為了前期方便編寫以及排查程式問題。在這個過程中前期使用"192.169.1.100"的目的是為了方便調試代碼，後面將IP_DEER修改為192.168.1.50才算是整個程式的完工。

常量替換需謹慎                                                                      

常量巨集定義出現問題的原因並不來自於巨集，而是來自常量本身不規範的使用。在 if(-1 > 2)這種簡單的判斷中，-1與2都是具有數據類型的常量，很多時候我們都會忽略-1與2本身的數據類型，在這個例子中兩個常量被系統預設為int數據類型，因此我們得到了正確的判斷結果，不過總有例外存在。當數據變成if(-1 > 2147483649)時，2147483649預設為long long型,而-1預設依舊為int型，這時候因為運算數據的類型不匹配，會導致導致編譯不能通過，還有些編譯器比較傻，雖然能編譯通過，但是其內在隱患並沒有解決掉。

以上是在常量使用中比較顯式的一類問題，另一類問題比較隱式，是在不同數據類型間的賦值中可能產生的。當一個int類型常量給long long進行賦值，可以得到正確的結果，而當以上的賦值順序交換，就有可能造成數據被截斷。由於數據複製過程中得到的的結果有可能是對的，所以這種問題往往被人忽略。

總之，一般由程式員主動定義的變數在使用過程中都會留意，不過當數據是通過巨集定義出現在式子中，就要謹慎了，因為一種數據的表達形式可能有不止一種的含義，比如說1可以是int型，也可以是long long，因此在編譯的過程中，系統本身對數據類型的預設選擇並不一定符合程式員的本意，也就導致了代碼運行過程產生了歧意。其它的一些數據類型的巨集替換，比如字元，字元串就沒有類似的問題，對它們來說，一種表現形式往往有且只有一種意義。

對於這種由於巨集定義導致的數據產生的歧意，可以通過在巨集定義過程中添加尾碼來解決。經過對巨集添加尾碼，我們可以對巨集定義的常量數據類型進行限定，而不是由系統對數據類型進行控制，從而降低代碼的相關風險。

#define  CECOND_PER_YEAR     (60*60*24*365UL)

上面這個例子中如果不加尾碼而是以(60*60*24*365)來表示，會產生數據截斷，加上了UL後，該數據的存儲方式會以無符號整型來存儲，在對常量進行巨集定義時要有加上尾碼的意識，很多時候程式出現BUG都是因為編寫者日常沒有養成良好的編程習慣帶來的，下麵是數據類型與尾碼的對應表項。

替換方案

小小的常量替換，大大的編程作用。不過在編程替換中只有巨集定義一家獨大嗎？答案是否定的，除了巨集定義還有const關鍵字修飾的變數與 enum可以擔此大任。與其把被const修飾的變數稱做常量，或許只讀的變數才更符合它的真實情況，但是最終達成的作用卻是類似的，都可以看成常量替換。相對而言，const 本身就具有類型檢測功能，因為在定義時，我們必須給const 修飾的常量指定類型，這就避免了使用巨集定義常量而存在的潛在問題，不過編者在平時編程中對於常量定義依舊是以巨集定義為主，因為巨集定義看起來更有美感，可憐的強迫症患者就是我了。

整體

什麼是整體呢？一把傘由傘柄、傘骨和傘面組成。其中傘柄是握住傘的部分；傘骨是支撐傘面的部分；傘面是遮雨的部分，這幾個部分在擋雨時缺一不可，如果缺少某個部分則就失去了傘的功能，就不能稱之為整體。我理解的編程整體也是這樣，它的功能具有單一性與唯一性，該整體不能有缺少，也不能畫蛇添足，通過巨集定義可以幫助我們封裝一個編程整體。

一個巨集定義的整體可以分為簡單巨集整體，複合巨集整體兩類。簡單巨集整體就是利用一些運算符結合起來的巨集整體，比如下麵這個比較數字大小的巨集定義

#define  MAX(x, y)    ((x)>(y)?(x):(y))

當然這類巨集整體並不都是這麼短，下麵是一個遍曆數組的巨集定義

#define FOREACH(item, array) \ // 定義一個遍曆數組的巨集
for(int keep=1, \ 
    count=0,\ 
    size=sizeof (array)/sizeof *(array); \ 
    keep && count != size; \ 
    keep = !keep, count++) \ 
  for(item = (array)+count; keep; keep = !keep)

瞭解了簡單巨集定義後再來看一下複合巨集整體，不過為什麼稱之為複合巨集定義呢？所謂複合就是巨集定義內不僅包含了一些運算符這些，還有了函數的參與

#define  ECHO(s)    (get(s), put(s))
ECHO(str);

 以上這個例子中，用巨集將get()與put()包裹起來，實現輸入輸出的一條龍服務，通過將巨集定義用於函數的結合，使我們的操作更加靈活，也一定程度提高了代碼的可讀性。

在上面對兩種巨集整體的講解例子中，都不同程度在巨集定義中使用了參數，不過巨集定義中的參數也可以不是固定的，這類巨集定義被稱為參數可變巨集，它可以根據不同情況傳遞不同類型和數量的參數。參數可變巨集的定義方法是在巨集定義後面的參數列表中的最後一個參數為省略號(…)，表示可以接受任意個數和類型的參數。例如：

#define  PRINTF(...)    printf(__VA_ARGS__) // 定義一個可以接受任意個數和類型的參數的巨集

在使用參數可變巨集時，需要用一個特殊的標識符 __VA_ARGS__來表示所有傳遞給巨集的可變參數。

PRINTF("Hello, world!\n");         // 調用巨集，相當於printf("Hello, world!\n");
PRINTF("The answer is %d\n", 42);  // 調用巨集，相當於printf("The answer is %d\n", 42);

註意什麼

隨著我們巨集定義的對象從簡單的常量到相對複雜的整體，巨集定義本身也從無參巨集定義過渡到有參巨集定義，但是由於巨集定義僅僅是在程式預編譯階段暴力的直接展開，當我們寫入帶參巨集定義的內容不只是一個簡單數字而是一段表達式就有可能會出現歧義與錯誤。比如我們定義了一個計算平方的巨集：

#define  SQUARE(x)    x * x

當使用該巨集時，如果我們直接使用SQUARE (a + b)，這個式子最後會被展開為a + b * a + b而不是我們期望的(a + b) * (a + b)，所以為了保證帶參巨集定義結果的正確性，我們應該像下麵這樣對被定義主體內的參數帶上()，如此就能保證巨集定義的正確結果。

#define  SQUARE(x)    (x) * (x)

替代方案

經過前面這麼多的敘述，有些小伙伴可能已經意識到了這裡提出來的整體的概念不就是函數嗎？其實開始我也準備這麼理解，但是巨集就是巨集，函數就是函數，總不能看到巨集的這類用法就把巨集歸納到函數的範疇吧，我們需要一個更加抽象的認識來統一這類用法，於是我就用了整體這個概念。既然這塊內容講的是替換方案，那我們另一個主角都不需要隆重介紹了，他就是 —— 函數。這時候問題就來了，巨集定義能完全代替函數嗎？或者說函數能完全代替巨集定義嗎？巨集與函數雖然在某些共同之處，但是在一些方面也存在差異。

• 函數的調用不同於巨集定義，它需要出棧與入棧的確操作，這些額外的開銷會降低程式的執行效率，巨集定義則是直接執行，但是巨集定義的每處展開都會多一份記憶體空間的申請，不像函數那樣一個程式只占用一個代碼塊。
• 含參巨集定義在使用時，我們並沒有像函數的參數那樣指定具體類型，這給我們編程者帶來一定便利，不過有時候這種無類型參數會帶來一定隱患。
• 由於函數名就是一個指針，而沒有指向巨集定義的指針，因此巨集無法得到指針帶來的便利。

 總之，函數與巨集定義在作為整體出現在編程中時，各有其優勢所在，在具體的編程環境中並沒有什麼最好之說，只有最適合的。

集合體

當一個集合有了專一的功能，我們稱之為整體，而在編程中有些部分集合由於不具備這種專一性並不能稱之為整體，卻由於其較高的重覆度而不得不封裝起來，我們將這類組合稱為集合體。

#define  ERROR(m)     \
do{               \
    perror(m);    \
    tfer();       \
}while(0)

 以上代碼是我寫的某個項目的一段，在每次處理完錯誤後都有這麼一段重覆內容，但是這部分代碼前那部分與錯誤處理相關的內容並不總是相同，因此不能作為一個整體來看待，我只需要對這部分內容進行復用。這個集合體是用do{}while封裝的，有些小伙伴可能覺得直接用{}也不錯，但是使用後者有時會因為疏忽出現問題。

我們在編程語句的結尾會習慣性的加上;，但在使用if else語句時如果遇上被{}封裝的巨集定義問題就顯現出來了，比如下麵的例子：

#define  ERROR(m)     \
{                \
    perror(m);   \
    tfer();      \
}

if(echo_flag)
    ERROR(echo_flag);
else 
    gets(str);

 這個語句乍一看沒有什麼問題，但是把它展開會發現在else前的;會導致無法錯誤。

#define  ERROR(m)     \
{                \
    perror(m);   \
    tfer();      \
}

if(echo_flag)
{
    perror(echo_flag);
    tfer();      
};
else 
    gets(str);

 而使用do{}while(0)來包裝就不會出現這種錯誤了。

if(echo_flag)
do{
    perror(echo_flag);
    tfer();      
}while(0);
else 
    gets(str);

我們程式員在一句代碼的結尾會習慣性加上;，用do{}while(0)進行封裝結尾必須加上 ;否則會報錯，而{} 後則是可加可不加，然而有時不小心加上後會出現以上的問題。總之，{}不是不能用，而是可能因為疏忽出現問題，而且由於一些編程習慣會讓人用的很難受，所以這裡還是建議使用do{}while(0) 。

以上三大塊是我這篇文章的主要內容與總結，但是我這裡還想給各位加一些飯後小甜點，巨集定義的內容就是只是替換，但是#與##在巨集定義中的妙用卻被很多人疏忽了。

'#'的用法

巨集定義中#的作用是把其後面的變數轉化為字元串。例如，如果定義了一個巨集：

#define  STR(s)    #s

 那麼當使用這個巨集定義時，RTR(hello)會被替換為"hello"，這樣做可以更加方便的輸出或處理字元串。

 "##"的用法

巨集定義中##的作用是將其前後的兩個變數無縫拼接在一起，並當做一個變數名使用。例如，我定義了這麼一個巨集：

#define  NAME(n)    num##n

當我使用這個巨集時，就可以把它當做一個變數名來使用，在這裡NAME(0)會被替換為num0,

int num1;
NAME(1) = 9;
num1 = 9;

 在這個例子中這兩條賦值語句是等效的，通過巨集定義配合##這種用法，可以方便的定義和使用一組相關的變數，提高編程代碼的靈活性。

以上幾乎就是巨集定義從入門到進階的全部內容了，寫這篇文章的的起源是一次項目實踐的總結，而這篇文章以這種方式來呈現巨集定義則是日常我對與編程知識總結的方法論而來的。在剛開始學習巨集定義時，我查過不少有關博客，但是這些博客有些要麼集中講巨集定義的某個方面，對於有些複習的老手來說這不會有什麼問題，但是對於新手而言，容易使他們形成對巨集定義以偏概全的認識。另一方面很多博客總是簡單粗暴的把巨集定義分成帶參數與不帶參數，這樣雖然讓人容易回憶起，但是無論是函數還是巨集定義，我們的目的都應當是以使用為導向的，在合適的時候用合適的方法，前者的簡單分類並不能將使用者引導入合適的實踐中去，沒有深入實踐的使用最終只是空中樓閣，只知道有這個東西，但是卻總也用不上，總也用不好。這也是這篇文章最後給各位的一些思路，用合適分類方法，以合理的角度去理解技術工具，希望各位有所收穫。