zlwu 2f6cab5b24 提交 1 год назад
..
src 2f6cab5b24 提交 1 год назад
README.md 6ebae87665 first commit 1 год назад
pom.xml 6066c4f5b1 提交代码 1 год назад

README.md

RuoYi CRM模块

📦 模块简介

CRM(Customer Relationship Management)客户关系管理模块,是RuoYi-Vue-Plus框架的扩展业务模块,提供完整的客户关系管理解决方案。

🎯 功能模块

已完成功能

1. 产品管理 ✅

  • 产品分类管理:树形结构,支持无限级分类
  • 产品信息管理:完整的CRUD操作
  • 产品搜索:支持关键词搜索和多条件筛选
  • 产品上架/下架:批量操作产品状态
  • 产品导出:导出Excel格式产品数据
  • 价格管理:支持标准价、成本价、最低价
  • 库存管理:库存数量、库存预警

2. 客户管理 🚧(规划中)

  • 客户基本信息管理
  • 客户分级分类
  • 客户跟进记录
  • 客户联系人管理
  • 客户标签管理

3. 商机管理 🚧(规划中)

  • 商机信息管理
  • 商机阶段跟踪
  • 商机产品关联
  • 商机转化分析

4. 报价管理 🚧(规划中)

  • 报价单创建
  • 报价产品选择
  • 价格折扣策略
  • 报价单审批

5. 合同管理 🚧(规划中)

  • 合同信息管理
  • 合同产品关联
  • 合同审批流程
  • 合同执行跟踪

6. 统计分析 🚧(规划中)

  • 销售数据统计
  • 客户分析报表
  • 产品销售分析
  • 业绩排行榜

📁 项目结构

ruoyi-crm/
├── src/main/
│   ├── java/org/dromara/crm/
│   │   ├── controller/          # 控制器层
│   │   │   ├── CrmProductController.java
│   │   │   └── CrmProductCategoryController.java
│   │   ├── service/             # 服务层
│   │   │   ├── ICrmProductService.java
│   │   │   ├── ICrmProductCategoryService.java
│   │   │   └── impl/            # 服务实现
│   │   ├── mapper/              # 数据访问层
│   │   │   ├── CrmProductMapper.java
│   │   │   └── CrmProductCategoryMapper.java
│   │   └── domain/              # 数据模型
│   │       ├── CrmProduct.java          # 产品实体
│   │       ├── CrmProductCategory.java  # 分类实体
│   │       ├── bo/              # 业务对象
│   │       │   ├── CrmProductBo.java
│   │       │   └── CrmProductCategoryBo.java
│   │       └── vo/              # 视图对象
│   │           ├── CrmProductVo.java
│   │           └── CrmProductCategoryVo.java
│   └── resources/
│       └── mapper/crm/          # MyBatis XML
│           ├── CrmProductMapper.xml
│           └── CrmProductCategoryMapper.xml
└── pom.xml

🔧 技术栈

后端技术

  • Spring Boot: 3.4.6
  • MyBatis-Plus: 3.5.12
  • Sa-Token: 1.42.0(权限认证)
  • Hutool: 5.8.35(工具库)
  • MapStruct-Plus: 1.5.0(对象转换)
  • FastExcel: 1.2.0(Excel导入导出)

核心依赖

<dependencies>
    <!-- 通用核心模块 -->
    <dependency>
        <groupId>org.dromara</groupId>
        <artifactId>ruoyi-common-mybatis</artifactId>
    </dependency>
    <dependency>
        <groupId>org.dromara</groupId>
        <artifactId>ruoyi-common-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.dromara</groupId>
        <artifactId>ruoyi-common-excel</artifactId>
    </dependency>
</dependencies>

📝 数据库设计

产品模块表

表名 说明 状态
crm_product 产品表 ✅ 已完成
crm_product_category 产品分类表 ✅ 已完成

客户模块表(规划中)

表名 说明 状态
crm_customer 客户表 🚧 规划中
crm_customer_contact 客户联系人表 🚧 规划中
crm_customer_follow 客户跟进记录表 🚧 规划中

商机模块表(规划中)

表名 说明 状态
crm_opportunity 商机表 🚧 规划中
crm_opportunity_product 商机产品关联表 🚧 规划中

🚀 快速开始

1. 数据库初始化

