使用Cmake生成跨平台项目编译解决方案

    项目最近有需求在windows下面运行，我花了几周时间将linux的服务器移植到windows下面，目前已经能够正常运行服务器，目前又有了新需求，两边的代码结构和组织是分开的，因此为了两边能够同步维护，需要一个能够跨平台的项目编译解决方案，经过调研之后，选择了使用cmake这个工具，本文主要讲述，使用cmake的生产项目的一些基础知识。

一、cmake简介

    你或许听过好几种 Make 工具，例如 GNU Make ，QT 的 qmake ，微软的 MS nmake，BSD Make（pmake），Makepp，等等。这些 Make 工具遵循着不同的规范和标准，所执行的 Makefile 格式也千差万别。这样就带来了一个严峻的问题：如果软件想跨平台，必须要保证能够在不同平台编译。而如果使用上面的 Make 工具，就得为每一种标准写一次 Makefile ，这将是一件让人抓狂的工作。

    CMake就是针对上面问题所设计的工具：它首先允许开发者编写一种平台无关的 CMakeList.txt 文件来定制整个编译流程，然后再根据目标用户的平台进一步生成所需的本地化 Makefile 和工程文件，如 linux的 Makefile 或 Windows 的 Visual Studio 工程。从而做到“Write once, run everywhere”。

1、Linux安装cmake

    在linux可以直接使用yum -y install cmake进行安装，默认的安装版本是cmake 2.8.12。

    除此之外，如果需要用到cmake的最新版本，那么我们可以到cmake官网下载https://cmake.org/download/，这个页面可以下载源代码自己编译，也可以下载zip文件直接使用。

    建议直接yum安装或者在官网下载cmake-3.12.0-rc2-Linux-x86_64.tar.gz。

2、windows安装cmake

    Windows安装cmake，直接到cmake官方网站的下载页面可以下载，官网提供了msi的安装版本，也提供了源代码，除此之外还提供依据编译好的release版本。

    建议在windows下面使用安装版本，也可以直接下载编译好的release版本cmake-3.12.0-rc2-win64-x64.zip，不过这个版本需要手动设置环境变量。

    Windows下有命令行版本和gui版本，主要看大家的使用习惯。

    设置环境变量的方法，我的电脑->属性->高级系统设置->环境变量，然后将cmake的路径加到path环境变量中。

二、Cmake初体验

    在本小节我们先假设已经有一个项目，并写好了cmake的配置文件CMakeLists.txt。

1、windows使用cmake_gui生成项目

    如上图，在source code处选择CMakeLists.txt文件所在的路径，然后在binaries中选择项目生成的地址，然后点击configure，选择本机安装过的编译器，例如vs2015等。

    然后在点击生成，在binaries目录就生成了vs的工程文件，打开工程文件就可以开始编译了。

2、windows使用cmake生成项目

    先配置好环境变量，然后打开windows命令行工具，进入到项目目录（CMakeLists.txt所在目录），新建一个build文件夹（因为cmake会产生很多自己的中间文件，因此新建一个文件夹，到时候需要clean的时候，直接删除build即可）。

    然后执行cmake ../

    然后在build目录就会产生vs的项目文件，在windows下默认是产生vs的项目，如果要产生其他编译器的makefile，则需要使用-G指定编译器，如下：

    cmake -G "MinGW Makefiles" ../

    可以使用cmake --help查看可以使用的编译器名字。

    生成项目工程文件或者makefile之后，就可以使用对应的编译器来编译项目了。

3、linux使用cmake生成项目

    在linux下使用cmake生成项目和和上面的第2小节类似。

    在CMakeLists.txt所在目录新建build目录，在build目录执行：

    cmake ../

    就会在build目录生成Makefile文件，然后就可以继续执行make编译项目。

4、cmake常用指令

    cmake [<options>] (<path-to-source> | <path-to-existing-build>)

    cmake [(-D<var>=<value>)...] -P <cmake-script-file>

    cmake --build <dir> [<options>] [-- <build-tool-options>...]

    cmake -E <command> [<options>...]

    cmake --find-package <options>...

三、Cmake配置文件语法

1、指定cmake最低版本

    cmake_minimum_required (VERSION 2.6)

2、设置项目名称

    project (LearnCMake)

3、创建可执行程序工程(exe)

    add_executable函数用于创建一个可执行程序工程。

    add_executable(<name> [WIN32] [MACOSX_BUNDLE]

                [EXCLUDE_FROM_ALL]

               source1 [source2 ...])

    如下所示：

    add_executable(FirstExecutable hello_world.cpp)

    也可以添加多个源文件到工程中，如下：

    add_executable(FirstExecutable main.cpp app_util.h app_util.cpp)

4、创建库文件工程(a/so/lib/dll)

    add_library函数用于创建一个库文件工程。

    add_library(<name> [STATIC | SHARED | MODULE]

                [EXCLUDE_FROM_ALL]

                source1 [source2 ...])

    如下所示：

    add_library(SecondLibrary second_library.cpp)

    和add_executable一样，也可以添加多个源文件。

    add_library(SecondLibrary test.cpp app_util.h app_util.cpp)

    默认的是静态库，也可以显式的设置库是否为静态库、动态库或者是模块。另外BUILD_SHARED_LIBS也可控制编译成哪种库。

    add_library(SecondLibrary SHARED second_library.cpp)

