Xmake 项目中 header-only 包的正确配置方式
2025-05-22 00:42:04作者:明树来
问题背景
在使用 Xmake 构建系统管理 C++ 项目时,开发者经常会遇到需要集成第三方库的情况。其中,nlohmann-json 是一个非常流行的 C++ JSON 库,它以纯头文件(header-only)的形式提供。最近 Xmake 开发版本(v2.9.3+)对这类纯头文件库的包管理方式做了重要调整。
问题现象
当用户尝试安装 nlohmann-json 包时,构建过程会失败并显示错误信息"package(nlohmann-json): links not found!"。这是因为 Xmake 默认会检查包的链接库,而纯头文件库实际上并不需要编译或链接任何库文件。
解决方案
Xmake 开发版本现在要求所有纯头文件库必须显式声明为 headeronly
类型。对于 nlohmann-json 这样的纯头文件库,正确的包定义方式是在 xmake.lua 中添加 set_kind("headeronly")
声明:
package("nlohmann-json")
set_kind("headeronly") -- 关键声明
set_homepage("https://nlohmann.github.io/json/")
set_description("JSON for Modern C++")
set_license("MIT")
-- 其余配置保持不变
add_urls("git@github.xxx.com:ceph/nlohmann-json.git")
add_versions("v3.11.3", "9cca280a4d0ccf0c08f47a99aa71d1b0e52f8d03")
add_deps("cmake")
on_install(function (package)
local configs = {"-DJSON_BuildTests=OFF"}
import("package.tools.cmake").install(package, configs)
end)
on_test(function (package)
-- 测试代码保持不变
end)
技术原理
纯头文件库(header-only)与常规库有以下重要区别:
- 无需编译:代码实现全部在头文件中,直接包含即可使用
- 无链接步骤:不会生成静态库(.a)或动态库(.so/.dll)文件
- 即时可用:包含头文件后立即可调用功能
Xmake 通过 headeronly
标记来识别这类特殊库,从而跳过不必要的编译和链接检查步骤。这种显式声明的方式比隐式推断更加可靠,能避免各种边界情况下的问题。
最佳实践
对于纯头文件库的 Xmake 包定义,建议:
- 始终明确设置
set_kind("headeronly")
- 在
on_install
阶段只需处理头文件的安装 - 测试阶段验证头文件能否正常包含和使用
- 不需要处理任何链接库相关的配置
这种声明方式不仅适用于 nlohmann-json,也适用于任何其他纯头文件库,如 Catch2、fmt 等。
总结
Xmake 对纯头文件库管理的改进体现了构建系统对现代 C++ 开发模式的支持。通过显式声明库类型,开发者可以更精确地控制构建过程,而构建系统也能做出更合理的决策。这一变化虽然简单,但对于确保构建可靠性和一致性非常重要。
登录后查看全文
热门项目推荐
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文(最高 256K tokens)、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型,并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0265cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K

deepin linux kernel
C
22
6

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

React Native鸿蒙化仓库
C++
192
273

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K

Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8