README.md 18 KB

apifox:afxp_dbfc98PyOcegSserl9U9k1wRhLfZJ5MGBUIA


待办清单

XXL-Job 定时任务

代码已从 Spring @Scheduled 改造为 @XxlJob;Cron 改由 XXL-Job 调度中心 配置。
依赖:jeesharp-spring-boot-starter-job(业务 application 模块 + web-starter)。
管理端页面 API 需开启:jeesharp.xxl.job.admin-client.enabled=true

一、已在代码中实现的 JobHandler(需在调度中心注册)

状态 JobHandler 模块 建议 Cron 说明
[ ] cmsContentScheduledPublishJob portal-cms CmsContentScheduledPublishJob 0 */1 * * * ? CMS 定时发布(每分钟扫描到期内容)
[ ] cmsStaticNightlyGenerateJob portal-cms CmsStaticNightlyGenerateJob 0 0 2 * * ? CMS 夜间全站静态化
[ ] mallOrderPayTimeoutCancelJob mall MallOrderPayTimeoutCancelJob 0 */5 * * * ? 商城待支付订单超时取消
[ ] commissionSettleJob commission CommissionSettleJob 0 */10 * * * ? 佣金冷静期到期结算(任务参数可传 batchSize,默认 50)
[ ] profitSharingRetryJob finance ProfitSharingRetryJob 0 */10 * * * ? 分账失败自动重试
[ ] platformRevenueRollupJob finance PlatformRevenueRollupJob 0 15 0 * * ? 平台收入日汇总(昨日)
[ ] yearcardBenefitWalletPeriodResetJob yearcard YearcardBenefitWalletPeriodResetJob 0 5 0 * * ? 年卡权益钱包周期配额重置

调度中心注册建议:路由策略「第一个」、阻塞策略「单机串行」。

二、环境与配置待办

状态 事项
[ ] jeesharp.xxl.job.enabled=true(执行器注册,任务才会被触发)
[ ] jeesharp.xxl.job.admin-client.enabled=true(管理端「定时任务」页面 API)
[ ] jeesharp.xxl.job.admin.addresses 指向可访问的 XXL-Job Admin
[ ] admin-client.username/password 与 XXL-Job Admin 登录账号一致
[ ] 执行器 app-name 与调度中心执行器管理中的 AppName 一致
[ ] 角色菜单权限:manager:system:scheduleTask:list 等(页面 403 时检查)

三、可选扩展(代码预留,尚未挂 Job)

状态 建议 JobHandler 模块 说明
[ ] mallSeckillSessionStatusJob mall MallSeckillSessionApplicationService#updateSessionStatus
[ ] foodTradeOrderShadowVerifyJob food FoodTradeOrderShadowService 影子核对(需封装批量扫描)
[ ] leisureTradeOrderShadowVerifyJob leisure LeisureTradeOrderShadowService
[ ] mallTradeOrderShadowVerifyJob mall MallTradeOrderShadowService
[ ] hotelTradeOrderShadowVerifyJob hotel HotelTradeOrderShadowService
[ ] scenicTradeOrderShadowVerifyJob scenic ScenicTradeOrderShadowService

Cursor AI 提示词使用指南

说明:本文档提供常用的 Cursor AI 提示词模板,帮助快速生成代码、文档和数据库脚本。
详细规则:请参考 .cursor/rules/ 目录下的规则文件


📋 常用提示词模板

1. 开发完整模块

提示词模板

基于项目规则,在 business-{模块名} 下开发一个 {功能名称} 模块,包含:
1. 数据库表设计(遵循 mysql-rules.mdc 规范)
2. Bean 层代码(Entity、DTO、VO、Convert、Enum)
3. Service 层代码(Domain Service、Mapper)
4. Application 层代码(Application Service)
5. Controller 层代码(后台管理端 Controller)
6. 移动端 Controller(如需要)
7. 后台管理端接口文档
8. 移动端接口文档(如需要)
9. 模块 README 文档

模块名:{模块名}
类名:{类名}
功能说明:{功能描述}

示例

基于项目规则,在 business-member 下开发一个会员管理模块,包含:
1. 数据库表设计(遵循 mysql-rules.mdc 规范)
2. Bean 层代码(Entity、DTO、VO、Convert、Enum)
3. Service 层代码(Domain Service、Mapper)
4. Application 层代码(Application Service)
5. Controller 层代码(后台管理端 Controller)
6. 移动端 Controller
7. 后台管理端接口文档
8. 移动端接口文档
9. 模块 README 文档

模块名:member
类名:member
功能说明:会员信息管理,包括会员注册、登录、信息维护等功能

2. 代码生成

2.1 生成后台管理端代码

提示词模板

