在完成了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'])
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)
- 调用/neutron/api/v2/base.py中的create_resource函数来构造请求的处理函数(即上面提到的controller);
- 构造传入mapper.collection函数的参数mapper_kwargs;
- 调用mapper.collection函数来实际进行map动作。
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)
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)
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)
- 从租户提交的请求中获取相关参数&#xff08;formate、action等&#xff09;&#xff1b;
- 根据action的类型从controller中获取相应处理函数&#xff1b;
- 调用获取到的处理函数得到结果&#xff1b;
- 最后返回response&#xff1b;
- 此外&#xff0c;还进行了序列化和反序列化的工作。
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动作。