FlaskAdmin的使用

背景

之前项目开发的时间不是十分充裕,对项目中管理员身份用户的部分业务直接使用了FlaskAdmin插件进行开发。
由于当初没有针对FlaskAdmin做相关设计,导致后期测试时,大部分Bug出现在这一模块。于是,就加深以下对FlaskAdmin插件的一些额外的使用方法。

部分用法介绍

基础模型

FlaskAdmin的的视图模型是直接与对应的数据库表同步的。与数据库模型对应关系建立十分简单。如果我们使用FlaskAdmin默认的视图模型。直接如下即可建立一个简单的页面。

from flask import Flask
from flask_admin import Admin
from flask_admin.contrib.sqla import ModelView
from webapp.models import db, User
app = Flask(__name__)
app.config....  # app.相关配置,DB等
admin = Admin(app)
admin.add_view(ModelView(User, db.session))

此时生成的界面如下:

初始界面

模型进阶

我们从上边的图可以看到:

  1. 全是英文显示,对用户有很大困扰。
  2. 所有的数据列都显示了,有的数据列可能不是我们需要的。
  3. 在每列左边的操作区,可以修改,删除等操作,我们可能只需要让用户保留一部分功能。如:只能修改。

为了自定义对应模型的界面,我们可以自定义相关的信息。所以我们自定义一个类并继承ModelView,就可以实现相关的操作。
首先我们给出修改后的界面。

基本页面.png

1.首先我们中文问题,我们使用了Flask的插件Flask-BableFlask-BabelEx,在配置中我们可以使用如下语句:

BABEL_DEFAULT_LOCALE = 'zh_CN'

然后就解决了界面上大部分的中文,但是表头不是中文。所以我们还要在FlaskAdmin中进行表头的配置。

column_labels = {
    'id': u'用户ID',
    'username': u'用户名',
    'password': u'密码',
    'name': u'姓名',
    'grade': u'年级',
    'emp_no': u'工号'
}

这样就完成了中文的翻译。

2.介绍FlaskAdmin的一些配置:

page_size= 10       # 每页显示几条
can_create=True     # 可以创建数据  False 
can_delete=True     # 可以删除数据  False
can_edit=True       # 可以编辑数据  False
can_view_details=True  # 可以查看详情  False

column_searchable_list=['列名']  # 可以搜索的列名
form_exclude_columns=['列名']    # 不显示的列

高级功能

1.我们在对Admin进行操作时,对于某些字段我们需要进行限制,比如字段校验,进行一些特殊的限制等。

这里我们可以用自定义的校验器。我们以一个例子展示。

我们需要让用户无法修改admin用户的数据。

在用户表的视图下:

# 自定义的校验器
def user_validator(form, field):
    if form._obj is not None:
        user_id = form._obj.id
        # 调用user表的方法,通过用户名得到用户信息
        user = User.get_user_info(user_id=user_id)
        if user.username == 'admin':
            if field.data != 'admin':
                raise ValidationError(u'admin为最高权限用户,不允许修改')

# FlaskAdmin的属性  form_args
form_args = {
    'username':{
        'label': u'用户',
        'validators': [DataRequired(), user_validator]
    }
}

这样,我们就完成了对用户名为'admin'的用户无法修改的限制。
在程序里,校验器的form属性中的_obj可以获取原始数据库中的数据,而不是当前form的数据。这样就避免了用户直接修改用户名。

2.对于基础的限制,我们还可以继承ModelView中的on_model_change()方法。

on_model_change()是在一个模型创建之前或者修改更新之前进行的操作,所以也可以加一些相关的限制。
参数有:
form: 将要更新或者创建模型的Form表单
model: 即将被创建或者更新的模型
is_created: 是不是新建的模型。 True/ False

我们同样给出一个示例:

def on_model_change(self, form, model, is_created):
    if 'user' not in [role.role_name for role in model.roles]:
        raise ValidationError(u'user角色是必须的。')

上边一个简单的例子,完成了在创建新的用户时,必须给用户加上一个user的角色的功能。
图如下:

无user角色报错

3.同样类似的方法还有after_model_changeon_model_deleteafter_model_delete等方法。具体的使用方法我们可以在FlaskAdmin的API上找到相关介绍。

其他操作

1.修改FlaskAdmin主页面

默认的主页面是空白的,当然不好看,我们可以在初始化admin的时候自定义主页。如下:

admin = Admin(index_view=AdminIndexView(
    name==u'数据管理',
    template='MyAdmin/welcome.html',
    url='/admin',
), template_mode='bootstrap3')

其中template对应的html文件是我们自己写的。
可以继承来自Admin的源码中的template进行改写。

现在的首页如下:

修改后的首页

2.结合权限管理。

对于Admin的界面,我们需要对访问其的权限进行限制,我们可以结合Flask的另外一个插件Flask-Login进行实现。

在我们自定义的ModeView中。

定义方法is_accessible()

如下:

def is_accessible(self):
    if current_user.is_authenticated and current_user.username == "admin":
        return True
    return False

这样的话如果用户没有登录,且不属于'admin'用户的话,就不会进入到该视图模型下面。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,529评论 5 475
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,015评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,409评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,385评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,387评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,466评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,880评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,528评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,727评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,528评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,602评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,302评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,873评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,890评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,132评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,777评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,310评论 2 342

推荐阅读更多精彩内容