[[390476]]

一、前言

我們平常在寫代碼的時(shí)候，特別是在制造輪子的時(shí)候(為別人提供庫文件)，會(huì)遇到各種不同的需求場(chǎng)景：

1. 有些人需要在 Linux 系統(tǒng)下使用，有些人需要在 Windows 系統(tǒng)下使用;
2. 有些人使用 C 語言開發(fā)，有些人使用 C++ 來開發(fā);
3. 有些人使用動(dòng)態(tài)庫，有些人使用靜態(tài)庫;

特別是在 Windows 系統(tǒng)中，庫文件中導(dǎo)出的函數(shù)需要使用 _declspec(dllexport) 來聲明函數(shù)，而使用者在導(dǎo)入的時(shí)候，需要使用 _declspec(dllimport) 來聲明函數(shù)，甚是麻煩!

這篇短文分享一個(gè)頭文件，利用這個(gè)頭文件，再加上幾個(gè)編譯期間傳遞的宏，就可以完美的處理剛才所說的各種需求。

二、頭文件

先直接上代碼，可以先試著分析一下，后面我們?cè)僦鹨环治霾煌氖褂脠?chǎng)景。

這個(gè)頭文件的主要目的，就是定義一個(gè)宏：MY_API，然后把這個(gè)宏添加在庫文件中每一個(gè)需要導(dǎo)出的函數(shù)或者類的聲明中即可。例如：

void MY_API do_work(); 

下面是頭文件：

_Pragma("once") 
 
#if defined(WIN32) || defined(_WIN32) || defined(__WIN32__) 
    #define MY_WIN32 
#elif defined(linux) || defined(__linux) || defined(__linux__) 
    #define MY_LINUX 
#endif 
 
#if defined(MY_WIN32) 
    #ifdef MY_API_STATIC 
      #ifdef __cplusplus 
         #define MY_API extern "C" 
      #else 
         #define MY_API 
      #endif 
   #else 
      #ifdef MY_API_EXPORTS 
         #ifdef __cplusplus 
            #define MY_API extern "C" __declspec(dllexport) 
         #else 
            #define MY_API __declspec(dllexport) 
         #endif 
      #else 
         #ifdef __cplusplus 
            #define MY_API extern "C" __declspec(dllimport) 
         #else 
            #define MY_API __declspec(dllimport) 
         #endif 
      #endif 
   #endif 
#elif defined(MY_LINUX) 
    #ifdef __cplusplus 
       #define MY_API extern "C" 
    #else 
       #define MY_API 
    #endif 
#endif 

三、預(yù)定義的宏

假設(shè)需要寫一個(gè)庫文件，提供給別人使用。定義了上面這個(gè)頭文件之后，其他的文件中都要include 這個(gè)頭文件。

1. 平臺(tái)宏定義

不同的平臺(tái)預(yù)定義了相應(yīng)的宏定義，例如：

• Windows 平臺(tái)：WIN32, _WIN32, WIN32;
• Linux 平臺(tái)：linux, __linux, linux;

在一個(gè)確定的平臺(tái)上，這些宏不一定全部定義，很可能只有其中的某一個(gè)宏是被定義的。

為了統(tǒng)一性，我們?cè)陬^文件的剛開始部分，把這些可能的宏統(tǒng)一起來，定義我們出我們自己的平臺(tái)宏定義：MY_WIN32 或者是 MY_LINUX，后面需要區(qū)分不同的平臺(tái)時(shí)，就用這個(gè)自己定義的平臺(tái)宏。

當(dāng)然，還可以繼續(xù)擴(kuò)充出其他平臺(tái)，例如：MY_MAC, MY_ARM 等等。

2. 編譯器宏定義

如果在寫庫代碼的時(shí)候，使用的是 C++，而使用者使用的是 C 語言，那么就需要對(duì)庫函數(shù)進(jìn)行extern “C” 聲明，讓編譯器不要對(duì)函數(shù)的名稱進(jìn)行改寫。

編譯器 g++ 預(yù)定義了宏 __cplusplus，因此，在頭文件中，就利用了這個(gè)宏，在 MY_API 中添加 extern "C" 聲明。

四、Windows 平臺(tái)場(chǎng)景分析

1. 編譯生成庫文件

(1) 生成靜態(tài)庫

在靜態(tài)庫中，不需要 __declspec(dllexport/dllimport) 的聲明，因此只需要區(qū)分編譯器即可(gcc or g++)，在編譯選項(xiàng)中定義宏 MY_API_STATIC，即可得到最終的 MY_API 為：

• gcc 編譯器：#define MY_API
• g++ 編譯器：#define MY_API extern "C"

(2) 生成動(dòng)態(tài)庫

在編譯選項(xiàng)中，定義宏 MY_API_EXPORTS，這樣最終得到的 MY_API 就會(huì)變成：

• gcc 編譯器：#define MY_API __declspec(dllexport)
• g++ 編譯器：#define MY_API extern "C" __declspec(dllexport)

2. 使用庫

在使用庫的應(yīng)用程序中，也需要在代碼中 include 這個(gè)頭文件，然后加上編譯選項(xiàng)中定義的各種宏，來生成對(duì)應(yīng)的 MY_API 宏定義。

(1) 使用靜態(tài)庫

需要在編譯選項(xiàng)中定義 MY_API_STATIC，即可得到最終的 MY_API 為：

• gcc 編譯器：#define MY_API
• g++ 編譯器：#define MY_API extern "C"

(2) 使用動(dòng)態(tài)庫

在編譯選項(xiàng)中不需要任何宏定義，即可得到最終的 MY_API 為：

• gcc 編譯器：#define MY_API extern "C" __declspec(dllimport)
• g++ 編譯器：#define MY_API __declspec(dllimport)

這樣就相當(dāng)于聲明導(dǎo)入庫函數(shù)了。

五、Linux 平臺(tái)場(chǎng)景分析

Linux 平臺(tái)下就簡(jiǎn)單多了，只需要注意編譯器的問題，而沒有導(dǎo)出和導(dǎo)入之分。