O3DE项目中Lua Editor设置持久化问题分析与解决方案

问题背景

在O3DE项目的Lua Editor中，用户发现了一个影响使用体验的问题：编辑器的设置无法正确保存。具体表现为用户在设置对话框中修改配置后，关闭并重新启动编辑器时，所有设置都会恢复为默认值，导致用户每次都需要重新配置。

问题根源分析

经过深入调查，发现问题出在设置文件的存储路径不一致上。核心问题在于：

1. 路径获取不一致：编辑器在加载和保存设置时使用了不同的存储路径

   • 加载时路径：~/.local/share/LuaIDE
   • 保存时路径：~/.local/share/O3DE/O3DE Editor/LuaIDE

2. 原因追溯：这种不一致性源于应用程序名称的设置时机不当。在UIFramework.cpp的Framework::Run函数中，设置了组织名称和应用程序名称：

   pApplication->setOrganizationName("O3DE");
   pApplication->setApplicationName("O3DE Editor");
   

   但这些设置在反序列化(加载)过程之后才执行，导致路径计算不一致。

解决方案探讨

针对这个问题，开发团队提出了几种解决方案：

1. 调整设置时机：将组织名称和应用程序名称的设置移到EditorFrameworkApplication.cpp的CreateApplicationComponent函数中，确保在反序列化前完成设置。

2. 更改存储位置：更改为使用项目用户目录存储设置文件，这样不仅解决了路径问题，还能实现按项目保存不同配置的额外好处。修改后的路径获取代码如下：

   AZStd::string Application::GetApplicationGlobalStoragePath()
   {
       return AZ::Utils::GetProjectUserPath().c_str();
   }
   

   这样设置文件将存储在：项目目录/user/LuaIDE/下。

最终解决方案

经过权衡，开发团队采用了第二种方案，即更改存储位置到项目用户目录。这一方案具有以下优势：

1. 解决路径不一致问题：确保加载和保存使用相同路径
2. 更好的隔离性：每个项目可以有自己的Lua Editor配置
3. 符合O3DE项目结构：与其他用户数据统一存储在user目录下
4. 便于管理：设置文件与项目一起存储，便于版本控制和迁移

验证与后续

该修复已合并到主分支。用户可以通过以下方式验证问题是否解决：

1. 修改Lua Editor设置并保存
2. 检查项目user目录下的LuaIDE子目录
3. 确认GlobalUserSettings.xml文件中的值已更新
4. 重启编辑器验证设置是否保持

如果问题仍然存在，可能是由于未更新到包含修复的版本，或者存在其他未发现的配置问题。

总结

这个案例展示了配置持久化中路径一致性的重要性，以及在复杂应用程序中组件初始化顺序的关键作用。通过将配置存储在项目相关目录中，不仅解决了当前问题，还提供了更好的用户体验和项目管理能力。