Flask-Admin 是 Flask 的管理插件,可以用于快速创建管理你的 Flask 项目的后台,最常用的功能还是可以很方便得管理 Model,你可以很方便得查看、创建、删除和修改 Model。

这是一个简单的例子,用来创建 Model。

安装 Flask-Admin

Flask-Admin 的安装很简单,尤其是使用 pip 等管理工具,就更简单了,直接使用以下命令安装:

pip install flask
pip install flask-admin


一个简单的 Flask应用

#!/usr/bin/env python
# encoding: utf-8
from flask import Flask
from flask.ext.admin import Admin

app = Flask(__name__)

admin = Admin(app)

app.run()


直接将这段代码保存为 app.py ,然后直接使用 python 运行

python app.py


接着在浏览器上访问地址:

http://localhost:5000/admin


你将看到一个最简约的 Flask-Admin 的页面。

管理 MongoDB Model 的 Flask-Admin

上面个例子我们可以访问 Flask-Admin 页面了,但是我们并没有管理到任何的数据,所以,这里我们就需要添加管理的数据。

要管理数据,首先需要有数据的结构,然后再指定数据的哪些结构需要管理,可以做哪些操作等等。总结起来,那么我们的操作步骤是:

  1. 创建 Models
  2. 指定可以操作的字段以及可以做的操作
  3. 将 Model 添加到 Flask-Admin 中

下面就先给出一份完整的代码:

#!/usr/bin/env python
# encoding: utf-8
from datetime import datetime
from flask import Flask
from flask_admin import Admin
from flask.ext.mongoengine import MongoEngine
from flask_admin.contrib.mongoengine import ModelView

app = Flask(__name__)

# Create dummy secrey key so we can use sessions
app.config['SECRET_KEY'] = '123456790'
app.config['MONGODB_SETTINGS'] = {'DB': 'testing',
                                  'host': '192.168.59.103',
                                  'port': 27017}

# extensions
db = MongoEngine()
admin = Admin(name="Learning", template_mode="bootstrap3")
db.init_app(app)
admin.init_app(app)


# Define mongoengine documents
class User(db.Document):
    name = db.StringField(max_length=40)
    tags = db.ListField(db.ReferenceField('Tag'))
    password = db.StringField(max_length=40)

    def __unicode__(self):
        return self.name


class Tag(db.Document):
    name = db.StringField(max_length=10)

    def __unicode__(self):
        return self.name


# add model to flask-admin
admin.add_view(ModelView(User))
admin.add_view(ModelView(Tag))

app.run(debug=True)


我们从上到下进行分析,首先 import 的东西就不说了,没太大必要。

然后是前面多出来的初始化语句:

# Create dummy secrey key so we can use sessions
app.config['SECRET_KEY'] = '123456790'
app.config['MONGODB_SETTINGS'] = {'DB': 'testing',
                                  'host': '192.168.59.103',
                                  'port': 27017}

# extensions
db = MongoEngine()
db.init_app(app)


这些都是配置 MongoDB 用的,所以和我们的主题没太大关系,可以忽略。因为换成其他数据库(例如 MySQL),那么都会不一样。

接下来的就是:

# Define mongoengine documents
class User(db.Document):
    name = db.StringField(max_length=40)
    tags = db.ListField(db.ReferenceField('Tag'))
    password = db.StringField(max_length=40)

    def __unicode__(self):
        return self.name


class Tag(db.Document):
    name = db.StringField(max_length=10)

    def __unicode__(self):
        return self.name


这两个是定义 Model 的语句了,也仅仅是定义了 Model 而已,没有其他太大的难点。

唯一需要注意的是 User 引用了 Tag 这个 Model,也就是 User Model 中的这一句:

tags = db.ListField(db.ReferenceField('Tag'))


然后也没其他了。

最后是关键的两句:

# add model to flask-admin
admin.add_view(ModelView(User))
admin.add_view(ModelView(Tag))


这两句才将我们的 Model 添加进 Flask-Admin 的管理之中。

至此,我们一个简单的 Flask-Admin 就算配置完全,可以进行使用了。还是将这个代码保存为 app.py,然后使用 python 运行:

python app.py


依旧访问原来的地址:

http://localhost:5000/admin


你将会看到一个带 User 和 Tag 的 Flask-Admin:

身份验证

因为 Flask-Admin 一般用于后台管理,所以权限相关的内容就非常重要了,所以 Flask-Admin 肯定是带权限管理相关的设置的啦。

在 Flask-Admin 中,控制权限主要依赖于一个方法,这个方法是

is_accessible


同时,还有个相关的方法是:

inaccessible_callback


这个方法用于当没有权限访问时如何处理用户的请求。

下面我就修改一下,修改的目的就是让只有用户名为 "admin" 的用户才能操作我们的 User 和 Tag 的数据。

其实很简单,我们只要继承 ModelView,然后在 is_accessible 方法中做一个限制:

#!/usr/bin/env python
# encoding: utf-8
from datetime import datetime
from flask import Flask
from flask.ext.login import current_user, LoginManager
from flask_admin import Admin
from flask.ext.mongoengine import MongoEngine
from flask_admin.contrib.mongoengine import ModelView

