# 基础框架

**Repository Path**: hot_summer/framework

## Basic Information

- **Project Name**: 基础框架
- **Description**: 基础框架
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-10
- **Last Updated**: 2026-08-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# SaaS 开发框架

SaaS-framework 是一个基于 Spring Cloud 的快速开发框架，集成了常用的企业级组件，适用于构建微服务架构的 SaaS 应用。配套有代码生成器（还在完善中）。

## 技术栈

- **核心框架**: Spring Cloud (微服务架构), Spring Boot
- **ORM**: MyBatis 3.4.6
- **工作流**: Activiti 5/6 (流程管理)
- **数据源**: Alibaba Druid
- **缓存**: Redis 4.x
- **安全**: Spring Security + OAuth2
- **API文档**: Swagger + Springfox
- **监控**: Spring Boot Admin, Zipkin (Sleuth)
- **其他**: Lombok, MapStruct 等

## 模块说明

项目采用模块化设计，主要分为以下几个部分：

### 1. boot-starter (启动模块)
基础启动模块。

### 2. cloud-starter (云服务模块)
包含微服务治理相关的组件：
- **cloud-discover**: 服务注册与发现 (Eureka Server)
- **cloud-gateway / cloud-zuul-gateway**: API 网关 (Zuul 路由、过滤)
- **cloud-admin**: 监控管理界面 (Spring Boot Admin)
- **cloud-sleuth-zipkin**: 分布式链路追踪

### 3. common-starter (公共模块)
提供通用的工具类和常量：
- **常量定义**: 各类全局常量、枚举
- **安全配置**: 浏览器登录、验证码、会话、OAuth2 等安全属性配置
- **工具类**: JSON处理 (FastJson), 加密 (RSAUtils), Redis操作 (RedisUtils), 字符串处理 (StringUtils)

### 4. component-starter (组件模块)
集成了各类中间件和功能组件：
- **component-activiti5-starter / component-activiti5-ui-starter**: Activiti 工作流引擎及流程设计器 UI (基于 Activiti Modeler)
- **component-auth2.0-starter**: OAuth2 认证授权服务 (JWT Token, Redis Token Store, 移动端认证)
- **component-blade-starter**: 基础业务支撑模块 (包含 BaseMapper, 基础实体类 BizEntity, 公共 DTO 等)

## 快速开始

### 环境要求
- JDK 1.8+
- Maven 3.x
- Redis
- MySQL (或其他关系型数据库)

### 配置

1. **数据库配置**: 在各模块的 `application.yml` 或 `bootstrap.yml` 中配置数据库连接信息 (使用 Druid 数据源)。
2. **Redis 配置**: 配置 Redis 连接信息。
3. **服务注册**: 确保服务注册中心 (Eureka) 已启动。
4. **构建**:
   ```bash
   mvn clean install
   ```

### 运行示例

1. **启动注册中心**:
   进入 `cloud-starter/cloud-discover` 模块，启动 `ServiceDiscoverApplication`。
   
2. **启动网关**:
   进入 `cloud-starter/cloud-zuul-gateway` 模块，启动 `GatewayApplication`。

3. **启动其他服务**:
   根据需要启动对应的业务服务模块。

## 代码生成器 (规划中)

配套的代码生成器正在开发中，旨在进一步提升开发效率。

## 许可证

本项目遵循开源协议。

## 贡献

欢迎提出问题或贡献代码。