引言

CMake 實踐幫助我們對 CMake 有一個系統(tǒng)全面的了解，并且有大量示例以供參考，至少在實際項目中可以讓我們有能力看懂并修改項目中現(xiàn)有的 CMake 。

閱讀完 CMake 實踐文檔，認為自己的任務(wù)也就結(jié)束了，可這樣總感覺不是自己的東西，不如整理一下并吸收其中自己認為最有用的東西，這樣也能極大的減輕自己的記憶負擔。

與此同時 CMake 實踐行文組織過于復(fù)雜，不方便遇到問題時快速查閱，所以我做了一些調(diào)整與總結(jié)，希望能夠?qū)ψx者更加友好。

本文不能代替 CMake 實踐文檔，有時間還是把 CMake 實踐文檔認真閱讀一遍。

CMake 生成庫

假設(shè)我們存在一個這樣的任務(wù)：

建立一個靜態(tài)庫和動態(tài)庫，提供 HelloFunc 函數(shù)以供其他程序編程使用，HelloFunc 向終端輸出 Hello World 字符串。安裝頭文件與共享庫。

靜態(tài)庫和動態(tài)庫的區(qū)別

• 靜態(tài)庫的擴展名一般為“.a”或“.lib”；動態(tài)庫的擴展名一般為“.so”或“.dll”。
• 靜態(tài)庫在編譯時會直接整合到目標程序中，編譯成功的可執(zhí)行文件可獨立運行（如果程序編譯成功，即使離開靜態(tài)庫，程序也是可以獨立運行）。
• 動態(tài)庫在編譯時不會放到連接的目標程序中，即可執(zhí)行文件無法單獨運行（如果程序編譯成功，必須要有動態(tài)庫的存在程序才可以運行，比如使用windows運行一些游戲程序時，會報缺少 .dll 文件的錯誤，導(dǎo)致程序無法正常運行，其實就是缺少動態(tài)庫）。

CMake 生成庫簡單實例

按照慣例，我們先來一個簡單地實例，以便對 CMake 生成庫有一個直觀的了解。

創(chuàng)建以下工程結(jié)構(gòu)

yxm@192:~/test3$ tree
.
├── build
├── CMakeLists.txt
└── lib
    ├── CMakeLists.txt
    ├── hello.cpp
    └── hello.h
2 directories, 4 files

hello.h中的內(nèi)容

#ifndef HELLO_H
#define Hello_H
void HelloFunc();
#endif

hello.cpp中的內(nèi)容

#include <iostream>
#include "hello.h"
void HelloFunc(){
    std::cout << "Hello World" << std::endl;
}

項目中的cmake內(nèi)容

PROJECT(HELLO)
ADD_SUBDIRECTORY(lib bin)

lib中CMakeLists.txt中的內(nèi)容

SET(LIBHELLO_SRC hello.cpp)
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

ADD_LIBRARY 指令詳細可見下文 CMake 語法。

外部編譯過程：

進入 build，運行 cmake …

在 build 目錄下，運行 make 命令編譯 Makefile 文件，并生成動態(tài)庫。

CMake 同時構(gòu)建靜態(tài)庫與動態(tài)庫

生成動態(tài)庫與靜態(tài)庫

有上面的例子可以看出，使用 ADD_LIBRARY 指令就可以同時構(gòu)建靜態(tài)和動態(tài)庫：

ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
ADD_LIBRARY(hello STATIC ${LIBHELLO_SRC})

但是如果使用這種方式，只會構(gòu)建一個動態(tài)庫，不會構(gòu)建出靜態(tài)庫，雖然靜態(tài)庫的后綴是.a，此時我們可以修改靜態(tài)庫的名字，這樣是可以同時構(gòu)建動態(tài)庫和靜態(tài)庫：

ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})

但是我們往往希望他們的名字是相同的，只是后綴不同而已，此時可以使用 SET_TARGET_PROPERTIES 指令（該指令詳細可見下文 CMake 語法），修改lib目錄下CMakeLists.txt文件：

