# cdaz-cloudpivot-backend

**Repository Path**: LiuGangQiang/cdaz-cloudpivot-backend

## Basic Information

- **Project Name**: cdaz-cloudpivot-backend
- **Description**: 云枢扩展工程示例项目
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-04-01
- **Last Updated**: 2026-02-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 云枢后端扩展开发项目 (cdaz-cloudpivot-backend)

## 📋 项目概述

这是一个基于云枢平台的后端扩展开发项目，提供了一套完整的企业级低代码平台后端扩展解决方案。项目采用模块化架构，支持多种扩展功能，包括认证、权限、服务、切面等功能模块。

**注意**: 此项目为云枢后端标准二开示例工程，新项目请严格按照此项目结构创建项目。

## 🏗️ 项目架构

```
cdaz-cloudpivot-backend                # 父项目，Multi-Module Maven项目
├── cdaz-extension-debug              # 调试工程，仅用于开发调试，不允许二开或打包
├── cdaz-extension-service            # 服务扩展模块，主要业务逻辑扩展
├── cdaz-extension-override           # 重写扩展模块，用于重写平台默认功能
├── cdaz-extension-online             # 在线编码工程，存储在线编码代码备份
├── cdaz-extension-permission         # 权限扩展模块
├── cdaz-extension-aspect             # 切面扩展模块，AOP功能
├── cdaz-extension-authentication     # 认证扩展模块
├── cdaz-extension-function           # 函数扩展模块
└── cdaz-extension-sso                # 单点登录扩展模块
```

> **说明**: `{cdaz}` 前缀可根据实际项目进行替换，例如零食很忙项目则项目名为 `lshm-cloudpivot-backend`

## 🛠️ 技术栈

- **Java版本**: JDK 1.8
- **框架**: Spring Boot 2.5.15
- **构建工具**: Maven
- **云枢平台版本**: 8.2.55
- **Foundation版本**: 1.0.20.2
- **许可证**: Apache License 2.0

## 📦 核心依赖

### 云枢平台依赖
- `web-api-service`: 云枢Web API服务
- `cloudpivot-app-integration-spi`: 应用集成SPI
- `cloudpivot-platform-integration-spi`: 平台集成SPI
- `cloudpivot-engine-*`: 引擎相关模块
- `cloudpivot-foundation-*`: 基础设施模块

### 第三方依赖
- **阿里云短信服务**: alibabacloud-dysmsapi20170525 (v2.0.24)
- **微信推送**: wxpusher-java-sdk (v2.1.4)
- **Jackson XML**: jackson-dataformat-xml
- **OkHttp**: okhttp (v4.8.1)

## 🔧 开发环境配置

### 构建项目
```bash
# 编译整个项目
mvn clean compile

# 打包项目
mvn clean package

# 跳过测试打包
mvn clean package -DskipTests
```

### 运行调试模块
```bash
# 进入debug模块目录
cd cdaz-extension-debug

# 运行Spring Boot应用
mvn spring-boot:run

# 或打包后运行
mvn clean package
java -jar target/web-api-${cloudpivot.version}.jar
```

## 📝 模块说明

### cdaz-extension-debug
- **用途**: 开发调试环境
- **特性**:
  - 集成所有扩展模块
  - 支持JAR和WAR两种打包格式
  - 包含完整的配置文件
  - 支持生产环境配置
- **注意**: 除了配置文件无需修改其他东西，不允许基于此项目做二开或者打包

### cdaz-extension-service
- **用途**: 主要业务逻辑扩展
- **功能**:
  - 自定义服务实现
  - 第三方服务集成
  - 业务逻辑扩展
- **说明**: 所有项目二开代码均放入此工程中，示例中已有部分示例代码可根据实际情况进行保留

### cdaz-extension-aspect
- **用途**: AOP切面功能
- **功能**:
  - 日志记录
  - 性能监控
  - 事务管理
  - 权限控制

### cdaz-extension-authentication
- **用途**: 认证扩展
- **功能**:
  - 自定义认证逻辑
  - 第三方认证集成
  - 用户认证扩展

### cdaz-extension-permission
- **用途**: 权限管理扩展
- **功能**:
  - 自定义权限逻辑
  - 权限控制扩展
  - 角色权限管理

### cdaz-extension-sso
- **用途**: 单点登录扩展
- **功能**:
  - SSO集成
  - 第三方登录
  - 统一认证

### cdaz-extension-function
- **用途**: 函数扩展
- **功能**:
  - 自定义函数
  - 业务函数扩展
  - 工具函数

### cdaz-extension-override
- **用途**: 功能重写
- **功能**:
  - 重写平台默认功能
  - 自定义实现替换
  - 行为定制

### cdaz-extension-online
- **用途**: 在线编码备份
- **功能**:
  - 存储在线编码代码
  - 代码备份管理
  - 版本控制
- **说明**: 此项目仅用于存储对应项目的在线编码的代码，留作备份避免线上环境因不可控因素导致在线编码丢失而带来的工作量问题

## 🚀 部署说明

### 开发环境
1. 确保JDK 1.8+和Maven 3.6+已安装
2. 克隆项目到本地
3. 修改配置文件（application.yml）
4. 运行`mvn clean package`
5. 启动应用

### 生产环境
1. 使用prod profile打包：
   ```bash
   mvn clean package -Pprod
   ```
2. 部署生成的JAR/WAR文件
3. 配置生产环境参数

## 📚 开发指南

### 添加新扩展
1. 在相应模块下创建新的包结构
2. 实现对应的SPI接口
3. 添加Spring注解（@Service, @Component等）
4. 在配置文件中添加相关配置

### 依赖管理
- 平台依赖使用`provided`作用域
- 第三方依赖会自动打包到common目录
- 避免版本冲突，使用dependencyManagement管理版本

### 代码规范
- 遵循Java编码规范
- 使用有意义的包名和类名
- 添加适当的注释和文档
- 编写单元测试

## 🔗 相关链接

- [云枢平台文档](https://docs.cloudpivot.cn)
- [Spring Boot文档](https://spring.io/projects/spring-boot)
- [Maven文档](https://maven.apache.org/)

## 📄 许可证

本项目采用Apache License 2.0许可证，详见[LICENSE](LICENSE)文件。

## 🤝 贡献指南

欢迎提交Issue和Pull Request来改进项目。在提交代码前，请确保：

1. 代码通过所有测试
2. 遵循项目编码规范
3. 添加必要的文档和注释
4. 更新相关README文档