5、set设置变量

    前面2小节的add_library和add_executable可以添加多个源文件，但是文件多了之后可能会一行占用很长，因此我们可以使用set函数来进行变量赋值，然后在调用add_library和add_executable生成项目。

    如下所示，效果和前面的示例一样。

    set(AppUtilSrcs app_util.h app_util.cpp)

    add_executable(FirstExecutable main.cpp ${AppUtilSrcs})

    add_library(FirstLibrary test.cpp ${AppUtilSrcs})

    使用set函数，还可以对变量值进行累加，如下AppUtilSrcs就代表3个文件了：

    set(AppUtilSrcs app_util.h app_util.cpp)

    set(AppUtilSrcs ${AppUtilSrcs} b.cpp)

    除了文件名定义，set还用于变量定义

    set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /MT")

6、代码控制

    如果一个项目太大，文件成千上万，那么一个一个文件的添加太过于麻烦了，因此cmake使用aux_source_directory函数来添加目录到工程中。

    如下所示，将目录下所有文件赋值给第一个变量，然后将这个变量加到工程中。

    aux_source_directory("./pbase/src" pbase_lib_src_files)

    add_library(pbase ${pbase_lib_src_files})

    除了添加文件目录外，我们经常还需要包含第三方库（头文件、库文件）等需求，添加头文件目录功能如下：

    include_directories函数用于添加头文件包含目录。

    include_directories("../thirdparty/googletest/googletest/include") 

    link_directories函数用于添加需要链接文件的库目录。

    link_directories("../thirdparty/googletest/googletest/lib") 

    link_libraries函数用于添加需要连接的库文件。

    link_libraries("protobuf.so")

    链接目标文件和的库文件，使用target_link_libraries函数，这里的目标文件是指通过add_executable()和add_library()指令生成已经创建的目标文件。

    target_link_libraries(test lua mysql)

    从编译文件列表中排除文件，可以使用cmake提供的list的REMOVE_ITEM功能来实现。

    aux_source_directory(src lua_src)

    list(REMOVE_ITEM lua_src "src/lua.c", "src/luac.c")

7、添加编译选项

        cmake使用add_compile_options函数来添加编译选项，示例如下：         add_compile_options(-std=gnu99)         cmake使用add_definitions函数来为源文件的编译添加由-D定义的标志，示例如下：

        add_definitions(-O3 -g -W -Wall

      -Wno-deprecated -Woverloaded-virtual -Wwrite-strings

      -D__WUR= -D_REENTRANT -D_FILE_OFFSET_BITS=64 -DTIXML_USE_STL

    )

        注意，这两个选项都是针对所有平台、编译器，因此需要慎重使用，最好使用if来进行流程处理。

8、添加其他的CMakeLists.txt

    一个CMakeLists.txt里面的target如果要链接其他CMakeLists.txt中的target，可以使用add_subdirectory函数，如下所示：

    add_subdirectory("../thirdparty/googletest/googletest/" gtest)

    target_link_libraries(gtest)

9、find_package

    find_package 为外部工程加载设置。

    find_package(<package> [version] [EXACT] [QUIET]

             [[REQUIRED|COMPONENTS] [components...]]                [NO_POLICY_SCOPE])

    QUIET选项将会禁掉包没有被发现时的警告信息。REQUIRED选项表示如果报没有找到的话，cmake的过程会终止，并输出警告信息。

    find_package可以根据cmake内置的.cmake的脚本去找相应的库的模块，调用了find_package成功之后，会有相应的变量“生成”有效。

    比如调用了find_package(Qt5Widgets)，返回之后就会有变量Qt5Widgets_FOUND，Qt5Widgets_INCLUDE_DIRS相应的变量生效。 然后就可以在CMakeLists.txt里面使用上述的变量了。    

10、条件、循环控制

    If else结构

    if(condition)         elseif(condition)         else()     endif()

    for循环

    foreach(loop_var arg1 arg2 ...)

        COMMAND1(ARGS ...)

        COMMAND2(ARGS ...)

        ...

    endforeach(loop_var)

    While循环

        while(condition)

        COMMAND1(ARGS ...)

        COMMAND2(ARGS ...)

        ...

    endwhile(condition)

11、Install指令

    Install指令用于定义安装规则，安装的内容可以包括目标二进制、动态库、静态库以及文件、目录、脚本等。

    参数中的TARGETS后面跟的就是我们通过ADD_EXECUTABLE或者ADD_LIBRARY定义的目标文件，可能是可执行二进制、动态库、静态库。

    目标类型也就相对应的有三种，ARCHIVE特指静态库，LIBRARY特指动态库，RUNTIME特指可执行目标二进制。

    INSTALL(TARGETS targets...

            [[ARCHIVE|LIBRARY|RUNTIME]

                [DESTINATION <dir>]

                  [PERMISSIONS permissions...]

                   [CONFIGURATIONS

            [Debug|Release|...]]

                   [COMPONENT <component>]

                   [OPTIONAL]

                 ] [...])

    示例如下：

    INSTALL(TARGETS myrun mylib mystaticlib

           RUNTIME DESTINATION bin

           LIBRARY DESTINATION lib

           ARCHIVE DESTINATION libstatic

    )

    上面的例子会将：

    可执行二进制myrun安装到${CMAKE_INSTALL_PREFIX}/bin目录

    动态库libmylib安装到${CMAKE_INSTALL_PREFIX}/lib目录

    静态库libmystaticlib安装到${CMAKE_INSTALL_PREFIX}/libstatic目录

    特别注意的是你不需要关心TARGETS具体生成的路径，只需要写上TARGETS名称就可以了。

    我的博客即将搬运同步至腾讯云+社区，邀请大家一同入驻：https://cloud.tencent.com/developer/support-plan?invite_code=1yx8jy1oza00c