# 芽儿框架SAAS

**Repository Path**: uesugi-java/dick-saas

## Basic Information

- **Project Name**: 芽儿框架SAAS
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-17
- **Last Updated**: 2025-12-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# dick SaaS 企业级多租户平台

[![Java](https://img.shields.io/badge/Java-11-orange.svg)](https://www.oracle.com/java/)
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-2.7.2-brightgreen.svg)](https://spring.io/projects/spring-boot)
[![Maven](https://img.shields.io/badge/Maven-3.6+-blue.svg)](https://maven.apache.org/)
[![MySQL](https://img.shields.io/badge/MySQL-5.7+-blue.svg)](https://www.mysql.com/)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

## 📖 项目简介

dick SaaS 是一个基于 Spring Boot 2.7.2 和 Java 11 构建的企业级多租户 SaaS 平台。该系统采用模块化架构设计，提供了完整的用户管理、权限控制、文件存储、日志记录等功能，支持快速构建企业级应用。

## ✨ 核心特性

- 🔐 **完整的权限体系** - 基于RBAC的用户、角色、权限管理
- 📁 **多存储支持** - 支持MinIO、阿里云OSS、腾讯云COS等存储服务
- 📊 **统一日志管理** - 支持数据库和Elasticsearch双存储模式
- 🏗️ **模块化架构** - 清晰的模块划分，便于扩展和维护
- 🚀 **代码生成器** - 自动生成CRUD代码，提高开发效率
- 📚 **完整API文档** - 集成Swagger/OpenAPI 3.0
- 🔒 **安全认证** - JWT Token认证，支持权限控制
- 📈 **监控支持** - 集成Spring Boot Actuator

## 🏗️ 系统架构

```
dick-saas/
├── dick-saas-root/          # 根模块，应用启动入口
├── dick-saas-system/        # 系统管理模块（用户、角色、权限、部门、公告）
├── dick-saas-storage/       # 文件存储模块（支持多种OSS存储）
├── dick-saas-sdk/           # SDK模块
│   └── dick-saas-log-sdk/   # 日志SDK（支持数据库和Elasticsearch存储）
└── dick-code-generator/     # 代码生成器
```

## 🚀 快速开始

### 环境要求

- **Java**: JDK 11+
- **Maven**: 3.6+
- **MySQL**: 5.7+ 或 8.0+
- **Redis**: 3.2+（可选）

### 快速启动

1. **克隆项目**
```bash
git clone http://fb69879f71e7/reaganjava/dick-saas.git
cd dick-saas
```

2. **配置数据库**
```bash
# 创建数据库
CREATE DATABASE saas DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
```

3. **修改配置**
编辑 `dick-saas-root/src/main/resources/application.yml`，修改数据库连接信息。

4. **启动应用**
```bash
mvn spring-boot:run -pl dick-saas-root
```

5. **访问应用**
- 应用首页: http://localhost:8081
- API文档: http://localhost:8081/swagger-ui.html
- 健康检查: http://localhost:8081/actuator/health

## 📚 详细文档

### 📖 完整使用教程

我们提供了详细的中文使用教程，包含以下内容：

- [📋 项目概述与架构说明](TUTORIAL_CN.md#项目概述)
- [🚀 环境搭建与快速开始](TUTORIAL_CN.md#快速开始)
- [🔧 功能模块详解](TUTORIAL_CN.md#功能模块详解)
  - 系统管理模块（用户、角色、权限、部门、公告）
  - 文件存储模块（多存储支持）
  - 日志SDK模块（双存储模式）
- [🛡️ 安全配置指南](TUTORIAL_CN.md#安全配置)
- [💻 开发指南](TUTORIAL_CN.md#开发指南)
- [🚀 部署指南](TUTORIAL_CN.md#部署指南)
- [❓ 常见问题解答](TUTORIAL_CN.md#常见问题)

**👉 [点击查看完整教程](TUTORIAL_CN.md)**

### 🔧 主要功能模块

#### 1. 系统管理模块
- **用户管理**: 用户CRUD、状态管理、信息查询
- **角色管理**: 角色创建、权限分配、用户关联
- **权限管理**: 权限资源管理、权限验证
- **部门管理**: 组织架构、层级关系管理
- **公告管理**: 系统公告发布、状态管理

#### 2. 文件存储模块
- **多存储支持**: MinIO、阿里云OSS、腾讯云COS
- **文件上传**: 单文件、多文件、头像、文档上传
- **附件管理**: 附件信息管理、下载、删除

#### 3. 日志SDK模块
- **多存储模式**: 数据库、Elasticsearch、双存储
- **操作日志**: 自动记录用户操作行为
- **日志查询**: 支持多条件查询和分页

## 🛠️ 技术栈

- **后端框架**: Spring Boot 2.7.2
- **安全框架**: Spring Security + JWT
- **数据访问**: MyBatis-Plus
- **数据库**: MySQL 5.7+
- **缓存**: Redis（可选）
- **文档**: Swagger/OpenAPI 3.0
- **构建工具**: Maven 3.6+
- **Java版本**: JDK 11

## 📦 项目结构

```
dick-saas/
├── pom.xml                           # 父级POM文件
├── README.md                         # 项目说明
├── TUTORIAL_CN.md                    # 中文使用教程
├── dick-saas-root/                  # 根模块
│   ├── src/main/java/
│   │   └── com/dick/saas/
│   │       ├── RootApplication.java  # 启动类
│   │       └── config/               # 配置类
│   └── src/main/resources/
│       ├── application.yml           # 主配置文件
│       └── application-ds.yml        # 数据源配置
├── dick-saas-system/                # 系统管理模块
│   └── src/main/java/com/dick/saas/system/
│       ├── controller/               # 控制器
│       ├── service/                  # 服务层
│       ├── mapper/                   # 数据访问层
│       └── domain/                   # 领域模型
├── dick-saas-storage/               # 文件存储模块
├── dick-saas-sdk/                   # SDK模块
│   └── dick-saas-log-sdk/           # 日志SDK
└── dick-code-generator/             # 代码生成器
```

## 🔧 开发指南

### 代码生成器使用

系统提供了代码生成器，可以快速生成CRUD代码：

```bash
# 运行代码生成器
mvn exec:java -pl dick-code-generator
```

### 自定义开发

1. **添加新模块**: 在相应模块下创建包结构
2. **集成存储服务**: 实现StorageService接口
3. **配置权限**: 使用@PreAuthorize注解
4. **记录日志**: 使用@OperationLog注解

## 🚀 部署指南

### Docker部署

```bash
# 构建镜像
mvn clean package -DskipTests
docker build -t dick-saas:latest .

# 使用Docker Compose
docker-compose up -d
```

### 生产环境配置

- 修改数据库连接配置
- 配置JWT密钥
- 设置日志级别
- 配置存储服务

详细部署说明请参考 [部署指南](TUTORIAL_CN.md#部署指南)

## 🤝 贡献指南

我们欢迎社区贡献！请遵循以下步骤：

1. Fork 本项目
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
4. 推送到分支 (`git push origin feature/AmazingFeature`)
5. 创建 Pull Request

## 📄 许可证

本项目采用 Apache License 2.0 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。

## 📞 技术支持

- **邮箱**: reagan@163.com
- **项目地址**: [GitLab Repository](http://fb69879f71e7/reaganjava/dick-saas)
- **问题反馈**: [Issues](http://fb69879f71e7/reaganjava/dick-saas/-/issues)

## 📈 更新日志

### v1.0.0 (2024-01-27)
- ✨ 初始版本发布
- 🔐 实现完整的用户权限管理体系
- 📁 集成多存储文件服务
- 📊 提供统一日志管理功能
- 📚 完整的API文档和中文教程

---

**⭐ 如果这个项目对您有帮助，请给我们一个Star！**