app = Flask(__name__)

# Create dummy secrey key so we can use sessions
app.config['SECRET_KEY'] = '123456790'
app.config['MONGODB_SETTINGS'] = {'DB': 'testing',
                                    'host': '192.168.59.103',
                                    'port': 27017}

# extensions
db = MongoEngine()
login_manager = LoginManager()
admin = Admin(name="Learning", template_mode="bootstrap3")

db.init_app(app)
login_manager.init_app(app)
admin.init_app(app)


# Define mongoengine documents
class User(db.Document):
    name = db.StringField(max_length=40)
    tags = db.ListField(db.ReferenceField('Tag'))
    password = db.StringField(max_length=40)

    def __unicode__(self):
        return self.name


class Tag(db.Document):
    name = db.StringField(max_length=10)

    def __unicode__(self):
        return self.name


class AdminModelView(ModelView):
    def is_accessible(self):
        if current_user.is_authenticated and current_user.name == "admin":
            return True
        return False

# add model to flask-admin
admin.add_view(AdminModelView(User))
admin.add_view(AdminModelView(Tag))

@login_manager.user_loader
def load_user(user_id):
    return User.objects(id=user_id).first()

app.run(port=5001, debug=True)


相比于第二个版本,我们这里引入了一个新的 Flask-Login 的插件,但是,没关系,这都不是关键,但是,为了防止你走偏,所以我把增加的和 Flask- Login相关的代码都罗列出来:

from flask.ext.login import current_user, LoginManager

login_manager = LoginManager()
login_manager.init_app(app)

@login_manager.user_loader
def load_user(user_id):
    return User.objects(id=user_id).first()


其实和本主题没关系的 Flask-Login 代码就这么多。

然后我们真正为了权限鉴定而修改的代码有:

class AdminModelView(ModelView):
    def is_accessible(self):
        if current_user.is_authenticated and current_user.name == "admin":
            return True
        return False

# add model to flask-admin
admin.add_view(AdminModelView(User))
admin.add_view(AdminModelView(Tag))


这里自己集成了 ModelView 类,然后重写了 is_accessible 这个方法,用于判断该用户是否有权限操作我们的 Model,然后,我们用我们自定义的 AdminModelView 来添加 Model,修改完之后,我们再重启一下服务器,

python app


然后再访问一下Flask-Admin 页面,我们看到的将会是这样:

因为我们没有权限修改 User 和 Tag,所以显示这个很科学。

Q&A

1. BaseView, BaseModelView 与 ModelView 的区别

BaseView: Base administrative view.
AdminIndexView: Default administrative interface index page when visiting the /admin/ URL.
BaseModelView: Base model view.
ModelView: SQLAlchemy model view

2. 修改Admin 首页

  1. 继承 AdminIndexView

    class MyHomeView(AdminIndexView): @expose('/') def index(self):

       arg1 = 'Hello'
       return self.render('admin/myhome.html', arg1=arg1)
    
    

    admin = Admin(index_view=MyHomeView())

  1. 初始化 Admin 添加参数

    admin = Admin( app, index_view=MyHomeView() )

或者,直接在初始化 Admin 时指定

admin = Admin(
    app,
    index_view=AdminIndexView(
        name='Home',
        template='admin/myhome.html',
        url='/'
    )
)


index 页面的默认值分别是:

3. 使用自定义存储

BaseModelView 对 model 如何存储和管理除了以下需求,不做任何其他假定:

1.  提供的 model 是一个对象
2.  model 包含一系列属性
3.  每个 model 都包含可以唯一标识自身的属性(例如数据库model的主键)
4.  可以从数据源中使用分页获取一系列有序的 Model
5.  可以从数据源中通过标识获取对应的model。


如果想要支持一个新的数据源,你需要做的是以下工作:

1.  继承 BaseModelView 类。
2.  实现不同的与数据关联的方法(get_list, get_one, create_model, etc)
3.  实现自动从 model 表示转换成表单表示的方式


4. 防止 CSRF

To add CSRF protection to the forms that are generated by ModelView instances, use the SecureForm class in your ModelView subclass by specifying the form_base_classparameter

from flask_admin.form import SecureForm
from flask_admin.contrib.sqla import ModelView

class CarAdmin(ModelView):
    form_base_class = SecureForm


SecureForm requires WTForms 2 or greater. It uses the WTForms SessionCSRF class to generate and validate the tokens for you when the forms are submitted.

5. 管理文件和目录

To manage static files instead of database records, Flask-Admin comes with the FileAdmin plug-in. It gives you the ability to upload, delete, rename, etc. You can use it by adding a FileAdmin view to your app:

from flask_admin.contrib.fileadmin import FileAdmin

import os.path as op

# Flask setup here

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

path = op.join(op.dirname(__file__), 'static')
admin.add_view(FileAdmin(path, '/static/', name='Static Files'))


6. 添加 Redis 控制台

from redis import Redis
from flask_admin.contrib import rediscli

# Flask setup here

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

admin.add_view(rediscli.RedisCli(Redis()))