# xm_lease

**Repository Path**: Clb_2333/xm_lease

## Basic Information

- **Project Name**: xm_lease
- **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-07-23
- **Last Updated**: 2025-07-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: SpringBoot

## README

# XM 租赁管理系统

## 项目简介

XM 租赁管理系统是一个基于 Spring Boot 的后台管理平台，主要用于管理公寓租赁相关业务。系统涵盖了公寓信息、房间管理、租约管理、用户管理、预约看房、支付方式、配套信息等多个模块，适用于租赁业务的全流程管理。

该项目主要面向房产租赁公司或物业管理公司，帮助其高效管理租赁业务，提升运营效率。

## 功能模块

### 公寓管理
- 公寓信息的增删改查
- 公寓发布状态管理
- 公寓与配套设施、标签、费用的关联管理

### 房间管理
- 房间信息维护
- 房间属性、配套设施、支付方式、租期等配置
- 房间发布状态管理

### 租约管理
- 租约信息维护
- 租约状态管理
- 租约分页查询

### 用户管理
- 后台用户管理
- 员工岗位管理
- 用户状态管理

### 预约看房
- 预约信息管理
- 预约状态更新

### 系统设置
- 登录认证与权限控制
- 图形验证码生成
- 文件上传管理（基于 MinIO）
- 定时任务（如租约状态检查）

### 数据字典
- 支付方式、租期、标签、配套等基础数据维护

## 技术栈

- **后端框架**：Spring Boot + MyBatis Plus
- **数据库**：MySQL
- **文件存储**：MinIO
- **权限控制**：JWT + Redis
- **接口文档**：Knife4j（Swagger 增强）
- **定时任务**：Spring Task
- **枚举转换**：自定义 ConverterFactory
- **异常处理**：全局异常处理器（`@ControllerAdvice`）

## 模块结构

- **common**：通用工具类、异常处理、Redis 常量、JWT 工具类、MyBatis Plus 配置等
- **model**：实体类、枚举定义、数据库表映射
- **web/web-admin**：后台管理模块，包含控制器、服务层、Mapper、VO、QueryVo 等

## 快速开始

### 环境要求

- JDK 1.8+
- Maven 3.5+
- MySQL 5.7+
- MinIO（可选）
- Redis

### 构建与运行

1. 克隆项目：

```bash
git clone https://gitee.com/Clb_2333/xm_lease.git
```

2. 修改配置文件：

```yaml
# web/web-admin/src/main/resources/application.yml
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/xm_lease?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
    username: root
    password: root
  redis:
    host: localhost
    port: 6379
minio:
  endpoint: http://localhost:9000
  accessKey: minioadmin
  secretKey: minioadmin
  bucketName: xm-lease
```

3. 初始化数据库：

导入项目 SQL 文件或手动创建表结构（表名与实体类中 `@TableName` 注解一致）

4. 启动项目：

```bash
cd xm_lease
mvn clean install
cd web/web-admin
mvn spring-boot:run
```

5. 访问接口文档：

```
http://localhost:8080/doc.html
```

## 接口文档

系统使用 Knife4j 提供可视化接口文档，支持以下模块的接口测试与调试：

- 公寓管理
- 房间管理
- 租约管理
- 用户管理
- 预约看房
- 登录认证
- 系统设置等

## 贡献指南

欢迎贡献代码和改进文档。请遵循以下流程：

1. Fork 项目
2. 创建新分支（`feature/your-feature-name`）
3. 提交代码
4. 创建 Pull Request

## 许可证

本项目采用 MIT 许可证。详情请查看 LICENSE 文件。