# small

**Repository Path**: iajie/small

## Basic Information

- **Project Name**: small
- **Description**: 阿杰的底座框架
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-10
- **Last Updated**: 2026-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Superb Small Framework

一个轻量级的 Java Web 应用框架，基于 Solon 构建，集成了 RBAC（基于角色的访问控制）权限管理、主题定制和标签页导航功能。

## 技术栈

### 后端
- **框架**: Solon 3.10.4（轻量级 Java 框架）
- **数据库**: MySQL 5.1.49
- **ORM**: Xbatis 1.9.6 + MyBatis
- **认证**: Sa-Token 1.45.0
- **连接池**: HikariCP
- **SQL 日志**: P6Spy 3.9.1
- **Java 版本**: 21

### 前端
- **框架**: UmiJS 4.6.23（基于 React 的框架）
- **UI 库**: Ant Design 5.0.1 + Ant Design Pro Components 2.4.4
- **语言**: TypeScript 5.0.3

## 项目结构

```
small-fremwork/
├── small-server/          # 后端服务
│   ├── src/main/java/com/superb/small/
│   │   ├── SolonApp.java              # 应用入口
│   │   ├── base/                      # 基础类
│   │   │   ├── BaseController.java    # 基础控制器
│   │   │   ├── BaseEntity.java        # 基础实体
│   │   │   ├── BaseService.java       # 基础服务接口
│   │   │   └── BaseServiceImpl.java   # 基础服务实现
│   │   ├── config/                    # 配置类
│   │   │   ├── SmallConfig.java       # 主配置
│   │   │   ├── GlobalFilter.java      # 全局过滤器
│   │   │   ├── GlobalInterceptor.java # 全局拦截器
│   │   │   └── SuperbOn*Listener.java # 实体监听器
│   │   ├── controller/                # REST 控制器
│   │   ├── service/                   # 业务服务
│   │   ├── mapper/                    # MyBatis 映射器
│   │   ├── entity/                    # 数据库实体
│   │   ├── domain/                    # DTO、VO、枚举、参数类
│   │   └── exception/                 # 自定义异常
│   └── src/main/resources/
│       ├── app.yml                    # 应用配置
│       └── mapper/                    # MyBatis XML 映射文件
│
└── small-ui/             # 前端应用
    ├── src/
    │   ├── pages/                    # 页面组件
    │   │   ├── Home/                 # 首页
    │   │   ├── Login/                # 登录页
    │   │   ├── System/               # 系统管理
    │   │   │   ├── User/             # 用户管理
    │   │   │   ├── Role/             # 角色管理
    │   │   │   └── Menu/             # 菜单/权限管理
    │   │   ├── ThemeSetting/         # 主题设置
    │   │   └── User/                 # 个人设置
    │   ├── components/               # 通用组件
    │   ├── layouts/                 # 布局组件
    │   ├── services/                # API 服务
    │   ├── models/                  # 全局状态模型
    │   └── utils/                   # 工具函数
    └── .umirc.ts                    # UmiJS 配置
```

## 功能特点

### 核心功能
- **用户管理**: 系统用户的增删改查操作
- **角色管理**: 角色创建和权限分配
- **权限管理**: 细粒度的 RBAC，支持菜单级和元素级权限
- **身份认证**: 基于 Token 的认证机制，支持 Redis 存储

### 前端功能
- **主题定制**: 多种主题可选，支持主色调和圆角设置
- **标签页导航**: 支持缓存的标签页和路由匹配
- **响应式设计**: 基于 Ant Design 组件的自适应布局

## 快速开始

### 环境要求
- JDK 21+
- Node.js 18+
- MySQL 5.7+
- Redis 6+

### 后端启动

1. 在 `small-server/src/main/resources/app.yml` 中配置数据库连接：
```yaml
dataSources:
  master!:
    jdbcUrl: jdbc:mysql://你的MySQL主机:3306/superb-small
    username: 你的用户名
    password: 你的密码
```

2. 配置 Redis 连接：
```yaml
sa-token:
  redis:
    server: 你的Redis主机:6379
    password: 你的密码
```

3. 编译运行：
```bash
cd small-server
./mvnw clean package
java -jar target/small-server.jar
```

### 前端启动

```bash
cd small-ui
npm install
npm run dev
```

## 接口文档

### 认证接口
| 方法 | 路径 | 描述 |
|------|------|------|
| POST | /api/auth/login | 用户登录 |
| POST | /api/auth/logout | 用户登出 |
| GET | /api/auth/info | 获取当前用户信息 |

### 用户管理接口
| 方法 | 路径 | 描述 |
|------|------|------|
| GET | /api/user/list | 获取用户列表 |
| POST | /api/user | 创建用户 |
| PUT | /api/user | 更新用户 |
| DELETE | /api/user/{id} | 删除用户 |

### 角色管理接口
| 方法 | 路径 | 描述 |
|------|------|------|
| GET | /api/role/list | 获取角色列表 |
| POST | /api/role | 创建角色 |
| PUT | /api/role | 更新角色 |
| DELETE | /api/role/{id} | 删除角色 |
| GET | /api/role/perms/{id} | 获取角色权限 |
| POST | /api/role/distribution | 分配权限 |

### 权限管理接口
| 方法 | 路径 | 描述 |
|------|------|------|
| GET | /api/permission/list | 获取权限树 |
| POST | /api/permission | 创建权限 |
| PUT | /api/permission | 更新权限 |
| DELETE | /api/permission/{id} | 删除权限 |

## 许可证

本项目仅供学习和开发使用。