Flask框架入门（7）工程结构与flask命令运行

下面介绍一个Flask应用的一般结构跟每个目录的作用。

工程结构

一般项目结构如下：

/home/user/Projects/flask-tutorial
├── flaskr/                    # 项目代码文件夹
│   ├── __init__.py            # application 工厂方法跟python的包声明
│   ├── db.py                  # 数据库操作
│   ├── schema.sql             # 数据库文件
│   ├── auth.py                # 认证操作
│   ├── blog.py
│   ├── templates/             # 模板文件夹
│   │   ├── base.html
│   │   ├── auth/
│   │   │   ├── login.html
│   │   │   └── register.html
│   │   └── blog/
│   │       ├── create.html
│   │       ├── index.html
│   │       └── update.html
│   └── static/                # 静态文件夹：css，js等
│       └── style.css
├── tests/                     # 测试代码文件夹
│   ├── conftest.py
│   ├── data.sql
│   ├── test_factory.py
│   ├── test_db.py
│   ├── test_auth.py
│   └── test_blog.py
├── venv/                      # python环境
├── setup.py                
└── MANIFEST.in

__init__.py 文件的作用有两个：

（1）作为python包管理，将当前文件夹声明为package。

（2）包含初始化Application工厂方法

flaskr/__init__.py 代码：

import os

from flask import Flask

# 工厂方法
def create_app(test_config=None):
    # 创建Flask实例
    # 第一个参数__name__是当前模块的名称，方便框架知道执行文件的位置
    # 第二个参数instance_relative_config=True 告诉应用程序配置文件是相对于实例文件夹的。实例文件夹位于flaskr包外部，可以保存不应提交给版本控制的本地数据，例如机密配置和数据库文件。
    app = Flask(__name__, instance_relative_config=True)

    # 设置一些应用的配置信息，可以有多种方式，也可单独写在一个class中通过from_object加载
    app.config.from_mapping(
        SECRET_KEY='dev',
        DATABASE=os.path.join(app.instance_path, 'flaskr.sqlite'),
    )

    if test_config is None:
        # load the instance config, if it exists, when not testing
        app.config.from_pyfile('config.py', silent=True)
    else:
        # load the test config if passed in
        app.config.from_mapping(test_config)

    # ensure the instance folder exists
    try:
        os.makedirs(app.instance_path)
    except OSError:
        pass

    # a simple page that says hello
    @app.route('/hello')
    def hello():
        return 'Hello, World!'

    return app

运行应用

使用flask命令运行应用，首先需要告诉Flask去哪找你的应用，然后运行在development模式。

如果按上面的工程目录来说，执行命令你需要在顶层目录flask-tutorial文件夹中，而不是flaskr文件夹。

Linux and Mac:

$ export FLASK_APP=flaskr
$ export FLASK_ENV=development
$ flask run

Windows cmd使用set代替export:

> set FLASK_APP=flaskr
> set FLASK_ENV=development
> flask run

Windows PowerShell使用$env代替 export:

> $env:FLASK_APP = "flaskr"
> $env:FLASK_ENV = "development"
> flask run

成功运行会输出以下类似信息：
* Serving Flask app "flaskr"
* Environment: development
* Debug mode: on
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
* Restarting with stat
* Debugger is active!
* Debugger PIN: 855-212-761