sol2是纯头文件的现代Lua绑定库,需链接Lua库但无需编译;使用前必须调用open_libraries(),通过sol::state管理脚本执行与C++交互,并注意生命周期安全。

可以直接用 sol2,它比原生 Lua C API 简洁得多,也比 tolua++ 或 luabind 更现代、更轻量,且头文件即用,无需编译依赖。
安装 sol2:头文件直接包含即可
sol2 是纯头文件库,不需要构建或链接额外的静态/动态库。只要你的 C++ 编译器支持 C++17(推荐),就能直接使用。
- 从 GitHub 仓库 下载
sol.hpp,或用 vcpkg:vcpkg install sol2 - 确保包含路径中能访问到
sol.hpp,然后在源文件中写:#include
- 不需要链接
-llua?错——你仍需链接系统 Lua 库(如liblua5.4)或自己编译 Lua 静态库;sol2只是绑定层,不提供 Lua 解释器本身
初始化 sol2 并运行简单脚本
最简启动流程就是创建 sol::state 对象,调用 open_libraries(),再用 do_string() 或 script_file() 执行 Lua 代码。
-
sol::state构造时默认不加载任何标准库,必须显式调用open_libraries()(否则连print都找不到) - 错误处理别忽略:脚本执行失败会抛出
sol::error异常,建议用try/catch捕获 - 示例:
#include
#include iostream> int main() { sol::state lua; lua.open_libraries(); // 必须!否则 print、math 等都不可用 try { lua.script("print('Hello from Lua!')"); } catch (const sol::error& e) { std::cerr
从 C++ 调用 Lua 函数并传参
用 sol::state::get<:function>() 获取函数对象,支持自动类型转换(C++ 基本类型、std::string、std::vector 等常见类型基本都能直传)。
立即学习“C++免费学习笔记(深入)”;
- Lua 函数返回多个值时,
sol::function调用结果是sol::protected_function_result,需用valid()判断是否成功,并用as()提取 - 如果 Lua 函数返回
nil,而你尝试as,会抛异常;稳妥做法是先检查() valid(),再用as_optional() - 示例(Lua 中定义
add(a,b)): lua.script(R"( function add(a, b) return a + b end )"); sol::function add_func = lua["add"]; auto result = add_func(3, 4); if (result.valid()) { int sum = result.as(); // 得到 7 }
将 C++ 类暴露给 Lua(注册成员函数与属性)
用 sol::state::new_usertype() 注册类,支持构造函数、普通成员函数、getter/setter、静态函数等,语法接近 Rust 的 derive 风格。
- 不要直接暴露裸指针(如
MyClass*);优先用std::shared_ptr或让 sol2 管理生命周期(通过sol::constructors) - 成员函数若含重载,sol2 默认无法自动分辨,需用
sol::resolve()显式指定签名 - 属性暴露用
sol::property包裹 lambda,避免直接暴露公有成员变量(破坏封装) - 示例:
struct Vec2 {
float x = 0.f, y = 0.f;
Vec2(float x_, float y_) : x(x_), y(y_) {}
float len() const { return sqrtf(x*x + y*y); }
};
lua.new_usertype
("Vec2", sol::constructors (), "x", &Vec2::x, "y", &Vec2::y, "len", &Vec2::len ); // Lua 中可写:local v = Vec2.new(3, 4); print(v:len())
真正容易卡住的地方不是语法,而是生命周期管理:Lua 对象引用 C++ 对象时,谁负责释放?sol2 默认按值拷贝或共享指针语义工作,但如果你传入栈上对象地址或自定义析构逻辑,就得手动控制 sol::object 的引用计数或用 sol::unique_usertype。这点文档里藏得深,出问题时往往表现为崩溃或 double-free。











