QML项目子文件夹多qmldir文件维护繁琐，如何优化？

项目结构 #

root_folder/
│
├── main.py
├── main.qml
├── qmldir
│
├── qml/
│   ├── app.qml
│   ├── qmldir
│   │
│   ├── pages/
│   │   ├── page1.qml
│   │   ├── page2.qml
│   │   └── qmldir
│   │
│   └── components/
│       ├── component1.qml
│       ├── component2.qml
│       └── qmldir
│
└── py/

问题分析 #

当前项目通过多份qmldir实现组件跨目录访问，但新增组件时需要在多份文件中添加条目，维护成本高。考虑两种优化方案：合并qmldir为单个文件，或改用相对导入。

方案1：合并所有qmldir为单个文件 #

完全可行，具体操作如下：

• 保留根目录下的qmldir，删除其他子目录的qmldir；
• 在根目录qmldir中统一注册所有QML组件，示例格式：

  // root_folder/qmldir
  module Root
  App 1.0 qml/app.qml
  Page1 1.0 qml/pages/page1.qml
  Page2 1.0 qml/pages/page2.qml
  Component1 1.0 qml/components/component1.qml
  Component2 1.0 qml/components/component2.qml
  

• 在任意QML文件中通过导入根模块访问组件：

  import Root 1.0
  
  Page1 { /* ... */ }
  Component1 { /* ... */ }
  

优缺点：

• 优点：集中管理所有组件注册，新增组件仅需修改一份文件，维护成本极低；
• 缺点：若项目规模极大，单个qmldir会变得冗长，但相比多文件维护仍更高效。

方案2：改用相对导入 #

同样可行，无需任何qmldir，直接在QML文件中通过相对路径导入组件：

// qml/app.qml中导入页面组件
import "./pages"
import "./components"

Page1 { /* ... */ }
Component1 { /* ... */ }

优缺点：

• 优点：完全省去qmldir的维护工作，适合小型项目或组件层级简单的场景；
• 缺点：组件路径变更时需同步修改所有导入语句，大型项目中依赖关系易混乱，代码可读性较差。

更优解决方案：模块化分层管理 #

结合模块化思想，既保持组件分类清晰，又减少qmldir维护量：

1. 为pages和components分别设置独立模块：
   • qml/pages/qmldir：

     module Pages
     Page1 1.0 page1.qml
     Page2 1.0 page2.qml
     

   • qml/components/qmldir：

     module Components
     Component1 1.0 component1.qml
     Component2 1.0 component2.qml
     

2. 在qml/qmldir中导入这两个子模块：

   module App
   import Pages 1.0
   import Components 1.0
   App 1.0 app.qml
   

3. 在根目录qmldir中导入App模块：

   module Root
   import App 1.0
   

4. 最终在任意QML文件中通过模块名导入：

   import Pages 1.0
   import Components 1.0
   
   Page1 { /* ... */ }
   Component1 { /* ... */ }
   

优势：

• 新增组件仅需在对应子目录的qmldir中添加条目，无需修改其他文件；
• 模块划分清晰，代码可读性强，适合中大型项目；
• 避免单个qmldir过于冗长，同时保留了模块导入的便捷性。

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