根据 pc-java-code-implementation-rules.mdc 规则,生成 {功能名称} 的后台管理端代码:
- 模块名:{模块名}
- 类名:{类名}
- 包含:Entity、DTO、VO(QueryVO、InfoVO、ExportVO、ImportVO)、Convert、Enum、Service、Application Service、Controller
- 代码位置:jeesharp-business/business-{模块名}-*

示例

根据 pc-java-code-implementation-rules.mdc 规则,生成订单管理的后台管理端代码:
- 模块名:mall
- 类名:order
- 包含:Entity、DTO、VO(QueryVO、InfoVO、ExportVO、ImportVO)、Convert、Enum、Service、Application Service、Controller
- 代码位置:jeesharp-business/business-mall-*

2.2 生成移动端代码

提示词模板

根据 mobile-java-generation-code-rules.mdc 规则,生成 {功能名称} 的移动端代码:
- 模块名:{模块名}
- 类名:{类名}
- 包含:Controller(继承 BaseMobileController)、DTO、VO
- 代码位置:business-mobile-gateway

示例

根据 mobile-java-generation-code-rules.mdc 规则,生成会员信息的移动端代码:
- 模块名:member
- 类名:member
- 包含:Controller(继承 BaseMobileController)、DTO、VO
- 代码位置:business-mobile-gateway

2.3 生成 Bean 层代码

提示词模板

根据 pc-java-code-implementation-rules.mdc 第 6.5 节规则,生成 {功能名称} 的 Bean 层代码:
- 模块名:{模块名}
- 类名:{类名}
- 包含:Entity、DTO(SaveDTO)、VO(QueryVO、InfoVO、ExportVO、ImportVO)、Convert、Enum
- 代码位置:business-{模块名}-bean

示例

根据 pc-java-code-implementation-rules.mdc 第 6.5 节规则,生成订单的 Bean 层代码:
- 模块名:mall
- 类名:order
- 包含:Entity、DTO(SaveDTO)、VO(QueryVO、InfoVO、ExportVO、ImportVO)、Convert、Enum
- 代码位置:business-mall-bean

3. 数据库建表

提示词模板

根据 mysql-rules.mdc 规则,创建 {表名} 数据库表:
- 表名:{表前缀}_{表名}(如 biz_order、app_member)
- 功能说明:{功能描述}
- 包含字段:{字段列表}
- 必需基础字段:id、create_by、create_date、update_by、update_date、del_flag、remarks、tenant_code、tenant_id
- 索引:idx_tenant_id、idx_status(如有)、idx_create_date

示例

根据 mysql-rules.mdc 规则,创建订单数据库表:
- 表名:biz_order
- 功能说明:订单主表,存储订单基本信息
- 包含字段:order_no(订单编号)、user_id(用户ID)、product_id(商品ID)、quantity(数量)、total_amount(总金额)、status(订单状态:0-待支付 1-已支付 2-已发货 3-已完成 4-已取消)
- 必需基础字段:id、create_by、create_date、update_by、update_date、del_flag、remarks、tenant_code、tenant_id
- 索引:idx_tenant_id、idx_status、idx_create_date、idx_user_id

4. 接口文档生成

4.1 生成后台管理端接口文档

提示词模板

根据 frontend-api-rules.mdc 规则,在 {模块目录}/doc/ 目录下生成 {功能名称} 的后台管理端接口文档:
- 模块名:{模块名}
- 类名:{类名}
- 接口路径:${adminPath}/{模块名}/{类名}/v1/{操作}
- 包含接口:info(详情)、list(列表分页)、save(保存)、delete(删除)、export(导出)、import(导入)、import/template(下载模板)
- 权限标识:{模块名}:{类名}:{操作}

示例

根据 frontend-api-rules.mdc 规则,在 business-mall/doc/ 目录下生成订单管理的后台管理端接口文档:
- 模块名:mall
- 类名:order
- 接口路径:${adminPath}/mall/order/v1/{操作}
- 包含接口:info(详情)、list(列表分页)、save(保存)、delete(删除)、export(导出)、import(导入)、import/template(下载模板)
- 权限标识:mall:order:{操作}

4.2 生成移动端接口文档

提示词模板

根据 mobile-api-rules.mdc 规则,在 {模块目录}/doc/ 目录下生成 {功能名称} 的移动端接口文档:
- 模块名:{模块名}
- 类名:{类名}
- 接口路径:/mobile/{模块名}/{类名}/{操作}
- 包含接口:{接口列表}
- 请求头:access_token、X-Device-Id、X-Platform、X-Version

示例

根据 mobile-api-rules.mdc 规则,在 business-member/doc/ 目录下生成会员信息的移动端接口文档:
- 模块名:member
- 类名:member
- 接口路径:/mobile/member/member/{操作}
- 包含接口:info(获取会员信息)、update(更新会员信息)
- 请求头:access_token、X-Device-Id、X-Platform、X-Version

