Flask-Admin 项目教程：如何为自定义数据库模型添加后端支持-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00218/article/details/148488324

Flask-Admin 项目教程：如何为自定义数据库模型添加后端支持

flask-admin Simple and extensible administrative interface framework for Flask 项目地址: https://gitcode.com/gh_mirrors/fla/flask-admin

前言

Flask-Admin 是一个功能强大的 Flask 扩展，它提供了现成的管理界面功能。虽然它默认支持 SQLAlchemy 等常见 ORM，但开发者也可以为其添加自定义数据库模型的后端支持。本文将详细介绍如何为 Flask-Admin 实现自定义模型后端。

核心概念

在开始实现前，需要理解 Flask-Admin 对数据库模型的两个基本假设：

主键要求：每个模型必须有一个字段作为主键，用于唯一标识模型实例。Flask-Admin 对主键字段的数据类型和名称没有限制。
属性访问：模型数据必须可以通过 Python 属性访问。

实现步骤

1. 继承 BaseModelView

首先创建一个继承自 BaseModelView 的类：

class MyDbModel(BaseModelView):
    pass

这个类会自动继承 __init__ 方法，接收模型类作为第一个参数，并将其存储为 self.model 属性。

2. 实现脚手架方法

需要实现以下关键方法才能使自定义后端正常工作：

2.1 获取主键值

def get_pk_value(self, model):
    return model.id  # 根据你的模型主键字段调整

2.2 定义列表列

def scaffold_list_columns(self):
    columns = []
    for attr_name in dir(self.model):
        attr = getattr(self.model, attr_name)
        if isinstance(attr, MyDbColumn):  # 替换为你的列类型检查
            columns.append(attr_name)
    return columns

2.3 可排序列

def scaffold_sortable_columns(self):
    return {
        'name': 'name',  # 字段名: 排序变量
        'created_at': 'created_at'
    }

2.4 搜索功能

def init_search(self):
    # 如果支持搜索则返回True
    return False

2.5 表单生成

def scaffold_form(self):
    class MyForm(Form):
        pass
    # 添加表单字段逻辑
    return MyForm

2.6 获取列表数据

def get_list(self, page, sort_field, sort_desc, search, filters, page_size=20):
    # 实现分页、排序、搜索和过滤逻辑
    return total_count, items

2.7 其他必要方法

还需要实现以下方法：

get_one: 根据主键获取单个模型实例
create_model: 从表单创建新模型
update_model: 从表单更新模型
delete_model: 删除模型实例
is_valid_filter: 验证过滤器是否有效

3. 实现过滤器

自定义后端需要自己的过滤器实现：

class MyBaseFilter(BaseFilter):
    def __init__(self, column, name, options=None, data_type=None):
        super().__init__(name, options, data_type)
        self.column = column

class MyEqualFilter(MyBaseFilter):
    def apply(self, query, value):
        return query.filter(self.column == value)
    
    def operation(self):
        return '等于'
    
    def validate(self, value):
        return True
    
    def clean(self, value):
        return value