模型管理¶

模型管理在后台管理中是最为常用的一个管理类,其使用功能也是最为丰富的. fastapi-amis-admin目前已经实现针对数据模型常用的各种基本操作, 并且你仍然可以在此基础上做出更多个性化的拓展.

示例1（基于SQLAlchemy 2.0）¶

from sqlalchemy import String
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from typing import Optional


class Base(DeclarativeBase):
    pass


class CategorySchema(BaseModel):
    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
    name: str = Field(title="CategoryName")
    description: str = Field(default="", title="CategoryDescription")

    class Config:
        # orm_mode = True
        from_attributes = True


# 创建SQLAlchemy 2.0模型,详细请参考: https://docs.sqlalchemy.org/en/20/orm/quickstart.html
class Category(Base):
    __tablename__ = "category"
    __pydantic_model__ = CategorySchema  # 指定模型对应的Schema类.省略可自动生成,但是建议指定.

    id: Mapped[int] = mapped_column(primary_key=True, nullable=False)
    name: Mapped[str] = mapped_column(String(100), unique=True, index=True, nullable=False)
    description: Mapped[str] = mapped_column(String(255), default="")

在app = FastAPI()下方添加以下内容来创建数据表：

@app.on_event("startup")
async def startup():
    await site.db.async_run_sync(Category.metadata.create_all, is_session=False)
    pass

示例-1(基于SQLModel)¶

# 先创建一个SQLModel模型,详细请参考: https://sqlmodel.tiangolo.com/
class Category(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
    name: str = Field(title='CategoryName')
    description: str = Field(default='', title='Description')


# 注册ModelAdmin
@site.register_admin
class CategoryAdmin(admin.ModelAdmin):
    page_schema = '分类管理'
    # 配置管理模型
    model = Category

先看一下这个简单的示例-1吧.它完成了以下几个步骤:

定义了一个Category模型.
定义一个模型管理类, 继承admin.ModelAdmin.
配置模型,并注册到管理站点.

关于SQLModel模型

事实上这部分代码并不属于amis-admin的代码,因为它可以用重用在任何需要ORM映射的地方, 在项目中你应该单独定义一个models.py文件编写这部分代码.

SQLModel是一个非常优秀的Python ORM库,由FastAPI同一位作者编写,完美的结合了SQLAlchemy和Pydantic.请阅读它的官方文档: https://sqlmodel.tiangolo.com/

示例-2（基于SQLAlchemy 2.0）¶

from sqlalchemy import String, Integer, Boolean, ForeignKey, Select
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from typing import Optional

class Article(Base):
    __tablename__ = 'article'

    id: Mapped[int] = mapped_column(Integer, primary_key=True, autoincrement=True)
    title: Mapped[str] = mapped_column(String(200), nullable=False)
    description: Mapped[str] = mapped_column(String(400), default='')
    status: Mapped[bool] = mapped_column(Boolean, default=False)
    content: Mapped[str] = mapped_column(String, nullable=False)
    category_id: Mapped[Optional[int]] = mapped_column(Integer, ForeignKey('category.id'))


@site.register_admin
class ArticleAdmin(admin.ModelAdmin):
    page_schema = '文章管理'
    model = Article
    # 设置需要展示的字段
    list_display = [Article.id, Article.title, Article.description, Article.status, Category.name]
    # 设置模糊搜索字段
    search_fields = [Article.title, Category.name]

    # 自定义基础选择器
    async def get_select(self, request: Request) -> Select:
        stmt = await super().get_select(request)
        return stmt.outerjoin(Category, Article.category_id == Category.id)

同时，将前文定义的def startup()函数追加一行await site.db.async_run_sync(Article.metadata.create_all, is_session=False)用于生成对应数据表。

_{示例-2(基于SQLModel)}¶

# 创建一个SQLModel模型,详细请参考: https://sqlmodel.tiangolo.com/
class Article(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True, nullable=False)
    title: str = Field(title='ArticleTitle', max_length=200)
    description: Optional[str] = Field(default='', title='ArticleDescription', max_length=400)
    status: bool = Field(False, title='status')
    content: str = Field(title='ArticleContent')
    # 关联Category模型,模型定义参考[示例-1]
    category_id: Optional[int] = Field(default=None, foreign_key="category.id", title='CategoryId')
    # category: Optional[Category] = Relationship(back_populates="articles")


@site.register_admin
class ArticleAdmin(admin.ModelAdmin):
    page_schema = '文章管理'
    model = Article
    # 设置需要展示的字段
    list_display = [Article.id, Article.title, Article.description, Article.status, Category.name]
    # 设置模糊搜索字段
    search_fields = [Article.title, Category.name]

    # 自定义基础选择器
    async def get_select(self, request: Request) -> Select:
        stmt = await super().get_select(request)
        return stmt.outerjoin(Category, Article.category_id == Category.id)

示例2相比于示例1显得更为复杂. 但是如果你熟悉Django-Admin你会发现他们非常的相似,是的. fastapi_amis_admin启发自Django-Admin ,所以很多功能的设计都与之类似, 并且fastapi_amis_admin 的功能更加丰富,配置更加灵活.

配置展示字段¶

默认情况下,管理列表会展示当前模型的全部字段.但是如果你只需要展示部分字段,或者你还需要展示相关模型的其他字段,你可以通过配置list_display 来自定义需要展示的字段.

例如在示例2中:
Article.content与Article.category_id并不包括在展示字段当中.
Category.name是另一个模型的字段,也可以包括在展示字段中, 但是这里需要通过get_select方法自定义选择器left join Category模型.

配置模糊搜索字段¶

search_fields配置针对字符串字段查询方式为like过滤.如果不配置search_fields,则默认为equal查询方式.

自定义选择器¶

get_select自定义选择器可以实现针对不同请求的获取不同的初始化数据查询条件,类似于django-admin当中的get_queryset方法.

功能列表¶

目前fastapi-amis-admin中的模型管理类ModelAdmin已支持功能包括但不限于以下列表.

功能	相关字段或方法	备注
自定义批量查询字段	`fields`, `exclude`
自定义批量查询展示字段	`list_display`, `get_list_display`	支持展示类型为图片,音频,视频,列表,`Json`
自定义批量查询过滤表单	`list_filter`	支持文本精准/模糊匹配,时间范围过滤,多选过滤
自定义批量查询排序字段	`ordering`
自定义模型主键	`pk_name`
自定义批量查询选择器	`get_select`	支持`Jion`其他数据库表模型
自定义模型数据库	`engine`
自定义批量查询只读字段	`readonly_fields`
自定义批量查询每页的数据量	`list_per_page`
自定义批量查询模糊搜索的字段	`search_fields`
自定义新增模型的字段	`create_fields`
自定义支持编辑的字段	`update_fields`
自定义支持批量编辑的字段	`bulk_update_fields`
自定义新增模型数据表单	`get_create_form`
自定义更新模型数据表单	`get_update_form`
自定义新增模型数据执行动作	`get_create_action`
自定义更新模型数据执行动作	`get_update_action`
自定义删除模型数据执行动作	`get_delete_action`
自定义批量查询数据返回协议	`schema_list`
自定义批量查询数据过滤提交协议	`schema_filter`
自定义创建数据提交协议	`schema_create`
自定义读取数据返回协议	`schema_read`
自定义更新数据提交协议	`schema_update`
自定义批量查询权限	`has_list_permission`
自定义单项查询权限	`has_read_permission`
自定义创建数据权限	`has_create_permission`
自定义更新数据权限	`has_update_permission`
自定义删除数据权限	`has_delete_permission`