Django StreamField 使用教程

1. 项目介绍

Django StreamField 是一个开源项目，它实现了 Wagtail CMS 中 StreamField 的概念，并使其能够在普通的 Django Admin 或者配合 Grappelli 皮肤使用。StreamField 允许用户以不同的区块类型构建页面，区块可以是文本、图片、视频等，并且可以对这些区块进行排序。

2. 项目快速启动

以下是快速启动 Django StreamField 的步骤：

首先，确保你的环境中已经安装了 Django（版本不低于 3.1）。

pip install django-streamfield

然后，在你的 Django 项目中创建一个新的应用，例如 streamblocks，并将相关的模型添加到该应用中。

# streamblocks/models.py
from django.db import models

class RichText(models.Model):
    text = models.TextField(blank=True, null=True)

    class Meta:
        verbose_name = "文本区块"

class ImageWithText(models.Model):
    image = models.ImageField(upload_to="images/")
    text = models.TextField(null=True, blank=True)

    class Meta:
        verbose_name = "图文区块"
        verbose_name_plural = "图文区块"

STREAMBLOCKS_MODELS = [
    RichText,
    ImageWithText
]

接着，将 streamblocks 和 streamfield 添加到 INSTALLED_APPS 中，并进行迁移。

python manage.py makemigrations
python manage.py migrate

在项目的 urls.py 中添加 streamfield 的 URL。

# urls.py
from django.urls import path
from streamfield import urls as streamfield_urls

urlpatterns += [
    path('streamfield/', include(streamfield_urls)),
]

为每个区块模型创建模板。例如：

<!-- streamblocks/templates/streamblocks/richtext.html -->
<div class="rich-text-block">
    {{ block_content.text|safe }}
</div>

在模型中添加 StreamField。

# models.py
from streamfield.fields import StreamField

class Page(models.Model):
    stream = StreamField(
        model_list=[
            RichText,
            ImageWithText
        ],
        verbose_name="页面区块"
    )

最后，在模板中使用 StreamField。

<!-- 使用页面模板 -->
<div class="content">
    {{ page.stream.render }}
</div>

3. 应用案例和最佳实践

在创建具有丰富内容的页面时，Django StreamField 允许开发者定义多种类型的区块，以满足不同的展示需求。例如，可以创建一个博客页面，其中包括文本区块、图文区块以及视频区块。

最佳实践之一是为每个区块类型定义清晰的结构和样式，确保页面在 Admin 界面中易于管理，并且在前端展示时效果一致。

4. 典型生态项目

Django StreamField 可以与 Django 其他插件如 Django-Filebrowser 结合使用，以提供更加强大的文件管理功能。此外，结合前端框架如 React 或 Vue，可以创建动态且响应迅速的用户界面。通过这种方式，Django StreamField 成为了构建复杂内容管理系统的基石之一。