| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" > |
| <head> |
| <meta charset="utf-8" /> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <link rel="shortcut icon" href="../img/favicon.ico" /> |
| <title>REST Transport Client 配置项 - ServiceComb Java Chassis 开发指南</title> |
| <link rel="stylesheet" href="../css/theme.css" /> |
| <link rel="stylesheet" href="../css/theme_extra.css" /> |
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" /> |
| |
| <script> |
| // Current page data |
| var mkdocs_page_name = "REST Transport Client \u914d\u7f6e\u9879"; |
| var mkdocs_page_input_path = "config-reference/rest-transport-client.md"; |
| var mkdocs_page_url = null; |
| </script> |
| |
| <script src="../js/jquery-3.6.0.min.js" defer></script> |
| <!--[if lt IE 9]> |
| <script src="../js/html5shiv.min.js"></script> |
| <![endif]--> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script> |
| <script>hljs.initHighlightingOnLoad();</script> |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search"> |
| <a href="../index.html" class="icon icon-home"> ServiceComb Java Chassis 开发指南 |
| </a> |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../toc.html">目录</a> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../index.html">概述</a> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../start/catalog.html">快速入门</a> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../start/design.html">设计选型参考</a> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../build-provider/definition/service-definition.html">微服务定义</a> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../build-provider/catalog.html">开发服务提供者</a> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../build-consumer/catalog.html">开发服务消费者</a> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../general-development/catalog.html">通用功能开发</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">多样化的通信协议功能参考</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../transports/introduction.html">多协议介绍</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../transports/rest-over-servlet.html">REST over Servlet</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../transports/rest-over-vertx.html">REST over Vertx</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../transports/http2.html">REST over HTTP2</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../transports/highway-rpc.html">Highway</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">多样化的服务注册与发现功能参考</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../registry/introduction.html">注册发现说明</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../registry/service-center.html">使用服务中心</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../registry/local-registry.html">本地注册发现</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../registry/distributed.html">去中心化注册发现</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">管理服务配置</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../config/general-config.html">通用配置说明</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../config/read-config.html">在程序中读取配置信息</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">服务治理功能参考</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../references-handlers/intruduction.html">处理链介绍</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../references-handlers/loadbalance.html">负载均衡</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../references-handlers/ratelimit.html">限流</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../references-handlers/router.html">灰度发布</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../references-handlers/fault-injection.html">故障注入</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../references-handlers/governance.html">流量特征治理</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../references-handlers/fail-retry.html">快速失败和重试</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">网关功能参考</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../edge/open-service.html">介绍</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../edge/by-servicecomb-sdk.html">使用 Edge Service 做网关</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../edge/zuul.html">使用 `zuul` 和 `spring cloud gateway` 做网关</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../edge/nginx.html">nginx 网关简单介绍</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">安全特性参考</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../references-handlers/publickey.html">公钥认证</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../security/tls.html">使用TLS通信</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../security/shi-yong-rsa-ren-zheng.html">使用RSA认证</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">服务打包和运行</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../packaging/standalone.html">以standalone模式打包</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../packaging/web-container.html">以WEB容器模式打包</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">专题文章</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../using-java-chassis-in-spring-boot/using-java-chassis-in-spring-boot.html">在Spring Boot中使用java chassis</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../featured-topics/features.html">新功能介绍系列文章</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../featured-topics/compatibility.html">兼容问题和兼容性策略</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../featured-topics/upgrading.html">升级指导系列文章</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../featured-topics/performance.html">性能问题分析和调优</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">常用配置项参考</span></p> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="reference internal current" href="rest-transport-client.html">REST Transport Client 配置项</a> |
| <ul class="current"> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="config-center-client.html">Config Center Client 配置项</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="service-center-client.html">Service Center Client 配置项</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="kie-client.html">ServiceComb Kie Client 配置项</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">常见问题</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../question-and-answer/faq.html">FAQ</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../question-and-answer/question_answer.html">Q & A</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../question-and-answer/interface-compatibility.html">微服务接口兼容常见问题</a> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu"> |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../index.html">ServiceComb Java Chassis 开发指南</a> |
| |
| </nav> |
| <div class="wy-nav-content"> |
| <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="../index.html" class="icon icon-home" alt="Docs"></a> »</li> |
| <li>常用配置项参考 »</li> |
| <li>REST Transport Client 配置项</li> |
| <li class="wy-breadcrumbs-aside"> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div class="section" itemprop="articleBody"> |
| |
| <h1 id="rest-transport-client">REST Transport Client 配置项</h1> |
| <ul> |
| <li>基本配置</li> |
| </ul> |
| <p>REST Trasnport Client 分为 HTTP 和 HTTP2, 它们共享很多配置项。下表中配置项名称包含 <code>http2</code> 的配置项， 是 HTTP2 独有的。 |
| HTTP2协议依赖于HTTP协议，HTTP和HTTP2的连接池是共享的，在使用HTTP2的情况下，同样需要配置HTTP的连接池参数。比如：</p> |
| <pre><code>servicecomb: |
| rest: |
| client: |
| connection: |
| maxPoolSize: 50 |
| http2: |
| maxPoolSize: 5 |
| </code></pre> |
| <p>连接池在计算是否超过大小的时候，会同时检查这两个配置项。假设访问的服务器为H，那么上述配置，和H建立的最大连接可能性为 |
| HTTP:HTTP2=50:0, HTTP:HTTP2=0:5, HTTP:HTTP2=20:3等。一个客户端和H建立的总的连接数还和servicecomb.rest.client.verticle-count |
| 有关。可以理解为每个vertical会针对H创建一个连接池，连接池个数为vertical-count。</p> |
| <p>由于HTTP和HTTP2协议之间这种紧密的关系，在使用HTTP2的情况下，其他相关的HTTP参数建议一并需要合理设置，比如连接闲置超时时间等。</p> |
| <table> |
| <thead> |
| <tr> |
| <th>配置项名称</th> |
| <th>版本</th> |
| <th>缺省值</th> |
| <th>功能描述</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>servicecomb.rest.client.enabled</td> |
| <td>2.0.2</td> |
| <td>true</td> |
| <td>是否启用Rest Transport Client, HTTP 1</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.verticle-count</td> |
| <td></td> |
| <td><a href="#note1">备注1</a></td> |
| <td><a href="#note2">备注2</a></td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.thread-count</td> |
| <td>废弃</td> |
| <td></td> |
| <td>同verticle-count</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.connection.timeoutInMillis</td> |
| <td>2.0.2</td> |
| <td>1000</td> |
| <td>连接超时时间</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.connection.idleTimeoutInSeconds</td> |
| <td></td> |
| <td>30</td> |
| <td>HTTP 连接闲置超时时间</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.connection.compression</td> |
| <td></td> |
| <td>false</td> |
| <td>是否启用压缩</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.maxWaitQueueSize</td> |
| <td></td> |
| <td>-1</td> |
| <td>HTTP HTTP2 等待队列大小</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.connection.maxPoolSize</td> |
| <td></td> |
| <td>5</td> |
| <td>HTTP 客户端连接池大小</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.connection.keepAlive</td> |
| <td></td> |
| <td>true</td> |
| <td>HTTP 连接是否保活</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.maxHeaderSize</td> |
| <td></td> |
| <td>8192</td> |
| <td>HTTP 最大头部限制</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.http2.enabled</td> |
| <td>2.0.2</td> |
| <td>true</td> |
| <td>是否启用Rest Transport Client，HTTP 2</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.http2.useAlpnEnabled</td> |
| <td></td> |
| <td>true</td> |
| <td></td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.http2.multiplexingLimit</td> |
| <td></td> |
| <td>-1</td> |
| <td>一条连接中，同时支持的最大的stream并发量，-1表示不限制。最终以服务端的concurrentStreams和客户端的multiplexingLimit较小值为准。</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.http2.maxPoolSize</td> |
| <td></td> |
| <td>1</td> |
| <td>HTTP2 客户端连接池大小</td> |
| </tr> |
| <tr> |
| <td>servicecomb.rest.client.http2.idleTimeoutInSeconds</td> |
| <td>2.0.1</td> |
| <td>0</td> |
| <td>HTTP2 连接闲置超时时间</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>请求超时配置</li> |
| </ul> |
| <p>可以针对每个具体的接口设置超时，配置项 <code>request.${op-any-priority}.timeout</code> ， 单位是毫秒，默认 30000。 举例：</p> |
| <pre><code> servicecomb.request.timeout=30000 |
| servicecomb.request.MyService.timeout=40000 |
| servicecomb.request.MyService.MySchema.MyOperation.timeout=50000 |
| </code></pre> |
| <ul> |
| <li>SSL 配置</li> |
| </ul> |
| <p>参考 <a href="../security/tls.html">使用TLS通信</a>。 tag 为 <code>rest.consumer</code>。</p> |
| <ul> |
| <li>Proxy 配置</li> |
| </ul> |
| <p>不支持。</p> |
| <p><strong>备注</strong>:</p> |
| <ol> |
| <li> |
| <p><a name="note1"></a> 如果CPU数小于8，则取CPU数。如果CPU数大于等于8，则为8。</p> |
| </li> |
| <li> |
| <p><a name="note2"></a> java-chassis 默认采用 vert.x 的 HTTP Client 功能，这个配置项对应的是 verticle instances 数量。 verticle instances 数量 |
| 会影响并发资源分配。比如： 如果 verticle instances 为 2， maxPoolSize 为 5， 那么实际创建的连接数为 2*5=10。</p> |
| </li> |
| </ol> |
| |
| </div> |
| </div><footer> |
| <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> |
| <a href="../featured-topics/performance.html" class="btn btn-neutral float-left" title="性能问题分析和调优"><span class="icon icon-circle-arrow-left"></span> Previous</a> |
| <a href="config-center-client.html" class="btn btn-neutral float-right" title="Config Center Client 配置项">Next <span class="icon icon-circle-arrow-right"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <!-- Copyright etc --> |
| </div> |
| |
| Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| <div class="rst-versions" role="note" aria-label="Versions"> |
| <span class="rst-current-version" data-toggle="rst-current-version"> |
| |
| |
| <span><a href="../featured-topics/performance.html" style="color: #fcfcfc">« Previous</a></span> |
| |
| |
| <span><a href="config-center-client.html" style="color: #fcfcfc">Next »</a></span> |
| |
| </span> |
| </div> |
| <script>var base_url = '..';</script> |
| <script src="../js/theme_extra.js" defer></script> |
| <script src="../js/theme.js" defer></script> |
| <script src="../search/main.js" defer></script> |
| <script defer> |
| window.onload = function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }; |
| </script> |
| |
| </body> |
| </html> |
