「Django REST Framework 框架」Serializers fields字段解析及应用举例

本是古典何须时尚 2023-01-10 03:40 234阅读 0赞

### 文章目录 ###

*  内容介绍
 *  Serializers fields字段解析

# 内容介绍 #

开发环境为 Python3.6，Django 版本 3.0.x ，REST Framework 版本 3.12.x

全部内容索引目录  
**[看懂Django框架，没有最好只有更好][Django]**

序列化器不仅仅是对需要参数的声明，更是参数校验和标准化输出的策略， 所以对此，你需要严格按照你的开发实际情况声明好你的字段约束。

# Serializers fields字段解析 #

**1.通用参数**

<table> 
 <thead> 
  <tr> 
   <th>关键字参</th> 
   <th align="left">数参数作用说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>read_only</td> 
   <td align="left">在更新或者创建资源的时候不应该包含的字段参数, 仅仅是只读数据的时候才需要反序列化, 默认 False</td> 
  </tr> 
  <tr> 
   <td>write_only</td> 
   <td align="left">在更新或创建资源的时候需要包含该字段参数, 而读取数据内容的时候将不会反序列化, 默认 False</td> 
  </tr> 
  <tr> 
   <td>required</td> 
   <td align="left">如果反序列化过程中未提供字段, 通常会引发错误, 设置该字段是否为必填对象, 默认 True</td> 
  </tr> 
  <tr> 
   <td>default</td> 
   <td align="left">当提交对象中不包含该字段时, 使用自动填充的默认值, 在局部更新的时候将不适用allow_null声明字段是否可以为空, 默认 False</td> 
  </tr> 
  <tr> 
   <td>source</td> 
   <td align="left">在对 ORM 字段重新声明新字段时, 需要将新字段指明对应的 ORM 字段</td> 
  </tr> 
  <tr> 
   <td>validators</td> 
   <td align="left">验证器功能列表, 应将其应用于传入字段输入, 并且会引发 serializers.ValidationError 验证错误或返回验证数据</td> 
  </tr> 
  <tr> 
   <td>error_messages</td> 
   <td align="left">验证错误时需要返回的错误信息字典</td> 
  </tr> 
  <tr> 
   <td>label</td> 
   <td align="left">短文本字符串, 可用作 HTML 表单字段或其他描述性元素中的字段名称。</td> 
  </tr> 
  <tr> 
   <td>help_text</td> 
   <td align="left">可用作在 HTML 表单字段或其他描述性元素中对该字段进行描述的文本字符串</td> 
  </tr> 
  <tr> 
   <td>initial</td> 
   <td align="left">该值应用于预先填充 HTML 表单字段的值</td> 
  </tr> 
  <tr> 
   <td>style</td> 
   <td align="left">键值对字典, 可用于控制渲染器应如何渲染字段, HTML＆Forms 文档</td> 
  </tr> 
 </tbody> 
</table>

**2.序列化字段类型**

<table> 
 <thead> 
  <tr> 
   <th align="center">字段类型</th> 
   <th>解释说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">BooleanField</td> 
   <td>布尔有效类型</td> 
  </tr> 
  <tr> 
   <td align="center">NullBooleanField</td> 
   <td>布尔有效类型，但同时也接受 None 类型</td> 
  </tr> 
  <tr> 
   <td align="center">CharField</td> 
   <td>文本字符串有效类型，可以检测验证字符串的长度是否符合 max_length 和 mix_length 等配置</td> 
  </tr> 
  <tr> 
   <td align="center">EmailField</td> 
   <td>文本字符串有效类型，并验证文本是否符合邮件格式</td> 
  </tr> 
  <tr> 
   <td align="center">RegexField</td> 
   <td>文本字符串有效类型，并验证字符串是否匹配强制参数 regex 所指定的正则表达式</td> 
  </tr> 
  <tr> 
   <td align="center">SlugField</td> 
   <td>文本字符串有效类型，并验证字符串是否匹配正则表达式：[a-zA-Z0-9_-]+</td> 
  </tr> 
  <tr> 
   <td align="center">URLField</td> 
   <td>文本字符串有效类型，并验证字符串是否符合 URL 规则：http://&lt;host&gt;/&lt;path&gt;</td> 
  </tr> 
  <tr> 
   <td align="center">UUIDField</td> 
   <td>UUID 字符串有效类型，指定 UUID 的表示类型</td> 
  </tr> 
  <tr> 
   <td align="center">FilePathField</td> 
   <td>文本字符串有效类型，选择仅限于文件系统上某个目录中的文件名</td> 
  </tr> 
  <tr> 
   <td align="center">IPAddressField</td> 
   <td>文本字符串有效类型，并确保输入为有效IPv4或IPv6字符串的字段</td> 
  </tr> 
  <tr> 
   <td align="center">IntegerField</td> 
   <td>整数数字有效类型</td> 
  </tr> 
  <tr> 
   <td align="center">DateTimeField</td> 
   <td>日期和时间表示</td> 
  </tr> 
  <tr> 
   <td align="center">DateField</td> 
   <td>日期表示</td> 
  </tr> 
  <tr> 
   <td align="center">TimeField</td> 
   <td>时间表示</td> 
  </tr> 
  <tr> 
   <td align="center">DurationField</td> 
   <td>持续时间表示</td> 
  </tr> 
  <tr> 
   <td align="center">ChoiceField</td> 
   <td>可以接受一组有限选择中的值的字段</td> 
  </tr> 
  <tr> 
   <td align="center">MultipleChoiceField</td> 
   <td>一个可以接受一组空、一个、多个值的字段</td> 
  </tr> 
  <tr> 
   <td align="center">FileField</td> 
   <td>文件表示。执行 Django 的标准 FileField 验证</td> 
  </tr> 
  <tr> 
   <td align="center">ImageField</td> 
   <td>图像表示。验证上传的文件内容是否与已知图像格式匹配</td> 
  </tr> 
  <tr> 
   <td align="center">ListField</td> 
   <td>验证对象列表的字段类</td> 
  </tr> 
  <tr> 
   <td align="center">DictField</td> 
   <td>验证对象字典的字段类</td> 
  </tr> 
  <tr> 
   <td align="center">HStoreField</td> 
   <td>DictField 与 Django 的 postgres 兼容的预配置字典类型</td> 
  </tr> 
  <tr> 
   <td align="center">JSONField</td> 
   <td>用于验证传入的数据结构是否包含有效的 JSON数据</td> 
  </tr> 
  <tr> 
   <td align="center">ReadOnlyField</td> 
   <td>仅返回该字段的值而无需修改</td> 
  </tr> 
  <tr> 
   <td align="center">HiddenField</td> 
   <td>不基于用户输入获取值，而是从默认值或可调用对象获取其值</td> 
  </tr> 
  <tr> 
   <td align="center">ModelField</td> 
   <td>可以绑定到任意模型字段的通用字段。</td> 
  </tr> 
  <tr> 
   <td align="center">SerializerMethodField</td> 
   <td>只读字段， 通过在附加的序列化器类上调用一个方法来获取值， 可以用于将任何类型的数据添加到对象的序列化表示中。</td> 
  </tr> 
  <tr> 
   <td align="center">method_name</td> 
   <td>要调用的序列化程序上的方法的名称。如果未包含， 则默认为 get_&lt;field_name&gt;</td> 
  </tr> 
 </tbody> 
