代码之家  ›  专栏  ›  技术社区  ›  Kirk Liemohn

当需要一些复杂的参数时,设计HTTP请求的最佳方法是什么?

  •  31
  • Kirk Liemohn  · 技术社区  · 17 年前

    我正在编写一些web服务,我正在尽可能地保持RESTful。我使用运行在IIS/ASP.NET/SharePoint内部的HTTPHandler托管这些web服务。

    我的大多数服务都需要HTTP GET。我有两个简单地返回一些数据(例如,一个查询),并且将 Idempotent

    通过使用IIS、ASP.NET和SharePoint,我发现URL路径中的以下字符甚至无法进入我的HttpHandler,即使URL已编码(请求中断,我无法轻松控制):

    • % (%25)
    • &(%26)
    • *(%2a,但没有Url编码)
    • +(%2b)
    • <
    • (%3e)

    • (%23)

    • . (%2e,但未进行Url编码;UriTemplate删除了“.”if is是/之前的最后一个字符)
    • /(%2f-UriTemplate由于明显的原因失败,即使UrlEncoded)

    所以,我已经有点透彻了,但我需要测试查询字符串中的这些url编码字符。看来,这将在那里的大部分工作。

    在我的一个服务中,作为参数的特殊字符在语义上是查询/过滤器的一部分(实际上是搜索服务的搜索词),但在另一个服务中,它们实际上不是查询/过滤器的一部分,因此理想情况下,它们是路径的一部分,而不是查询字符串。

    我的问题是,什么选择是最好的?以下是我所知道的一些:

    1. 使用HTTP GET和查询字符串。 这正是我学习的地方,但我关心的是非常长的查询字符串(即限制为2083)

    2. 使用 Modified Base64 for URL 对于可能使用特殊字符的任何参数,如果愿意,请将其保留为路径的一部分。

    3. 使用HTTP POST和消息体。 任何可能使用特殊字符的内容都应该在请求正文中。 这似乎是一个不错的解决方案,但帖子被理解为 不 是 幂等元

    4. 使用HTTP GET和消息体。 任何可能使用特殊字符的内容都应该在请求正文中。根据他的说法,这似乎是个坏主意 SO: HTTP GET with request body 和 Roy Fielding .

    5. 另外

    请注意,在某些情况下,我可能能够改变周围的情况以防止出现特殊字符(我也可以这样做),但我不能在所有情况下都这样做。


    关于URI长度, RFC2616 Sec3.2.1 他说:

    HTTP协议对URI的长度没有任何先验限制。服务器必须能够处理它们所服务的任何资源的URI,并且如果它们提供可以生成此类URI的基于GET的表单,则应该能够处理长度无限的URI。如果URI超过服务器可以处理的长度,则服务器应返回414(请求URI过长)状态(参见第10.4.15节)。

      Note: Servers ought to be cautious about depending on URI lengths
      above 255 bytes, because some older client or proxy
      implementations might not properly support these lengths.
    

    Maximum URL length is 2,083 characters in Internet Explorer .

    相关的: How to pass complex queries in REST?

    11 回复  |  直到 9 年前
        1
  •  33
  •   Nelson    17 年前

    没有完美的方法可以做到这一点。

    正确的HTTP/REST方法是使用GET并将URL中的所有参数作为查询参数。您已经确定了此方法的两个实际问题

    您最实用的解决方案可能是选项3,即HTTP POST。这不是安宁;您应该使用GET进行只读查询。您将失去REST方法在缓存GET等方面的一些优势。另一方面,它将正确地工作,简单地使用各种各样的互联网基础设施和软件库。然后,您可以通过多部分/表单数据编码、JSON或XML在POST正文中传递任意数量的数据。(我已经使用SOAP构建了两个主要的公共web服务,SOAP只是POST上的XML。它很难看,也不是RESTful,但它确实工作可靠。)

    REST是一个伟大的设计范例。这是一个指导方针。如果它不适合你的应用程序,不要觉得你需要坚持使用它。HTTP不擅长使用GET将大量数据传递给服务器。如果您需要巨大的查询参数,请执行其他操作。

        2
  •  17
  •   dat    9 年前

    我为一家酒店的预订系统开发了一个restful API;搜索查询的参数太多(首选项、房间列表等),因此我将其转换为一个资源,并将其发布到服务器。然后,服务器使用唯一标识搜索的URI进行回复,该URI是发布的查询及其结果的主体:

    POST http://hotels.xyz/searches
    body <search><query>...</query></search>
    

    回答

    201 Created - Location: http://hotels.xyz/searches/someID
    Body <search><query>...</query><results>...</results></search>
    
        4
  •  5
  •   lenkite    17 年前

    如果没有其他解决方案,请将自定义HTTP头与HTTP GET一起使用。几乎所有客户端都可以设置HTTP头。

    通常,最好在查询字符串中使用URL参数。过多的URL参数表明您需要拆分为更细粒度的服务。

        5
  •  2
  •   glaz666    17 年前

    因此,如果您有/?param1=bla bla&之类的内容;param2=bla bla您只需压缩该参数,并使url看起来像/?query=ASsadcnfAFFASFscnsdlc

    当您收到这样的请求时,您只需解压缩它们并解析参数字符串

        6
  •  2
  •   John Millikin    17 年前

    您应该使用HTTP GET请求将参数放置在查询字符串中。一些较旧的web浏览器中的限制并不令人担忧,因为在web浏览器中浏览API的人可能只有开发人员(或者至少是技术人员)。

    请记住,客户端应用程序应该 不 操作API提供的URL。URL是客户端的不透明标识符,仅用于将它们定向到可以找到特定资源的位置。

        7
  •  2
  •   ifatree    17 年前

    我不建议您使用拆分参数抛出多个get,并尝试以这种方式跟踪请求。。。

    我唯一建议的“健壮”方法是在一个请求(POST)中存储/设置请求的querystring,并让它返回一个固定大小的ID(或guid),用于标识数据存储中的请求参数位置(filterID),然后使用filterID令牌而不是完整的筛选器查询字符串值发出实际的GET请求。这将允许各种整洁的事情,比如缓存基于filterID的响应,以便(理论上)以后可以重用相同的过滤器(而不是手动重新输入它们,只需将“标签”与过滤器主体一起保存,然后按标签从最后5个过滤器中进行选择),或者至少将它们与您的数据一起存储,以便每次刷新页面时不会重新发送整个筛选请求。

        8
  •  2
  •   Steven Huwig    17 年前

    Roy Fielding

    通常,大多数应用程序 提供给服务器的数据不安全。 唯一的例外是当信息以 哪一个 两者之间存在权衡 获取和发布通常涉及 . 仅适用于这些情况 其中可以表示参数 作为一个有意义的URI。

        9
  •  1
  •   Mark L    17 年前

        10
  •  0
  •   user142019 user142019    17 年前

    base64应该做到这一点。另一种明智的做法是使用标准的%-符号。

        11
  •  0
  •   Christophe Quintard    9 年前

    考虑支持:
    -使用短查询字符串获取请求
    https://en.wikipedia.org/wiki/List_of_HTTP_header_fields )

    注意不要将批量创建新订单的“POST/orders”和搜索订单的“X-HTTP-Method-Override:GET”混合在一起。