为Zed代码编辑器添加Lua脚本支持遇线程安全问题求助

核心问题分析 #

mlua的Lua类型默认不实现Send和Sync——这是因为Lua虚拟机本身是单线程设计。你用Arc<Mutex<Lua>>试图实现线程安全，但如果Lua本身不满足Send，Mutex<Lua>也无法满足Sync，最终导致LuaExtension结构体无法符合Zed扩展要求的线程安全约束（Zed的Extension trait隐含要求实现Send+Sync）。

解决方案步骤 #

1. 启用mlua的send特性 #

在Cargo.toml中为mlua添加send特性，让Lua实例实现Send trait：

[dependencies]
mlua = { version = "0.27", features = ["send"] }
zed_extension_api = "0.10"

2. 调整扩展结构体设计 #

无需单独存储LuaTable，将Lua实例用Arc<Mutex>包裹，每次调用扩展方法时通过锁获取Lua实例，再调用对应的Lua函数。这种方式既能避免生命周期绑定问题，也能保证线程安全。

3. 处理Zed类型的Lua转换 #

Zed扩展API中的类型（如LanguageServerId、Worktree）默认不实现mlua的ToLua trait，需要手动将其转换为Lua能处理的基本类型（比如字符串），或根据需求实现复杂类型的转换逻辑。

修改后的完整代码 #

use mlua::prelude::*;
use std::sync::{Arc, Mutex};
use zed_extension_api as zed;

struct LuaExtension {
    lua: Arc<Mutex<Lua>>,
    // 存储Lua扩展表的全局键名，避免重复加载
    extension_table_key: String,
}

impl zed::Extension for LuaExtension {
    fn new() -> Self
    where
        Self: Sized,
    {
        // 启用send特性后，创建线程安全的Lua实例
        let lua = Lua::new();
        let lua = Arc::new(Mutex::new(lua));

        let lua_script = include_str!("test.lua");
        let extension_table_key = "__ZED_LUA_EXTENSION_TABLE".to_string();

        {
            let mut lua_lock = lua.lock().unwrap();
            // 加载Lua脚本并将返回的表存入全局变量
            let lua_table: LuaTable = lua_lock
                .load(lua_script)
                .eval()
                .expect("failed to load Lua extension");
            lua_lock.globals().set(&extension_table_key, lua_table).unwrap();
        }

        LuaExtension { lua, extension_table_key }
    }

    fn language_server_command(
        &mut self,
        language_server_id: &zed::LanguageServerId,
        worktree: &zed::Worktree,
    ) -> Result<zed::Command, String> {
        let mut lua_lock = self.lua.lock().map_err(|e| e.to_string())?;
        let globals = lua_lock.globals();
        let extension_table: LuaTable = globals.get(&self.extension_table_key).map_err(|e| e.to_string())?;

        // 将Zed类型转换为Lua可接受的字符串类型
        let command_result: Vec<String> = extension_table
            .call_function(
                "language_server_command",
                (language_server_id.to_string(), worktree.path().to_string_lossy().to_string())
            )
            .map_err(|e| e.to_string())?;

        command_result
            .first()
            .cloned()
            .map(zed::Command::from)
            .ok_or_else(|| "Lua returned empty command list".to_string())
    }

    fn run_slash_command(
        &self,
        command: zed_extension_api::Command,
        args: Vec<String>,
        worktree: Option<&zed_extension_api::Worktree>,
    ) -> zed_extension_api::Result<zed_extension_api::CommandOutput, String> {
        let mut lua_lock = self.lua.lock().map_err(|e| e.to_string())?;
        let globals = lua_lock.globals();
        let extension_table: LuaTable = globals.get(&self.extension_table_key).map_err(|e| e.to_string())?;

        // 转换worktree为Lua可处理的字符串类型
        let worktree_path = worktree.map(|wt| wt.path().to_string_lossy().to_string());
        let output: String = extension_table
            .call_function("run_slash_command", (command.name, args, worktree_path))
            .map_err(|e| e.to_string())?;

        Ok(zed::CommandOutput::success(output))
    }
}

zed::register_extension!(LuaExtension);

关键说明 #

• 线程安全保障：启用send特性后，Lua实例实现Send，配合Arc<Mutex<Lua>>确保LuaExtension结构体满足Send+Sync，符合Zed扩展的要求。
• 生命周期处理：不再存储'static生命周期的LuaTable，每次调用时从Lua全局变量中获取，避免生命周期绑定问题。
• 类型转换：将Zed复杂类型转换为Lua原生支持的字符串，你可以根据需求扩展转换逻辑（比如将Worktree转换成Lua table）。

内容的提问来源于stack exchange，提问作者Sol Wolf