link-wechat/CLAUDE.md

LinkWeChat 开源项目 - Claude AI 辅助开发指南

项目概述

LinkWeChat 是基于企业微信的开源 SCRM（Social Customer Relationship Management）系统，是企业私域流量管理与营销的综合解决方案。本项目采用微服务架构，基于 Spring Cloud & Alibaba 技术栈开发。

技术栈

后端技术栈

• 框架: Spring Boot 2.6.6
• 微服务: Spring Cloud 2021.0.1
• 服务注册/配置: Nacos
• 网关: Spring Cloud Gateway 3.0.7
• 数据库: MyBatis-Plus 3.4.0
• 定时任务: XXL-Job
• 消息队列: RabbitMQ
• HTTP 客户端: Forest 1.5.24
• 其他: Druid、FastJSON、JWT、Lombok、Hutool 等

前端技术栈

• 框架: Vue.js
• 状态管理: Vuex
• 路由: Vue-router
• UI组件: Element-ui
• 构建工具: Vue-cli
• HTTP客户端: Axios

项目结构

linkwechat-cloud/
├── linkwe-api/              # 系统业务接口模块
├── linkwe-auth/             # 角色权限部门用户认证等模块
├── linkwe-common/           # 公共组件模块
├── linkwe-fileservice/      # 文件服务模块
├── linkwe-framework/        # 框架配置
├── linkwe-gateway/          # 网关服务
├── linkwe-scheduler/        # 定时任务相关模块
├── linkwe-service/          # 系统service层抽取,与数据库相关交互
├── linkwe-ai/               # AI相关功能模块
├── linkwe-chinacoal/        # 中煤定制模块
├── linkwe-wecom/            # 企微接口实现
├── linkwe-wx-api/           # 系统中设计微信公众号相关接口模块
├── config/                  # 配置文件目录
├── xxl-job-master/          # XXL-Job 任务调度中心
└── pom.xml                  # Maven 主配置文件

开发环境要求

• JDK 1.8+
• Maven 3.5+
• MySQL 5.7+
• Redis 3.0+
• RabbitMQ 3.8+
• Node.js 12+

核心业务模块

1. 运营中心: 客户、客群、会话等全功能数据报表
2. 引流获客: 活码、群活码、公海、客服等多渠道引流
3. 销售中心: 承接引流获客模块客户线索，高效协作跟进
4. 客户中心: 助力企业搭建私域流量池，高效运营客户
5. 客群中心: 客群运营场景全覆盖
6. 客情维系: 企业客户运营精细化，朋友圈、红包工具提高客户活跃度
7. 内容中心: 搭建企业自有内容库，多类型素材一键调用
8. 全能营销: 提供多类型、多场景客户营销工具
9. 商城中心: 自有小程序商城，快捷搭建企业转化链路
10. 企业风控: 会话合规存档，敏感内容全局风控
11. 企业管理: 组织架构、自建应用全融合，实现"一个后台"

开发指南

本地开发环境搭建

1. 克隆项目到本地
2. 安装依赖：mvn clean install
3. 配置数据库连接信息
4. 启动 Nacos 服务注册中心
5. 启动 Redis、RabbitMQ 等中间件
6. 按顺序启动各个微服务模块

代码规范

• 遵循阿里巴巴 Java 开发手册
• 使用 Lombok 简化代码
• 实体类使用 MyBatis-Plus 注解
• Controller 使用 RESTful 风格
• 统一异常处理和返回格式

API 接口规范

• 统一使用 /api 前缀
• 使用 RESTful 风格设计接口
• 统一返回格式：{ code: 200, msg: "success", data: {} }
• 接口文档使用 Swagger 生成

部署指南

Docker 部署

项目提供 Docker Compose 配置文件，可一键部署所有服务：

docker-compose up -d

传统部署

1. 打包项目：mvn clean package
2. 上传 jar 包到服务器
3. 启动各微服务：java -jar xxx.jar

常见问题

Q: 如何配置企业微信相关参数？

A: 在系统管理-企业配置中填写企业微信的 CorpID、Secret 等参数。

Q: 如何添加新的微服务模块？

A: 1. 在主 pom.xml 中添加模块；2. 创建新的模块目录结构；3. 配置 application.yml；4. 在 Nacos 中注册服务。

Q: 如何扩展企微 API？

A: 在 linkwe-wecom 模块中添加新的 API 接口实现。

贡献指南

欢迎提交 Pull Request 或 Issue，请确保：

1. 代码风格统一
2. 添加必要的注释
3. 编写单元测试
4. 更新相关文档

许可证

本项目遵循 GPL-3.0 开源协议。

联系方式

• 官网：http://www.linkwechat.net/
• 官方论坛：http://community.linkwechat.net/
• 在线演示：http://demo.linkwechat.net/

相关链接

• 企业微信开放文档：https://open.work.weixin.qq.com/api/doc
• 前端项目：https://gitee.com/LinkWeChat/link-we-chat-front
• 帮助手册：https://www.yuque.com/linkwechat/help

---

注意：本项目为企业微信 SCRM 系统，开发前请务必熟悉企业微信官方开发文档和相关 API。