CLAUDE.md 4.1 KB

YShop Drink 后端 - Claude Code 配置

项目信息

属性
项目名称 yshop-drink
项目类型 backend (后端 API)
版本 3.2.3
Java 版本 17
框架 Spring Boot 3.2.2

技术栈

技术 版本 用途
Spring Boot 3.2.2 核心框架
Spring Security - 安全认证
OAuth2 + JWT - Token 认证
MyBatis Plus - ORM 框架
MySQL 8.x 数据库
Redis - 缓存/Session
MapStruct 1.5.5 对象映射
Lombok 1.18.30 代码简化

项目结构

yshop-drink/
├── pom.xml                     # 父 POM
├── yshop-dependencies/         # BOM 依赖管理
├── yshop-framework/            # 核心框架
│   ├── yshop-common/           # 通用工具类
│   ├── yshop-spring-boot-starter-biz-*/  # 业务 Starter
│   ├── yshop-spring-boot-starter-mybatis/
│   ├── yshop-spring-boot-starter-redis/
│   ├── yshop-spring-boot-starter-security/
│   └── yshop-spring-boot-starter-web/
├── yshop-server/               # 启动入口
├── yshop-module-system/        # 系统管理模块
├── yshop-module-infra/         # 基础设施模块
├── yshop-module-mall/          # 商城核心模块
├── yshop-module-member/        # 会员模块
├── yshop-module-pay/           # 支付模块
├── yshop-module-mp/            # 微信公众号模块
├── yshop-module-marketing/     # 营销模块
├── yshop-module-score/         # 积分模块
├── yshop-module-message/       # 消息模块
├── yshop-module-express/       # 物流模块
├── yshop-module-merchant/      # 商户模块
└── sql/                        # 数据库脚本

模块说明

核心业务模块

模块 路径 功能
mall yshop-module-mall 商品、订单、门店、购物车、收银
member yshop-module-member 会员、地址、账单
pay yshop-module-pay 微信支付、余额、充值
marketing yshop-module-marketing 优惠券、满减
score yshop-module-score 积分商城

支撑模块

模块 路径 功能
system yshop-module-system 用户、角色、菜单、字典
infra yshop-module-infra 文件、配置、任务、日志
message yshop-module-message 通知、打印
mp yshop-module-mp 公众号
express yshop-module-express 物流配送
merchant yshop-module-merchant 商户管理

开发命令

# 安装依赖
mvn clean install -DskipTests

# 启动开发服务
mvn spring-boot:run -pl yshop-server

# 打包
mvn package -DskipTests

# 单独编译某模块
mvn compile -pl yshop-module-mall

# 运行测试
mvn test

配置文件

yshop-server/src/main/resources/
├── application.yaml           # 主配置
├── application-dev.yaml       # 开发环境
├── application-prod.yaml      # 生产环境
└── logback-spring.xml         # 日志配置

API 文档

启动后访问 Swagger UI:

  • 开发环境: http://localhost:8080/doc.html

数据库

初始化

# 新用户导入完整脚本
mysql -u root -p < sql/yixiang-drink.sql

# 升级脚本
mysql -u root -p < sql/updateV3.x.x.sql

核心表

  • yshop_store_product - 商品
  • yshop_store_order - 订单
  • yshop_store_shop - 门店
  • yshop_user - 会员
  • yshop_coupon - 优惠券

模块开发规范

每个模块结构:

yshop-module-xxx/
├── yshop-module-xxx-api/      # API 定义 (DTO/VO)
└── yshop-module-xxx-biz/      # 业务实现
    └── src/main/java/co/yixiang/yshop/module/xxx/
        ├── controller/
        │   ├── admin/         # 管理端接口
        │   └── app/           # 用户端接口
        ├── service/           # 服务层
        ├── dal/               # 数据访问层
        │   ├── dataobject/    # DO 实体
        │   └── mysql/         # Mapper
        └── convert/           # 对象转换 (MapStruct)