基于FastAPI+Python 实现的房屋租赁系统

# 基于FastAPI的房屋租赁系统 ## 项目背景 传统的线下租房不便、途径少、信息更新慢，导致房屋租赁效率低。为了有效的提升租赁效率和房源信息管理、提供更优质的租赁服务。让房东出租宣传展示与房源管理、租客更好的检索房源信息、发布租房需求以及入住预定、后台房源管理、审核等一站式租赁服务平台。 - 租客：浏览房源、收藏房源、预定房源、发布租房需求、查看电子合同。 - 房东：发布房源、订单管理、查看电子合同。 - 管家：查看房源信息、回复咨询、线下带看房源。 - 管理员：用户管理、房源管理、订单管理、租房需求、实名认证、系统公告管理。 ## TODO - 房源全文检索 - 租房需求支持评论 - 日租、合租模式 - 房源推荐系统（Go开发） ## 项目索引 - 后端服务 https://github.com/HuiDBK/HuiHome - 前端服务： - 用户前台：https://github.com/HuiDBK/HuiHome/home_front - 后台管理：https://gitee.com/huiDBK/house_admin ## 项目特色 - 基于FastAPI、Uvicorn的异步框架服务，aiomysql、aioredis、tortoise-orm异步数据库、aiofiles等异步IO库 - 分页、实名认证、缓存装饰器、请求Context的Depends、序列化工具函数的封装 - 基于 pydantic 请求入参、响应出参封装，以及通用模型封装 - 上下文无关联耗时业务并发处理 `asyncio.gather` - 读多写少的业务数据采用 Redis 缓存，提高性能 - 统一错误处理，鉴权、日志、防爬虫Web中间件封装 - 采用了七牛云OSS、CDN服务加速一些图片资源 - 采用 FastAPI 的后台任务 BackendTasks 实现异步发送短信验证码 - 采用 tortoise-orm 完成数据库操作的封装 - 通过模板字符串动态渲染富文本实现电子合同功能 - 对接阿里支付实现了订单、支付模块，对接百度地图实现当前城市定位、房源附近信息查询等功能 - 前端界面采用 Vue.js + Element ui 实现数据渲染，Bootstrap 实现自适应布局 ## 项目体验 项目体验地址 [http://43.138.173.93:6868](http://43.138.173.93:6868) 由于注册需要发送短信验证码，而手机验证码服务现在只能给我的测试手机号发送验证码，因此不能使用注册服务。大家可以使用已有账号去登录体验。 | 账号类别 | 用户名 | 密码 | 备注 | | --- | --- | --- | --- | | 用户账号 | hui | 123456 | 租客账号 | | 用户账号 | wang | 123456 | 房东账号 | 项目还没有太完善，服务器也只是学习级别的，可能会出现很多异常，望大家多担待。如有好的建议或者不懂的可以加入我们的群聊一起探讨与学习 **293874607**  ## 项目启动 ### 本地运行 1. 申请第三方服务：七牛云的OSS服务、容联云的短信服务、阿里的支付服务、百度地图服务 2. 然后修改 `house_rental/commons/settings` 配置文件信息 3. 导入 `resource\house_rental.sql` 构造MySQL数据 4. 安装依赖 `pip install -r requirements.txt` 5. 项目启动 `python main.py` **准备数据库数据** 导入 `resource\house_rental.sql` 构造MySQL数据 如果成功在本地启动项目，访问 [http://127.0.0.1:8080/docs](http://127.0.0.1:8080/docs) 地址查看接口文档  ### 容器启动与部署 1. 申请第三方服务：七牛云的OSS服务、容联云的短信服务、阿里的支付服务、百度地图服务 2. 然后修改 `house_rental/commons/settings` 配置文件信息 3. 准备好 docker 与 docker-compose 环境 4. 构造项目镜像 `docker build -t house_rental_image .` 5. 然后直接运行 `bin\start.sh` 使用docker-compose部署mysql、redis、nginx、后端api 服务 6. docker ps 或 docker-compose ps 查看容器启动情况 7. 停止服务运行 `bin\stop.sh` ## 系统整体功能图  ## 项目结构 项目开发整体采用的是Python的FastAPI框架来搭建系统的接口服务，接口设计遵循 `Restful API`接口规范。接口前后端交互都采用json格式进行数据交互，项目整体的结构如下： ```python ─house_rental ├─commons ------------------------- 项目公共模块 │ ├─exceptions ------------------- 项目全局异常模块 │ ├─libs ------------------------- 第三方服务模块 │ ├─responses -------------------- 项目全局响应模块 │ ├─settings --------------------- 项目配置 │ └─utils ------------------------ 项目工具类 ├─constants ----------------------- 项目常量模块 ├─logic --------------------------- 项目逻辑模块 ├─managers ------------------------ 项目数据库模型管理器模块 ├─middlewares --------------------- 项目中间件模块 ├─models -------------------------- 项目数据库模型模块 ├─routers ------------------------- 项目路由模块 │ ├─admin ------------------------ 后台管理路由 │ │ ├─apis ---------------------- 后台管理路由接口 │ │ ├─request_models ------------ 后台路由请求模型 │ │ └─response_models ----------- 后台路由响应模型 │ ├─common ----------- 公共路由模块 │ │ ├─apis │ │ ├─request_models │ │ └─response_models │ ├─house ------------ 房源路由模块 │ │ ├─apis │ │ ├─request_models │ │ └─response_models │ ├─order ------------ 订单路由模块 │ │ ├─apis │ │ ├─request_models │ │ └─response_models │ ├─payment ---------- 支付路由模块 │ │ ├─apis │ │ ├─request_models │ │ └─response_models │ ├─user ------------- 用户路由模块 │ │ ├─apis │ │ ├─request_models │ │ ├─response_models └─server.py --------- 项目服务模块 └─Dockerfile ------------------- 项目docker部署文件 └─docker-compose.yaml ---------- 项目docker容器配置部署文件 └─requirements.txt ------------- 项目依赖库文件 └─README.md -------------------- 项目说明文档 └─main.py ---------------------- 项目启动入口 ``` ## 项目Redis缓存设计 ### Redis key 规范： ```python project : module : business : unique key 项目名 : 模块名 : 业务 : 唯一区别key 例如：用户手机短信验证码缓存 house_rental:user:sms_code:13022331752 ``` ### 用户模块缓存 | Key | 类型 | 过期时间 | 说明 | | --- | --- | --- | --- | | **house_rental:user:sms_code:{mobile}** | string | 5分钟 | 存储用户手机短信验证码 | | | | | | ### 房源模块缓存 | Key | 类型 | 过期时间 | 说明 | |-----------------------------------------------| --- |------| --- | | **house_rental:house:collect:user:{user_id}** | set | 不过期 | 存储用户收藏的房源id | | **house_rental:house:home_houses:{city}** | string | 7天 | 首页房源信息缓存，存储json | | **house_rental:house:facilities** | string | 15天 | 房源设施缓存，存储json | | **house_rental:house:detail:{house_id}** | string | 7天 | 房源详情缓存，存储json | ### 其他缓存 | Key | 类型 | 过期时间 | 说明 | | --- | --- | --- | --- | | **house_rental:common:areas** | string | 3个月 | 存储省市区json字符串数据 | | | | | | ## 系统整体ER图 ![image.png](https://p3-juejin.byteimg.com/t