简单的 C/C++ 项目自动化构建--Xmake

2023-06-21 294

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： 简单的 C/C++ 项目自动化构建--Xmake

Xmake 简介

https://xmake.io/#/

XMake是一个基于Lua的轻量级跨平台自动构建工具，支持在各种主流平台上构建项目。

Xmake = Build backend + Project Generator + Package Manager

它跟cmake、automake、premake有点类似，但是机制不同，它默认不会去生成IDE相关的工程文件，采用直接编译，并且更加的方便易用采用lua的工程描述语法更简洁直观，支持在大部分常用平台上进行构建，以及交叉编译。

已经有强大的cmake了，既生瑜何生亮，xmake好在哪？

相比 makefile/CMakeLists.txt，配置语法更加简洁直观，对新手非常友好。短时间内就能快速入门，能够让用户把更多的精力集中在实际的项目开发上。

能够使用它像 Make/Ninja 那样可以直接编译项目，也可以像 CMake/Meson 那样生成工程文件，另外它还有内置的包管理系统来帮助用户解决 C/C++ 依赖库的集成使用问题。

目前，Xmake 主要用于 C/C++ 项目的构建，但是同时也支持其他 native 语言的构建，可以实现跟 C/C++ 进行混合编译，同时编译速度也是非常的快，可以跟 Ninja 持平。

xmake的理念：真正的一致维护, 真正的一键编译。

构建行为的一致性: 不管你的项目是否有库依赖，工具依赖，只需要执行一个xmake命令，即可编译通过。

项目维护的一致性: 不管你的项目是在windows上用，还是给linux, iphone, android上用，都只需要一份xmake.lua维护项目即可。

而cmake还需要生成额外的第三方IDE工程文件，即使cmakelist.txt相同，但是构建、维护体验上对用户来讲都不可能保证完全一致，毕竟还受限于vc/make此类工具。

项目地址：

GitHub - xmake-io/xmake: 🔥 A cross-platform build utility based on Lua

增长趋势图，比cmake简单好用，有超越cmake之势。它是一个国人开发的不断维护发展壮大的项目，前景不错。

下载安装

windows下，安装包地址：

https://github.com/xmake-io/xmake/releases

或者使用powershell

Invoke-Expression (Invoke-Webrequest 'https://xmake.io/psget.text' -UseBasicParsing).Content

入门使用

创建项目

xmake也完全支持对Qt5项目的维护和构建。先举一个简单的入门例子：

创建一个名叫 hello 的c语言控制台工程（-l选项指定语言，若是cpp则指定为-l c++）：

-P 工程名(目录名)

$xmake create -l c -P ./hello

执行完后，将会生成一个简单工程结构：

其中xmake.lua是工程描述文件，内容非常简单，告诉xmake添加src目录下的所有.c源文件：

构建项目

$xmake

运行程序

$xmake run hello

调试程序

$xmake run -d hello

QT的项目创建

基于qt的项目，也是秒建。

举例，创建一个带qml的quickapp空工程，只需要敲如下命令：

$xmake create -t qt.quickapp test

xmake会生成带有xmake.lua的Qt项目，xmake.lua内容也很简单。

会自动检测你的qt本机安装的环境，自动的找到。当然也可以指定：

$xmake f --qt=/home/xxx/qtsdk

或者设置到全局路径，避免每次编译切换都要配置一遍：

$xmake g --qt=/home/xxx/qtsdk

除了源文件的添加，其他基本上都跟之前的可执行程序项目没什么不同，唯一的区别就是通过add_rules("qt.quickapp")这个内置的Qt构建规则来代替set_kind("binary")。

其实qt.quickapp规则内部最终还是设置了binary类型，只不过在此基础上额外增加了一些只有Qt才需要的构建规则，比如：特定links，flags还有includedirs等。

运行下看看：

$xmake run

运行和断点调试

我们可以通过xmake run -d命令来加载gdb/lldb调试程序，或者搭配xmake-vscode插件的断点调试支持，来开发和调试Qt程序。这块可以阅读前文：xmake从入门到精通3：运行和调试目标程序

