整体规范

以下为 UCF-WEB 中脚手架整体结构规范说明:

  1. .
  2. ├── LICENSE # 开源协议
  3. ├── README.md # 项目脚手架说明
  4. ├── docs # 开发业务说明文档目录
  5. └── README.md
  6. ├── package.json # npm packages 依赖包
  7. ├── ucf-apps # 【目录名不可修改】微服务应用根目录,用于加载微服务
  8. ├── demo-app-org # 组织管理示例
  9. └── demo-app-staff # 同上不在阐述
  10. ├── ucf-common # 【目录名不可修改】公共组件、样式、图片、字体等静态资源存放
  11. ├── README.md # 描述公共组件等说明
  12. └── src
  13. ├── ucf-publish # 【目录名不可修改】构建出来的静态资源
  14. ├── demo-app-org # 组织管理示例
  15. └── demo-app-staff
  16. └── ucf.config.js # ucf 核心配置文件

特别说明

一级文件夹归类说明(以下三个文件目录为框架内置,不可修改):

目录 说明
ucf-apps 各个微应用子目录
ucf-common 项目级公共资源,如公共组件、样式、资源、函数库等。
ucf-publish 构建出来的静态资源文件,用于部署和集成

两种微应用目录结构说明

遵循【功能优先】的原则,区分不同应用类型。

MPA 微应用目录

ucf-cli 1.4.0版本以前

  1. MPA
  2. ├── README.md
  3. ├── package.json
  4. └── src
  5. ├── app.js
  6. ├── app.less
  7. ├── components
  8. ├── App
  9. ├── index.js
  10. └── index.less
  11. ├── OrgModal
  12. └── index.js
  13. └── SearchArea
  14. ├── index.js
  15. └── index.less
  16. ├── container.js
  17. ├── index.html
  18. ├── model.js
  19. └── service.js
  20. 5 directories, 13 files

ucf-cli 1.4.0版本及以后

  1. MPA
  2. ├── README.md
  3. ├── package.json
  4. └── src
  5. ├── app.js
  6. ├── app.less
  7. ├── components
  8. ├── App
  9. ├── index.js
  10. └── index.less
  11. ├── OrgModal
  12. └── index.js
  13. └── SearchArea
  14. ├── index.js
  15. └── index.less
  16. ├── index.html
  17. ├── model.js
  18. └── service.js
  19. 5 directories, 13 files

SPA 微应用目录

ucf-cli 1.4.0版本以前

  1. SPA
  2. ├── README.md
  3. ├── package.json
  4. └── src
  5. ├── app.js
  6. ├── app.less
  7. ├── index.html
  8. └── routes
  9. ├── contact
  10. ├── components
  11. └── IndexView
  12. ├── index.js
  13. └── index.less
  14. ├── container.js
  15. ├── model.js
  16. └── service.js
  17. ├── home
  18. ├── components
  19. └── IndexView
  20. ├── index.js
  21. └── index.less
  22. ├── container.js
  23. ├── model.js
  24. └── service.js
  25. └── index.js
  26. 10 directories, 20 files

ucf-cli 1.4.0版本及以后

  1. SPA
  2. ├── README.md
  3. ├── package.json
  4. └── src
  5. ├── app.js
  6. ├── app.less
  7. ├── index.html
  8. └── routes
  9. ├── contact
  10. ├── components
  11. └── IndexView
  12. ├── index.js
  13. └── index.less
  14. ├── model.js
  15. └── service.js
  16. ├── home
  17. ├── components
  18. └── IndexView
  19. ├── index.js
  20. └── index.less
  21. ├── model.js
  22. └── service.js
  23. └── index.js
  24. 10 directories, 20 files

详细说明

默认支持 alias 别名

按照原有的开发规范,我们统一需要拆分出来的公共组件、样式、资源图片等资源,需要放到ucf-common/src文件夹下,可以在里面建立自己的文件夹归档,默认的已经划分为componentsstaticstylesutils等,对应的alias内置了一些默认别名如下:

alias 别名 对应的实际路径
ucf-apps ucf-apps/
ucf-common ucf-common/src/
components ucf-common/src/components/
static ucf-common/src/static/
utils ucf-common/src/utils/

以上别名如果不够,可在 ucf.config.js 中的alias字段中进行扩展。
_

构建后的资源规范(ucf-publish目录)

构建完成后的目录:

  1. ucf-publish
  2. ├── demo-app-org
  3. ├── index.css
  4. ├── index.html
  5. └── index.js
  6. └── demo-app-staff
  7. ├── index.css
  8. ├── index.html
  9. └── index.js
  10. 2 directories, 6 files

微应用相关规范和介绍访问 微应用类型