django 内置 JSON 字段 使用场景

Django 内置的 JSON 字段（JSONField）是在 Django 3.1 版本中引入的，用于处理 JSON 格式的数据。JSONField 允许在数据库表中存储和查询 JSON 数据，并且在与 Python 代码交互时自动转换为合适的 Python 数据类型。以下是一些常见的使用场景：

1. 存储动态结构的数据

当你需要存储结构不固定的数据时，JSONField 非常有用。例如，某个表中的某些记录可能具有不同的属性和值。在这种情况下，可以使用 JSONField 来灵活地存储这些数据，而不需要为每个可能的属性创建单独的数据库列。

from django.db import models

class Product(models.Model):
    name = models.CharField(max_length=100)
    attributes = models.JSONField()

在上面的例子中，attributes 字段可以存储任意 JSON 数据，例如：

{
    "color": "red",
    "size": "M",
    "weight": "1.5kg"
}

2. 配置数据的存储

JSONField 非常适合存储配置数据或其他设置，这些数据可能在应用的不同部分被使用和修改。

class UserSettings(models.Model):
    user = models.OneToOneField(User, on_delete=models.CASCADE)
    settings = models.JSONField()

例如，用户设置可能包含通知偏好、界面定制等：

{
    "notifications": {
        "email": true,
        "sms": false
    },
    "theme": "dark"
}

3. API 数据的存储

在处理从外部 API 获取的数据时，通常数据格式为 JSON。将这些数据直接存储在 JSONField 中，可以减少解析和重新组装数据的开销。

class ApiResponse(models.Model):
    response_data = models.JSONField()

这样你可以直接将整个 API 响应存储在数据库中，方便以后检索和分析。

4. 日志和事件数据

对于一些应用来说，日志和事件数据可能是高度动态和嵌套的结构。JSONField 可以方便地存储这些信息。

class EventLog(models.Model):
    timestamp = models.DateTimeField(auto_now_add=True)
    event_type = models.CharField(max_length=100)
    details = models.JSONField()

例如，事件详情可能包含各种不同的字段和嵌套结构：

{
    "user_id": 123,
    "action": "login",
    "metadata": {
        "ip_address": "192.168.1.1",
        "device": "mobile"
    }
}

5. 分析和报表

在某些情况下，你可能需要存储复杂的分析结果或报表数据，这些数据通常也是动态的和结构化的。JSONField 可以帮助你高效地存储和查询这些数据。

6. 简单对象存储

当需要在模型中存储一个简单的对象（例如，字典、列表）时，JSONField 是一个简单而有效的解决方案。

生产案例

使用django 接收统计普罗米修斯的告警，直接使用JSON 字段保存数据

数据结构语句：

CREATE TABLE `zabbix_prometheusalert` (
	`id` BIGINT(20) NOT NULL AUTO_INCREMENT,
	`status` VARCHAR(50) NOT NULL COLLATE 'utf8mb4_general_ci',
	`labels` JSON NOT NULL,
	`annotations` JSON NOT NULL,
	`starts_at` DATETIME(6) NOT NULL,
	`ends_at` DATETIME(6) NULL DEFAULT NULL,
	`generator_url` VARCHAR(1000) NOT NULL COLLATE 'utf8mb4_general_ci',
	`fingerprint` VARCHAR(50) NOT NULL COLLATE 'utf8mb4_general_ci',
	`recorded_time` DATETIME(6) NOT NULL COMMENT '记录时间',
	PRIMARY KEY (`id`) USING BTREE
)
COMMENT='prometheus alert'
COLLATE='utf8mb4_general_ci'
ENGINE=InnoDB
AUTO_INCREMENT=3200
;