集成vcpkg包管理

$xmake f --vcpkg=F:\vcpkg

比如加载以下库，xmake.lua示例：

add_requires("vcpkg::zlib 1.2.11")
target("test")
    add_files("src/*.c")
    add_packages("vcpkg::zlib")

至于加载conan的库，需要下载exe文件。安装后，配置path路径，然后就可以使用了如下：

add_requires("conan::poco/1.9.4", {alias = "poco", debug = true})

添加代理

注意添加代理,这样访问github会快：

$xmake g --proxy_pac=github_mirror.lua

关于包管理

关于包管理，虽然现在已经有了homebrew, vcpkg等包管理工具来解决这一问题，但是多少都有一些局限性。

例如：

homebrew不支持iphoneos, android, windows平台。

vcpkg不支持语义版本选择，多版本管理。

都不支持项目管理和构建。

做过c、c++开发的朋友都会有找库的痛苦。有时候要编译一个库，这个库又依赖其他的库，需要我们自己去搜索，下载，解压，编译安装，不同的平台编译方法有差异，编译好了又有可能发现需要的库的版本和我们下的不一致，工作要重头再来。

其他语言像java有maven对依赖的jar进行管理，像js有npm来做包管理，rust有cargo，主要这些语言要么背靠一个大公司，要么是一个独立的公司在运作，所以包管理作的都比较不错。

c或c++程序员就比较痛苦了，没有统一的包管理，都没有大规模流行起来，以至于很长时间我都不知道c、c++也有包管理器。后来发现c、c++ 也有些包管理器，比如微软的Vpckg在visual studio下使用；conan 有可能成为事实标准的包管理器，配合cmake，应用还是比较广泛。

关于conan ，conan这5年期间成长还是挺多的，现在可以用的库也达到了八百多个，如果没有的话，也可以很方便的自己写一个，上传到自己的私人包管理服务器里，C++开发终于有了cargo的感觉了。

xmake的包管理工具xrepo

使用举例：

PS F:\ccode\test> xrepo search zlib
The package names:
    zlib:
      -> chromium_zlib-2022.02.22: zlib from chromium (in xmake-repo)
      -> zlib-v1.2.11: A Massively Spiffy Yet Delicately Unobtrusive Compression Library (in xmake-repo)
      -> zlib-ng-2.0.5: zlib replacement with optimizations for next generation systems. (in xmake-repo)
PS F:\ccode\test> xrepo install  zlib 
note: install or modify (m) these packages (pass -y to skip confirm)?
in xmake-repo:
  -> zlib v1.2.11 [vs_runtime:"MT"]
please input: y (y/n/m)
y
  => install zlib v1.2.11 .. ok

PS F:\ccode\test> xrepo list-repo
global repositories:
    vcpkg https://github.com/microsoft/vcpkg
    conan https://github.com/conan-io/conan-center-index
    build-artifacts https://gitee.com/xmake-mirror/build-artifacts.git main
    xmake-repo https://gitee.com/tboox/xmake-repo.git master
    builtin-repo D:\Program Files\xmake\repository
5 repositories were found!
PS F:\ccode\test> xrepo rm-repo conan
remove global repository(conan): ok!

在xmake.lua下写就更简单了，增加一句话就行：

add_requires("zlib 1.2.11")

还可以用其他包管理器的包，比如：

add_requires("vcpkg::zlib 1.2.11")
target("test")
    add_files("src/*.c")
    add_packages("vcpkg::zlib")

build结果示例

举例，xmake.lua中增加如下库依赖：

add_requires("conan::poco/1.9.4", {alias = "poco", debug = true})

build过程：

PS F:\ccode\test> xmake
checking for Microsoft Visual Studio (x64) version ... 2019
note: install or modify (m) these packages (pass -y to skip confirm)?
in conan:
  -> conan::poco/1.9.4 latest [debug:y, vs_runtime:"MT"]
please input: y (y/n/m)
y
  => install conan::poco/1.9.4 latest .. ok
[ 25%]: compiling.release src\main.c
[ 50%]: linking.release test.exe
[100%]: build ok!