</table>

**3.序列化字段类型参数**

<table> 
 <thead> 
  <tr> 
   <th>字段</th> 
   <th>字段构造方式</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>BooleanField</td> 
   <td>BooleanField()</td> 
  </tr> 
  <tr> 
   <td>NullBooleanField</td> 
   <td>NullBooleanField()</td> 
  </tr> 
  <tr> 
   <td>CharField</td> 
   <td>CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)</td> 
  </tr> 
  <tr> 
   <td>EmailField</td> 
   <td>EmailField(max_length=None, min_length=None, allow_blank=False)</td> 
  </tr> 
  <tr> 
   <td>RegexField</td> 
   <td>RegexField(regex, max_length=None, min_length=None, allow_blank=False)</td> 
  </tr> 
  <tr> 
   <td>SlugField</td> 
   <td>SlugField(maxlength=50, min_length=None, allow_blank=False) 正则字段，验证正则模式 [a-zA-Z0-9-]+</td> 
  </tr> 
  <tr> 
   <td>URLField</td> 
   <td>URLField(max_length=200, min_length=None, allow_blank=False)</td> 
  </tr> 
  <tr> 
   <td>UUIDField</td> 
   <td>UUIDField(format=‘hex_verbose’) [‘hex_verbose’, ‘hex’, ‘int’,‘urn’ ]</td> 
  </tr> 
  <tr> 
   <td>IPAddressField</td> 
   <td>IPAddressField(protocol=‘both’, unpack_ipv4=False, **options)</td> 
  </tr> 
  <tr> 
   <td>IntegerField</td> 
   <td>IntegerField(max_value=None, min_value=None)</td> 
  </tr> 
  <tr> 
   <td>FloatField</td> 
   <td>FloatField(max_value=None, min_value=None)</td> 
  </tr> 
  <tr> 
   <td>DecimalField</td> 
   <td>DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) [max_digits: 最多位数,decimal_palces: 小数点位置]</td> 
  </tr> 
  <tr> 
   <td>DateTimeField</td> 
   <td>DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)</td> 
  </tr> 
  <tr> 
   <td>DateField</td> 
   <td>DateField(format=api_settings.DATE_FORMAT, input_formats=None)</td> 
  </tr> 
  <tr> 
   <td>TimeField</td> 
   <td>TimeField(format=api_settings.TIME_FORMAT, input_formats=None)</td> 
  </tr> 
  <tr> 
   <td>DurationField</td> 
   <td>DurationField()</td> 
  </tr> 
  <tr> 
   <td>ChoiceField</td> 
   <td>ChoiceField(choices) choices与Django的用法相同</td> 
  </tr> 
  <tr> 
   <td>MultipleChoiceField</td> 
   <td>MultipleChoiceField(choices)</td> 
  </tr> 
  <tr> 
   <td>FileField</td> 
   <td>FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)</td> 
  </tr> 
  <tr> 
   <td>ImageField</td> 
   <td>ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)</td> 
  </tr> 
  <tr> 
   <td>ListField</td> 
   <td>ListField(child=, min_length=None, max_length=None)</td> 
  </tr> 
  <tr> 
   <td>DictField</td> 
   <td>DictField(child=)</td> 
  </tr> 
 </tbody> 
</table>

**4.选项参数**

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>max_length</td> 
   <td>最大长度</td> 
  </tr> 
  <tr> 
   <td>min_lenght</td> 
   <td>最小长度</td> 
  </tr> 
  <tr> 
   <td>allow_blank</td> 
   <td>是否允许为空</td> 
  </tr> 
  <tr> 
   <td>trim_whitespace</td> 
   <td>是否截断空白字符</td> 
  </tr> 
  <tr> 
   <td>max_value</td> 
   <td>最大值</td> 
  </tr> 
  <tr> 
   <td>min_value</td> 
   <td>最小值</td> 
  </tr> 
 </tbody> 
</table>

[Django]: https://blog.csdn.net/qq_20288327/article/details/117383454