5. 模块文档生成

提示词模板

根据 documentation-rules.mdc 规则,在 business-{模块名}/ 目录下生成模块 README 文档:
- 模块名:{模块名}
- 功能说明:{功能描述}
- 包含内容:
  1. 模块概述
  2. 模块结构
  3. 功能特性
  4. API 接口(接口路径和基本说明)
  5. 权限配置(权限标识列表)
  6. 基础字段规范
  7. 数据库表设计
  8. 版本记录

示例

根据 documentation-rules.mdc 规则,在 business-mall/ 目录下生成模块 README 文档:
- 模块名:mall
- 功能说明:商城模块,包含订单管理、商品管理等功能
- 包含内容:
  1. 模块概述
  2. 模块结构
  3. 功能特性
  4. API 接口(接口路径和基本说明)
  5. 权限配置(权限标识列表)
  6. 基础字段规范
  7. 数据库表设计
  8. 版本记录

6. 快速修复和优化

6.1 修复依赖关系

提示词模板

检查并修复 business-{模块名} 模块的依赖关系:
- 检查 Bean 模块是否包含 jeesharp-spring-boot-starter-mybatis 依赖
- 检查 Service 模块是否依赖 Bean 模块
- 检查 Application 模块是否依赖 Service 模块
- 检查 Controller 模块是否依赖 Application 模块
- 如缺失,自动添加依赖

6.2 添加依赖

提示词模板

根据 pre-check-rules.mdc 第 0.6 节依赖版本管理规则,添加 {依赖名称} 依赖:
- groupId: {groupId}
- artifactId: {artifactId}
- 模块:{模块名}
- 检查 jeesharp-parent 中是否已定义
- 如已定义(jeesharp 框架依赖或常见框架依赖),不指定版本号
- 如未定义(第三方依赖),指定版本号 {version}
- 添加到 {模块名} 模块的 pom.xml

示例

根据 pre-check-rules.mdc 第 0.6 节依赖版本管理规则,添加 jeesharp-spring-boot-starter-mybatis 依赖:
- groupId: org.jeesharp.boot
- artifactId: jeesharp-spring-boot-starter-mybatis
- 模块:business-member-bean
- jeesharp 框架依赖,不指定版本号(从 jeesharp-parent 继承)
- 添加到 business-member-bean 模块的 pom.xml

第三方依赖示例

根据 pre-check-rules.mdc 第 0.6 节依赖版本管理规则,添加 JustAuth 依赖:
- groupId: me.zhyd.oauth
- artifactId: JustAuth
- 模块:business-mobile-gateway
- 第三方依赖,jeesharp-parent 中未定义,指定版本号 1.16.6
- 添加到 business-mobile-gateway 模块的 pom.xml

6.3 添加枚举定义

提示词模板

根据 pc-java-code-implementation-rules.mdc 第 6.5.0 节规则,为 {功能名称} 添加 {字段名} 枚举:
- 模块名:{模块名}
- 类名:{类名}
- 枚举名:{Xxx}StatusEnum(或 {Xxx}TypeEnum)
- 枚举值:{枚举值列表}
- 位置:business-{模块名}-bean/src/main/java/com/jeesharp/business/modules/{模块名}/{类名}/enums/

示例

根据 pc-java-code-implementation-rules.mdc 第 6.5.0 节规则,为订单管理添加订单状态枚举:
- 模块名:mall
- 类名:order
- 枚举名:OrderStatusEnum
- 枚举值:PENDING(0, "待支付")、PAID(1, "已支付")、SHIPPED(2, "已发货")、COMPLETED(3, "已完成")、CANCELLED(4, "已取消")
- 位置:business-mall-bean/src/main/java/com/jeesharp/business/modules/mall/order/enums/

🎯 提示词使用技巧

1. 明确指定规则文件

  • 正确根据 frontend-api-rules.mdc 规则,生成...
  • 错误生成接口文档(未指定规则文件)

2. 提供完整的上下文信息

  • 正确:提供模块名、类名、功能说明等完整信息
  • 错误:只提供功能名称,缺少模块信息

3. 明确代码生成位置

  • 正确代码位置:jeesharp-business/business-{模块名}-*
  • 错误生成代码(未指定位置)

