diff --git a/docs/code_framework.md b/docs/code_framework.md index 62e3c76..ff20245 100644 --- a/docs/code_framework.md +++ b/docs/code_framework.md @@ -1,66 +1,67 @@ -## 项目目录结构 +## 椤圭洰鐩綍缁撴瀯 -项目开发的目录结构保持一致,容易理解并方便管理。 +椤圭洰寮鍙戠殑鐩綍缁撴瀯淇濇寔涓鑷达紝瀹规槗鐞嗚В骞舵柟渚跨鐞嗐 -## 目录结构 +## 鐩綍缁撴瀯 -- `/app/` 服务端总工作目录 +- `/app/` 鏈嶅姟绔伐浣滅洰褰 - `/app/controller/` 路由入口Action层 + `/app/controller/` 璺敱鍏ュ彛Action灞 - `/app/config/` 业务配置层 + `/app/common/` 瀛樻斁鍏叡鍑芥暟鍜屽父閲忓畾涔 - `/app/dao/` 数据库表实例层 + `/app/dao/` 鏁版嵁搴撹〃瀹炰緥灞 - `/app/model/` 模型文件存放目录 + `/app/service/` 涓氬姟閫昏緫灞 - `/app/service/` 业务逻辑层 +- `/uweb/` 绠$悊绔伐浣滅洰褰 - `/app/service/algorithm/` 算法层 + `/uweb/custom/` WEB绔墍闇闈欐佹枃浠剁洰褰 - `/app/service/feature/` 特征层 + `/uweb/lib/` WEB绔鏋剁洰褰 - `/app/utils/` 存放公共函数 + `/uweb/src/` WEB绔紑鍙戠洰褰 -- `/uweb/` 管理端总工作目录 + `/uweb/src/pages/` WEB绔墍鏈夐〉闈㈢殑鐩綍 - `/uweb/custom/` WEB端所需静态文件目录 + `/uweb/src/plugins/` WEB绔嚜瀹氫箟鎻掍欢鐩綍 - `/uweb/lib/` WEB端框架目录 + `/uweb/src/app.json` WEB绔厤缃枃浠 - `/uweb/src/` WEB端开发目录 + `/uweb/src/app.less` WEB绔叏灞鏍峰紡鏂囦欢 - `/uweb/src/pages/` WEB端所有页面的目录 + `/uweb/dist/` WEB绔墦鍖呭悗鐨勯潤鎬佹枃浠剁洰褰 - `/uweb/src/plugins/` WEB端自定义插件目录 +- `/time_series_detector/` 鏃堕棿搴忓垪寮傚父妫娴嬪浠剁洰褰 - `/uweb/src/app.json` WEB端配置文件 + `/time_series_detector/model/` 妯″瀷鏂囦欢瀛樻斁鐩綍 + + `/time_series_detector/algorithm/` 绠楁硶灞 - `/uweb/src/app.less` WEB端全局样式文件 + `/time_series_detector/feature/` 鐗瑰緛灞 + + 椤圭洰涓敮鎸佷互涓嬬被鍨嬬殑鏂囦欢锛 + 1. `.json`: 閰嶇疆鏂囦欢 + 2. `.uwx`: UWEB 瑙嗗浘鏂囦欢 + 3. `.uw`: UWEB 閫昏緫鑴氭湰 + 4. `.js`: 鏅 JavaScript 閫昏緫鑴氭湰 + 5. `.ts`: 鏅 TypeScript 閫昏緫鑴氭湰 + 6. `.less`: Less 鏍峰紡鏂囦欢 + 7. `.css`: CSS 鏍峰紡鏂囦欢 + 8. `.jsx`: 寮鍙戣嚜瀹氫箟鎻掍欢鏃跺彲浣跨敤鐨 JavaScript React 鑴氭湰鏂囦欢 + 9. `.tsx`: 寮鍙戣嚜瀹氫箟鎻掍欢鏃跺彲浣跨敤鐨 TypeScript React 鑴氭湰鏂囦欢 + 10. `.png`銆乣.jpg`銆乣.gif`銆乣.svg`: 鍥剧墖鏂囦欢 - `/uweb/dist/` WEB端打包后的静态文件目录 - - 项目中支持以下类型的文件: - 1. `.json`: 配置文件 - 2. `.uwx`: UWEB 视图文件 - 3. `.uw`: UWEB 逻辑脚本 - 4. `.js`: 普通 JavaScript 逻辑脚本 - 5. `.ts`: 普通 TypeScript 逻辑脚本 - 6. `.less`: Less 样式文件 - 7. `.css`: CSS 样式文件 - 8. `.jsx`: 开发自定义插件时可使用的 JavaScript React 脚本文件 - 9. `.tsx`: 开发自定义插件时可使用的 TypeScript React 脚本文件 - 10. `.png`、`.jpg`、`.gif`、`.svg`: 图片文件 - -- `/docs/` 项目文档存放目录 +- `/docs/` 椤圭洰鏂囨。瀛樻斁鐩綍 -## 调用关系 +## 璋冪敤鍏崇郴 -`/app/controller/` 为服务端路由入口,可调用service业务层 +`uweb` 涓虹鐞嗙宸ヤ綔鐩綍锛屽彲璋冪敤鏈嶅姟绔帴鍙 -`/app/service/` 为service业务层,可调用私有对象dao数据库层 +`/app/controller/` 涓烘湇鍔$璺敱鍏ュ彛锛屽彲璋冪敤service涓氬姟灞 -`/app/model/` 模型文件存放目录,供service业务层加载 +`/app/service/` 涓簊ervice涓氬姟灞傦紝鍙皟鐢ㄧ鏈夊璞ao鏁版嵁搴撳眰鍜宼ime_series_detector瀛︿欢鎺ュ彛 + +`/time_series_detector/` 瀛︿欢鐩綍锛屼緵service涓氬姟灞傝皟鐢 -`/app/utils/` 公共函数层全局可调用 \ No newline at end of file diff --git a/docs/images/code_arch.png b/docs/images/code_arch.png index 6d30acd..35c3073 100644 Binary files a/docs/images/code_arch.png and b/docs/images/code_arch.png differ