JSONField en serializadores – Django REST Framework

En Django REST Framework, el concepto mismo de Serialización es convertir datos de base de datos a un tipo de datos que pueda ser utilizado por javascript. Cada serializador viene con algunos campos (entradas) que se van a procesar. Por ejemplo, si tiene una clase con el nombre Empleado y sus campos como Employee_id, Employee_name, is_admin, etc. Entonces, necesitará AutoField, CharField y BooleanField para almacenar y manipular datos a través de Django. De manera similar, el serializador también funciona con el mismo principio y tiene campos que se usan para crear un serializador. Este artículo gira en torno a JSONField en serializadores en Django REST Framework.

campo JSON

JSONField es básicamente una clase de campo que valida que la estructura de datos entrantes consiste en primitivas JSON válidas. En su modo binario alternativo, representará y validará strings binarias codificadas en JSON. Tiene los siguientes argumentos:

• binario : si se establece en Verdadero, el campo generará y validará una string codificada en JSON, en lugar de una estructura de datos primitiva. El valor predeterminado es falso.
• codificador : use este codificador JSON para serializar el objeto de entrada. El valor predeterminado es Ninguno.

Sintaxis – 

field_name = serializers.JSONField(*args, **kwargs)

¿Cómo usar JSONField en serializadores?

Para explicar el uso de JSONField, usemos la misma configuración de proyecto de: ¿Cómo crear una API básica usando Django Rest Framework? . Ahora que tiene un archivo llamado serializadores en su proyecto, creemos un serializador con JSONField como campo. 

# import serializer from rest_framework
from rest_framework import serializers
 
class Geeks(object):
    def __init__(self, json_data):
        self.json_data = json_data
 
# create a serializer
class GeeksSerializer(serializers.Serializer):
    # initialize fields
    json_data = serializers.JSONField()
    

Ahora vamos a crear algunos objetos e intentar serializarlos y verificar si realmente funcionan, Ejecutar, –

Python manage.py shell

Ahora, ejecute los siguientes comandos de python en el shell

# create a json object
>>> import json
>>> x = json.dumps({"name":"Naveen", "Age":"21"})
>>> x
'{"name": "Naveen", "Age": "21"}'

# import everything from serializers
>>> from apis.serializers import *

# create a object of type Geeks
>>> obj = Geeks(x)

# serialize the object
>>> serializer = GeeksSerializer(obj)

# print serialized data
>>> serializer.data
{'json_data': '{"name": "Naveen", "Age": "21"}'}

Aquí está el resultado de todas estas operaciones en la terminal:

Validación en JSONField

Tenga en cuenta que el lema principal de estos campos es impartir validaciones, como JSONField valida los datos solo para JSON. Verifiquemos si estas validaciones funcionan o no:

# Create a dictionary and add invalid values
>>> data = {}
>>> data['json_data'] = x

# dictionary created
>>> data
{'json_data': '{"name": "Naveen", "Age": "21"}'}

# deserialize the data
>>> serializer = GeeksSerializer(data=data)

# check if data is valid
>>> serializer.is_valid()
True

# check the errors
>>> serializer.errors
{}

Aquí está el resultado de estos comandos que muestra claramente que json_data es válido:

Conceptos avanzados

Las validaciones son parte de la deserialización y no de la serialización. Como se explicó anteriormente, la serialización es un proceso de conversión de datos ya creados en otro tipo de datos, por lo que no se requieren estas validaciones predeterminadas. La deserialización requiere validaciones ya que los datos deben guardarse en la base de datos o cualquier otra operación según lo especificado. Entonces, si serializa datos usando estos campos, eso funcionaría.

Argumentos centrales en los campos del serializador

.math-table { borde-colapso: colapsar; ancho: 100%; } .math-table td { borde: 1px sólido #5fb962; alineación de texto: izquierda! importante; relleno: 8px; } .math-table th { borde: 1px sólido #5fb962; relleno: 8px; } .math-table tr>th{ color de fondo: #c6ebd9; alineación vertical: medio; } .math-table tr:nth-child(odd) { background-color: #ffffff; }