Makefile和CMake

Makefile和CMake

一、Makefile实战

1. Makefile基本概念

Makefile是一个自动化构建工具,它定义了一系列规则来指定如何编译和链接程序。其核心思想是目标(target)、依赖(prerequisites)和命令(command)三要素。通过比较目标文件和依赖文件的修改时间,决定哪些需要重新编译,从而实现增量构建。

2. Makefile三要素

一个典型的规则格式如下:

target: prerequisites
	command
  • 目标(target):通常是要生成的文件名,也可以是伪目标(如clean)。
  • 依赖(prerequisites):生成目标所需的文件或其他目标。
  • 命令(command):生成目标的具体shell命令,必须以Tab键开头,不能用空格。

示例:

all: test1 test2
	@echo "all done"

test1:
	@echo "test1"

test2:
	@echo "test2"

执行make会默认执行第一个目标all,输出:

test1
test2
all done

执行顺序:依赖树从底向上执行,同级依赖按从左到右顺序执行。

3. 工作原理:时间戳检测

Make通过比较目标文件和依赖文件的最后修改时间来决定是否重新生成目标。如果依赖比目标新,则执行命令更新目标。

示例:编译C程序

simple: main.o foo.o
	gcc -o simple main.o foo.o

main.o: main.c
	gcc -c main.c

foo.o: foo.c
	gcc -c foo.c

clean:
	rm -f simple *.o
  • 修改foo.c后,执行make:先重新编译foo.o,再重新链接simple;main.o未变动,跳过编译。
  • 这种增量编译大大提高了大型项目的构建效率。

4. 伪目标 .PHONY

当目标不是一个实际文件时(如clean),应声明为伪目标,避免与同名文件冲突。

.PHONY: clean
clean:
	rm -f *.o simple

5. 变量

Makefile支持变量,用于简化重复内容。常用赋值方式:

  • = :递归展开赋值(使用时才展开)
  • := :简单赋值(立即展开)
  • ?= :条件赋值(仅当变量未定义时赋值)

示例:

CC = gcc
CFLAGS = -Wall -g
TARGET = myapp
OBJS = main.o foo.o

$(TARGET): $(OBJS)
	$(CC) -o $@ $^

%.o: %.c
	$(CC) $(CFLAGS) -c $< -o $@

.PHONY: clean
clean:
	rm -f $(TARGET) $(OBJS)

6. 自动变量

自动变量在规则中自动展开,简化书写:

  • $@ :当前规则的目标文件名
  • $^ :所有依赖文件列表(去重)
  • $< :第一个依赖文件
  • $? :所有比目标新的依赖文件列表

示例对比:

# 不使用自动变量
simple: main.o foo.o
	gcc -o simple main.o foo.o

# 使用自动变量
simple: main.o foo.o
	gcc -o $@ $^

7. 函数

Makefile提供内置函数,如wildcard和patsubst,用于处理文件列表。

SRCS = $(wildcard *.c)                 # 获取所有.c文件
OBJS = $(patsubst %.c, %.o, $(SRCS))   # 将.c替换为.o

8. 依赖第三方库

通过变量管理头文件路径、库路径和链接库,便于跨平台适配。

CC = gcc
CFLAGS = -Wall -g
INCLUDES = -I/usr/local/include
LIBDIRS = -L/usr/local/lib
LIBS = -lpthread

TARGET = myapp
SRCS = $(wildcard *.c)
OBJS = $(SRCS:.c=.o)

$(TARGET): $(OBJS)
	$(CC) -o $@ $^ $(LIBDIRS) $(LIBS)

%.o: %.c
	$(CC) $(CFLAGS) $(INCLUDES) -c $< -o $@

.PHONY: clean
clean:
	rm -f $(TARGET) $(OBJS)
  • -I:指定头文件搜索路径
  • -L:指定库文件搜索路径
  • -l:指定要链接的库(如-lpthread链接libpthread.so)

9. 常见错误及排查

  • missing separator:命令前未使用Tab,而是用了空格。
  • undefined reference:可能源文件未加入编译列表,或未链接所需库。
  • 文件未找到:检查头文件路径(-I)和库路径(-L)是否正确。

调试技巧:

  • 使用make -n预览将要执行的命令。
  • 添加$(warning VAR)打印变量值。

二、CMake实战

1. CMake简介

CMake是一个跨平台的构建系统生成器,它通过CMakeLists.txt配置文件生成原生的构建文件(如Makefile、Visual Studio解决方案等)。相比手写Makefile,CMake更易于管理大型项目,并提供了丰富的模块和函数。

