热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

OcataNeutron代码分析(六)——APIRouter的初始化(3)顶级resource的map过程

在完成了plugins和extensions的加载后,进行四个顶级resource(分别是network、subnet、subnetpool和port&

在完成了plugins和extensions的加载后,进行四个顶级resource(分别是network、subnet、subnetpool和port)的map过程。map过程指的是,将各个resource的相关请求(例如创建network、删除subnet)映射到相应的处理函数的过程。APIRouter构造函数中相关代码如下:

RESOURCES = {'network': 'networks','subnet': 'subnets','subnetpool': 'subnetpools','port': 'ports'}
SUB_RESOURCES
= {}
class APIRouter(base_wsgi.Router):......def __init__(self, **local_config):mapper = routes_mapper.Mapper()......mapper.connect('index', '/', controller=Index(RESOURCES))for resource in RESOURCES:_map_resource(RESOURCES[resource], resource,attributes.RESOURCE_ATTRIBUTE_MAP.get(RESOURCES[resource], dict()))resource_registry.register_resource_by_name(resource)for resource in SUB_RESOURCES:_map_resource(SUB_RESOURCES[resource]['collection_name'], resource,attributes.RESOURCE_ATTRIBUTE_MAP.get(SUB_RESOURCES[resource]['collection_name'],dict()),SUB_RESOURCES[resource]['parent'])

map过程的关键就是调用Mapper类的函数来实现,这里首先实例化了Mapper类。
接着,调用其connect函数来进行map。这是一个最简单的map方式。这里匹配到的url为http://controller_ip:neutron_server_port/v2.0/,controller_ip和neutron_server_port在配置文件中指定,/v2.0为api-paste.ini中指定的匹配url。能与该url匹配的请求的controller是Index类的__call__函数,即能与该url匹配的request将交给Index类中的__call__函数来处理,这样的处理函数一般为一个经过webob.dec.wsgify修饰后的函数。
最后,依次调用_map_resource函数对RESOURCES中的各个顶级resource进行map,并注册各个顶级resource。向_map_resource传入的参数分别是collection(resource的集合的名称,string)、resource(resource的名称,string)和resource相关的属性(dict)。
下面重点分析_map_resource函数:

class APIRouter(base_wsgi.Router):def __init__(self, **local_config):col_kwargs = dict(collection_actions=COLLECTION_ACTIONS,member_actions=MEMBER_ACTIONS)def _map_resource(collection, resource, params, parent=None):allow_bulk = cfg.CONF.allow_bulkcontroller = base.create_resource( # 1collection, resource, plugin, params, allow_bulk=allow_bulk,parent=parent, allow_pagination=True,allow_sorting=True)path_prefix = Noneif parent:path_prefix = "/%s/{%s_id}/%s" % (parent['collection_name'],parent['member_name'],collection)mapper_kwargs = dict(controller=controller, # 2requirements=REQUIREMENTS,path_prefix=path_prefix,**col_kwargs)return mapper.collection(collection, resource, # 3**mapper_kwargs)

_map_resource函数主要包含了三个步骤:
  1. 调用/neutron/api/v2/base.py中的create_resource函数来构造请求的处理函数(即上面提到的controller);
  2. 构造传入mapper.collection函数的参数mapper_kwargs;
  3. 调用mapper.collection函数来实际进行map动作。
先分析create_resource函数:

def create_resource(collection, resource, plugin, params, allow_bulk=False,member_actions=None, parent=None, allow_pagination=False,allow_sorting=False):controller = Controller(plugin, collection, resource, params, allow_bulk,member_actions=member_actions, parent=parent,allow_pagination=allow_pagination,allow_sorting=allow_sorting)return wsgi_resource.Resource(controller, FAULT_MAP)

该函数首先实例化Controller类赋给controller变量,然后将controller作为参数调用/neutron/api/v2/resource.py的Resource函数。
先看看Controller的构造函数:

class Controller(object):LIST = 'list'SHOW = 'show'CREATE = 'create'UPDATE = 'update'DELETE = 'delete'def __init__(self, plugin, collection, resource, attr_info,allow_bulk=False, member_actions=None, parent=None,allow_pagination=False, allow_sorting=False):if member_actions is None:member_actions = []self._plugin = pluginself._collection = collection.replace('-', '_')self._resource = resource.replace('-', '_')self._attr_info = attr_infoself._allow_bulk = allow_bulkself._allow_pagination = allow_paginationself._allow_sorting = allow_sortingself._native_bulk = self._is_native_bulk_supported()self._native_pagination = self._is_native_pagination_supported()self._native_sorting = self._is_native_sorting_supported()self._policy_attrs = self._init_policy_attrs()self._notifier = n_rpc.get_notifier('network')self._member_actions = member_actionsself._primary_key = self._get_primary_key()if self._allow_pagination and self._native_pagination:# Native pagination need native sorting supportif not self._native_sorting:raise exceptions.Invalid(_("Native pagination depend on native sorting"))if not self._allow_sorting:LOG.info(_LI("Allow sorting is enabled because native ""pagination requires native sorting"))self._allow_sorting = Trueself.parent = parentif parent:self._parent_id_name = '%s_id' % parent['member_name']parent_part = '_%s' % parent['member_name']else:self._parent_id_name = Noneparent_part = ''self._plugin_handlers = {self.LIST: 'get%s_%s' % (parent_part, self._collection),self.SHOW: 'get%s_%s' % (parent_part, self._resource)}for action in [self.CREATE, self.UPDATE, self.DELETE]:self._plugin_handlers[action] = '%s%s_%s' % (action, parent_part,self._resource)

Controller的构造函数主要进行了参数的赋值、参数的合理性检查等。这里最重要的成员变量是self._plugin_handlers,它是一个对该resource采取的action名称与对应处理函数名称的字典。以network这一resource为例,其_plugin_handlers如下:
{'list': 'get_networks', 'show': 'get_network', 'create': 'create_network', 'update': 'update_network', 'delete': 'delete_network'}
分别表示:获取network列表,获取某个network,创建某个network,更新某个network和删除某个network。
后续流程会通过这个变量来获取相应处理函数的名称。
实例化后的controller变量传入/neutron/api/v2/resource.py的Resource函数:

def Resource(controller, faults=None, deserializers=None, serializers=None,action_status=None):"""Represents an API entity resource and the associated serialization anddeserialization logic"""default_deserializers = {'application/json': wsgi.JSONDeserializer()}default_serializers = {'application/json': wsgi.JSONDictSerializer()}format_types = {'json': 'application/json'}action_status = action_status or dict(create=201, delete=204)default_deserializers.update(deserializers or {})default_serializers.update(serializers or {})deserializers = default_deserializersserializers = default_serializersfaults = faults or {}@webob.dec.wsgify(RequestClass=Request)def resource(request):......# NOTE(blogan): this is something that is needed for the transition to# pecan. This will allow the pecan code to have a handle on the controller# for an extension so it can reuse the code instead of forcing every# extension to rewrite the code for use with pecan.setattr(resource, 'controller', controller)setattr(resource, 'action_status', action_status)return resource

可以看到,Resource函数只是在其中的resource函数外多加了一层壳,这层壳主要是进行序列化和反序列化组件(serializers和deserializers)的配置。其中的resource函数经过webob.dec.wsgify修饰,所以各个resource的request均是交给这里的resource函数来处理。下面分析这个resource函数:

@webob.dec.wsgify(RequestClass=Request)def resource(request): # 处理Request的函数route_args = request.environ.get('wsgiorg.routing_args')if route_args:args = route_args[1].copy()else:args = {}# NOTE(jkoelker) by now the controller is already found, remove# it from the args if it is in the matchdictargs.pop('controller', None)fmt = args.pop('format', None)action = args.pop('action', None) # 获取请求中的format和action,移除controller。content_type = format_types.get(fmt,request.best_match_content_type())language = request.best_match_language()deserializer = deserializers.get(content_type) # 从deserializers中获取Content_type对应的deserializer。serializer = serializers.get(content_type) # 序列化同理。try:if request.body:args['body'] = deserializer.deserialize(request.body)['body'] # 将request中的body反序列化,e.g.str -> json。# Routes library is dumb and cuts off everything after last dot (.)# as format. At the same time, it doesn't enforce format suffix,# which combined makes it impossible to pass a 'id' with dots# included (the last section after the last dot is lost). This is# important for some API extensions like tags where the id is# really a tag name that can contain special characters.#
# To work around the Routes behaviour, we will attach the suffix# back to id if it&#39;s not one of supported formats (atm json only).# This of course won&#39;t work for the corner case of a tag name that# actually ends with &#39;.json&#39;, but there seems to be no better way# to tackle it without breaking API backwards compatibility.if fmt is not None and fmt not in format_types:args[&#39;id&#39;] &#61; &#39;.&#39;.join([args[&#39;id&#39;], fmt])method &#61; getattr(controller, action) # 从controller获取执行action的函数。result &#61; method(request&#61;request, **args) # 执行action&#xff0c;相关参数经反序列化后通过args参数传入controller。except Exception as e:mapped_exc &#61; api_common.convert_exception_to_http_exc(e, faults,language)if hasattr(mapped_exc, &#39;code&#39;) and 400 <&#61; mapped_exc.code <500:LOG.info(_LI(&#39;%(action)s failed (client error): %(exc)s&#39;),{&#39;action&#39;: action, &#39;exc&#39;: mapped_exc})else:LOG.exception(_LE(&#39;%(action)s failed: %(details)s&#39;),{&#39;action&#39;: action,&#39;details&#39;: utils.extract_exc_details(e),})raise mapped_excstatus &#61; action_status.get(action, 200)body &#61; serializer.serialize(result) # 将result序列化&#xff0c;e.g.json -> str。# NOTE(jkoelker) Comply with RFC2616 section 9.7if status &#61;&#61; 204:content_type &#61; &#39;&#39;body &#61; Nonereturn webob.Response(request&#61;request, status&#61;status, # 构造Response进行返回。content_type&#61;content_type,body&#61;body)

总而言之&#xff0c;resource函数主要完成以下几个工作&#xff1a;
  1. 从租户提交的请求中获取相关参数&#xff08;formate、action等&#xff09;&#xff1b;
  2. 根据action的类型从controller中获取相应处理函数&#xff1b;
  3. 调用获取到的处理函数得到结果&#xff1b;
  4. 最后返回response&#xff1b;
  5. 此外&#xff0c;还进行了序列化和反序列化的工作。
所以&#xff0c;先在create_resource函数中实例化的controller&#xff0c;包含了所有action类型&#xff08;包括index、show、create、update和delete&#xff09;的实现函数。针对某个resource的某个action经过resource函数&#xff0c;最终还是来到了controller中的相应action函数中进行处理。具体action函数的处理会在后续章节中分析。
下面回到_map_resource函数的分析中&#xff1a;

class APIRouter(base_wsgi.Router):def __init__(self, **local_config):col_kwargs &#61; dict(collection_actions&#61;COLLECTION_ACTIONS,member_actions&#61;MEMBER_ACTIONS)def _map_resource(collection, resource, params, parent&#61;None):allow_bulk &#61; cfg.CONF.allow_bulkcontroller &#61; base.create_resource( # 1collection, resource, plugin, params, allow_bulk&#61;allow_bulk,parent&#61;parent, allow_pagination&#61;True,allow_sorting&#61;True)path_prefix &#61; Noneif parent:path_prefix &#61; "/%s/{%s_id}/%s" % (parent[&#39;collection_name&#39;],parent[&#39;member_name&#39;],collection)mapper_kwargs &#61; dict(controller&#61;controller, # 2requirements&#61;REQUIREMENTS,path_prefix&#61;path_prefix,**col_kwargs)return mapper.collection(collection, resource, # 3**mapper_kwargs)

create_resource返回的&#xff08;即这里的controller变量&#xff09;是经过webob.dec.wsgify修饰后的resource函数。然后&#xff0c;在2中&#xff0c;构造传入mapper.collection函数的参数&#xff0c;其中最关键的就是controller变量。最后&#xff0c;在3中&#xff0c;调用mapper.collection完成该resource的各个action的map动作。


转:https://www.cnblogs.com/Luka-Modric/p/8258385.html



推荐阅读
  • Web动态服务器Python基本实现
    Web动态服务器Python基本实现 ... [详细]
  • 本文探讨了如何通过Service Locator模式来简化和优化在B/S架构中的服务命名访问,特别是对于需要频繁访问的服务,如JNDI和XMLNS。该模式通过缓存机制减少了重复查找的成本,并提供了对多种服务的统一访问接口。 ... [详细]
  • 本文将从基础概念入手,详细探讨SpringMVC框架中DispatcherServlet如何通过HandlerMapping进行请求分发,以及其背后的源码实现细节。 ... [详细]
  • 本文详细介绍了Oracle 11g中的创建表空间的方法,以及如何设置客户端和服务端的基本配置,包括用户管理、环境变量配置等。 ... [详细]
  • Maven + Spring + MyBatis + MySQL 环境搭建与实例解析
    本文详细介绍如何使用MySQL数据库进行环境搭建,包括创建数据库表并插入示例数据。随后,逐步指导如何配置Maven项目,整合Spring框架与MyBatis,实现高效的数据访问。 ... [详细]
  • 调试利器SSH隧道
    在开发微信公众号或小程序的时候,由于微信平台规则的限制,部分接口需要通过线上域名才能正常访问。但我们一般都会在本地开发,因为这能快速的看到 ... [详细]
  • spring boot使用jetty无法启动 ... [详细]
  • 本文详细介绍了如何在Oracle VM VirtualBox中实现主机与虚拟机之间的数据交换,包括安装Guest Additions增强功能,以及如何利用这些功能进行文件传输、屏幕调整等操作。 ... [详细]
  • Beetl是一款先进的Java模板引擎,以其丰富的功能、直观的语法、卓越的性能和易于维护的特点著称。它不仅适用于高响应需求的大型网站,也适合功能复杂的CMS管理系统,提供了一种全新的模板开发体验。 ... [详细]
  • CentOS下ProFTPD的安装与配置指南
    本文详细介绍在CentOS操作系统上安装和配置ProFTPD服务的方法,包括基本配置、安全设置及高级功能的启用。 ... [详细]
  • 本文详细介绍了如何正确设置Shadowsocks公共代理,包括调整超时设置、检查系统限制、防止滥用及遵守DMCA法规等关键步骤。 ... [详细]
  • 深入体验Python的高级交互式Shell - IPython
    IPython 是一个增强型的 Python 交互式 Shell,提供了比标准 Python 控制台更为强大的功能,适用于开发和调试过程。它不仅支持直接执行 Linux 命令,还提供了丰富的特性来提高编程效率。 ... [详细]
  • Jupyter Notebook多语言环境搭建指南
    本文详细介绍了如何在Linux环境下为Jupyter Notebook配置Python、Python3、R及Go四种编程语言的环境,包括必要的软件安装和配置步骤。 ... [详细]
  • 如何在PHP中安装Xdebug扩展
    本文介绍了如何从PECL下载并编译安装Xdebug扩展,以及如何配置PHP和PHPStorm以启用调试功能。 ... [详细]
  • 本文详细介绍了如何搭建一个高可用的MongoDB集群,包括环境准备、用户配置、目录创建、MongoDB安装、配置文件设置、集群组件部署等步骤。特别关注分片、读写分离及负载均衡的实现。 ... [详细]
author-avatar
蔚-然之林
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有