使用Flask构建TODO应用 - The Way to Flask项目实战(第一部分)

前言

在The Way to Flask项目中，作者通过前两部分详细讲解了Flask的基础知识和各种扩展的使用方法。从本章开始，我们将进入实战环节，通过构建一个完整的TODO应用来整合之前学到的知识。

TODO应用需求分析

我们的TODO应用需要实现以下核心功能：

1. 基本CRUD操作：

   • 查询所有待办事项
   • 查看指定待办事项详情
   • 新增待办事项
   • 删除待办事项
   • 修改待办事项内容

2. 高级功能：

   • 为待办事项添加标记/标签
   • 标记待办事项为已完成状态
   • 用户认证与权限控制

项目结构设计

遵循良好的代码组织结构，我们的项目采用如下目录结构：

.
├── application/          # 应用核心代码
│   ├── __init__.py       # 应用工厂
│   ├── controllers/      # 视图控制器
│   ├── extensions.py     # 扩展初始化
│   └── models/          # 数据模型
├── config/               # 配置文件
├── manage.py             # 命令行管理
└── tests/                # 测试代码

这种结构清晰地将不同功能的代码分离，便于维护和扩展。

数据模型设计

User模型

class User(db.Document):
    name = db.StringField()
    password = db.StringField()
    email = db.StringField()
    role = db.ReferenceField('Role')
    
    # Flask-Login需要的认证方法
    def is_authenticated(self): ...
    def is_active(self): ...
    def is_anonymous(self): ...
    def get_id(self): ...

Item模型

class Item(db.Document):
    content = db.StringField(required=True)
    created_date = db.DateTimeField()
    completed = db.BooleanField(default=False)
    completed_date = db.DateTimeField()
    created_by = db.ReferenceField('User', required=True)
    notes = db.ListField(db.StringField())
    priority = db.IntField()
    
    def to_json(self):
        return {
            'id': str(self.id),
            'content': self.content,
            'completed': self.completed,
            # 其他字段...
        }

视图控制器设计

我们使用Blueprint来组织路由，将不同功能的视图分开：

认证模块(auth.py)

auth_bp = Blueprint('auth', __name__, url_prefix='/auth')

@auth_bp.route('/login', methods=['POST'])
def login():
    # 处理用户登录逻辑
    user = Models.User.objects(name=username, password=password).first()
    if user:
        login_user(user)  # Flask-Login的登录方法
        return jsonify(user.to_json())

TODO模块(todo.py)

todo_bp = Blueprint('todos', __name__, url_prefix='/todo')

@todo_bp.route('/item', methods=['POST'])
@login_required
def create_todo_item():
    # 创建新待办事项
    item = Models.Item(content=content, created_date=datetime.now(),
                     created_by=current_user.id)
    item.save()
    return jsonify(item.to_json())

应用初始化

在__init__.py中，我们使用应用工厂模式创建Flask实例：

def create_app(mode):
    app = Flask(__name__)
    app.config.from_object(load_config(mode))
    
    # 注册扩展
    register_extensions(app)
    # 注册蓝图
    register_blueprint(app)
    
    return app

扩展初始化

在extensions.py中集中管理所有扩展：

from flask_admin import Admin
from flask_login import LoginManager
from flask_mongoengine import MongoEngine

db = MongoEngine()
login_manager = LoginManager()
admin = Admin()

总结

本部分我们完成了TODO应用的基础架构设计，包括：

1. 明确了应用的功能需求
2. 设计了合理的项目结构
3. 创建了核心数据模型
4. 实现了基本的视图控制器
5. 完成了应用和扩展的初始化

在下一部分中，我们将进一步完善这个应用，添加更多功能和优化细节。