-- 按顺序执行SQL脚本
source sql/crm/11-crm_product.sql       -- 创建产品相关表
source sql/crm/12-crm_product_menu.sql  -- 配置产品菜单权限

2. 配置文件

无需特殊配置,使用RuoYi主配置文件即可。

3. 启动服务

# 编译CRM模块
mvn clean install -pl ruoyi-modules/ruoyi-crm -am

# 启动主应用
mvn spring-boot:run -pl ruoyi-admin

4. 访问系统

  • 访问地址:http://localhost:80
  • 登录系统后,在左侧菜单栏找到 "产品管理" 菜单

🔐 权限管理

产品模块权限

权限标识 权限名称 说明
crm:product:list 产品列表 查看产品列表
crm:product:query 产品详情 查看产品详细信息
crm:product:add 产品新增 新增产品
crm:product:edit 产品修改 修改产品信息
crm:product:remove 产品删除 删除产品
crm:product:export 产品导出 导出产品数据
crm:product:import 产品导入 导入产品数据
crm:product:cost 查看成本价 查看产品成本价(敏感权限)
crm:product:category:list 分类列表 查看产品分类
crm:product:category:add 分类新增 新增产品分类
crm:product:category:edit 分类修改 修改产品分类
crm:product:category:remove 分类删除 删除产品分类

📖 接口文档

产品管理接口

1. 查询产品列表(分页)

GET /crm/product/list
权限:crm:product:list

2. 查询产品详情

GET /crm/product/{id}
权限:crm:product:query

3. 新增产品

POST /crm/product
权限:crm:product:add

4. 修改产品

PUT /crm/product
权限:crm:product:edit

5. 删除产品

DELETE /crm/product/{ids}
权限:crm:product:remove

6. 产品搜索(下拉选择)

GET /crm/product/search
权限:crm:product:list
参数:keyword, categoryId, status, limit

7. 批量上架/下架

PUT /crm/product/status
权限:crm:product:edit
Body: { "ids": [1,2,3], "status": "on" }

8. 导出产品

POST /crm/product/export
权限:crm:product:export

产品分类接口

1. 查询分类树

GET /crm/product/category/tree
权限:crm:product:category:list

2. 新增分类

POST /crm/product/category
权限:crm:product:category:add

3. 修改分类

PUT /crm/product/category
权限:crm:product:category:edit

4. 删除分类

DELETE /crm/product/category/{ids}
权限:crm:product:category:remove

更多详细接口文档,请参考:docs/crm/产品模块开发文档.md

📚 相关文档

🛠️ 开发规范

命名规范

  1. 包命名:org.dromara.crm.模块名
  2. 类命名:

    • Controller:Crm模块名Controller
    • Service:ICrm模块名Service
    • ServiceImpl:Crm模块名ServiceImpl
    • Mapper:Crm模块名Mapper
    • Entity:Crm模块名
    • Bo:Crm模块名Bo
    • Vo:Crm模块名Vo
  3. 权限命名:crm:模块:操作

    • 示例:crm:product:list
  4. 接口路径:/crm/模块名/操作

    • 示例:/crm/product/list

代码规范

  1. 使用 @RequiredArgsConstructor 实现构造器注入
  2. 使用 MyBatis-Plus 的 LambdaQueryWrapper 构建查询
  3. 使用 @SaCheckPermission 进行权限控制
  4. 使用 @Log 记录重要操作日志
  5. 使用 @RepeatSubmit 防止重复提交
  6. 使用 @Validated 进行参数校验

🐛 已知问题

暂无

📋 TODO清单

  • 产品导入功能
  • 产品图片上传功能
  • 产品SKU管理
  • 产品价格策略(阶梯价格)
  • 客户管理模块
  • 商机管理模块
  • 报价管理模块
  • 合同管理模块

🤝 贡献指南

欢迎提交Issue和Pull Request!

  1. Fork本项目
  2. 创建新分支:git checkout -b feature/your-feature
  3. 提交更改:git commit -am 'Add some feature'
  4. 推送分支:git push origin feature/your-feature
  5. 提交Pull Request

📄 开源协议

本项目采用 MIT 协议,详见 LICENSE 文件。

👥 联系方式


Version: 1.0.0
Last Updated: 2025-01-20
Author: RuoYi-Vue-Plus Team