django restframework serializer 增加自定义字段操作

下面是完整攻略：

什么是django restframework serializer

Django REST framework 是一个强大而灵活的 Web API 工具，可以用来构建 RESTful API。Serializer 是其中一个重要的组件，用于序列化（将复杂的数据结构转换为Python数据类型）和反序列化（将Python数据类型转换为复杂的数据结构）。

如何增加自定义字段

步骤一：创建Serializer类

在使用 REST framework 的 Serializer 进行序列化操作时，需要先创建 Serializer 类。可以继承 DRF 中的 serializer 类，比如ModelSerializer 或者 Serializer，对于简单的需求，可以使用 Serializer。

下面是一个创建 Serializer 类的示例：

from rest_framework import serializers
from myapp.models import Order

class OrderSerializer(serializers.Serializer):
  order_id = serializers.IntegerField()
  order_name = serializers.CharField(max_length=100)

步骤二：添加自定义字段

在 Serializer 中，可以通过定义 SerializerMethodField 类型的字段来添加自定义字段。

class OrderSerializer(serializers.Serializer):
  order_id = serializers.IntegerField()
  order_name = serializers.CharField(max_length=100)
  customer_name = serializers.SerializerMethodField('get_customer_name')

  def get_customer_name(self, obj):
      return obj.customer.name

以上代码中，我们添加了一个 customer_name 字段，并且定义了 get_customer_name 方法来获取 Order 模型对应的 Customer 的 name 字段。注意此处 SerializerMethodField 被设置了 get_customer_name 参数，这个指定了使用哪个方法来获取值。

步骤三：序列化数据

在获得了 Serializer 实例后，就可以将要序列化的数据传入 serializer_class() 中，得到序列化后的结果。

order = Order.objects.get(id=1) 
serializer = OrderSerializer(order) 
json_data = serializer.data

序列化后的结果如下：

{
  "order_id": 1,
  "order_name": "test",
  "customer_name": "customer1"
}

以上就是增加自定义字段的完整攻略了。如果在操作过程中，需要添加其他类型的自定义字段，可以参照 DRF 相关文档来实现。

示例说明

下面，我们来看两个示例说明如何实现自定义字段。

示例一：计算两个字段的和

假设有一个 User 模型，有两个字段：age 和 salary，期望添加一个字段 total，表示两个字段的和，该如何实现呢？

class UserSerializer(serializers.ModelSerializer):
  total = serializers.SerializerMethodField()

  class Meta:
    model = User
    fields = ('id', 'name', 'age', 'salary', 'total')

  def get_total(self, obj):
    return obj.age + obj.salary

以上代码中，我们创建了 UserSerializer 类，并添加了一个 total 字段。在 get_total() 方法中，计算了 age 和 salary 的和，并返回。

示例二：从字符串中提取数字

假设有一个 Article 模型，有两个字段：title 和 subtitle，其中 title 字段的格式为 "title (number)"，比如 "Article 1 (100)"，希望添加一个字段 number，表示 title 中数字的大小，该如何实现呢？

class ArticleSerializer(serializers.ModelSerializer):
  number = serializers.SerializerMethodField('get_number')

  class Meta:
    model = Article
    fields = ('title', 'subtitle', 'number')

  def get_number(self, obj):
    import re
    pattern = r"\((\d+)\)$"
    match = re.search(pattern, obj.title)
    return match.group(1) if match else ""

以上代码中，我们创建了 ArticleSerializer 类，并添加了一个 number 字段。在 get_number() 方法中，利用正则表达式从 title 字段中提取数字，并返回。

以上就是两个示例的说明，可以根据实际需求，在 Serializer 中添加相应的自定义字段。