Cursor rule

1---
2description: 模块开发(module)
3globs: 
4---
5# 模块开发(module)
6 
7对于一个应用开发，我们应该更加有规划，`cool-admin`提供了模块开发的概念。
8 
9建议模块目录`src/modules/模块名`
10 
11```ts
12 ├── modules
13 │   └── base(基础的权限管理系统)
14 │   │    └── controller(api接口， 用法参考 [controller.mdc](mdc:.cursor/rules/controller.mdc) ，必要时需要创建关联查询， 配置pageQueryOp)
15 │   │    │    └── admin(后台管理接口)
16 │   │    │    └── app(应用接口，如小程序APP等)
17 │   │    └── dto(可选，参数校验)
18 │   │    └── entity(实体类， 用法参考 [db.mdc](mdc:.cursor/rules/db.mdc) )
19 │   │    └── middleware(可选，中间件， 参考 [middleware.code-snippets](mdc:.vscode/middleware.code-snippets) [authority.ts](mdc:src/modules/base/middleware/authority.ts) )
20 │   │    └── schedule(可选，定时任务 参考 [task.mdc](mdc:.cursor/rules/task.mdc) )
21 │   │    └── service(服务，写业务逻辑，参考 [service.mdc](mdc:.cursor/rules/service.mdc) )
22 │   │    └── config.ts(必须，模块的配置)
23 │   │    └── db.json(可选，初始化该模块的数据，参考 [db.json](mdc:src/modules/base/db.json) )
24 │   │    └── menu.json(可选(7.x新增，配合模块市场使用)，初始化该模块的菜单，参考 [menu.json](mdc:src/modules/base/menu.json) )
25 
26```
27 
28创建模块一般需要创建`controller`、`entity`、`service`，
29如果entity文件夹没有子文件夹，那么引用BaseEntity是
30 
31 - 引用BaseEntity固定为
32 
33```ts
34import { BaseEntity } from '../../modules/base/entity/base';
35```
36 
37 错误示例
38 
39```ts
40import { BaseEntity } from '../../../modules/base/entity/base';
41```
42 
43 多了一个层级
44 
45## 模块配置
46 
47#### config.ts
48 
49```ts
50import { ModuleConfig } from '@cool-midway/core';
51 
52/**
53 * 模块配置
54 */
55export default () => {
56  return {
57    // 必须，模块名称
58    name: '聊天模块',
59    // 必须，模块描述
60    description: '基于socket.io提供即时通讯聊天功能',
61    // 可选，中间件，只对本模块有效
62    middlewares: [],
63    // 可选，全局中间件
64    globalMiddlewares: [],
65    // 可选，模块加载顺序，默认为0，值越大越优先加载
66    order: 1;
67    // 其他配置，jwt配置
68    jwt: 'IUFHOFNIWI',
69  } as ModuleConfig;
70};
71 
72```
73 
74::: warning
75config.ts 的配置文件是必须的，有几个必填项描述着模块的功能，当然除此之外，你还可以设置模块的一些特有配置
76:::
77 
78#### 引入配置
79 
80```ts
81 
82  @Config('module.模块名，模块文件夹名称，如demo')
83  config;
84 
85```
86 
87## 数据导入
88 
89在模块中预设要导入的数据，位于`模块/db.json`
90 
911、向`dict_type`表导入数据
92 
93```json
94{
95	"dict_type": [
96		{
97			"name": "升级类型",
98			"key": "upgradeType"
99		}
100	]
101}
102```
103 
1042、导入有层级的数据，比如`dict_info`表需要先插入`dict_type`拿到`id`，再插入`dict_info`
105 
106```json
107{
108	"dict_type": [
109		{
110			"name": "升级类型",
111			"key": "upgradeType",
112			"@childDatas": {
113				"dict_info": [
114					{
115						"typeId": "@id",
116						"name": "安卓",
117						"orderNum": 1,
118						"remark": null,
119						"parentId": null,
120						"value": "0"
121					},
122					{
123						"typeId": "@id",
124						"name": "IOS",
125						"orderNum": 1,
126						"remark": null,
127						"parentId": null,
128						"value": "1"
129					}
130				]
131			}
132		}
133	]
134}
135```
136 
137`@childDatas`是一个特殊的字段，表示该字段下的数据需要先插入父级表，再插入子级表，`@id`表示父级表的`id`，`@id`是一个特殊的字段，表示插入父级表后，会返回`id`，然后插入子级表
138 
139## 菜单导入
140 
141在模块中预设要导入的菜单，位于`模块/menu.json`，菜单数据可以通过后台管理系统的菜单管理导出，不需要手动编写
142 
143详细参考 [menu.json](mdc:src/modules/base/menu.json)
144 
145```json
146[
147	{
148		"name": "应用管理",
149		"router": null,
150		"perms": null,
151		"type": 0,
152		"icon": "icon-app",
153		"orderNum": 2,
154		"viewPath": null,
155		"keepAlive": true,
156		"isShow": true,
157		"childMenus": [
158			{
159				"name": "套餐管理",
160				"router": "/app/goods",
161				"perms": null,
162				"type": 1,
163				"icon": "icon-goods",
164				"orderNum": 0,
165				"viewPath": "modules/app/views/goods.vue",
166				"keepAlive": true,
167				"isShow": true
168			}
169		]
170	}
171]
172```
173 
174#### 关闭自动导入
175 
176通过该配置开启自动初始化模块数据库脚本
177 
178```ts
179cool: {
180    // 是否自动导入数据库
181    initDB: false,
182  } as CoolConfig,
183```
184 
185::: warning
186我们不建议在生产环境使用该功能，生产环境是数据库请通过本地导入与同步数据库结构
187:::
188 
189#### 重新初始化
190 
191首次启动会初始化模块数据库，初始化完成会在项目根目录生成`.lock`文件，下次启动就不会重复导入，如果需要重新导入，删除该文件夹即可
192 
193```ts
194 ├── lock
195 │   ├── db
196 │        └── base.db.lock(base模块)
197 │        └── task.db.lock(task模块)
198 │   ├── menu
199 │        └── base.menu.lock(base模块)
200 │        └── task.menu.lock(task模块)
201 │──package.json
202```
203