SET(LIBHELLO_SRC hello.cpp)
ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})
# 對hello_static的重名為hello
SET_TARGET_PROPERTIES(hello_static PROPERTIES  OUTPUT_NAME "hello")
# cmake 在構(gòu)建一個新的target 時，會嘗試清理掉其他使用這個名字的庫，如果沒有清理還是會只會構(gòu)建一個動態(tài)庫，不會構(gòu)建出靜態(tài)庫
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
# 對hello_static的重名為hello
SET_TARGET_PROPERTIES(hello PROPERTIES  OUTPUT_NAME "hello")
SET_TARGET_PROPERTIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)

外部編譯過程：

進入 build，運行 cmake …

在 build 目錄下，運行 make 命令編譯 Makefile 文件，并生成動態(tài)庫與靜態(tài)庫。

修改動態(tài)庫版本號

同時我們還可以修改動態(tài)庫的版本號

// 一般動態(tài)庫都有一個版本號的關(guān)聯(lián)
libhello.so.1.2
libhello.so ->libhello.so.1
libhello.so.1->libhello.so.1.2

修改 lib/CMakeLists.txt ，重新構(gòu)建看看結(jié)果：

SET(LIBHELLO_SRC hello.cpp)
ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})
SET_TARGET_PROPERTIES(hello_static PROPERTIES  OUTPUT_NAME "hello")
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
SET_TARGET_PROPERTIES(hello PROPERTIES  OUTPUT_NAME "hello")
SET_TARGET_PROPERTIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)
SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)

安裝共享庫和頭文件

本例中我們將 hello 的共享庫安裝到 <prefix>/lib 目錄；將 hello.h 安裝到 <prefix>/include/hello 目錄，這樣共享庫才能夠被調(diào)用。

修改lib目錄下CMakeLists.txt文件：

SET(LIBHELLO_SRC hello.cpp)
ADD_LIBRARY(hello_static STATIC ${LIBHELLO_SRC})
SET_TARGET_PROPERTIES(hello_static PROPERTIES  OUTPUT_NAME "hello")
SET_TARGET_PROPERTIES(hello_static PROPERTIES CLEAN_DIRECT_OUTPUT 1)
ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})
SET_TARGET_PROPERTIES(hello PROPERTIES  OUTPUT_NAME "hello")
SET_TARGET_PROPERTIES(hello PROPERTIES CLEAN_DIRECT_OUTPUT 1)
# 文件放到該目錄下
INSTALL(FILES hello.h DESTINATION include/hello)
# 二進制，靜態(tài)庫，動態(tài)庫安裝都用TARGETS
# ARCHIVE 特指靜態(tài)庫，LIBRARY 特指動態(tài)庫，RUNTIME 特指可執(zhí)行目標二進制。
INSTALL(TARGETS hello hello_static LIBRARY DESTINATION lib ARCHIVE DESTINATION lib)

外部編譯過程：

進入 build，運行 cmake -DCMAKE_INSTALL_PREFIX=/usr …

• 注意：安裝的時候，指定一下路徑，放到系統(tǒng)下，-D之后加不加空格都可。
• 注意：直接安裝在 usr 系統(tǒng)目錄下，以便后續(xù)可以直接調(diào)用

在 build 目錄下，運行 make 命令編譯 Makefile 文件，并生成動態(tài)庫與靜態(tài)庫。

在 build 目錄下，運行 make install

使用外部動態(tài)庫和頭文件

新建一個目錄來使用外部共享庫和頭文件，創(chuàng)建以下工程結(jié)構(gòu)：

yxm@192:~/test4$ tree
.
├── build
├── CMakeLists.txt
└── src
    ├── CMakeLists.txt
    └── main.cpp
2 directories, 3 files

main.cpp中的內(nèi)容

#include <hello.h>
int main(){
	HelloFunc();
}

項目中的CMakeLists.txt內(nèi)容

PROJECT(HELLO)
ADD_SUBDIRECTORY(src bin)

src中CMakeLists.txt中的內(nèi)容

ADD_EXECUTABLE(hello main.cpp)

外部編譯過程：

進入 build，運行 cmake …

在 build 目錄下，運行 make 命令編譯 Makefile 文件。注意此時 make 會報錯：

解決：make 后頭文件找不到的問題

make 時會提示找不到頭文件，兩種解決方法：

修改成 include <hello/hello.h> ，但這樣修改代碼冗余。當然也可以使用一下關(guān)鍵字：INCLUDE_DIRECTORIES （詳細見下文 CMake 語法）

