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

前言

我的 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开发WebService系列教程之REST,web.py,eurasia,Django
  • Python的Django REST框架中的序列化及请求和返回
  • django rest framework之请求与响应(详解)
  • 浅谈Django REST Framework限速
赞 (0)

相关推荐

  • Python开发WebService系列教程之REST,web.py,eurasia,Django

    在Bioinformatics(生物信息学)领域,WebService是很重要的一种数据交换技术,未来必将更加重要.目前EBI所提供的WebService就分别有SOAP和REST两种方式的服务,不管是数据服务还是计算服务(计算任务提交). 1 Python + SOAP/WSDL/UDDI 最普遍的做法(个人观点)是使用 python ZSI2.0   ,ZSI还依赖于 SOAPpy  和 pyXML  等LIB. SOAP协议很多人都很熟悉,有很多现有的应用也都使用Java等语言来开发服务端

  • django rest framework之请求与响应(详解)

    前言:在上一篇文章,已经实现了访问指定URL就返回了指定的数据,这也体现了RESTful API的一个理念,每一个URL代表着一个资源.当然我们还知道RESTful API的另一个特性就是,发送不同的请求动作,会返还不同的响应,这篇文章就讲一下django-rest-framework这个工具在这方面给我们带来的便捷操作. 一.Request对象 平时我们在写Django的视图函数的时候,都会带上一个request参数,这样就能处理平时搭建网站时,浏览器访问网页时发出的常规的HttpReques

  • Python的Django REST框架中的序列化及请求和返回

    序列化Serialization 1. 设置一个新的环境 在我们开始之前, 我们首先使用virtualenv要创建一个新的虚拟环境,以使我们的配置和我们的其他项目配置彻底分开. $mkdir ~/env $virtualenv ~/env/tutorial $source ~/env/tutorial/bin/avtivate 现在我们处在一个虚拟的环境中,开始安装我们的依赖包 $pip install django $pip install djangorestframework $pip i

  • 浅谈Django REST Framework限速

    浅谈Django REST Framework限速

    官方文档 settings.py配置 REST_FRAMEWORK = { 'DEFAULT_THROTTLE_CLASSES': ( 'rest_framework.throttling.AnonRateThrottle', 'rest_framework.throttling.UserRateThrottle' ), 'DEFAULT_THROTTLE_RATES': { 'anon': '100/day', 'user': '1000/day' } } AnonRateThrottle:用

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

    前言 我的 App 项目的 API 部分是使用 Django REST Framework 来搭建的,它可以像搭积木一样非常方便地搭出 API,兼具方便和灵活. django是一个神奇的框架,而restframework又是遵循了这个框架的另一个神奇的框架,然而由于restframework的文档稀烂无比,很多时候你必须看源码才能写出科学的代码,这挡住了很多新手的路. 在使用的过程中我也积累了一些小技巧,这里写一则关于如何为文件属性输出完整 URL 的字段. 实现方法 一个典型的案例是,当请求

  • Django shell调试models输出的SQL语句方法

    在settings.py里,配置如下logging: LOGGING = { 'version': 1, 'disable_existing_loggers': False, 'handlers': { 'console':{ 'level':'DEBUG', 'class':'logging.StreamHandler', }, }, 'loggers': { 'django.db.backends': { 'handlers': ['console'], 'propagate': True,

  • PHP获取当前页面完整URL的方法

    一.利用javascript实现: top.location.href 顶级窗口的地址 this.location.href 当前窗口的地址 二.利用PHP实现 http://localhost/PHP/XX.php?id=5 //获取域名或主机地址 echo $_SERVER['HTTP_HOST']; #localhost //获取网页地址 echo $_SERVER['PHP_SELF']; #/PHP/XX.php //获取网址参数 echo $_SERVER["QUERY_STRING

  • 多种语言下获取当前页完整URL及其参数

    PHP如何获取当前页完整URL及其参数 <? echo 'http://'.$_SERVER['SERVER_NAME'].':'.$_SERVER["SERVER_PORT"].$_SERVER["REQUEST_URI"]."<br>"; echo $_SERVER['SERVER_NAME']."<br>";//  cike.org echo $_SERVER["SERVER_PO

  • php获取当前页面完整URL地址

    使用PHP编写程序的时候,我们常常想要获取当前页面的URL.下面提供一个用于获取当前页面URL的函数以及使用方法: 示例一: <?php // 说明:获取完整URL function curPageURL() { $pageURL = 'http'; if ($_SERVER["HTTPS"] == "on") { $pageURL .= "s"; } $pageURL .= "://"; if ($_SERVER[&q

  • python实现对一个完整url进行分割的方法

    本文实例讲述了python实现对一个完整url进行分割的方法.分享给大家供大家参考.具体分析如下: python对一个完整的url进行分割,将url分割成单独的部分,包括协议.域名.端口.路径.参数等等 import urlparse print urlparse.urlsplit('http://www.jb51.net:80/faq.cgi?src=fie') 结果如下: 复制代码 代码如下: SplitResult(scheme='http', netloc='www.jb51.net:8

  • PHP获取当前完整URL地址的函数

    这里主要是给大家分享一个非常实用的PHP函数,代码很简单,就不多废话了,小伙伴们需要的话直接拿去用. 复制代码 代码如下: //php获取当前访问的完整url地址 function get_current_url(){     $current_url='http://';     if(isset($_SERVER['HTTPS'])&&$_SERVER['HTTPS']=='on'){         $current_url='https://';     }     if($_SE

  • C#实现在网页中根据url截图并输出到网页的方法

    本文实例讲述了C#实现在网页中根据url截图并输出到网页的方法.分享给大家供大家参考,具体如下: 网页截图是很多站点的一个小需求,这段代码实现的是如何根据url获得网页截图并输出到网页中. using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.Web.UI; using System.Web.UI.WebControls; using System.Thr

  • Django 在iframe里跳转顶层url的例子

    描述 A网页为一个专门设计的登录页面login.html,通过iframe嵌套在B页面中index.html,登录后会进入后台C页面consule.html.问题来了,登录成功后,通过Django-url跳转,页面一直在iframe里面,没有跳出嵌入的框架中. 解决方法 通过HttpResponse来返回一段js脚本,直接让你丫的跳,代码如下 def login(request): login_form = loginForm() if request.method == 'POST': log

  • Django框架实现逆向解析url的方法

    本文实例讲述了Django框架实现逆向解析url的方法.分享给大家供大家参考,具体如下: Django中提供了一个关于URL的映射的解决方案,你可以做两个方向的使用: ①. 有客户端的浏览器发起一个url请求,Django根据URL解析,把url中的参数捕获,调用相应的试图,获取相应的数据,然后返回给客户端显示 ②. 通过一个视图的名字,再加上一些参数和值,逆向获取相应的URL 第一个就是平常的请求有URLconf来解析的过程, 第二个叫做,url的逆向解析,url逆向匹配,url的逆向查阅,等

随机推荐