4. 遵循命名规范

  • 正确:模块名使用小写(如 mallmember),类名使用小写(如 orderproduct
  • 错误:使用大写或驼峰命名(如 MallOrder

📚 相关规则文件

用途 规则文件 说明
代码生成 .cursor/rules/code/pc-java-code-implementation-rules.mdc 后台管理端代码实现规范
移动端代码 .cursor/rules/code/mobile-java-generation-code-rules.mdc 移动端代码生成规范
接口规范 .cursor/rules/api/frontend-api-rules.mdc 后台管理端接口规范
移动端接口 .cursor/rules/api/mobile-api-rules.mdc 移动端接口规范
数据库规范 .cursor/rules/database/mysql-rules.mdc MySQL 建表规范
文档规范 .cursor/rules/documentation/documentation-rules.mdc 文档编写规范
命名规范 .cursor/rules/code/naming-rules.mdc 命名规范
架构规范 .cursor/rules/architecture/architecture-rules.mdc 架构设计原则

💡 示例场景

场景 1:开发订单管理模块

基于项目规则,在 business-mall 下开发一个订单管理模块,包含:
1. 数据库表设计(遵循 mysql-rules.mdc 规范)
   - 表名:biz_order
   - 字段:order_no、user_id、product_id、quantity、total_amount、status
2. Bean 层代码(Entity、DTO、VO、Convert、Enum)
3. Service 层代码(Domain Service、Mapper)
4. Application 层代码(Application Service)
5. Controller 层代码(后台管理端 Controller)
6. 后台管理端接口文档
7. 模块 README 文档

模块名:mall
类名:order
功能说明:订单管理,包括订单创建、查询、更新、删除等功能

场景 2:生成移动端会员接口

根据 mobile-api-rules.mdc 规则,生成会员信息的移动端代码和接口文档:
- 模块名:member
- 类名:member
- 包含:Controller(继承 BaseMobileController)、DTO、VO
- 接口:info(获取会员信息)、update(更新会员信息)
- 代码位置:business-mobile-gateway
- 文档位置:business-member/doc/

最后更新:2026-07-13
维护者:项目团队

根据小程序docs下的设计文档、小程序接口文档,在后台项目开发酒店模块,后台要在jeesharp-business下新建一个模块,同时编写后台的前端模块,提供小程序端接口,输出代码、建表语句、菜单和权限的插入sql,按开发规约开始写代码

INSERT INTO xinghc_travel.pay_wechat_config (id, channel_config_id, config_code, config_name, status, wx_enabled, mock_fallback, app_id, mch_id, wechat_pay_mode, merchant_serial_no, merchant_private_key_pem, public_key_id, public_key_pem, public_key_path, cert_path, cert_private_key_path, cert_private_cert_path, mch_key, notify_base_url, pay_center_notify_path, api_v3_key, skip_signature_verify, platform_serial_no, create_by, create_date, update_by, update_date, del_flag, remarks, tenant_code, tenant_id, organize_id) VALUES ('2059120010287452162', '2059513091620925441', 'DEFAULT', '杏花村微信支付', 1, 1, 0, 'wx2aa33e1b0f13463e', '1746874930', 'DIRECT', '38E1EAB92C9B1DAEA2CACB02CAC44F08F04533B9', '', 'PUB_KEY_ID_0117468749302026061200191626000205', '', '/Users/qiyuan/workspace_fangshi/code/xinghuacun_travel/TravelWebSystem/doc/pay/fws/pub_key.pem', '/Users/qiyuan/workspace_fangshi/code/xinghuacun_travel/TravelWebSystem/doc/pay/fws/apiclient_cert.p12', '/Users/qiyuan/workspace_fangshi/code/xinghuacun_travel/TravelWebSystem/doc/pay/fws/apiclient_key.pem', '/Users/qiyuan/workspace_fangshi/code/xinghuacun_travel/TravelWebSystem/doc/pay/fws/apiclient_cert.pem', '9aB2cD4eF6gH8jK0mL2nP4qR6sT8vW0x', 'https://fs.towantto.com:10007', '/mobile/order/pay/notify/wechat', 'zY3xW5vU7tS9rQ7pO5nM3lK1jI9hG7fE', 0, '', '1', '2026-05-26 11:50:42', '1', '2026-06-12 17:39:50', '0', '', '1', '1', NULL);

【积分配置】 /business/member/pointsRule # 积分规则列表(菜单) /business/member/pointsRule/form # 积分规则表单(隐藏) /business/member/pointsLog # 积分流水(菜单) /business/member/levelFeature # 等级权益(菜单) /business/mall/rewardLevelConfig # 商城等级奖励/消费送积分(asyncRouter 兜底)

【分销返佣 · 费率与提现】 /business/commission/withdraw # 佣金提现 /business/commission/rateRule # 关系链费率(二/三级) /business/commission/rateRule/form # 关系链费率表单 /business/commission/globalConfig # 分销全局开关/冷静期/提现门槛 /business/commission/shareRateRule # 分享直推费率 /business/commission/shareRateRule/form # 分享直推费率表单 /business/commission/distributorLevel # 分销员等级 /business/commission/distributorLevel/form

【分销返佣 · 活动运营】 /business/marketing/activity # 分享返佣活动 /business/marketing/rule # 返佣奖励规则 /business/marketing/posterTemplate # 返佣海报 /business/marketing/scope # 投放范围