版本要求:建议使用CMake 3.10以上版本,低版本可能不支持某些特性。检查版本:cmake --version

2. 基本语法

一个最简单的CMakeLists.txt示例:

cmake_minimum_required(VERSION 3.10)
project(MyApp)

set(SOURCES main.c foo.c)

add_executable(myapp ${SOURCES})
  • cmake_minimum_required:指定所需的最低CMake版本。
  • project:定义项目名称。
  • set:设置变量。
  • add_executable:生成可执行文件。

编译流程:

mkdir build && cd build   # 在独立目录构建,保持源码清洁
cmake ..                  # 生成Makefile
make                      # 编译
./myapp                   # 运行

3. 变量与路径

CMake内置许多有用变量:

  • PROJECT_SOURCE_DIR:项目源码根目录
  • PROJECT_BINARY_DIR:构建目录
  • CMAKE_CURRENT_SOURCE_DIR:当前处理的CMakeLists.txt所在目录
  • EXECUTABLE_OUTPUT_PATH:可执行文件输出路径(可自定义)

打印变量调试:

message("PROJECT_SOURCE_DIR = ${PROJECT_SOURCE_DIR}")

4. 子目录管理

使用add_subdirectory添加子目录,每个子目录应有自己的CMakeLists.txt。

顶层CMakeLists.txt:

cmake_minimum_required(VERSION 3.10)
project(MultiDir)

add_subdirectory(src)
add_subdirectory(lib)

src/CMakeLists.txt:

add_executable(myapp main.c)
target_link_libraries(myapp mylib)   # 链接子目录生成的库

lib/CMakeLists.txt:

add_library(mylib STATIC foo.c)      # 生成静态库

5. 头文件包含

使用include_directories添加头文件搜索路径(但现代CMake推荐使用target_include_directories)。

include_directories(${PROJECT_SOURCE_DIR}/include)

6. 生成库

  • 静态库:add_library(mylib STATIC sources...)
  • 动态库:add_library(mylib SHARED sources...)

链接库:target_link_libraries(target lib1 lib2 ...)

注意:链接库名通常省略前缀lib和后缀(如mylib对应libmylib.so或libmylib.a)。

7. 自动收集源文件

使用aux_source_directory或file(GLOB ...)自动收集源文件。

aux_source_directory(. SRC_LIST)          # 收集当前目录所有.c/.cpp文件
add_executable(myapp ${SRC_LIST})

但注意aux_source_directory不会在添加新文件后自动重新运行CMake,需手动重新配置。

8. 安装

使用install命令指定安装规则:

install(TARGETS myapp DESTINATION bin)
install(FILES mylib.h DESTINATION include)

安装路径默认前缀为/usr/local,可通过-DCMAKE_INSTALL_PREFIX修改:

cmake .. -DCMAKE_INSTALL_PREFIX=/custom/path
make install

9. 第三方库查找

使用find_package查找系统已安装的库,例如OpenSSL:

find_package(OpenSSL REQUIRED)
if(OPENSSL_FOUND)
    include_directories(${OPENSSL_INCLUDE_DIR})
    target_link_libraries(myapp ${OPENSSL_LIBRARIES})
endif()

10. 条件编译与选项

通过选项控制编译行为:

 文件和链接
endif()

在命令行中覆盖默认值:

cmake .. -DUSE_MYSQL=OFF

11. 编译类型与标志

设置编译类型(Debug/Release):

cmake .. -DCMAKE_BUILD_TYPE=Debug

添加编译标志:

set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11 -Wall")

12. 静态库与动态库同名冲突

若同时生成静态库和动态库且同名,会导致冲突。可通过设置不同的输出名称解决:

add_library(mylib_static STATIC src/mylib.c)
add_library(mylib_shared SHARED src/mylib.c)
set_target_properties(mylib_static PROPERTIES OUTPUT_NAME mylib)
set_target_properties(mylib_shared PROPERTIES OUTPUT_NAME mylib)

13. 常见问题

  • CMakeLists.txt文件名拼写错误:必须严格命名为CMakeLists.txt。
  • 路径问题:注意相对路径是相对于当前源码目录,而非构建目录。
  • 库未链接:使用target_link_libraries显式链接。
  • 权限不足:安装到系统目录需要sudo make install。
posted @ 2026-03-06 17:54  xggx  阅读(44)  评论(0)    收藏  举报