从零开始搭建一个Python Flask项目

Flask是一个轻量级的Web框架,以其简单的功能,深受众多开发者的喜爱,其核心功能非常简单,但可以通过扩展支持复杂的Web应用开发,下面我们就来演示一下如何从零开始搭建一个Flask项目。

环境准备

在搭建 Flask 项目之前,首先需要准备Python3的开发环境。通过在终端中运行以下命令来检查Python是否已经安装成功如果没有安装可以按照官网教程进行安装。

python3 --version

创建虚拟环境

在开发过程中我们可以使用虚拟环境来隔离项目依赖,避免与系统中的其他项目的依赖库产生不必要的冲突。

python3 -m venv venv

激活虚拟环境

#  macOS/Linux 上
source venv/bin/activate
# 在 Windows 上
venv\Scripts\activate

激活虚拟环境后,命令行提示符会发生变化,显示虚拟环境的名称,我们可以在项目的虚拟环境中来创建项目。

安装Flask

确保虚拟环境已激活后,运行以下命令通过pip安装Flask。

pip install flask

安装完成后,可以使用pip list命令查看已安装的库,确认Flask是否成功安装。

创建Flask项目结构

接下来,我们就可以搭建项目的基本目录结构。这里我们创建了一个名为flask_project的项目,然后通过如下的结构来构建项目。

flask_project/
│
├── app/
│   ├── __init__.py        # 项目的初始化文件
│   ├── routes.py          # 路由定义文件
│   └── templates/         # HTML 模板文件目录
│       └── index.html
│   └── static/            # 静态文件目录(CSS、JS、图片等)
│       └── style.css
├── venv/                  # 虚拟环境文件夹
├── requirements.txt       # 依赖文件
└── run.py                 # 启动项目的脚本

编写Flask应用

创建run.py文件

run.py是用于启动Flask的入库文件,如下所示。

from app import create_app

app = create_app()

if __name__ == '__main__':
    app.run(debug=True)

创建 app/__init__.py 文件

在app/__init__.py文件中,需要创建一个create_app函数来对Flask应用进行初始化操作,用来对项目进行扩展和配置管理。

from flask import Flask

def create_app():
    app = Flask(__name__)

    # 配置应用
    app.config['SECRET_KEY'] = 'your-secret-key'

    # 注册蓝图
    from .routes import main
    app.register_blueprint(main)

    return app

在这个文件中,初始化了Flask应用并配置密钥。除此之外还注册了路由模块,这样可以方便将路由逻辑与应用程序结构分离。

创建app/routes.py文件

接下来,我们需要定义应用的路由。将路由封装在一个Flask模块中,这样方便在应用规模扩展时,能够方便地管理不同的路由模块,如下所示。

from flask import Blueprint, render_template

main = Blueprint('main', __name__)

@main.route('/')
def index():
    return render_template('index.html')

创建 HTML 模板

在上面的代码中在根路径 (/) 上定义了一个index视图,接下来我们就在app/templates/目录下,创建一个简单的index.html文件来展示网页内容,如下所示。




    
    
    Flask Web App
    


    

Welcome to Flask!

This is your first Flask web application.

添加静态文件

在app/static/目录下,创建CSS 文件style.css。如下所示

body {
    font-family: Arial, sans-serif;
    background-color: #f0f0f0;
    text-align: center;
    padding-top: 50px;
}

h1 {
    color: #2c3e50;
}

p {
    color: #7f8c8d;
}

运行项目

在项目根目录下,通过如下的命令来启动Flask项目。

python run.py

启动之后,就会看到如下的内容输出。

* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

打开浏览器,访问 http://127.0.0.1:5000/,将看到显示 "Welcome to Flask!" 的网页内容。

总结

到目前为止,搭建了一个简单的Flask应用,展示了包括环境搭建、项目结构设计、路由定义、模板渲染以及静态文件管理等步骤的具体实现,当然我们也可以继续扩展上面的项目,例如添加数据支持、添加多路由、多视图支持,增加用户认证等操作逐渐对项目进行扩展形成一个完整的复杂的项目。