从零开始：Makefile 与 CMake 的基础入门与实践

本文适合基础学者零基础

makefile

定义：Makefile 是一种传统的构建工具，用于定义如何编译和链接源代码。它通过一系列规则来描述如何生成目标文件（如可执行文件或库）。
功能：
定义编译规则（如如何从源文件生成目标文件）。
指定依赖关系（如哪些文件需要重新编译）。
执行编译、链接等任务。
特点：
灵活性高，可以直接控制构建过程。
适用于小型项目或简单的构建需求。
编写规则需要手动处理依赖关系和平台差异。

server:g++ server.cpp -o server && g++ client.cpp -o client

即编译server.cpp 和clien.cpp 分别命名为server 和client

CMake

定义：CMake 是一个跨平台的构建工具生成器。它通过读取项目的配置文件（通常是 CMakeLists.txt），生成适合特定平台的构建系统（如 Makefile、Visual Studio 项目文件等）。
功能：
自动生成 Makefile 或其他构建系统文件。
检测平台和编译器特性，自动调整构建规则。
管理项目的依赖关系和库路径。
支持复杂的项目结构和多平台构建。
特点：
高度抽象，简化了跨平台构建的复杂性。
适用于大型项目或需要跨平台支持的项目。
需要编写 CMakeLists.txt 文件来描述项目的结构和依赖关系。

总结两者关系

Makefile 是一种具体的构建工具，直接用于编译和链接代码。
CMake 是一个构建工具生成器，它通过生成 Makefile 或其他构建系统文件来简化构建过程。
关系：CMake 是 Makefile 的“上层工具”，它生成 Makefile，而 Makefile 是实际执行构建任务的工具。

零基础写cmake

创建一个cmakelist.txt
运行命令为 cmake .
然后为 make

最基本的cmake


# 设置 CMake 最低版本
cmake_minimum_required(VERSION 3.10)# 定义项目名称
project(MyProject)# 指定源文件路径
set(SOURCE_FILESsrc/main.cppsrc/utils.cpp
)
add_executable(${PROJECT_NAME} ${SOURCE_FILES})

set
set(VARIABLE_NAME VALUE1 VALUE2 ... VALUE_N)
- VARIABLE_NAME：变量的名称。
- VALUE1 … VALUE_N：变量的值，可以是字符串、路径、文件名等(文件路径为项目根目录的路径（相对路径）)
add_executable
add_executable(TARGET_NAME SOURCE_FILES)
- TARGET_NAME：生成的可执行文件的名称。
- SOURCE_FILES：用于生成可执行文件的源文件列表（$是代表变量的意思）
  你也可以不使用变量：
- add_executable(my_program src/main.cpp src/utils.cpp)

疑问：他有两个文件你怎么一个变量参数？
set 命令可以将多个值赋给一个变量，形成一个列表。当你将这个变量传递给 add_executable 时，CMake 会将这个列表展开，作为多个参数传递给add_executable。这就是为什么一个变量可以代表多个文件的原因。

链接其他库

前言
静态库

定义：静态库是编译后的代码，直接嵌入到可执行文件中。生成的可执行文件是独立的，不需要额外的库文件。
优点：可执行文件是独立的，不需要额外的库文件。
适合小型项目或需要独立分发的程序。
缺点：可执行文件体积较大。
库的更新需要重新编译整个程序。

动态库

定义：动态库是编译后的代码，但在运行时加载。生成的可执行文件需要在运行时找到动态库文件。
优点：
可执行文件体积较小。
多个程序可以共享同一个动态库。
库的更新不需要重新编译整个程序。
缺点：
可执行文件依赖于动态库文件，需要确保运行时库文件存在。
需要管理动态库的路径。

系统库(单个库)

cmake_minimum_required(VERSION 3.10)
project(MyProject)# 指定头文件路径
include_directories(include)# 指定源文件
set(SOURCE_FILESsrc/main.cpp
)# 生成可执行文件
add_executable(${PROJECT_NAME} ${SOURCE_FILES})# 查找系统库
find_library(SSL_LIBRARY ssl)# 链接到目标
target_link_libraries(${PROJECT_NAME} ${SSL_LIBRARY})

find_library
find_library(VARIABLE_NAME library_name [PATHS path1 path2 ...])
VARIABLE_NAME：用于存储找到的库文件路径的变量名。
library_name：要查找的库文件名（不包括前缀 lib 和后缀 .so、.a 等）。
PATHS（可选）：指定查找库文件的路径列表。如果省略，CMake 会在默认的系统库路径中查找。

在 Linux 系统中，CMake 会查找以下默认路径：
/usr/lib
/usr/local/lib
/lib
/usr/lib64（64位系统）
/usr/local/lib64（64位系统
Windows
C:\Windows\System32
C:\Windows\System
C:\Windows
C:\Program Files
C:\Program Files (x86)
你可以通过运行以下命令查看 CMake 的默认库查找路径:cmake --help-variable CMAKE_FIND_ROOT_PATH

include_directories ([AFTER|BEFORE] dir1 [dir2 ...])
- AFTER 或 BEFORE（可选）：指定目录的优先级。默认是 AFTER，表示目录会添加到包含路径的后面。如果指定 BEFORE，目录会添加到包含路径的前面。
- dir1, dir2, …：要添加的头文件路径。

自己的库

