flask笔记

flask笔记

2026-05-19 15:45 技术

flask

Flask 是一个用 Python 编写的轻量级 Web 应用框架。 Flask 基于 WSGI(Web Server Gateway Interface)和 Jinja2 模板引擎,旨在帮助开发者快速、简便地创建 Web 应用。 Flask 让我们用 Python 快速写出网站、接口、后台服务。。 Flask 适合小项目、API 接口、微服务。

flask 基础概念

  • 路由: 路由是 URL 到 Python 函数的映射。 Flask 允许你定义路由,这样当特定的 URL 被访问时,就会调用相应的函数。
  • 视图函数: 视图函数是处理请求并返回响应的 Python 函数。 它们通常接收请求对象作为参数,并返回响应对象。
  • 请求对象: 请求对象包含了客户端发送的请求信息,如请求方法、URL、请求头、表单数据等。
  • 响应对象: 响应对象包含了发送给客户端的响应信息,如状态码、响应头、响应体等。
  • 模板: Flask 使用 Jinja2 模板引擎来渲染 HTML 模板。 模板允许你将 Python 代码嵌入到 HTML 中,从而动态生成网页。
  • 应用工厂: 应用工厂是一个 Python 函数,它创建并返回一个 Flask 应用实例。 这允许你配置和初始化你的应用,并且可以创建多个应用实例。
  • 配置对象: Flask 应用有一个配置对象,你可以使用它来设置各种配置选项,如数据库连接字符串、调试模式等。
  • 蓝图: 蓝图是 Flask 中的一个组织代码的方式, 它允许你将相关的视图函数、模板和静态文件组织在一起,并且可以在多个应用中重用。
  • 静态文件: 静态文件是不会被服务器端执行的文件,如 CSS、JavaScript 和图片文件。 Flask 提供了一个简单的方法来服务这些文件。
  • 扩展: Flask 有许多扩展,可以添加额外的功能,如数据库集成、表单验证、用户认证等。
  • 会话: Flask 使用客户端会话来存储用户信息,这允许你在用户浏览你的应用时记住他们的状态。
  • 错误处理: Flask 允许你定义错误处理函数,当特定的错误发生时,这些函数会被调用。

路由

实例

from flask import Flask

app = Flask(__name__)

@app.route('/')
def home():
    return 'Welcome to the My Home Page!'

@app.route('/about')
def about():
    return 'This is the About Page.'
  • @app.route('/'):将根 URL / 映射到 home 函数。
  • @app.route('/about'):将 /about URL 映射到 about 函数。

视图函数

实例

from flask import request

@app.route('/greet/<name>')
def greet(name):
    return f'Hello, {name}!'

greet 函数接收 URL 中的 name 参数,并返回一个字符串响应。

请求对象

实例

from flask import request

@app.route('/submit', methods=['POST'])
def submit():
    username = request.form.get('username')
    return f'Hello, {username}!'

request.form.get('username'):获取 POST 请求中表单数据的 username 字段。

响应对象

实例

from flask import make_response

@app.route('/custom_response')
def custom_response():
    response = make_response('This is a custom response!')
    response.headers['X-Custom-Header'] = 'Value'
    return response

make_response:创建一个自定义响应对象,并设置响应头 X-Custom-Header。

模板

实例

from flask import render_template

@app.route('/hello/<name>')
def hello(name):
    return render_template('hello.html', name=name)

模板文件 (templates/hello.html):

<!DOCTYPE html>
<html>
<head>
    <title>Hello</title>
</head>
<body>
    <h1>Hello, {{ name }}!</h1>
</body>
</html>

应用工厂

实例

from flask import Flask

def create_app(config_name):
    app = Flask(__name__)
    app.config.from_object(config_name)

    from . import routes
    app.register_blueprint(routes.bp)

    return app

create_app 函数创建一个 Flask 应用实例,并从配置对象中加载配置。

配置对象

实例

class Config:
    DEBUG = True
    SECRET_KEY = 'mysecretkey'
    SQLALCHEMY_DATABASE_URI = 'sqlite:///mydatabase.db'

app.config.from_object(Config):将 Config 类中的配置项加载到应用配置中。

蓝图

实例

from flask import Blueprint

bp = Blueprint('main', __name__)

@bp.route('/')
def home():
    return 'Home Page'

注册蓝图 (app/__init__.py):

from flask import Flask
from .routes import bp as main_bp

def create_app():
    app = Flask(__name__)
    app.register_blueprint(main_bp)
    return app

静态文件

访问静态文件

<link rel="stylesheet" type="text/css" href="{{ url_for('static', filename='style.css') }}">

静态文件目录:将静态文件放在 static 文件夹中,Flask 会自动提供服务。

扩展

实例

from flask_sqlalchemy import SQLAlchemy

app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///mydatabase.db'
db = SQLAlchemy(app)

SQLAlchemy:用于数据库集成的扩展。

会话

实例

from flask import session

# 自动生成的密钥
app.secret_key = 'your_secret_key_here'

@app.route('/set_session/<username>')
def set_session(username):
    session['username'] = username
    return f'Session set for {username}'

@app.route('/get_session')
def get_session():
    username = session.get('username')
    return f'Hello, {username}!' if username else 'No session data'

session 对象用于存取会话数据。 你可以使用 Python 内置的 secrets 模块生成一个强随机性的密钥。 python3 -c 'import secrets; print(secrets.token_hex())'

错误处理

实例

@app.errorhandler(404)
def page_not_found(e):
    return 'Page not found', 404

@app.errorhandler(500)
def internal_server_error(e):
    return 'Internal server error', 500

@app.errorhandler(404):定义 404 错误的处理函数,返回自定义错误页面。

参考文档

Flask 官网: Flask 中文文档: Flask 开源地址: