Flask-Admin-Dashboard 项目教程

1. 项目目录结构及介绍

Flask-Admin-Dashboard/
├── app.py
├── config.py
├── flask_admin/
│   ├── __init__.py
│   ├── helpers.py
│   ├── model.py
│   ├── form.py
│   ├── form/
│   │   ├── rules.py
│   │   ├── fields.py
│   │   ├── upload.py
│   ├── tools.py
│   ├── actions.py
│   ├── contrib/
│   │   ├── sqla/
│   │   │   ├── fields.py
│   │   ├── peewee/
│   │   ├── pymongo/
│   │   ├── fileadmin/
│   ├── model_template/
├── requirements.txt
├── sample_db.sqlite
├── static/
├── templates/
├── screenshots/
├── LICENSE
├── README.md
└── .gitignore

目录结构介绍

• app.py: 项目的启动文件。
• config.py: 项目的配置文件。
• flask_admin/: 包含 Flask-Admin 扩展的相关文件和模块。
  • __init__.py: 初始化 Flask-Admin 扩展。
  • helpers.py: 包含一些辅助函数。
  • model.py: 处理与数据库模型相关的逻辑。
  • form.py: 处理表单相关的逻辑。
  • form/: 包含表单相关的子模块。
    • rules.py: 表单验证规则。
    • fields.py: 自定义表单字段。
    • upload.py: 文件上传处理。
  • tools.py: 包含一些工具函数。
  • actions.py: 处理批量操作。
  • contrib/: 包含与其他数据库后端集成的模块。
    • sqla/: SQLAlchemy 集成。
    • peewee/: Peewee 集成。
    • pymongo/: PyMongo 集成。
    • fileadmin/: 文件管理集成。
  • model_template/: 模型模板。
• requirements.txt: 项目依赖文件。
• sample_db.sqlite: 示例 SQLite 数据库文件。
• static/: 静态文件目录，包含 CSS、JavaScript 等文件。
• templates/: 模板文件目录，包含 HTML 模板文件。
• screenshots/: 项目截图目录。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• .gitignore: Git 忽略文件配置。

2. 项目启动文件介绍

app.py

app.py 是 Flask-Admin-Dashboard 项目的启动文件。它包含了 Flask 应用的初始化、路由配置、数据库连接等核心逻辑。

from flask import Flask
from flask_admin import Admin
from flask_admin.contrib.sqla import ModelView
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config.from_object('config')

db = SQLAlchemy(app)

admin = Admin(app, name='Admin Dashboard', template_mode='bootstrap3')

# 添加模型视图
from models import User, Role
admin.add_view(ModelView(User, db.session))
admin.add_view(ModelView(Role, db.session))

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

主要功能

• Flask 应用初始化: 创建 Flask 应用实例 app。
• 配置加载: 从 config.py 文件中加载配置。
• 数据库初始化: 初始化 SQLAlchemy 数据库连接。
• Flask-Admin 初始化: 初始化 Flask-Admin 并添加模型视图。
• 启动应用: 在调试模式下启动 Flask 应用。

3. 项目配置文件介绍

config.py

config.py 文件包含了 Flask-Admin-Dashboard 项目的配置信息，包括数据库连接、密钥、调试模式等。

import os

basedir = os.path.abspath(os.path.dirname(__file__))

class Config(object):
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'you-will-never-guess'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or \
        'sqlite:///' + os.path.join(basedir, 'sample_db.sqlite')
    SQLALCHEMY_TRACK_MODIFICATIONS = False
    DEBUG = True

主要配置项

• SECRET_KEY: Flask 应用的密钥，用于加密会话等敏感数据。
• SQLALCHEMY_DATABASE_URI: 数据库连接字符串，默认使用 SQLite 数据库。
• SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪数据库修改，默认关闭以提高性能。
• DEBUG: 是否启用调试模式，默认启用。

通过这些配置项，可以灵活地调整项目的运行环境和行为。