Django REST为文件属性输出完整URL的方法


Posted in Python onDecember 18, 2017

前言

我的 App 项目的 API 部分是使用 Django REST Framework 来搭建的,它可以像搭积木一样非常方便地搭出 API,兼具方便和灵活。

django是一个神奇的框架,而restframework又是遵循了这个框架的另一个神奇的框架,然而由于restframework的文档稀烂无比,很多时候你必须看源码才能写出科学的代码,这挡住了很多新手的路。

在使用的过程中我也积累了一些小技巧,这里写一则关于如何为文件属性输出完整 URL 的字段。

实现方法

一个典型的案例是,当请求 /profile/ 这个 API 的时候,返回类似于这样的结果:

{
 "id": 1,
 "nickname": "管理员",
 "mobilephone": "1234567890",
 "avatar": "/media/profiles/2017/12/17/avatar.png"
}

在 Django REST 的定义中,我使用了自定义的一个扩展自 rest_framework.views.APIView 的 ProfileView 类型,实现了它的 get 方法,来给认证的用户返回一个 Profile 对象:

class ProfileView(APIView):
 def get(self, request):
  user = request.user
  if user.is_authenticated:
   profile = Profile.objects.get(user=user)
   return Response(ProfileSerializer(profile).data)
  else:
   raise exceptions.AuthenticationFailed('Not authenticated user!')

这里的逻辑很简单,判断请求当前 API 的用户是不是已经验证过的用户,如果是的话,再得到它的 Profile,再通过 ProfileSerializer 把 profile 实例序列化成 JSON 对象。如果不是已验证用户,则会返回 401 验证失败相关信息。

以上输出的内容,交给 Web 前端使用是没什么问题的,但如果是给 App 使用,那么 avatar 这个文件属性的相对 URL 不太合适,于是我们要改造一下这个 API,使其能输出绝对 URL。

如何做呢?只需要将上面的 get 方法,稍加修改即可:

-class ProfileView(APIView):
+class ProfileView(generics.GenericAPIView):
  parser_classes = (MultiPartParser, FormParser)
+ serializer_class = ProfileSerializer
  def get(self, request):
   user = request.user
   if user.is_authenticated:
    profile = Profile.objects.get(user=user)
-   return Response(ProfileSerializer(profile).data)
+   serializer = self.get_serializer(profile)
+   return Response(serializer.data)
   else:
    raise exceptions.AuthenticationFailed('Not authenticated user!')

不同于之前继承自 APIView,现在继承自 generics.GenericAPIView,这是一个更通用的类,可以看到,这里通过手动构建 ProfileSerializer 改成通过 self.get_serializer 来进行,这里有什么不同呢?

还得看看 Django REST 的源码,GenericAPIView 这个类的 get_serializer 在做什么。

def get_serializer(self, *args, **kwargs):
    """
    Return the serializer instance that should be used for validating and
    deserializing input, and for serializing output.
    """
    serializer_class = self.get_serializer_class()
    kwargs['context'] = self.get_serializer_context()
    return serializer_class(*args, **kwargs)

可以看到,这个方法在创建 serializer 的时候,会把 context 传进去,而 get_serializer_context 也是一个固定方法,它会把 request、view 和 format 这些信息包含在里面。

那么 request、view 和 format 这些信息,是如何用在 serializer 里面,最后把一个文件对象的全路径展开的呢?

省略中间 serializer 一系列序列化过程,当它遇到 FileField 的时候,会通过判断 context 里面有没有 reuqest,有的话,就调用 request.build_absolute_uri(url) 方法,把绝对地址 build 出来,而不是默认存在数据库里的相对地址。

def to_representation(self, value):
  if not value:
   return None
  use_url = getattr(self, 'use_url', api_settings.UPLOADED_FILES_USE_URL)
  if use_url:
   if not getattr(value, 'url', None):
    # If the file has not been saved it may not have a URL.
    return None
   url = value.url
   request = self.context.get('request', None)
   if request is not None:
    return request.build_absolute_uri(url)
   return url
  return value.name