這里使用第二種方法，在src下的 CMakeLists.txt 文件中加入頭文件搜索路徑：

INCLUDE_DIRECTORIES(/usr/include/hello)
ADD_EXECUTABLE(hello main.cpp) 

外部編譯過程：

進入 build，運行 cmake …

在 build 目錄下，運行 make 命令編譯 Makefile 文件。注意此時還是 make 會報錯：

解決：找到引用的函數(shù)問題

報錯信息：undefined reference to `HelloFunc()'，所以我們需要將 .so 文件關(guān)聯(lián)起來。

解決方法有兩種：

• 關(guān)鍵字：LINK_DIRECTORIES 添加非標準的共享庫搜索路徑
  指定第三方庫所在路徑，LINK_DIRECTORIES(/home/myproject/libs)
• 關(guān)鍵字：TARGET_LINK_LIBRARIES 添加需要鏈接的共享庫（詳細見下文 CMake 語法）

? TARGET_LINK_LIBRARIES 的時候，只需要給出動態(tài)鏈接庫的名字就行了。

這里使用第二種方法，在src下的 CMakeLists.txt 文件中添加需要鏈接的共享庫（主要要插在executable的后面）：

INCLUDE_DIRECTORIES(/usr/include/hello)
ADD_EXECUTABLE(hello main.cpp) 
TARGET_LINK_LIBRARIES(hello libhello.so)

外部編譯過程：

進入 build，運行 cmake …

在 build 目錄下，運行 make 命令編譯 Makefile 文件。

在 build/bin 目錄下，運行 ./hello ，執(zhí)行結(jié)果如下：

yxm@192:~/test4/build$ cd bin/
yxm@192:~/test4/build/bin$ ./hello 
Hello World

注意：如果你的 linux 虛擬機是64位會報錯，需要移動動態(tài)庫到64位下：

使用外部靜態(tài)庫

上面的例子使用的是外部動態(tài)庫，如果想要使用外部靜態(tài)庫，步驟也是相同的，只需要將上面例子中.so換成.a即可，不過使用外部靜態(tài)庫不需要頭文件。

TARGET_LINK_LIBRARIES(main libhello.a)

補充：

特殊的環(huán)境變量 CMAKE_INCLUDE_PATH 和 CMAKE_LIBRARY_PATH

注意：這兩個是環(huán)境變量而不是 cmake 變量，可以在linux的bash中進行設(shè)置

我們上面例子中使用了絕對路徑INCLUDE_DIRECTORIES(/usr/include/hello)來指明include路徑的位置，我們還可以使用另外一種方式，使用環(huán)境變量export CMAKE_INCLUDE_PATH=/usr/include/hello

CMake 語法

（1）ADD_LIBRARY 語法

ADD_LIBRARY(hello SHARED ${LIBHELLO_SRC})

• hello：就是正常的庫名，生成的名字前面會加上lib，最終產(chǎn)生的文件是libhello.so
• SHARED，動態(tài)庫 STATIC，靜態(tài)庫
• ${LIBHELLO_SRC} ：源文件

（2）SET_TARGET_PROPERTIES 語法

這條指令可以用來設(shè)置輸出的名稱，對于動態(tài)庫，還可以用來指定動態(tài)庫版本和 API 版本

• 對hello_static的重名為hello，例如：SET_TARGET_PROPERTIES(hello_static PROPERTIES OUTPUT_NAME “hello”)
• 指定動態(tài)庫版本和 API 版本，例如：SET_TARGET_PROPERTIES(hello PROPERTIES VERSION 1.2 SOVERSION 1)

其中VERSION 指代動態(tài)庫版本，SOVERSION 指代 API 版本。

（3）INCLUDE_DIRECTORIES 語法

找頭?件：可以用來向工程添加多個特定的頭文件搜索路徑，路徑之間用空格分割

（4）TARGET_LINK_LIBRARIES 語法

TARGET_LINK_LIBRARIES 用于從鏈接庫到執(zhí)行件上

到此這篇關(guān)于CMake 生成靜態(tài)庫與動態(tài)庫的方法步驟的文章就介紹到這了,更多相關(guān)CMake 生成靜態(tài)庫與動態(tài)庫內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論