logo cmdragon's Blog

分层架构在博客评论功能中的应用与实现

avatar
cmdragon 大乘
  2025-04-24 12:45:43   2025-04-24 12:45:43   1.8k 字  7 分钟
image image

扫描二维码关注或者微信搜一搜：编程智域 前端至全栈交流与成长

探索数千个预构建的 AI 应用，开启你的下一个伟大创意

1. 分层架构核心概念与优势

在开发Web应用程序时，合理的分层架构能显著提升代码可维护性和扩展性。对于博客评论功能，我们采用四层结构设计：

  1. 路由层（Routers）：处理HTTP请求与响应
  2. 服务层（Services）：封装业务逻辑
  3. 模型层（Models）：定义数据结构和数据库操作
  4. Schema层（Schemas）：数据验证与序列化

这种分层结构的优势在于：

  • 职责分离：各层专注单一职责
  • 易于测试：可对每层进行独立单元测试
  • 代码复用：通用逻辑可跨多个路由复用
  • 扩展灵活：修改某一层不影响其他层

2. 模型层设计与实现

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# models/comment.py
from tortoise.models import Model
from tortoise import fields


class Comment(Model):
    id = fields.IntField(pk=True)
    content = fields.TextField()
    author_id = fields.IntField()
    post_id = fields.IntField()
    created_at = fields.DatetimeField(auto_now_add=True)
    parent_id = fields.IntField(null=True)  # 支持回复评论

    class Meta:
        table = "comments"

    @classmethod
    async def get_comments_with_author(cls, post_id: int):
        return await cls.filter(post_id=post_id).prefetch_related('author')

模型层要点说明：

  • 使用prefetch_related实现关联数据的预加载
  • parent_id字段实现评论的树形结构
  • 自定义查询方法封装复杂查询逻辑
  • Datetime字段自动记录创建时间

3. Schema数据验证设计

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# schemas/comment.py
from pydantic import BaseModel
from datetime import datetime


class CommentBase(BaseModel):
    content: str
    post_id: int
    parent_id: int | None = None


class CommentCreate(CommentBase):
    pass


class CommentResponse(CommentBase):
    id: int
    author_id: int
    created_at: datetime
    replies: list['CommentResponse'] = []

    class Config:
        orm_mode = True

Schema设计原则：

  • 使用继承结构减少重复定义
  • 单独的Create Schema用于创建验证
  • Response Schema包含ORM转换配置
  • 递归定义实现评论的嵌套回复结构

4. 服务层业务逻辑封装

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# services/comment.py
from models.comment import Comment
from schemas.comment import CommentCreate, CommentResponse


class CommentService:
    @staticmethod
    async def create_comment(comment_data: CommentCreate, user_id: int) -> Comment:
        try:
            return await Comment.create(
                **comment_data.dict(),
                author_id=user_id
            )
        except Exception as e:
            raise ValueError("评论创建失败") from e

    @staticmethod
    async def get_post_comments(post_id: int) -> list[CommentResponse]:
        comments = await Comment.get_comments_with_author(post_id)
        return await CommentResponse.from_queryset(comments)

服务层特点：

  • 静态方法方便直接调用
  • 异常处理封装底层数据库错误
  • 业务逻辑与数据访问解耦
  • 返回类型提示增强代码可读性

5. 路由层接口实现

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# routers/comments.py
from fastapi import APIRouter, Depends
from services.comment import CommentService
from schemas.comment import CommentCreate, CommentResponse

router = APIRouter(prefix="/posts/{post_id}/comments", tags=["comments"])


@router.post("/", response_model=CommentResponse)
async def create_comment(
        post_id: int,
        comment_data: CommentCreate,
        user_id: int = Depends(get_current_user)
):
    return await CommentService.create_comment(comment_data, user_id)


@router.get("/", response_model=list[CommentResponse])
async def get_comments(post_id: int):
    return await CommentService.get_post_comments(post_id)

路由层关键点：

  • 使用路径参数post_id关联文章
  • 依赖注入获取当前用户
  • 清晰的响应模型定义
  • 路由分组增强文档可读性

6. 项目结构组织

推荐的项目目录结构：

1
2
3
4
5
6
7
8
9
10
11
12
/blog_api/
├── main.py
├── models/
│   ├── __init__.py
│   └── comment.py
├── schemas/
│   └── comment.py
├── services/
│   └── comment.py
├── routers/
│   └── comments.py
└── dependencies.py

7. 运行环境配置

安装依赖：

1
pip install fastapi uvicorn tortoise-orm pydantic python-multipart

数据库配置示例：

1
2
3
4
5
6
7
8
9
10
# main.py
from tortoise import Tortoise


async def init_db():
    await Tortoise.init(
        db_url='sqlite://db.sqlite3',
        modules={'models': ['models.comment']}
    )
    await Tortoise.generate_schemas()

8. 课后Quiz

问题1：当收到422 Validation Error时，应该如何快速定位问题？

答案解析：

  1. 检查请求体是否符合Schema定义
  2. 查看错误详情中的”loc”字段定位错误字段
  3. 验证字段类型和约束条件
  4. 使用Swagger文档测试接口

问题2：如何优化获取评论列表时的N+1查询问题？

答案解析：

  1. 使用prefetch_related预加载关联数据
  2. 在ORM查询中指定需要的关系字段
  3. 使用Tortoise的annotate进行批量查询
  4. 在Service层实现数据批量加载

9. 常见报错处理

报错1：RuntimeError - Event loop is closed

1
2
3
4
5
6
7
8
# 解决方法
import asyncio

if __name__ == "__main__":
    asyncio.run(main())

# 预防建议
确保数据库连接在应用关闭时正确释放

报错2：ValidationError - field required

1
2
3
4
5
6
7
8
9
10
# 原因分析
请求体缺少Schema要求的必填字段

# 解决方案
1.
检查前端发送的JSON结构
2.
在Schema中设置Optional字段
3.
使用exclude_unset模式处理部分更新

报错3：OperationalError - Connection refused

1
2
3
4
5
6
7
8
9
# 排查步骤
1.
检查数据库连接字符串
2.
验证数据库服务是否运行
3.
检查网络连接和端口开放情况
4.
查看数据库日志定位连接问题

余下文章内容请点击跳转至 个人博客页面 或者 扫码关注或者微信搜一搜：编程智域 前端至全栈交流与成长，阅读完整的文章：

往期文章归档：

分层架构在博客评论功能中的应用与实现
posts/a344f0dfbdbf/
作者
cmdragon
发布于
2025-04-24 12:45
许可
  1. 1. 1. 分层架构核心概念与优势
  2. 2. 2. 模型层设计与实现
  3. 3. 3. Schema数据验证设计
  4. 4. 4. 服务层业务逻辑封装
  5. 5. 5. 路由层接口实现
  6. 6. 6. 项目结构组织
  7. 7. 7. 运行环境配置
  8. 8. 8. 课后Quiz
  9. 9. 9. 常见报错处理
    1. 9.1. 往期文章归档：
  1. 1. 1. 分层架构核心概念与优势
  2. 2. 2. 模型层设计与实现
  3. 3. 3. Schema数据验证设计
  4. 4. 4. 服务层业务逻辑封装
  5. 5. 5. 路由层接口实现
  6. 6. 6. 项目结构组织
  7. 7. 7. 运行环境配置
  8. 8. 8. 课后Quiz
  9. 9. 9. 常见报错处理
    1. 9.1. 往期文章归档：