这就是为什么通过 GenericAPIView 来输出 API 对象,文件属性默认有绝对路径而不是相对路径的原因了~

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对三水点靠木的支持。

Python 相关文章推荐
使用Python压缩和解压缩zip文件的教程
May 06 Python
Python实现命令行通讯录实例教程
Aug 18 Python
Python实现将不规范的英文名字首字母大写
Nov 15 Python
python+selenium实现京东自动登录及秒杀功能
Nov 18 Python
Python最火、R极具潜力 2017机器学习调查报告
Dec 11 Python
python实现隐马尔科夫模型HMM
Mar 25 Python
三步实现Django Paginator分页的方法
Jun 11 Python
pyqt5 获取显示器的分辨率的方法
Jun 18 Python
Python 写入训练日志文件并控制台输出解析
Aug 13 Python
使用TensorBoard进行超参数优化的实现
Jul 06 Python
python 删除excel表格重复行,数据预处理操作
Jul 06 Python
Linux系统下升级pip的完整步骤
Jan 31 Python
Python3计算三角形的面积代码
Dec 18 #Python
利用python解决mysql视图导入导出依赖的问题
Dec 17 #Python
python 3.5实现检测路由器流量并写入txt的方法实例
Dec 17 #Python
python中闭包Closure函数作为返回值的方法示例
Dec 17 #Python
django模板语法学习之include示例详解
Dec 17 #Python
详解python string类型 bytes类型 bytearray类型
Dec 16 #Python
python使用os.listdir和os.walk获得文件的路径的方法
Dec 16 #Python
You might like
PHP动态生成javascript文件的2个例子
2014/04/11 PHP
PHP GD库生成图像的几个函数总结
2014/11/19 PHP
typecho插件编写教程(四):插件挂载
2015/05/28 PHP
如何使用PHP对网站验证码进行破解
2015/09/17 PHP
PHP实现四种基础排序算法的运行时间比较(推荐)
2016/08/11 PHP
PHP Post获取不到非表单数据的问题解决办法
2018/02/27 PHP
syntaxhighlighter 使用方法
2007/07/02 Javascript
一个简单的JavaScript 日期计算算法
2009/09/11 Javascript
Extjs学习笔记之四 工具栏和菜单
2010/01/07 Javascript
学习JavaScript的最佳方法分享
2011/10/21 Javascript
JS与C#编码解码
2013/12/03 Javascript
浅析js中的浮点型运算问题
2014/01/06 Javascript
做好七件事帮你提升jQuery的性能
2014/02/06 Javascript
jquery使用$(element).is()来判断获取的tagName
2014/08/24 Javascript
Bootstrap插件全集
2016/07/18 Javascript
AJAX和jQuery动态加载数据的实现方法
2016/12/05 Javascript
使用weixin-java-miniapp配置进行单个小程序的配置详解
2019/03/29 Javascript
vue如何限制只能输入正负数及小数
2019/07/04 Javascript
ionic2.0双击返回键退出应用
2019/09/17 Javascript
浅谈Webpack4 Tree Shaking 终极优化指南
2019/11/18 Javascript
Python之re操作方法(详解)
2017/06/14 Python
Python使用Matplotlib模块时坐标轴标题中文及各种特殊符号显示方法
2018/05/04 Python
浅谈flask源码之请求过程
2018/07/26 Python
Python实现扫码工具的示例代码
2020/10/09 Python
罗马尼亚购物网站:Vivantis.ro
2019/07/20 全球购物
学生处主任岗位职责
2013/12/01 职场文书
幼儿园优秀教师事迹
2014/02/13 职场文书
实践单位评语
2014/04/26 职场文书
保护环境建议书100字
2014/05/13 职场文书
中学教师师德师风演讲稿
2014/08/22 职场文书
小学教师师德师风自我剖析材料
2014/09/29 职场文书
党员对照检查剖析材料
2014/10/13 职场文书
财务稽核岗位职责
2015/04/13 职场文书
如何写好一份优秀的工作总结?
2019/06/21 职场文书
预备党员的思想汇报,你真的会写吗?
2019/06/28 职场文书
Python下载商品数据并连接数据库且保存数据
2022/03/31 Python