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实现大文件排序的方法
Jul 10 Python
详解Python中映射类型的内建函数和工厂函数
Aug 19 Python
jupyter安装小结
Mar 13 Python
Python的Django REST框架中的序列化及请求和返回
Apr 11 Python
python自带的http模块详解
Nov 06 Python
详解python中requirements.txt的一切
Mar 03 Python
python抓取文件夹的所有文件
Feb 27 Python
小白如何入门Python? 制作一个网站为例
Mar 06 Python
python 日志增量抓取实现方法
Apr 28 Python
python 反向输出字符串的方法
Jul 16 Python
python实现布隆过滤器及原理解析
Dec 08 Python
什么是Python包的循环导入
Sep 08 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
咖啡因含量是由谁决定的?低因咖啡怎么来?低因咖啡适合什么人喝
2021/03/06 新手入门
PHP中数据库单例模式的实现代码分享
2014/08/21 PHP
织梦sitemap地图实时推送给百度的教程
2015/08/03 PHP
Three.js源码阅读笔记(基础的核心Core对象)
2012/12/27 Javascript
JavaScript获取客户端计算机硬件及系统等信息的方法
2014/01/02 Javascript
jQuery中filter()方法用法实例
2015/01/06 Javascript
jQuery实现的五子棋游戏实例
2015/06/13 Javascript
Angularjs整合微信UI(weui)
2016/03/15 Javascript
JS中的forEach、$.each、map方法推荐
2016/04/05 Javascript
javascript中this指向详解
2016/04/23 Javascript
laypage分页控件使用实例详解
2016/05/19 Javascript
jQuery通过deferred对象管理ajax异步
2016/05/20 Javascript
JavaScript中原型链存在的问题解析
2016/09/25 Javascript
Vue 固定头 固定列 点击表头可排序的表格组件
2016/11/25 Javascript
JavaScript用构造函数如何获取变量的类型名
2016/12/23 Javascript
本地存储localStorage用法详解
2017/07/31 Javascript
如何重置vue打印变量的显示方式
2017/12/06 Javascript
微信小程序使用slider设置数据值及switch开关组件功能【附源码下载】
2017/12/09 Javascript
vuex提交state&&实时监听state数据的改变方法
2018/09/16 Javascript
VueJS 组件参数名命名与组件属性转化问题
2018/12/03 Javascript
ES6 如何改变JS内置行为的代理与反射
2019/02/11 Javascript
详解JS浏览器事件循环机制
2019/03/27 Javascript
Python面向对象之静态属性、类方法与静态方法分析
2018/08/24 Python
Python进程池Pool应用实例分析
2019/11/27 Python
解决python脚本中error: unrecognized arguments: True错误
2020/04/20 Python
Python常用扩展插件使用教程解析
2020/11/02 Python
python 爬取百度文库并下载(免费文章限定)
2020/12/04 Python
Python非单向递归函数如何返回全部结果
2020/12/18 Python
Python与C/C++的相互调用案例
2021/03/04 Python
CSS3 实现的加载动画
2020/12/07 HTML / CSS
Original Penguin美国官网:布拉德皮特、强尼德普喜爱的服装品牌
2016/10/25 全球购物
小学生操行评语
2014/04/22 职场文书
法人代表授权委托书范文
2014/09/10 职场文书
党员对照检查剖析材料
2014/10/13 职场文书
上班迟到检讨书范文300字
2014/11/02 职场文书
硕士论文致谢范文
2015/05/14 职场文书