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中强大的命令行库click入门教程
Dec 26 Python
PIL对上传到Django的图片进行处理并保存的实例
Aug 07 Python
浅谈Python 递归算法指归
Aug 22 Python
Python3如何对urllib和urllib2进行重构
Nov 25 Python
Python文本处理简单易懂方法解析
Dec 19 Python
MNIST数据集转化为二维图片的实现示例
Jan 10 Python
详解django使用include无法跳转的解决方法
Mar 19 Python
Python基于codecs模块实现文件读写案例解析
May 11 Python
如何更换python默认编辑器的背景色
Aug 10 Python
python 实现关联规则算法Apriori的示例
Sep 30 Python
selenium如何定位span元素的实现
Jan 13 Python
python中time tzset()函数实例用法
Feb 18 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获取mysql数据库中的所有表名的代码
2011/04/23 PHP
CodeIgniter视图使用注意事项
2016/01/20 PHP
PHP QRCODE生成彩色二维码的方法
2016/05/19 PHP
详解no input file specified 三种解决方法
2019/11/29 PHP
在javascript将NodeList作为Array数组处理的方法
2010/07/09 Javascript
Iframe自适应高度绝对好使的代码 兼容IE,遨游,火狐
2011/01/27 Javascript
JS数组去重与取重的示例代码
2014/01/24 Javascript
JS计算网页停留时间代码
2014/04/28 Javascript
BootStrap+Angularjs+NgDialog实现模式对话框
2016/08/24 Javascript
AngularJS equal比较对象实例详解
2016/09/14 Javascript
浅谈javascript中的三种弹窗
2016/10/21 Javascript
JavaScript使用链式方法封装jQuery中CSS()方法示例
2017/04/07 jQuery
Vue.js实现一个todo-list的上移下移删除功能
2017/06/26 Javascript
javascript修改浏览器title方法 JS动态修改浏览器标题
2017/11/30 Javascript
JavaScript同源策略和跨域访问实例详解
2018/04/03 Javascript
js实现数字滚动特效
2019/12/16 Javascript
python 七种邮件内容发送方法实例
2014/04/22 Python
python使用xmlrpclib模块实现对百度google的ping功能
2015/06/02 Python
Python实现比较两个文件夹中代码变化的方法
2015/07/10 Python
python如何对实例属性进行类型检查
2018/03/20 Python
python requests爬取高德地图数据的实例
2018/11/10 Python
python开发游戏的前期准备
2019/05/05 Python
详解PyCharm+QTDesigner+PyUIC使用教程
2019/06/13 Python
python日志模块logbook使用方法
2019/09/19 Python
python 异步async库的使用说明
2020/05/04 Python
使用BeautifulSoup4解析XML的方法小结
2020/12/07 Python
使用CSS3来绘制一个月食图案
2015/07/18 HTML / CSS
极简的HTML5模版
2015/07/09 HTML / CSS
Html5基于canvas实现电子签名并生成PDF文档
2020/12/07 HTML / CSS
捷克建筑材料网上商店:DEK.cz
2021/03/06 全球购物
部队党性分析材料
2014/02/16 职场文书
党员公开承诺书范文
2014/03/25 职场文书
护理学院专科毕业生求职信
2014/06/28 职场文书
小学教师教学随笔
2015/08/14 职场文书
2016年教师新年寄语
2015/08/18 职场文书
《从现在开始》教学反思
2016/02/16 职场文书