首页 › Flask Web 开发 › 蓝图与项目结构
蓝图与项目结构
当路由越来越多时,把所有代码写在一个 app.py 里会难以维护。Flask 的蓝图(Blueprint)可以把应用拆分成多个模块。
推荐的项目结构
myapp/
app/
__init__.py # 应用工厂
config.py
auth/
__init__.py
routes.py # 登录、注册
blog/
__init__.py
routes.py # 文章相关
templates/
static/
tests/
run.py
定义蓝图
# app/blog/routes.py
from flask import Blueprint, render_template
bp = Blueprint("blog", __name__, url_prefix="/blog")
@bp.route("/")
def index():
return render_template("blog/index.html")
@bp.route("/<int:post_id>")
def detail(post_id):
return f"文章 {post_id}"
应用工厂
用函数创建应用实例,便于测试和使用不同配置:
# app/__init__.py
from flask import Flask
def create_app(config_name="default"):
app = Flask(__name__)
app.config.from_object(f"app.config.{config_name.title()}Config")
from app.blog.routes import bp as blog_bp
from app.auth.routes import bp as auth_bp
app.register_blueprint(blog_bp)
app.register_blueprint(auth_bp)
return app
# run.py
from app import create_app
app = create_app()
if __name__ == "__main__":
app.run(debug=True)
配置类
# app/config.py
import os
class DefaultConfig:
SECRET_KEY = os.environ.get("SECRET_KEY", "dev-only")
DATABASE = "app.db"
class TestingConfig(DefaultConfig):
TESTING = True
DATABASE = ":memory:"
在蓝图中生成 URL
使用蓝图后,url_for 的端点名要带上蓝图名:
url_for("blog.detail", post_id=3) # /blog/3
url_for("auth.login")
测试
应用工厂让测试变得简单:
import pytest
from app import create_app
@pytest.fixture
def client():
app = create_app("testing")
return app.test_client()
def test_blog_index(client):
resp = client.get("/blog/")
assert resp.status_code == 200练习题
学完本节后,试着独立完成下面的练习,再展开参考答案对照。
练习 1 新建一个 api 蓝图,前缀为 /api/v1,提供 /ping 接口返回 {"pong": true}。
查看参考答案
from flask import Blueprint
bp = Blueprint("api", __name__, url_prefix="/api/v1")
@bp.get("/ping")
def ping():
return {"pong": True}
# 在 create_app 中:app.register_blueprint(bp)