cmake_minimum_required(VERSION 3.10)
project(MyProject)# 添加子目录（如果库在子目录中）
add_subdirectory(lib/mylib)# 指定头文件路径
include_directories(include)# 指定源文件
set(SOURCE_FILESsrc/main.cppsrc/utils.cpp
)# 生成可执行文件
add_executable(${PROJECT_NAME} ${SOURCE_FILES})# 链接到库
target_link_libraries(${PROJECT_NAME} mylib)

这个你添加目录就行了add_subdirectory(lib/mylib)

第三方库（多库可以算框架吧）

cmake_minimum_required(VERSION 3.10)
project(MyProjectWithDependencies)# 指定头文件路径
include_directories(include)# 指定源文件
set(SOURCE_FILESsrc/main.cpp
)# 生成可执行文件
add_executable(${PROJECT_NAME} ${SOURCE_FILES})# 查找第三方库（如 Boost）
find_package(Boost REQUIRED)
include_directories(${Boost_INCLUDE_DIRS})
target_link_libraries(${PROJECT_NAME} ${Boost_LIBRARIES})

find_package(PackageName [version] [REQUIRED])
- PackageName：要查找的包名称。
- version（可选）：指定所需的包版本。
- REQUIRED（可选）：如果包未找到，CMake 会报错并停止构建。
  并设置

Boost_INCLUDE_DIRS：包含 Boost 的头文件路径。
Boost_LIBRARIES：包含 Boost 的库文件路径。

跨平台

cmake_minimum_required(VERSION 3.10)
project(MyCrossPlatformProject)# 指定源文件
set(SOURCE_FILESsrc/main.cpp
)# 生成可执行文件
add_executable(${PROJECT_NAME} ${SOURCE_FILES})# 根据平台设置不同的编译选项
if(WIN32)target_compile_definitions(${PROJECT_NAME} PRIVATE _WIN32)
elseif(APPLE)target_compile_definitions(${PROJECT_NAME} PRIVATE _MACOS)
elseif(UNIX)target_compile_definitions(${PROJECT_NAME} PRIVATE _LINUX)
endif()

target_compile_definitions(TARGET_NAME [INTERFACE|PUBLIC|PRIVATE] definition1 [definition2 ...]) -
- TARGET_NAME：目标名称（通常是通过 add_executable 或 add_library 定义的）。
- INTERFACE、PUBLIC、PRIVATE（可选）：指定宏的作用域：
- - INTERFACE：宏对目标本身和依赖该目标的其他目标可见。
- -PUBLIC：宏对目标本身和依赖该目标的其他目标可见。
- - PRIVATE：宏仅对目标本身可见。
definition1, definition2, …：要定义的宏。

优化和调试

Debug 构建
目的：用于开发和调试阶段。
特点：
包含调试信息（如符号表），便于使用调试器（如 GDB）进行调试。
不启用优化，确保代码的可读性和调试的准确性。
通常会定义调试相关的宏（如 _DEBUG）。
编译选项：
-g：生成调试信息。
用途：帮助开发者快速定位和修复问题。
2. Release 构建
目的：用于生产环境或最终发布。
特点：
启用优化，提高代码的执行效率。
不包含调试信息，减小可执行文件的体积。
通常会定义发布相关的宏（如 NDEBUG）。
编译选项：
-O3：启用最高级别的优化。
用途：确保程序在生产环境中性能最佳。

cmake_minimum_required(VERSION 3.10)
project(MyOptimizedProject)# 指定源文件
set(SOURCE_FILESsrc/main.cpp
)# 生成可执行文件
add_executable(${PROJECT_NAME} ${SOURCE_FILES})# 设置编译选项
if(CMAKE_BUILD_TYPE STREQUAL "Release") #CMAKE_BUILD_TYPE 内置变量 STREQUAL：是否相等target_compile_options(${PROJECT_NAME} PRIVATE -O3) #：GCC/Clang 编译器的优化选项，启用最高级别的优化
elseif(CMAKE_BUILD_TYPE STREQUAL "Debug")target_compile_options(${PROJECT_NAME} PRIVATE -g) # -g：GCC/Clang 编译器的选项，用于生成调试信息
endif()

生成安装脚本

cmake_minimum_required(VERSION 3.10)
project(MyInstallableProject)# 指定源文件
set(SOURCE_FILESsrc/main.cpp
)# 生成可执行文件
add_executable(${PROJECT_NAME} ${SOURCE_FILES})# 设置安装路径
install(TARGETS ${PROJECT_NAME}DESTINATION bin
)

install(TARGETS target1 [target2 ...]DESTINATION destination[RUNTIME DESTINATION runtime_destination][LIBRARY DESTINATION library_destination][ARCHIVE DESTINATION archive_destination][PERMISSIONS permissions...])

TARGETS：指定要安装的目标（如可执行文件或库）。
DESTINATION：指定安装目标的目录。
RUNTIME DESTINATION（可选）：指定可执行文件的安装目录。
LIBRARY DESTINATION（可选）：指定动态库的安装目录。
ARCHIVE DESTINATION（可选）：指定静态库的安装目录。
PERMISSIONS（可选）：指定安装文件的权限。

示例
假设你有一个项目，需要将生成的可执行文件安装到 /usr/local/bin 目录。

DESTINATION：指定安装目录，这里是 bin。如果安装路径是绝对路径（如 /usr/local/bin），则文件会被安装到该路径。如果路径是相对的，则文件会被安装到 CMake 的安装前缀（默认是 CMAKE_INSTALL_PREFIX，通常是 /usr/local）下的对应目录。

cmake .#生成makefile文件
make #执行makefile文件
sudo make install#安装