| <!doctype html><html lang=en class=no-js><head><meta name=ROBOTS content="INDEX, FOLLOW"><link rel=canonical href=https://cn.dubbo.apache.org/en/docs/v2.7/user/references/protocol/rest/><script>var _hmt=_hmt||[];(function(){var e,t=document.createElement("script");t.src="https://hm.baidu.com/hm.js?3b78f49ba47181e4d998a66b689446e9",e=document.getElementsByTagName("script")[0],e.parentNode.insertBefore(t,e)})()</script><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1,shrink-to-fit=no"><meta http-equiv=Content-Security-Policy content="frame-src *"><meta name=generator content="Hugo 0.122.0"><link rel="shortcut icon" type=image/png href=/imgs/favicon.png><link rel=apple-touch-icon href=/favicons/apple-touch-icon-180x180.png sizes=180x180><link rel=manifest href=/manifest.webmanifest><title>rest protocol | Apache Dubbo</title><meta property="og:title" content="rest protocol"> |
| <meta property="og:description" content="References documentation for rest protocol"><meta property="og:type" content="article"><meta property="og:url" content="https://cn.dubbo.apache.org/en/docs/v2.7/user/references/protocol/rest/"><meta property="article:section" content="docs"><meta property="article:modified_time" content="2020-12-22T13:19:33+08:00"><meta itemprop=name content="rest protocol"><meta itemprop=description content="References documentation for rest protocol"><meta itemprop=dateModified content="2020-12-22T13:19:33+08:00"><meta itemprop=wordCount content="930"><meta itemprop=keywords content><meta name=twitter:card content="summary"><meta name=twitter:title content="rest protocol"><meta name=twitter:description content="References documentation for rest protocol"><script async src="https://www.googletagmanager.com/gtag/js?id=G-NM6FFMT51J"></script><script>var doNotTrack=!1;if(!doNotTrack){window.dataLayer=window.dataLayer||[];function gtag(){dataLayer.push(arguments)}gtag("js",new Date),gtag("config","G-NM6FFMT51J",{anonymize_ip:!1})}</script><link rel=preload href=/scss/main.min.f77e221bcdbe0cadb996060fe82063c747b60c229a1f8bbf0ee529adbadd84fa.css as=style><link href=/scss/main.min.f77e221bcdbe0cadb996060fe82063c747b60c229a1f8bbf0ee529adbadd84fa.css rel=stylesheet integrity><script src=/js/jquery-3.5.1.min.js integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin=anonymous></script><meta name=theme-color content="#326ce5"><link rel=stylesheet href=/css/feature-states.css><meta name=description content="References documentation for rest protocol"><meta property="og:description" content="References documentation for rest protocol"><meta name=twitter:description content="References documentation for rest protocol"><meta property="og:url" content="https://cn.dubbo.apache.org/en/docs/v2.7/user/references/protocol/rest/"><meta property="og:title" content="rest protocol"><meta name=twitter:title content="rest protocol"><meta name=twitter:image:alt content="Apache Dubbo"><meta property="og:type" content="article"><meta name=viewport content="width=device-width"><script async defer src=/js/github-buttons.js></script><link href=/css/community.css rel=stylesheet><link href=/css/contactus.css rel=stylesheet><link href=/css/language.css rel=stylesheet><script src=/js/script.js></script></head><body class="td-page td-documentation"><header><nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar" data-auto-burger=primary><a class=navbar-brand href=/en/><span class=navbar-logo></span><span class="text-uppercase font-weight-bold">Apache Dubbo</span></a><div class="td-navbar-nav-scroll ml-md-auto" id=main_navbar><ul class="navbar-nav mt-2 mt-lg-0"><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=/en/overview/><span>Overview</span></a></li><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=/en/docs3-v2/><span>SDK Manual</span></a></li><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=/en/blog/><span>Blog</span></a></li><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=/en/download/><span>Download</span></a></li><li class="nav-item mr-4 mb-2 mb-lg-0"><a class=nav-link href=https://start.dubbo.apache.org/bootstrap.html target=_blank><span>Initializer</span><i class='fas fa-external-link-alt'></i></a></li><li class="nav-item dropdown d-lg-block"><a class="nav-link dropdown-toggle" href=# id=navbarDropdownMenuLink role=button data-toggle=dropdown aria-haspopup=true aria-expanded=false>English</a><div class="dropdown-menu dropdown-menu-right" aria-labelledby=navbarDropdownMenuLink><a class=dropdown-item href=/zh-cn/>中文</a></div></li><li class="nav-item dropdown d-lg-block"><div class="nav-item d-none d-lg-block"></div></li></ul></div></nav><section class="header-hero text-white pb-0 light-text"></section></header><div class="container-fluid td-outer"><div class=td-main><div class="row flex-md-nowrap"><div class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none"><script>$(function(){$("#td-section-nav a").removeClass("active"),$("#td-section-nav #m-endocsv27userreferencesprotocolrest").addClass("active"),$("#td-section-nav #m-endocsv27userreferencesprotocolrest-li span").addClass("td-sidebar-nav-active-item"),$("#td-section-nav #m-endocsv27userreferencesprotocolrest").parents("li").addClass("active-path"),$("#td-section-nav li.active-path").addClass("show"),$("#td-section-nav li.active-path").children("input").prop("checked",!0),$("#td-section-nav #m-endocsv27userreferencesprotocolrest-li").siblings("li").addClass("show"),$("#td-section-nav #m-endocsv27userreferencesprotocolrest-li").children("ul").children("li").addClass("show"),$("#td-sidebar-menu").toggleClass("d-none")})</script><div id=td-sidebar-menu class="td-sidebar__inner d-none"><div id=content-mobile><form class="td-sidebar__search d-flex align-items-center"><button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type=button data-toggle=collapse data-target=#td-section-nav aria-controls=td-docs-nav aria-expanded=false aria-label="Toggle section navigation"></button></form></div><div id=content-desktop></div><nav class="collapse td-sidebar-nav foldable-nav" id=td-section-nav><ul class="td-sidebar-nav__section pr-md-3 ul-0"><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocs-li><ul class=ul-1><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27-li><input type=checkbox id=m-endocsv27-check> |
| <label for=m-endocsv27-check><a href=/en/docs/v2.7/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27><span>Dubbo 2.7</span></a></label><ul class="ul-2 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27user-li><input type=checkbox id=m-endocsv27user-check> |
| <label for=m-endocsv27user-check><a href=/en/docs/v2.7/user/ title="User Documentation" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27user><span>User</span></a></label><ul class="ul-3 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27userpreface-li><input type=checkbox id=m-endocsv27userpreface-check> |
| <label for=m-endocsv27userpreface-check><a href=/en/docs/v2.7/user/preface/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27userpreface><span>Preface</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userprefacebackground-li><input type=checkbox id=m-endocsv27userprefacebackground-check> |
| <label for=m-endocsv27userprefacebackground-check><a href=/en/docs/v2.7/user/preface/background/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userprefacebackground><span>Background</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userprefacerequirements-li><input type=checkbox id=m-endocsv27userprefacerequirements-check> |
| <label for=m-endocsv27userprefacerequirements-check><a href=/en/docs/v2.7/user/preface/requirements/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userprefacerequirements><span>Requirements</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userprefacearchitecture-li><input type=checkbox id=m-endocsv27userprefacearchitecture-check> |
| <label for=m-endocsv27userprefacearchitecture-check><a href=/en/docs/v2.7/user/preface/architecture/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userprefacearchitecture><span>Architecture</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userprefaceusage-li><input type=checkbox id=m-endocsv27userprefaceusage-check> |
| <label for=m-endocsv27userprefaceusage-check><a href=/en/docs/v2.7/user/preface/usage/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userprefaceusage><span>Usage</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userquick-start-li><input type=checkbox id=m-endocsv27userquick-start-check> |
| <label for=m-endocsv27userquick-start-check><a href=/en/docs/v2.7/user/quick-start/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userquick-start><span>Quick start</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userdependencies-li><input type=checkbox id=m-endocsv27userdependencies-check> |
| <label for=m-endocsv27userdependencies-check><a href=/en/docs/v2.7/user/dependencies/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userdependencies><span>Dependencies</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27usermaturity-li><input type=checkbox id=m-endocsv27usermaturity-check> |
| <label for=m-endocsv27usermaturity-check><a href=/en/docs/v2.7/user/maturity/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27usermaturity><span>Maturity</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27userconfiguration-li><input type=checkbox id=m-endocsv27userconfiguration-check> |
| <label for=m-endocsv27userconfiguration-check><a href=/en/docs/v2.7/user/configuration/ title="Dubbo Configuration" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27userconfiguration><span>Configuration</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userconfigurationxml-li><input type=checkbox id=m-endocsv27userconfigurationxml-check> |
| <label for=m-endocsv27userconfigurationxml-check><a href=/en/docs/v2.7/user/configuration/xml/ title="XML Configuration" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userconfigurationxml><span>XML</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userconfigurationproperties-li><input type=checkbox id=m-endocsv27userconfigurationproperties-check> |
| <label for=m-endocsv27userconfigurationproperties-check><a href=/en/docs/v2.7/user/configuration/properties/ title="Properties Configuration" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userconfigurationproperties><span>Properties</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userconfigurationapi-li><input type=checkbox id=m-endocsv27userconfigurationapi-check> |
| <label for=m-endocsv27userconfigurationapi-check><a href=/en/docs/v2.7/user/configuration/api/ title="API Configuration" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userconfigurationapi><span>API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userconfigurationannotation-li><input type=checkbox id=m-endocsv27userconfigurationannotation-check> |
| <label for=m-endocsv27userconfigurationannotation-check><a href=/en/docs/v2.7/user/configuration/annotation/ title="Annotation Configuration" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userconfigurationannotation><span>Annotation</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userconfigurationconfiguration-load-process-li><input type=checkbox id=m-endocsv27userconfigurationconfiguration-load-process-check> |
| <label for=m-endocsv27userconfigurationconfiguration-load-process-check><a href=/en/docs/v2.7/user/configuration/configuration-load-process/ title="Configuration Loading Process" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userconfigurationconfiguration-load-process><span>Loading Process</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27userexamples-li><input type=checkbox id=m-endocsv27userexamples-check> |
| <label for=m-endocsv27userexamples-check><a href=/en/docs/v2.7/user/examples/ title="Dubbo Examples" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27userexamples><span>Examples</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplespreflight-check-li><input type=checkbox id=m-endocsv27userexamplespreflight-check-check> |
| <label for=m-endocsv27userexamplespreflight-check-check><a href=/en/docs/v2.7/user/examples/preflight-check/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplespreflight-check><span>Preflight Check</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesfault-tolerent-strategy-li><input type=checkbox id=m-endocsv27userexamplesfault-tolerent-strategy-check> |
| <label for=m-endocsv27userexamplesfault-tolerent-strategy-check><a href=/en/docs/v2.7/user/examples/fault-tolerent-strategy/ title="Fault Tolerance Strategy" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesfault-tolerent-strategy><span>Fault Tolerance</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesloadbalance-li><input type=checkbox id=m-endocsv27userexamplesloadbalance-check> |
| <label for=m-endocsv27userexamplesloadbalance-check><a href=/en/docs/v2.7/user/examples/loadbalance/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesloadbalance><span>Load Balance</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesthread-model-li><input type=checkbox id=m-endocsv27userexamplesthread-model-check> |
| <label for=m-endocsv27userexamplesthread-model-check><a href=/en/docs/v2.7/user/examples/thread-model/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesthread-model><span>Thread Model</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesexplicit-target-li><input type=checkbox id=m-endocsv27userexamplesexplicit-target-check> |
| <label for=m-endocsv27userexamplesexplicit-target-check><a href=/en/docs/v2.7/user/examples/explicit-target/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesexplicit-target><span>Explicit Target</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplessubscribe-only-li><input type=checkbox id=m-endocsv27userexamplessubscribe-only-check> |
| <label for=m-endocsv27userexamplessubscribe-only-check><a href=/en/docs/v2.7/user/examples/subscribe-only/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplessubscribe-only><span>Subscribe Only</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesmulti-protocols-li><input type=checkbox id=m-endocsv27userexamplesmulti-protocols-check> |
| <label for=m-endocsv27userexamplesmulti-protocols-check><a href=/en/docs/v2.7/user/examples/multi-protocols/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesmulti-protocols><span>Multiple Protocols</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesmulti-registry-li><input type=checkbox id=m-endocsv27userexamplesmulti-registry-check> |
| <label for=m-endocsv27userexamplesmulti-registry-check><a href=/en/docs/v2.7/user/examples/multi-registry/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesmulti-registry><span>Multiple Registries</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesservice-group-li><input type=checkbox id=m-endocsv27userexamplesservice-group-check> |
| <label for=m-endocsv27userexamplesservice-group-check><a href=/en/docs/v2.7/user/examples/service-group/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesservice-group><span>Service Group</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesstatic-service-li><input type=checkbox id=m-endocsv27userexamplesstatic-service-check> |
| <label for=m-endocsv27userexamplesstatic-service-check><a href=/en/docs/v2.7/user/examples/static-service/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesstatic-service><span>Static Service</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesmulti-versions-li><input type=checkbox id=m-endocsv27userexamplesmulti-versions-check> |
| <label for=m-endocsv27userexamplesmulti-versions-check><a href=/en/docs/v2.7/user/examples/multi-versions/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesmulti-versions><span>Multiple Versions</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesgroup-merger-li><input type=checkbox id=m-endocsv27userexamplesgroup-merger-check> |
| <label for=m-endocsv27userexamplesgroup-merger-check><a href=/en/docs/v2.7/user/examples/group-merger/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesgroup-merger><span>Group Merger</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesparameter-validation-li><input type=checkbox id=m-endocsv27userexamplesparameter-validation-check> |
| <label for=m-endocsv27userexamplesparameter-validation-check><a href=/en/docs/v2.7/user/examples/parameter-validation/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesparameter-validation><span>Parameter Validation</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesresult-cache-li><input type=checkbox id=m-endocsv27userexamplesresult-cache-check> |
| <label for=m-endocsv27userexamplesresult-cache-check><a href=/en/docs/v2.7/user/examples/result-cache/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesresult-cache><span>Cache Result</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesbroadcast-resp-collect-li><input type=checkbox id=m-endocsv27userexamplesbroadcast-resp-collect-check> |
| <label for=m-endocsv27userexamplesbroadcast-resp-collect-check><a href=/en/docs/v2.7/user/examples/broadcast-resp-collect/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesbroadcast-resp-collect><span>Collect Broadcast Responses</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesgeneric-invoke-with-json-li><input type=checkbox id=m-endocsv27userexamplesgeneric-invoke-with-json-check> |
| <label for=m-endocsv27userexamplesgeneric-invoke-with-json-check><a href=/en/docs/v2.7/user/examples/generic-invoke-with-json/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesgeneric-invoke-with-json><span>json generic invoke</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesmsgpack-serialization-li><input type=checkbox id=m-endocsv27userexamplesmsgpack-serialization-check> |
| <label for=m-endocsv27userexamplesmsgpack-serialization-check><a href=/en/docs/v2.7/user/examples/msgpack-serialization/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesmsgpack-serialization><span>msgpack serialization</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesprovider-timeout-release-li><input type=checkbox id=m-endocsv27userexamplesprovider-timeout-release-check> |
| <label for=m-endocsv27userexamplesprovider-timeout-release-check><a href=/en/docs/v2.7/user/examples/provider-timeout-release/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesprovider-timeout-release><span>provider timeout release</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesinvoke-with-specified-ip-li><input type=checkbox id=m-endocsv27userexamplesinvoke-with-specified-ip-check> |
| <label for=m-endocsv27userexamplesinvoke-with-specified-ip-check><a href=/en/docs/v2.7/user/examples/invoke-with-specified-ip/ title="Invoke provider with specified IP port" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesinvoke-with-specified-ip><span>Specified IP port</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesgeneric-reference-li><input type=checkbox id=m-endocsv27userexamplesgeneric-reference-check> |
| <label for=m-endocsv27userexamplesgeneric-reference-check><a href=/en/docs/v2.7/user/examples/generic-reference/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesgeneric-reference><span>Generic Reference</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesgeneric-service-li><input type=checkbox id=m-endocsv27userexamplesgeneric-service-check> |
| <label for=m-endocsv27userexamplesgeneric-service-check><a href=/en/docs/v2.7/user/examples/generic-service/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesgeneric-service><span>Generic Service</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesecho-service-li><input type=checkbox id=m-endocsv27userexamplesecho-service-check> |
| <label for=m-endocsv27userexamplesecho-service-check><a href=/en/docs/v2.7/user/examples/echo-service/ title="Echo Testing Service" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesecho-service><span>Echo Service</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplescontext-li><input type=checkbox id=m-endocsv27userexamplescontext-check> |
| <label for=m-endocsv27userexamplescontext-check><a href=/en/docs/v2.7/user/examples/context/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplescontext><span>Context</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesattachment-li><input type=checkbox id=m-endocsv27userexamplesattachment-check> |
| <label for=m-endocsv27userexamplesattachment-check><a href=/en/docs/v2.7/user/examples/attachment/ title="Implicit parameters" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesattachment><span>Attachment</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesasync-call-li><input type=checkbox id=m-endocsv27userexamplesasync-call-check> |
| <label for=m-endocsv27userexamplesasync-call-check><a href=/en/docs/v2.7/user/examples/async-call/ title="Asynchronous Call" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesasync-call><span>Async Call</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesasync-execute-on-provider-li><input type=checkbox id=m-endocsv27userexamplesasync-execute-on-provider-check> |
| <label for=m-endocsv27userexamplesasync-execute-on-provider-check><a href=/en/docs/v2.7/user/examples/async-execute-on-provider/ title="Asynchronous Execution" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesasync-execute-on-provider><span>Async Execution</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexampleslocal-call-li><input type=checkbox id=m-endocsv27userexampleslocal-call-check> |
| <label for=m-endocsv27userexampleslocal-call-check><a href=/en/docs/v2.7/user/examples/local-call/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexampleslocal-call><span>Local Call</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplescallback-parameter-li><input type=checkbox id=m-endocsv27userexamplescallback-parameter-check> |
| <label for=m-endocsv27userexamplescallback-parameter-check><a href=/en/docs/v2.7/user/examples/callback-parameter/ title="Callback parameter" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplescallback-parameter><span>Callback</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesevents-notify-li><input type=checkbox id=m-endocsv27userexamplesevents-notify-check> |
| <label for=m-endocsv27userexamplesevents-notify-check><a href=/en/docs/v2.7/user/examples/events-notify/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesevents-notify><span>Event Notification</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexampleslocal-stub-li><input type=checkbox id=m-endocsv27userexampleslocal-stub-check> |
| <label for=m-endocsv27userexampleslocal-stub-check><a href=/en/docs/v2.7/user/examples/local-stub/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexampleslocal-stub><span>Local Stub</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexampleslocal-mock-li><input type=checkbox id=m-endocsv27userexampleslocal-mock-check> |
| <label for=m-endocsv27userexampleslocal-mock-check><a href=/en/docs/v2.7/user/examples/local-mock/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexampleslocal-mock><span>Local Mock</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesdelay-publish-li><input type=checkbox id=m-endocsv27userexamplesdelay-publish-check> |
| <label for=m-endocsv27userexamplesdelay-publish-check><a href=/en/docs/v2.7/user/examples/delay-publish/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesdelay-publish><span>Delay Publish</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesconcurrency-control-li><input type=checkbox id=m-endocsv27userexamplesconcurrency-control-check> |
| <label for=m-endocsv27userexamplesconcurrency-control-check><a href=/en/docs/v2.7/user/examples/concurrency-control/ title="Concurrency Control" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesconcurrency-control><span>Concurrency</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesconfig-connections-li><input type=checkbox id=m-endocsv27userexamplesconfig-connections-check> |
| <label for=m-endocsv27userexamplesconfig-connections-check><a href=/en/docs/v2.7/user/examples/config-connections/ title="Config connections" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesconfig-connections><span>Connection</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexampleslazy-connect-li><input type=checkbox id=m-endocsv27userexampleslazy-connect-check> |
| <label for=m-endocsv27userexampleslazy-connect-check><a href=/en/docs/v2.7/user/examples/lazy-connect/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexampleslazy-connect><span>Lazy Connect</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesstickiness-li><input type=checkbox id=m-endocsv27userexamplesstickiness-check> |
| <label for=m-endocsv27userexamplesstickiness-check><a href=/en/docs/v2.7/user/examples/stickiness/ title="Stickiness Connection" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesstickiness><span>Stickiness</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplestoken-authorization-li><input type=checkbox id=m-endocsv27userexamplestoken-authorization-check> |
| <label for=m-endocsv27userexamplestoken-authorization-check><a href=/en/docs/v2.7/user/examples/token-authorization/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplestoken-authorization><span>Token Authorization</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesrouting-rule-li><input type=checkbox id=m-endocsv27userexamplesrouting-rule-check> |
| <label for=m-endocsv27userexamplesrouting-rule-check><a href=/en/docs/v2.7/user/examples/routing-rule/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesrouting-rule><span>Routing Rule</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesconfig-rule-li><input type=checkbox id=m-endocsv27userexamplesconfig-rule-check> |
| <label for=m-endocsv27userexamplesconfig-rule-check><a href=/en/docs/v2.7/user/examples/config-rule/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesconfig-rule><span>Configure rule</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesservice-downgrade-li><input type=checkbox id=m-endocsv27userexamplesservice-downgrade-check> |
| <label for=m-endocsv27userexamplesservice-downgrade-check><a href=/en/docs/v2.7/user/examples/service-downgrade/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesservice-downgrade><span>Service Downgrade</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesgraceful-shutdown-li><input type=checkbox id=m-endocsv27userexamplesgraceful-shutdown-check> |
| <label for=m-endocsv27userexamplesgraceful-shutdown-check><a href=/en/docs/v2.7/user/examples/graceful-shutdown/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesgraceful-shutdown><span>Graceful Shutdown</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexampleshostname-binding-li><input type=checkbox id=m-endocsv27userexampleshostname-binding-check> |
| <label for=m-endocsv27userexampleshostname-binding-check><a href=/en/docs/v2.7/user/examples/hostname-binding/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexampleshostname-binding><span>Hostname Binding</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexampleslogger-strategy-li><input type=checkbox id=m-endocsv27userexampleslogger-strategy-check> |
| <label for=m-endocsv27userexampleslogger-strategy-check><a href=/en/docs/v2.7/user/examples/logger-strategy/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexampleslogger-strategy><span>Logger Strategy</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesaccesslog-li><input type=checkbox id=m-endocsv27userexamplesaccesslog-check> |
| <label for=m-endocsv27userexamplesaccesslog-check><a href=/en/docs/v2.7/user/examples/accesslog/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesaccesslog><span>Access Log</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesservice-container-li><input type=checkbox id=m-endocsv27userexamplesservice-container-check> |
| <label for=m-endocsv27userexamplesservice-container-check><a href=/en/docs/v2.7/user/examples/service-container/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesservice-container><span>Service Container</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesreference-config-cache-li><input type=checkbox id=m-endocsv27userexamplesreference-config-cache-check> |
| <label for=m-endocsv27userexamplesreference-config-cache-check><a href=/en/docs/v2.7/user/examples/reference-config-cache/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesreference-config-cache><span>ReferenceConfig Cache</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesregistry-only-li><input type=checkbox id=m-endocsv27userexamplesregistry-only-check> |
| <label for=m-endocsv27userexamplesregistry-only-check><a href=/en/docs/v2.7/user/examples/registry-only/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesregistry-only><span>Register Only</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesdistributed-transaction-li><input type=checkbox id=m-endocsv27userexamplesdistributed-transaction-check> |
| <label for=m-endocsv27userexamplesdistributed-transaction-check><a href=/en/docs/v2.7/user/examples/distributed-transaction/ title="Distributed transaction" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesdistributed-transaction><span>Transaction</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesdump-li><input type=checkbox id=m-endocsv27userexamplesdump-check> |
| <label for=m-endocsv27userexamplesdump-check><a href=/en/docs/v2.7/user/examples/dump/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesdump><span>Thread Dump</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userexamplesnetty4-li><input type=checkbox id=m-endocsv27userexamplesnetty4-check> |
| <label for=m-endocsv27userexamplesnetty4-check><a href=/en/docs/v2.7/user/examples/netty4/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userexamplesnetty4><span>Netty4</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27userreferences-li><input type=checkbox id=m-endocsv27userreferences-check> |
| <label for=m-endocsv27userreferences-check><a href=/en/docs/v2.7/user/references/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27userreferences><span>References</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27userreferencesxml-li><input type=checkbox id=m-endocsv27userreferencesxml-check> |
| <label for=m-endocsv27userreferencesxml-check><a href=/en/docs/v2.7/user/references/xml/ title="Schema Configuration Reference" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27userreferencesxml><span>XML</span></a></label><ul class="ul-5 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-application-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-application-check> |
| <label for=m-endocsv27userreferencesxmldubbo-application-check><a href=/en/docs/v2.7/user/references/xml/dubbo-application/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-application><span>dubbo:application</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-argument-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-argument-check> |
| <label for=m-endocsv27userreferencesxmldubbo-argument-check><a href=/en/docs/v2.7/user/references/xml/dubbo-argument/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-argument><span>dubbo:argument</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-config-center-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-config-center-check> |
| <label for=m-endocsv27userreferencesxmldubbo-config-center-check><a href=/en/docs/v2.7/user/references/xml/dubbo-config-center/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-config-center><span>dubbo:config-center</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-consumer-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-consumer-check> |
| <label for=m-endocsv27userreferencesxmldubbo-consumer-check><a href=/en/docs/v2.7/user/references/xml/dubbo-consumer/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-consumer><span>dubbo:consumer</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-method-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-method-check> |
| <label for=m-endocsv27userreferencesxmldubbo-method-check><a href=/en/docs/v2.7/user/references/xml/dubbo-method/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-method><span>dubbo:method</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-module-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-module-check> |
| <label for=m-endocsv27userreferencesxmldubbo-module-check><a href=/en/docs/v2.7/user/references/xml/dubbo-module/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-module><span>dubbo:module</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-monitor-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-monitor-check> |
| <label for=m-endocsv27userreferencesxmldubbo-monitor-check><a href=/en/docs/v2.7/user/references/xml/dubbo-monitor/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-monitor><span>dubbo:monitor</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-parameter-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-parameter-check> |
| <label for=m-endocsv27userreferencesxmldubbo-parameter-check><a href=/en/docs/v2.7/user/references/xml/dubbo-parameter/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-parameter><span>dubbo:parameter</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-protocol-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-protocol-check> |
| <label for=m-endocsv27userreferencesxmldubbo-protocol-check><a href=/en/docs/v2.7/user/references/xml/dubbo-protocol/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-protocol><span>dubbo:protocol</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-provider-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-provider-check> |
| <label for=m-endocsv27userreferencesxmldubbo-provider-check><a href=/en/docs/v2.7/user/references/xml/dubbo-provider/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-provider><span>dubbo:provider</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-reference-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-reference-check> |
| <label for=m-endocsv27userreferencesxmldubbo-reference-check><a href=/en/docs/v2.7/user/references/xml/dubbo-reference/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-reference><span>dubbo:reference</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-registry-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-registry-check> |
| <label for=m-endocsv27userreferencesxmldubbo-registry-check><a href=/en/docs/v2.7/user/references/xml/dubbo-registry/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-registry><span>dubbo:registry</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesxmldubbo-service-li><input type=checkbox id=m-endocsv27userreferencesxmldubbo-service-check> |
| <label for=m-endocsv27userreferencesxmldubbo-service-check><a href=/en/docs/v2.7/user/references/xml/dubbo-service/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesxmldubbo-service><span>dubbo:service</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27userreferencesprotocol-li><input type=checkbox id=m-endocsv27userreferencesprotocol-check> |
| <label for=m-endocsv27userreferencesprotocol-check><a href=/en/docs/v2.7/user/references/protocol/ title="Protocol References" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27userreferencesprotocol><span>Protocol</span></a></label><ul class="ul-5 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesprotocoldubbo-li><input type=checkbox id=m-endocsv27userreferencesprotocoldubbo-check> |
| <label for=m-endocsv27userreferencesprotocoldubbo-check><a href=/en/docs/v2.7/user/references/protocol/dubbo/ title="dubbo protocol" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesprotocoldubbo><span>dubbo://</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesprotocolrest-li><input type=checkbox id=m-endocsv27userreferencesprotocolrest-check> |
| <label for=m-endocsv27userreferencesprotocolrest-check><a href=/en/docs/v2.7/user/references/protocol/rest/ title="rest protocol" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesprotocolrest><span>rest://</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesprotocolhttp-li><input type=checkbox id=m-endocsv27userreferencesprotocolhttp-check> |
| <label for=m-endocsv27userreferencesprotocolhttp-check><a href=/en/docs/v2.7/user/references/protocol/http/ title="http protocol" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesprotocolhttp><span>http://</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesprotocolhessian-li><input type=checkbox id=m-endocsv27userreferencesprotocolhessian-check> |
| <label for=m-endocsv27userreferencesprotocolhessian-check><a href=/en/docs/v2.7/user/references/protocol/hessian/ title="hessian protocol" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesprotocolhessian><span>hessian://</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesprotocolredis-li><input type=checkbox id=m-endocsv27userreferencesprotocolredis-check> |
| <label for=m-endocsv27userreferencesprotocolredis-check><a href=/en/docs/v2.7/user/references/protocol/redis/ title="redis protocol" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesprotocolredis><span>redis://</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesprotocolthrift-li><input type=checkbox id=m-endocsv27userreferencesprotocolthrift-check> |
| <label for=m-endocsv27userreferencesprotocolthrift-check><a href=/en/docs/v2.7/user/references/protocol/thrift/ title="thrift protocol" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesprotocolthrift><span>thrift://</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesprotocolmemcached-li><input type=checkbox id=m-endocsv27userreferencesprotocolmemcached-check> |
| <label for=m-endocsv27userreferencesprotocolmemcached-check><a href=/en/docs/v2.7/user/references/protocol/memcached/ title="memcached protocol" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesprotocolmemcached><span>memcached://</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesprotocolrmi-li><input type=checkbox id=m-endocsv27userreferencesprotocolrmi-check> |
| <label for=m-endocsv27userreferencesprotocolrmi-check><a href=/en/docs/v2.7/user/references/protocol/rmi/ title="rmi protocol" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesprotocolrmi><span>rmi://</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesprotocolwebservice-li><input type=checkbox id=m-endocsv27userreferencesprotocolwebservice-check> |
| <label for=m-endocsv27userreferencesprotocolwebservice-check><a href=/en/docs/v2.7/user/references/protocol/webservice/ title="webservice protocol" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesprotocolwebservice><span>webservice://</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27userreferencesregistry-li><input type=checkbox id=m-endocsv27userreferencesregistry-check> |
| <label for=m-endocsv27userreferencesregistry-check><a href=/en/docs/v2.7/user/references/registry/ title="Registry Server References" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27userreferencesregistry><span>Registry Server</span></a></label><ul class="ul-5 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesregistrynacos-li><input type=checkbox id=m-endocsv27userreferencesregistrynacos-check> |
| <label for=m-endocsv27userreferencesregistrynacos-check><a href=/en/docs/v2.7/user/references/registry/nacos/ title="Nacos Registry Center" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesregistrynacos><span>Nacos</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesregistryzookeeper-li><input type=checkbox id=m-endocsv27userreferencesregistryzookeeper-check> |
| <label for=m-endocsv27userreferencesregistryzookeeper-check><a href=/en/docs/v2.7/user/references/registry/zookeeper/ title="Zookeeper Registry Server" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesregistryzookeeper><span>Zookeeper</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesregistrymulticast-li><input type=checkbox id=m-endocsv27userreferencesregistrymulticast-check> |
| <label for=m-endocsv27userreferencesregistrymulticast-check><a href=/en/docs/v2.7/user/references/registry/multicast/ title="Multicast Registry" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesregistrymulticast><span>Multicast</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesregistryredis-li><input type=checkbox id=m-endocsv27userreferencesregistryredis-check> |
| <label for=m-endocsv27userreferencesregistryredis-check><a href=/en/docs/v2.7/user/references/registry/redis/ title="Redis Registry Server" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesregistryredis><span>Redis</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesregistrysimple-li><input type=checkbox id=m-endocsv27userreferencesregistrysimple-check> |
| <label for=m-endocsv27userreferencesregistrysimple-check><a href=/en/docs/v2.7/user/references/registry/simple/ title="Simple Registry Server" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesregistrysimple><span>Simple</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesmetadata-li><input type=checkbox id=m-endocsv27userreferencesmetadata-check> |
| <label for=m-endocsv27userreferencesmetadata-check><a href=/en/docs/v2.7/user/references/metadata/ title="Metadata Reference" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesmetadata><span>Metadata</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesapi-li><input type=checkbox id=m-endocsv27userreferencesapi-check> |
| <label for=m-endocsv27userreferencesapi-check><a href=/en/docs/v2.7/user/references/api/ title="API Reference" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesapi><span>API</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesqos-li><input type=checkbox id=m-endocsv27userreferencesqos-check> |
| <label for=m-endocsv27userreferencesqos-check><a href=/en/docs/v2.7/user/references/qos/ title="Qos Command Usage " class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesqos><span>Qos</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencestelnet-li><input type=checkbox id=m-endocsv27userreferencestelnet-check> |
| <label for=m-endocsv27userreferencestelnet-check><a href=/en/docs/v2.7/user/references/telnet/ title="Telnet Command Reference" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencestelnet><span>Telnet</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userreferencesmaven-li><input type=checkbox id=m-endocsv27userreferencesmaven-check> |
| <label for=m-endocsv27userreferencesmaven-check><a href=/en/docs/v2.7/user/references/maven/ title="Maven Plugin Reference" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userreferencesmaven><span>Maven</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userbest-practice-li><input type=checkbox id=m-endocsv27userbest-practice-check> |
| <label for=m-endocsv27userbest-practice-check><a href=/en/docs/v2.7/user/best-practice/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userbest-practice><span>Best practice</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userrecommend-li><input type=checkbox id=m-endocsv27userrecommend-check> |
| <label for=m-endocsv27userrecommend-check><a href=/en/docs/v2.7/user/recommend/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userrecommend><span>Recommended usage</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27usercapacity-plan-li><input type=checkbox id=m-endocsv27usercapacity-plan-check> |
| <label for=m-endocsv27usercapacity-plan-check><a href=/en/docs/v2.7/user/capacity-plan/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27usercapacity-plan><span>Capacity plan</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userperf-test-li><input type=checkbox id=m-endocsv27userperf-test-check> |
| <label for=m-endocsv27userperf-test-check><a href=/en/docs/v2.7/user/perf-test/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userperf-test><span>Performance</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27usercoveragence-li><input type=checkbox id=m-endocsv27usercoveragence-check> |
| <label for=m-endocsv27usercoveragence-check><a href=/en/docs/v2.7/user/coveragence/ title="Test coverage report" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27usercoveragence><span>Test coverage</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userbenchmark-tool-li><input type=checkbox id=m-endocsv27userbenchmark-tool-check> |
| <label for=m-endocsv27userbenchmark-tool-check><a href=/en/docs/v2.7/user/benchmark-tool/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userbenchmark-tool><span>Benchmark Suite</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userrest-li><input type=checkbox id=m-endocsv27userrest-check> |
| <label for=m-endocsv27userrest-check><a href=/en/docs/v2.7/user/rest/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userrest><span>REST support</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27usersimple-monitor-li><input type=checkbox id=m-endocsv27usersimple-monitor-check> |
| <label for=m-endocsv27usersimple-monitor-check><a href=/en/docs/v2.7/user/simple-monitor/ title="Simple Monitor" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27usersimple-monitor><span>Simple monitor</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27userlanguages-li><input type=checkbox id=m-endocsv27userlanguages-check> |
| <label for=m-endocsv27userlanguages-check><a href=/en/docs/v2.7/user/languages/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27userlanguages><span>Other Languages</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27userlanguageserlang-li><input type=checkbox id=m-endocsv27userlanguageserlang-check> |
| <label for=m-endocsv27userlanguageserlang-check><a href=/en/docs/v2.7/user/languages/erlang/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27userlanguageserlang><span>Erlang</span></a></label><ul class="ul-5 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userlanguageserlangquick-start-li><input type=checkbox id=m-endocsv27userlanguageserlangquick-start-check> |
| <label for=m-endocsv27userlanguageserlangquick-start-check><a href=/en/docs/v2.7/user/languages/erlang/quick-start/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userlanguageserlangquick-start><span>Quick Start</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userlanguageserlangreference-li><input type=checkbox id=m-endocsv27userlanguageserlangreference-check> |
| <label for=m-endocsv27userlanguageserlangreference-check><a href=/en/docs/v2.7/user/languages/erlang/reference/ title="Consumer Configuration" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userlanguageserlangreference><span>Consumer</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userlanguageserlangservice-li><input type=checkbox id=m-endocsv27userlanguageserlangservice-check> |
| <label for=m-endocsv27userlanguageserlangservice-check><a href=/en/docs/v2.7/user/languages/erlang/service/ title="Provider Configuration" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userlanguageserlangservice><span>Provider</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27userlanguageserlangserialization-li><input type=checkbox id=m-endocsv27userlanguageserlangserialization-check> |
| <label for=m-endocsv27userlanguageserlangserialization-check><a href=/en/docs/v2.7/user/languages/erlang/serialization/ title="Protocol Configuration" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27userlanguageserlangserialization><span>Protocol</span></a></label></li></ul></li></ul></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27dev-li><input type=checkbox id=m-endocsv27dev-check> |
| <label for=m-endocsv27dev-check><a href=/en/docs/v2.7/dev/ title="Dubbo Developer Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27dev><span>Developer</span></a></label><ul class="ul-3 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devbuild-li><input type=checkbox id=m-endocsv27devbuild-check> |
| <label for=m-endocsv27devbuild-check><a href=/en/docs/v2.7/dev/build/ title="Source Code Build" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devbuild><span>Build</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devdesign-li><input type=checkbox id=m-endocsv27devdesign-check> |
| <label for=m-endocsv27devdesign-check><a href=/en/docs/v2.7/dev/design/ title="Framework Design" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devdesign><span>Design</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devspi-li><input type=checkbox id=m-endocsv27devspi-check> |
| <label for=m-endocsv27devspi-check><a href=/en/docs/v2.7/dev/spi/ title="SPI Loading" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devspi><span>SPI</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplementation-li><input type=checkbox id=m-endocsv27devimplementation-check> |
| <label for=m-endocsv27devimplementation-check><a href=/en/docs/v2.7/dev/implementation/ title="Implementation details" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplementation><span>Implementation</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27devprincipals-li><input type=checkbox id=m-endocsv27devprincipals-check> |
| <label for=m-endocsv27devprincipals-check><a href=/en/docs/v2.7/dev/principals/ title="Dubbo Design Principals" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27devprincipals><span>Design Principals</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devprincipalscode-detail-li><input type=checkbox id=m-endocsv27devprincipalscode-detail-check> |
| <label for=m-endocsv27devprincipalscode-detail-check><a href=/en/docs/v2.7/dev/principals/code-detail/ title="The Devil Is In The Details" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devprincipalscode-detail><span>Details</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devprincipalsconfiguration-li><input type=checkbox id=m-endocsv27devprincipalsconfiguration-check> |
| <label for=m-endocsv27devprincipalsconfiguration-check><a href=/en/docs/v2.7/dev/principals/configuration/ title="The Configuration Design" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devprincipalsconfiguration><span>Configuration</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devprincipalsdummy-li><input type=checkbox id=m-endocsv27devprincipalsdummy-check> |
| <label for=m-endocsv27devprincipalsdummy-check><a href=/en/docs/v2.7/dev/principals/dummy/ title=' "Fool-proof" Design' class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devprincipalsdummy><span>Fool-proof</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devprincipalsexpansibility-li><input type=checkbox id=m-endocsv27devprincipalsexpansibility-check> |
| <label for=m-endocsv27devprincipalsexpansibility-check><a href=/en/docs/v2.7/dev/principals/expansibility/ title="Talk About Expansion Of Extension And Incremental Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devprincipalsexpansibility><span>Extensibility</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devprincipalsextension-li><input type=checkbox id=m-endocsv27devprincipalsextension-check> |
| <label for=m-endocsv27devprincipalsextension-check><a href=/en/docs/v2.7/dev/principals/extension/ title="Extension Points To Reconstruct" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devprincipalsextension><span>Extension</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devprincipalsgeneral-knowledge-li><input type=checkbox id=m-endocsv27devprincipalsgeneral-knowledge-check> |
| <label for=m-endocsv27devprincipalsgeneral-knowledge-check><a href=/en/docs/v2.7/dev/principals/general-knowledge/ title="Some In The Design Of The Basic Common Sense" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devprincipalsgeneral-knowledge><span>General Rule</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devprincipalsrobustness-li><input type=checkbox id=m-endocsv27devprincipalsrobustness-check> |
| <label for=m-endocsv27devprincipalsrobustness-check><a href=/en/docs/v2.7/dev/principals/robustness/ title="The Robustness Of The Design Implementation" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devprincipalsrobustness><span>Robustness</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27devimpls-li><input type=checkbox id=m-endocsv27devimpls-check> |
| <label for=m-endocsv27devimpls-check><a href=/en/docs/v2.7/dev/impls/ title="SPI Extension Implementations" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27devimpls><span>SPI Impls</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsprotocol-li><input type=checkbox id=m-endocsv27devimplsprotocol-check> |
| <label for=m-endocsv27devimplsprotocol-check><a href=/en/docs/v2.7/dev/impls/protocol/ title="Protocol Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsprotocol><span>Protocol</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsfilter-li><input type=checkbox id=m-endocsv27devimplsfilter-check> |
| <label for=m-endocsv27devimplsfilter-check><a href=/en/docs/v2.7/dev/impls/filter/ title="Filter Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsfilter><span>Filter</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsinvoker-listener-li><input type=checkbox id=m-endocsv27devimplsinvoker-listener-check> |
| <label for=m-endocsv27devimplsinvoker-listener-check><a href=/en/docs/v2.7/dev/impls/invoker-listener/ title="InvokerListener Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsinvoker-listener><span>InvokerListener</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsexporter-listener-li><input type=checkbox id=m-endocsv27devimplsexporter-listener-check> |
| <label for=m-endocsv27devimplsexporter-listener-check><a href=/en/docs/v2.7/dev/impls/exporter-listener/ title="ExporterListener Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsexporter-listener><span>ExporterListener</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplscluster-li><input type=checkbox id=m-endocsv27devimplscluster-check> |
| <label for=m-endocsv27devimplscluster-check><a href=/en/docs/v2.7/dev/impls/cluster/ title="Cluster Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplscluster><span>Cluster</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsrouter-li><input type=checkbox id=m-endocsv27devimplsrouter-check> |
| <label for=m-endocsv27devimplsrouter-check><a href=/en/docs/v2.7/dev/impls/router/ title="Router Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsrouter><span>Router</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsload-balance-li><input type=checkbox id=m-endocsv27devimplsload-balance-check> |
| <label for=m-endocsv27devimplsload-balance-check><a href=/en/docs/v2.7/dev/impls/load-balance/ title="LoadBalance Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsload-balance><span>LoadBalance</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsmerger-li><input type=checkbox id=m-endocsv27devimplsmerger-check> |
| <label for=m-endocsv27devimplsmerger-check><a href=/en/docs/v2.7/dev/impls/merger/ title="Merger Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsmerger><span>Merger</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsregistry-li><input type=checkbox id=m-endocsv27devimplsregistry-check> |
| <label for=m-endocsv27devimplsregistry-check><a href=/en/docs/v2.7/dev/impls/registry/ title="Registry Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsregistry><span>Registry</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsmonitor-li><input type=checkbox id=m-endocsv27devimplsmonitor-check> |
| <label for=m-endocsv27devimplsmonitor-check><a href=/en/docs/v2.7/dev/impls/monitor/ title="Monitor Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsmonitor><span>Monitor</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsextension-factory-li><input type=checkbox id=m-endocsv27devimplsextension-factory-check> |
| <label for=m-endocsv27devimplsextension-factory-check><a href=/en/docs/v2.7/dev/impls/extension-factory/ title="ExtensionFactory Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsextension-factory><span>ExtensionFactory</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsproxy-factory-li><input type=checkbox id=m-endocsv27devimplsproxy-factory-check> |
| <label for=m-endocsv27devimplsproxy-factory-check><a href=/en/docs/v2.7/dev/impls/proxy-factory/ title="ProxyFactory Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsproxy-factory><span>ProxyFactory</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplscompiler-li><input type=checkbox id=m-endocsv27devimplscompiler-check> |
| <label for=m-endocsv27devimplscompiler-check><a href=/en/docs/v2.7/dev/impls/compiler/ title="Compiler Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplscompiler><span>Compiler</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsconfig-center-li><input type=checkbox id=m-endocsv27devimplsconfig-center-check> |
| <label for=m-endocsv27devimplsconfig-center-check><a href=/en/docs/v2.7/dev/impls/config-center/ title="Dubbo Configuration Center Extensions" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsconfig-center><span>Config Center</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsdispatcher-li><input type=checkbox id=m-endocsv27devimplsdispatcher-check> |
| <label for=m-endocsv27devimplsdispatcher-check><a href=/en/docs/v2.7/dev/impls/dispatcher/ title="Dispatcher Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsdispatcher><span>Dispatcher</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsthreadpool-li><input type=checkbox id=m-endocsv27devimplsthreadpool-check> |
| <label for=m-endocsv27devimplsthreadpool-check><a href=/en/docs/v2.7/dev/impls/threadpool/ title="ThreadPool Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsthreadpool><span>ThreadPool</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsserialize-li><input type=checkbox id=m-endocsv27devimplsserialize-check> |
| <label for=m-endocsv27devimplsserialize-check><a href=/en/docs/v2.7/dev/impls/serialize/ title="Serialization Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsserialize><span>Serialization</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsremoting-li><input type=checkbox id=m-endocsv27devimplsremoting-check> |
| <label for=m-endocsv27devimplsremoting-check><a href=/en/docs/v2.7/dev/impls/remoting/ title="Transporter Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsremoting><span>Transporter</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsexchanger-li><input type=checkbox id=m-endocsv27devimplsexchanger-check> |
| <label for=m-endocsv27devimplsexchanger-check><a href=/en/docs/v2.7/dev/impls/exchanger/ title="Exchanger Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsexchanger><span>Exchanger</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsnetworker-li><input type=checkbox id=m-endocsv27devimplsnetworker-check> |
| <label for=m-endocsv27devimplsnetworker-check><a href=/en/docs/v2.7/dev/impls/networker/ title="Networker Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsnetworker><span>Networker</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplstelnet-handler-li><input type=checkbox id=m-endocsv27devimplstelnet-handler-check> |
| <label for=m-endocsv27devimplstelnet-handler-check><a href=/en/docs/v2.7/dev/impls/telnet-handler/ title="TelnetHandler Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplstelnet-handler><span>TelnetHandler</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsstatus-checker-li><input type=checkbox id=m-endocsv27devimplsstatus-checker-check> |
| <label for=m-endocsv27devimplsstatus-checker-check><a href=/en/docs/v2.7/dev/impls/status-checker/ title="StatusChecker Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsstatus-checker><span>StatusChecker</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplscontainer-li><input type=checkbox id=m-endocsv27devimplscontainer-check> |
| <label for=m-endocsv27devimplscontainer-check><a href=/en/docs/v2.7/dev/impls/container/ title="Container Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplscontainer><span>Container</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplspage-li><input type=checkbox id=m-endocsv27devimplspage-check> |
| <label for=m-endocsv27devimplspage-check><a href=/en/docs/v2.7/dev/impls/page/ title="PageHandler Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplspage><span>PageHandler</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplscache-li><input type=checkbox id=m-endocsv27devimplscache-check> |
| <label for=m-endocsv27devimplscache-check><a href=/en/docs/v2.7/dev/impls/cache/ title="Cache Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplscache><span>Cache</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplsvalidation-li><input type=checkbox id=m-endocsv27devimplsvalidation-check> |
| <label for=m-endocsv27devimplsvalidation-check><a href=/en/docs/v2.7/dev/impls/validation/ title="Validation Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplsvalidation><span>Validation</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devimplslogger-adapter-li><input type=checkbox id=m-endocsv27devimplslogger-adapter-check> |
| <label for=m-endocsv27devimplslogger-adapter-check><a href=/en/docs/v2.7/dev/impls/logger-adapter/ title="LoggerAdapter Extension" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devimplslogger-adapter><span>LoggerAdapter</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devcontract-li><input type=checkbox id=m-endocsv27devcontract-check> |
| <label for=m-endocsv27devcontract-check><a href=/en/docs/v2.7/dev/contract/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devcontract><span>Public Agreement</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devrelease-li><input type=checkbox id=m-endocsv27devrelease-check> |
| <label for=m-endocsv27devrelease-check><a href=/en/docs/v2.7/dev/release/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devrelease><span>Versions</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devchecklist-li><input type=checkbox id=m-endocsv27devchecklist-check> |
| <label for=m-endocsv27devchecklist-check><a href=/en/docs/v2.7/dev/checklist/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devchecklist><span>Checklist</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devcode-smell-li><input type=checkbox id=m-endocsv27devcode-smell-check> |
| <label for=m-endocsv27devcode-smell-check><a href=/en/docs/v2.7/dev/code-smell/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devcode-smell><span>Bad Smell</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devcoding-li><input type=checkbox id=m-endocsv27devcoding-check> |
| <label for=m-endocsv27devcoding-check><a href=/en/docs/v2.7/dev/coding/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devcoding><span>Coding Convention</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27devtck-li><input type=checkbox id=m-endocsv27devtck-check> |
| <label for=m-endocsv27devtck-check><a href=/en/docs/v2.7/dev/tck/ title="Compatibility Test" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27devtck><span>TCK</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27admin-li><input type=checkbox id=m-endocsv27admin-check> |
| <label for=m-endocsv27admin-check><a href=/en/docs/v2.7/admin/ title="Admin Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27admin><span>Admin</span></a></label><ul class="ul-3 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27adminops-li><input type=checkbox id=m-endocsv27adminops-check> |
| <label for=m-endocsv27adminops-check><a href=/en/docs/v2.7/admin/ops/ title="Dubbo Admin Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27adminops><span>Dubbo Admin</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27adminopsfunctions-li><input type=checkbox id=m-endocsv27adminopsfunctions-check> |
| <label for=m-endocsv27adminopsfunctions-check><a href=/en/docs/v2.7/admin/ops/functions/ title="Dubbo Admin Functions" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27adminopsfunctions><span>Functions</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27adminopsintroduction-li><input type=checkbox id=m-endocsv27adminopsintroduction-check> |
| <label for=m-endocsv27adminopsintroduction-check><a href=/en/docs/v2.7/admin/ops/introduction/ title="Dubbo Admin Introductions" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27adminopsintroduction><span>Introductions</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27adminopssearch-li><input type=checkbox id=m-endocsv27adminopssearch-check> |
| <label for=m-endocsv27adminopssearch-check><a href=/en/docs/v2.7/admin/ops/search/ title="Service Search And Service Detail" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27adminopssearch><span>Search</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27adminopstest-li><input type=checkbox id=m-endocsv27adminopstest-check> |
| <label for=m-endocsv27adminopstest-check><a href=/en/docs/v2.7/admin/ops/test/ title="Service Test" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27adminopstest><span>Test</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27adminopsapidocs-li><input type=checkbox id=m-endocsv27adminopsapidocs-check> |
| <label for=m-endocsv27adminopsapidocs-check><a href=/en/docs/v2.7/admin/ops/apidocs/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27adminopsapidocs><span>API Docs&Test</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27adminopsgovernance-li><input type=checkbox id=m-endocsv27adminopsgovernance-check> |
| <label for=m-endocsv27adminopsgovernance-check><a href=/en/docs/v2.7/admin/ops/governance/ title="Service Governance And Configuration Management" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27adminopsgovernance><span>Governance</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27adminopspinpoint-li><input type=checkbox id=m-endocsv27adminopspinpoint-check> |
| <label for=m-endocsv27adminopspinpoint-check><a href=/en/docs/v2.7/admin/ops/pinpoint/ title="Tracking with Pinpoint" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27adminopspinpoint><span>Pinpoint</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27adminopsskywalking-li><input type=checkbox id=m-endocsv27adminopsskywalking-check> |
| <label for=m-endocsv27adminopsskywalking-check><a href=/en/docs/v2.7/admin/ops/skywalking/ title="Tracing Dubbo service with Apache Skywalking" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27adminopsskywalking><span>Skywalking</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv27admininstall-li><input type=checkbox id=m-endocsv27admininstall-check> |
| <label for=m-endocsv27admininstall-check><a href=/en/docs/v2.7/admin/install/ title="Dubbo Installation Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv27admininstall><span>Installation</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27admininstalladmin-console-li><input type=checkbox id=m-endocsv27admininstalladmin-console-check> |
| <label for=m-endocsv27admininstalladmin-console-check><a href=/en/docs/v2.7/admin/install/admin-console/ title="Install Admin Console" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27admininstalladmin-console><span>Admin Console</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27admininstallprovider-demo-li><input type=checkbox id=m-endocsv27admininstallprovider-demo-check> |
| <label for=m-endocsv27admininstallprovider-demo-check><a href=/en/docs/v2.7/admin/install/provider-demo/ title="Install Demo Provider" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27admininstallprovider-demo><span>Demo Provider</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27admininstallconsumer-demo-li><input type=checkbox id=m-endocsv27admininstallconsumer-demo-check> |
| <label for=m-endocsv27admininstallconsumer-demo-check><a href=/en/docs/v2.7/admin/install/consumer-demo/ title="Install Demo Consumer" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27admininstallconsumer-demo><span>Demo Consumer</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27admininstallzookeeper-li><input type=checkbox id=m-endocsv27admininstallzookeeper-check> |
| <label for=m-endocsv27admininstallzookeeper-check><a href=/en/docs/v2.7/admin/install/zookeeper/ title="install Zookeeper Configuration Center" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27admininstallzookeeper><span>Config Center</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27admininstallredis-li><input type=checkbox id=m-endocsv27admininstallredis-check> |
| <label for=m-endocsv27admininstallredis-check><a href=/en/docs/v2.7/admin/install/redis/ title="Install Redis Register Center" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27admininstallredis><span>Register Center</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv27admininstallmonitor-center-li><input type=checkbox id=m-endocsv27admininstallmonitor-center-check> |
| <label for=m-endocsv27admininstallmonitor-center-check><a href=/en/docs/v2.7/admin/install/monitor-center/ title="Install Simple monitor center" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv27admininstallmonitor-center><span>Monitor Center</span></a></label></li></ul></li></ul></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv30-li><input type=checkbox id=m-endocsv30-check> |
| <label for=m-endocsv30-check><a href=/en/docs/v3.0/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv30><span>Dubbo 3.0</span></a></label><ul class="ul-2 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30loadbalance-li><input type=checkbox id=m-endocsv30loadbalance-check> |
| <label for=m-endocsv30loadbalance-check><a href=/en/docs/v3.0/loadbalance/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv30loadbalance><span>Load Balance</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30whats-new-in-dubbo3-li><input type=checkbox id=m-endocsv30whats-new-in-dubbo3-check> |
| <label for=m-endocsv30whats-new-in-dubbo3-check><a href=/en/docs/v3.0/whats-new-in-dubbo3/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv30whats-new-in-dubbo3><span>What's new in Apache Dubbo 3.x?</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv30references-li><input type=checkbox id=m-endocsv30references-check> |
| <label for=m-endocsv30references-check><a href=/en/docs/v3.0/references/ title="Function Reference Manual" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv30references><span>Reference</span></a></label><ul class="ul-3 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv30referenceslifecycle-li><input type=checkbox id=m-endocsv30referenceslifecycle-check> |
| <label for=m-endocsv30referenceslifecycle-check><a href=/en/docs/v3.0/references/lifecycle/ title="Align with Kubernetes Lifecycle" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv30referenceslifecycle><span>Probe</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30referenceslifecyclebrief-li><input type=checkbox id=m-endocsv30referenceslifecyclebrief-check> |
| <label for=m-endocsv30referenceslifecyclebrief-check><a href=/en/docs/v3.0/references/lifecycle/brief/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv30referenceslifecyclebrief><span>Brief</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30referenceslifecycleliveness-li><input type=checkbox id=m-endocsv30referenceslifecycleliveness-check> |
| <label for=m-endocsv30referenceslifecycleliveness-check><a href=/en/docs/v3.0/references/lifecycle/liveness/ title="Liveness Probe" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv30referenceslifecycleliveness><span>Liveness</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30referenceslifecyclereadiness-li><input type=checkbox id=m-endocsv30referenceslifecyclereadiness-check> |
| <label for=m-endocsv30referenceslifecyclereadiness-check><a href=/en/docs/v3.0/references/lifecycle/readiness/ title="Readiness Probe" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv30referenceslifecyclereadiness><span>Readiness</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30referenceslifecyclestartup-li><input type=checkbox id=m-endocsv30referenceslifecyclestartup-check> |
| <label for=m-endocsv30referenceslifecyclestartup-check><a href=/en/docs/v3.0/references/lifecycle/startup/ title="Startup Probe" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv30referenceslifecyclestartup><span>Startup</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv30referencesgraalvm-li><input type=checkbox id=m-endocsv30referencesgraalvm-check> |
| <label for=m-endocsv30referencesgraalvm-check><a href=/en/docs/v3.0/references/graalvm/ title="graalvm support" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv30referencesgraalvm><span>support graalvm</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30referencesgraalvmsupport-graalvm-li><input type=checkbox id=m-endocsv30referencesgraalvmsupport-graalvm-check> |
| <label for=m-endocsv30referencesgraalvmsupport-graalvm-check><a href=/en/docs/v3.0/references/graalvm/support-graalvm/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv30referencesgraalvmsupport-graalvm><span></span></a></label></li></ul></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv30languages-li><input type=checkbox id=m-endocsv30languages-check> |
| <label for=m-endocsv30languages-check><a href=/en/docs/v3.0/languages/ title="Multi-language implementation" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv30languages><span>multi-language</span></a></label><ul class="ul-3 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv30languageserlang-li><input type=checkbox id=m-endocsv30languageserlang-check> |
| <label for=m-endocsv30languageserlang-check><a href=/en/docs/v3.0/languages/erlang/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv30languageserlang><span>Erlang</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30languageserlangquick-start-li><input type=checkbox id=m-endocsv30languageserlangquick-start-check> |
| <label for=m-endocsv30languageserlangquick-start-check><a href=/en/docs/v3.0/languages/erlang/quick-start/ title="Quick start " class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv30languageserlangquick-start><span>Quick start</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30languageserlangreference-li><input type=checkbox id=m-endocsv30languageserlangreference-check> |
| <label for=m-endocsv30languageserlangreference-check><a href=/en/docs/v3.0/languages/erlang/reference/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv30languageserlangreference><span>Consumer configuration</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30languageserlangservice-li><input type=checkbox id=m-endocsv30languageserlangservice-check> |
| <label for=m-endocsv30languageserlangservice-check><a href=/en/docs/v3.0/languages/erlang/service/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv30languageserlangservice><span>Provider configuration</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30languageserlangserialization-li><input type=checkbox id=m-endocsv30languageserlangserialization-check> |
| <label for=m-endocsv30languageserlangserialization-check><a href=/en/docs/v3.0/languages/erlang/serialization/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv30languageserlangserialization><span>Serialized configuration items</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocsv30languagesgolang-li><input type=checkbox id=m-endocsv30languagesgolang-check> |
| <label for=m-endocsv30languagesgolang-check><a href=/en/docs/v3.0/languages/golang/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv30languagesgolang><span>golang</span></a></label><ul class="ul-4 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30languagesgolanggo-specific-li><input type=checkbox id=m-endocsv30languagesgolanggo-specific-check> |
| <label for=m-endocsv30languagesgolanggo-specific-check><a href=/en/docs/v3.0/languages/golang/go-specific/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv30languagesgolanggo-specific><span>Go language definition service</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30languagesgolangquick-start-li><input type=checkbox id=m-endocsv30languagesgolangquick-start-check> |
| <label for=m-endocsv30languagesgolangquick-start-check><a href=/en/docs/v3.0/languages/golang/quick-start/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocsv30languagesgolangquick-start><span>Go quick start</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsv30languagesrust-li><input type=checkbox id=m-endocsv30languagesrust-check> |
| <label for=m-endocsv30languagesrust-check><a href=/en/docs3-v2/rust-sdk/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsv30languagesrust><span>Rust</span></a></label></li></ul></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocscontribution-guidelines-li><input type=checkbox id=m-endocscontribution-guidelines-check> |
| <label for=m-endocscontribution-guidelines-check><a href=/en/docs/contribution-guidelines/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocscontribution-guidelines><span>Contribution Guideline</span></a></label><ul class="ul-2 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocscontribution-guidelinescontributor-li><input type=checkbox id=m-endocscontribution-guidelinescontributor-check> |
| <label for=m-endocscontribution-guidelinescontributor-check><a href=/en/docs/contribution-guidelines/contributor/ title="Contributor Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocscontribution-guidelinescontributor><span>Contributor</span></a></label><ul class="ul-3 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescontributorbecome-a-committer_dev-li><input type=checkbox id=m-endocscontribution-guidelinescontributorbecome-a-committer_dev-check> |
| <label for=m-endocscontribution-guidelinescontributorbecome-a-committer_dev-check><a href=/en/docs/contribution-guidelines/contributor/become-a-committer_dev/ title="How to become a Dubbo committer" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescontributorbecome-a-committer_dev><span>How To</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescontributorcla-signing-guide_dev-li><input type=checkbox id=m-endocscontribution-guidelinescontributorcla-signing-guide_dev-check> |
| <label for=m-endocscontribution-guidelinescontributorcla-signing-guide_dev-check><a href=/en/docs/contribution-guidelines/contributor/cla-signing-guide_dev/ title="CLA Signing Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescontributorcla-signing-guide_dev><span>CLA</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescontributornew-contributor-guide_dev-li><input type=checkbox id=m-endocscontribution-guidelinescontributornew-contributor-guide_dev-check> |
| <label for=m-endocscontribution-guidelinescontributornew-contributor-guide_dev-check><a href=/en/docs/contribution-guidelines/contributor/new-contributor-guide_dev/ title="New Contributor Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescontributornew-contributor-guide_dev><span>New Contributor</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescontributormailing-list-subscription-guide_dev-li><input type=checkbox id=m-endocscontribution-guidelinescontributormailing-list-subscription-guide_dev-check> |
| <label for=m-endocscontribution-guidelinescontributormailing-list-subscription-guide_dev-check><a href=/en/docs/contribution-guidelines/contributor/mailing-list-subscription-guide_dev/ title="Mailing List Subscription Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescontributormailing-list-subscription-guide_dev><span>Mailing List</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescontributorsoftware-donation-guide_dev-li><input type=checkbox id=m-endocscontribution-guidelinescontributorsoftware-donation-guide_dev-check> |
| <label for=m-endocscontribution-guidelinescontributorsoftware-donation-guide_dev-check><a href=/en/docs/contribution-guidelines/contributor/software-donation-guide_dev/ title="Software Donation Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescontributorsoftware-donation-guide_dev><span>Donation</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescontributorreporting-security-issues_dev-li><input type=checkbox id=m-endocscontribution-guidelinescontributorreporting-security-issues_dev-check> |
| <label for=m-endocscontribution-guidelinescontributorreporting-security-issues_dev-check><a href=/en/docs/contribution-guidelines/contributor/reporting-security-issues_dev/ title="Reporting Security Issues" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescontributorreporting-security-issues_dev><span>Security Issue</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescontributordubbo-extension-guide_dev-li><input type=checkbox id=m-endocscontribution-guidelinescontributordubbo-extension-guide_dev-check> |
| <label for=m-endocscontribution-guidelinescontributordubbo-extension-guide_dev-check><a href=/en/docs/contribution-guidelines/contributor/dubbo-extension-guide_dev/ title="Extension Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescontributordubbo-extension-guide_dev><span>Developing Extension</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescontributortest-coverage-guide_dev-li><input type=checkbox id=m-endocscontribution-guidelinescontributortest-coverage-guide_dev-check> |
| <label for=m-endocscontribution-guidelinescontributortest-coverage-guide_dev-check><a href=/en/docs/contribution-guidelines/contributor/test-coverage-guide_dev/ title="Test Coverage Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescontributortest-coverage-guide_dev><span>Test Coverage</span></a></label></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section with-child" id=m-endocscontribution-guidelinescommitter-li><input type=checkbox id=m-endocscontribution-guidelinescommitter-check> |
| <label for=m-endocscontribution-guidelinescommitter-check><a href=/en/docs/contribution-guidelines/committer/ title="Committer Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocscontribution-guidelinescommitter><span>Committer</span></a></label><ul class="ul-3 foldable"><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescommitternew-committer-guide_dev-li><input type=checkbox id=m-endocscontribution-guidelinescommitternew-committer-guide_dev-check> |
| <label for=m-endocscontribution-guidelinescommitternew-committer-guide_dev-check><a href=/en/docs/contribution-guidelines/committer/new-committer-guide_dev/ title="Apache Committer Guide" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescommitternew-committer-guide_dev><span>Committer Guide</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescommitterrelease-guide_dev-li><input type=checkbox id=m-endocscontribution-guidelinescommitterrelease-guide_dev-check> |
| <label for=m-endocscontribution-guidelinescommitterrelease-guide_dev-check><a href=/en/docs/contribution-guidelines/committer/release-guide_dev/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescommitterrelease-guide_dev><span>Release Guide</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescommitterlabel-an-issue-guide_dev-li><input type=checkbox id=m-endocscontribution-guidelinescommitterlabel-an-issue-guide_dev-check> |
| <label for=m-endocscontribution-guidelinescommitterlabel-an-issue-guide_dev-check><a href=/en/docs/contribution-guidelines/committer/label-an-issue-guide_dev/ title="Label an Issue" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescommitterlabel-an-issue-guide_dev><span>Issue Guide</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescommitterwebsite-guide_dev-li><input type=checkbox id=m-endocscontribution-guidelinescommitterwebsite-guide_dev-check> |
| <label for=m-endocscontribution-guidelinescommitterwebsite-guide_dev-check><a href=/en/docs/contribution-guidelines/committer/website-guide_dev/ class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescommitterwebsite-guide_dev><span>Website Guide</span></a></label></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocscontribution-guidelinescommitterapache-dubbo-page_dev-li><input type=checkbox id=m-endocscontribution-guidelinescommitterapache-dubbo-page_dev-check> |
| <label for=m-endocscontribution-guidelinescommitterapache-dubbo-page_dev-check><a href=/en/docs/contribution-guidelines/committer/apache-dubbo-page_dev/ title="Apache Official Dubbo Page Maintenance" class="align-left pl-0 td-sidebar-link td-sidebar-link__page" id=m-endocscontribution-guidelinescommitterapache-dubbo-page_dev><span>Official Page</span></a></label></li></ul></li></ul></li><li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child" id=m-endocsfaq-li><input type=checkbox id=m-endocsfaq-check> |
| <label for=m-endocsfaq-check><a href=/en/docs/faq/ class="align-left pl-0 td-sidebar-link td-sidebar-link__section" id=m-endocsfaq><span>FAQ - Frequently Asked Questions</span></a></label></li></ul></li></ul></nav></div></div><main class="col-12 col-md-9 col-xl-8 pl-md-5" role=main><nav aria-label=breadcrumb class=td-breadcrumbs><ol class=breadcrumb><li class=breadcrumb-item><a href=https://cn.dubbo.apache.org/en/docs/>Documentation</a></li><li class=breadcrumb-item><a href=https://cn.dubbo.apache.org/en/docs/v2.7/>Dubbo 2.7</a></li><li class=breadcrumb-item><a href=https://cn.dubbo.apache.org/en/docs/v2.7/user/>User</a></li><li class=breadcrumb-item><a href=https://cn.dubbo.apache.org/en/docs/v2.7/user/references/>References</a></li><li class=breadcrumb-item><a href=https://cn.dubbo.apache.org/en/docs/v2.7/user/references/protocol/>Protocol</a></li><li class="breadcrumb-item active" aria-current=page><a href=https://cn.dubbo.apache.org/en/docs/v2.7/user/references/protocol/rest/ aria-disabled=true class="btn-link disabled">rest://</a></li></ol></nav><div class=td-content><h1>rest protocol</h1><div class=lead>References documentation for rest protocol</div><header class=article-meta></header><p>基于标准的Java REST API——JAX-RS 2.0（Java API for RESTful Web Services的简写）实现的REST调用支持</p><h2 id=快速入门>快速入门</h2><p>在dubbo中开发一个REST风格的服务会比较简单，下面以一个注册用户的简单服务为例说明。</p><p>这个服务要实现的功能是提供如下URL（注：这个URL不是完全符合REST的风格，但是更简单实用）：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-fallback data-lang=fallback><span style=display:flex><span>http://localhost:8080/users/register |
| </span></span></code></pre></div><p>而任何客户端都可以将包含用户信息的JSON字符串POST到以上URL来完成用户注册。</p><p>首先，开发服务的接口：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>UserService</span> { |
| </span></span><span style=display:flex><span> <span style=color:#dc322f>void</span> <span style=color:#268bd2>registerUser</span>(User user); |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>然后，开发服务的实现：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@Path</span>(<span style=color:#2aa198>"users"</span>) |
| </span></span><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>UserServiceImpl</span> <span style=color:#268bd2>implements</span> UserService { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@POST</span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@Path</span>(<span style=color:#2aa198>"register"</span>) |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@Consumes</span>({MediaType.APPLICATION_JSON}) |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>public</span> <span style=color:#dc322f>void</span> <span style=color:#268bd2>registerUser</span>(User user) { |
| </span></span><span style=display:flex><span> <span style=color:#586e75>// save the user...</span> |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>上面的实现非常简单，但是由于该 REST 服务是要发布到指定 URL 上，供任意语言的客户端甚至浏览器来访问，所以这里额外添加了几个 JAX-RS 的标准 annotation 来做相关的配置。</p><p>@Path(“users”)：指定访问UserService的URL相对路径是/users，即http://localhost:8080/users</p><p>@Path(“register”)：指定访问registerUser()方法的URL相对路径是/register，再结合上一个@Path为UserService指定的路径，则调用UserService.register()的完整路径为http://localhost:8080/users/register</p><p>@POST：指定访问registerUser()用HTTP POST方法</p><p>@Consumes({MediaType.APPLICATION_JSON})：指定registerUser()接收JSON格式的数据。REST框架会自动将JSON数据反序列化为User对象</p><p>最后，在spring配置文件中添加此服务，即完成所有服务开发工作：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#586e75><!-- 用rest协议在8080端口暴露服务 --></span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> port=<span style=color:#2aa198>"8080"</span><span style=color:#268bd2>/></span> |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span><span style=color:#586e75><!-- 声明需要暴露的服务接口 --></span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2><dubbo:service</span> interface=<span style=color:#2aa198>"xxx.UserService"</span> ref=<span style=color:#2aa198>"userService"</span><span style=color:#268bd2>/></span> |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span><span style=color:#586e75><!-- 和本地bean一样实现服务 --></span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2><bean</span> id=<span style=color:#2aa198>"userService"</span> class=<span style=color:#2aa198>"xxx.UserServiceImpl"</span> <span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><h2 id=rest服务提供端详解>REST服务提供端详解</h2><p>下面我们扩充“快速入门”中的UserService，进一步展示在dubbo中REST服务提供端的开发要点。</p><h3 id=http-postget的实现>HTTP POST/GET的实现</h3><p>REST服务中虽然建议使用HTTP协议中四种标准方法POST、DELETE、PUT、GET来分别实现常见的“增删改查”，但实际中，我们一般情况直接用POST来实现“增改”，GET来实现“删查”即可（DELETE和PUT甚至会被一些防火墙阻挡）。</p><p>前面已经简单演示了POST的实现，在此，我们为UserService添加一个获取注册用户资料的功能，来演示GET的实现。</p><p>这个功能就是要实现客户端通过访问如下不同URL来获取不同ID的用户资料：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-fallback data-lang=fallback><span style=display:flex><span>http://localhost:8080/users/1001 |
| </span></span><span style=display:flex><span>http://localhost:8080/users/1002 |
| </span></span><span style=display:flex><span>http://localhost:8080/users/1003 |
| </span></span></code></pre></div><p>当然，也可以通过其他形式的URL来访问不同ID的用户资料，例如：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-gdscript3 data-lang=gdscript3><span style=display:flex><span>http:<span style=color:#719e07>//</span>localhost:<span style=color:#2aa198>8080</span><span style=color:#719e07>/</span>users<span style=color:#719e07>/</span><span style=color:#b58900>load</span>?id<span style=color:#719e07>=</span><span style=color:#2aa198>1001</span> |
| </span></span></code></pre></div><p>JAX-RS本身可以支持所有这些形式。但是上面那种在URL路径中包含查询参数的形式（http://localhost:8080/users/1001） 更符合REST的一般习惯，所以更推荐大家来使用。下面我们就为UserService添加一个getUser()方法来实现这种形式的URL访问：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@GET</span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2>@Path</span>(<span style=color:#2aa198>"{id : \\d+}"</span>) |
| </span></span><span style=display:flex><span><span style=color:#268bd2>@Produces</span>({MediaType.APPLICATION_JSON}) |
| </span></span><span style=display:flex><span><span style=color:#268bd2>public</span> User <span style=color:#268bd2>getUser</span>(<span style=color:#268bd2>@PathParam</span>(<span style=color:#2aa198>"id"</span>) Long id) { |
| </span></span><span style=display:flex><span> <span style=color:#586e75>// ...</span> |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>@GET：指定用HTTP GET方法访问</p><p>@Path("{id : \d+}")：根据上面的功能需求，访问getUser()的URL应当是“http://localhost:8080/users/ + 任意数字"，并且这个数字要被做为参数传入getUser()方法。 这里的annotation配置中，@Path中间的{id: xxx}指定URL相对路径中包含了名为id参数，而它的值也将被自动传递给下面用@PathParam(“id”)修饰的方法参数id。{id:后面紧跟的\d+是一个正则表达式，指定了id参数必须是数字。</p><p>@Produces({MediaType.APPLICATION_JSON})：指定getUser()输出JSON格式的数据。框架会自动将User对象序列化为JSON数据。</p><h3 id=annotation放在接口类还是实现类>Annotation放在接口类还是实现类</h3><p>在Dubbo中开发REST服务主要都是通过JAX-RS的annotation来完成配置的，在上面的示例中，我们都是将annotation放在服务的实现类中。但其实，我们完全也可以将annotation放到服务的接口上，这两种方式是完全等价的，例如：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@Path</span>(<span style=color:#2aa198>"users"</span>) |
| </span></span><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>interface</span> <span style=color:#268bd2>UserService</span> { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@GET</span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@Path</span>(<span style=color:#2aa198>"{id : \\d+}"</span>) |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@Produces</span>({MediaType.APPLICATION_JSON}) |
| </span></span><span style=display:flex><span> User <span style=color:#268bd2>getUser</span>(<span style=color:#268bd2>@PathParam</span>(<span style=color:#2aa198>"id"</span>) Long id); |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>在一般应用中，我们建议将annotation放到服务实现类，这样annotation和java实现代码位置更接近，更便于开发和维护。另外更重要的是，我们一般倾向于避免对接口的污染，保持接口的纯净性和广泛适用性。</p><p>但是，如后文所述，如果我们要用dubbo直接开发的消费端来访问此服务，则annotation必须放到接口上。</p><p>如果接口和实现类都同时添加了annotation，则实现类的annotation配置会生效，接口上的annotation被直接忽略。</p><h3 id=jsonxml等多数据格式的支持>JSON、XML等多数据格式的支持</h3><p>在dubbo中开发的REST服务可以同时支持传输多种格式的数据，以给客户端提供最大的灵活性。其中我们目前对最常用的JSON和XML格式特别添加了额外的功能。</p><p>比如，我们要让上例中的getUser()方法支持分别返回JSON和XML格式的数据，只需要在annotation中同时包含两种格式即可：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@Produces</span>({MediaType.APPLICATION_JSON, MediaType.TEXT_XML}) |
| </span></span><span style=display:flex><span>User <span style=color:#268bd2>getUser</span>(<span style=color:#268bd2>@PathParam</span>(<span style=color:#2aa198>"id"</span>) Long id); |
| </span></span></code></pre></div><p>或者也可以直接用字符串（还支持通配符）表示MediaType：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@Produces</span>({<span style=color:#2aa198>"application/json"</span>, <span style=color:#2aa198>"text/xml"</span>}) |
| </span></span><span style=display:flex><span>User <span style=color:#268bd2>getUser</span>(<span style=color:#268bd2>@PathParam</span>(<span style=color:#2aa198>"id"</span>) Long id); |
| </span></span></code></pre></div><p>如果所有方法都支持同样类型的输入输出数据格式，则我们无需在每个方法上做配置，只需要在服务类上添加annotation即可：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@Path</span>(<span style=color:#2aa198>"users"</span>) |
| </span></span><span style=display:flex><span><span style=color:#268bd2>@Consumes</span>({MediaType.APPLICATION_JSON, MediaType.TEXT_XML}) |
| </span></span><span style=display:flex><span><span style=color:#268bd2>@Produces</span>({MediaType.APPLICATION_JSON, MediaType.TEXT_XML}) |
| </span></span><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>UserServiceImpl</span> <span style=color:#268bd2>implements</span> UserService { |
| </span></span><span style=display:flex><span> <span style=color:#586e75>// ...</span> |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>在一个REST服务同时对多种数据格式支持的情况下，根据JAX-RS标准，一般是通过HTTP中的MIME header（content-type和accept）来指定当前想用的是哪种格式的数据。</p><p>但是在dubbo中，我们还自动支持目前业界普遍使用的方式，即用一个URL后缀（.json和.xml）来指定想用的数据格式。例如，在添加上述annotation后，直接访问http://localhost:8888/users/1001.json则表示用json格式，直接访问http://localhost:8888/users/1002.xml则表示用xml格式，比用HTTP Header更简单直观。Twitter、微博等的REST API都是采用这种方式。</p><p>如果你既不加HTTP header，也不加后缀，则dubbo的REST会优先启用在以上annotation定义中排位最靠前的那种数据格式。</p><blockquote><p>注意：这里要支持XML格式数据，在annotation中既可以用MediaType.TEXT_XML，也可以用MediaType.APPLICATION_XML，但是TEXT_XML是更常用的，并且如果要利用上述的URL后缀方式来指定数据格式，只能配置为TEXT_XML才能生效。</p></blockquote><h3 id=中文字符支持>中文字符支持</h3><p>为了在dubbo REST中正常输出中文字符，和通常的Java web应用一样，我们需要将HTTP响应的contentType设置为UTF-8编码。</p><p>基于JAX-RS的标准用法，我们只需要做如下annotation配置即可：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@Produces</span>({<span style=color:#2aa198>"application/json; charset=UTF-8"</span>, <span style=color:#2aa198>"text/xml; charset=UTF-8"</span>}) |
| </span></span><span style=display:flex><span>User <span style=color:#268bd2>getUser</span>(<span style=color:#268bd2>@PathParam</span>(<span style=color:#2aa198>"id"</span>) Long id); |
| </span></span></code></pre></div><p>为了方便用户，我们在dubbo REST中直接添加了一个支持类，来定义以上的常量，可以直接使用，减少出错的可能性。</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@Produces</span>({ContentType.APPLICATION_JSON_UTF_8, ContentType.TEXT_XML_UTF_8}) |
| </span></span><span style=display:flex><span>User <span style=color:#268bd2>getUser</span>(<span style=color:#268bd2>@PathParam</span>(<span style=color:#2aa198>"id"</span>) Long id); |
| </span></span></code></pre></div><h3 id=xml数据格式的额外要求>XML数据格式的额外要求</h3><p>由于JAX-RS的实现一般都用标准的JAXB（Java API for XML Binding）来序列化和反序列化XML格式数据，所以我们需要为每一个要用XML传输的对象添加一个类级别的JAXB annotation，否则序列化将报错。例如为getUser()中返回的User添加如下：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@XmlRootElement</span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>User</span> <span style=color:#268bd2>implements</span> Serializable { |
| </span></span><span style=display:flex><span> <span style=color:#586e75>// ...</span> |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>此外，如果service方法中的返回值是Java的 primitive类型（如int，long，float，double等），最好为它们添加一层wrapper对象，因为JAXB不能直接序列化primitive类型。</p><p>例如，我们想让前述的registerUser()方法返回服务器端为用户生成的ID号：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#dc322f>long</span> <span style=color:#268bd2>registerUser</span>(User user); |
| </span></span></code></pre></div><p>由于primitive类型不被JAXB序列化支持，所以添加一个wrapper对象：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@XmlRootElement</span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>RegistrationResult</span> <span style=color:#268bd2>implements</span> Serializable { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>private</span> Long id; |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>public</span> <span style=color:#268bd2>RegistrationResult</span>() { |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>public</span> <span style=color:#268bd2>RegistrationResult</span>(Long id) { |
| </span></span><span style=display:flex><span> <span style=color:#719e07>this</span>.id <span style=color:#719e07>=</span> id; |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>public</span> Long <span style=color:#268bd2>getId</span>() { |
| </span></span><span style=display:flex><span> <span style=color:#719e07>return</span> id; |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>public</span> <span style=color:#dc322f>void</span> <span style=color:#268bd2>setId</span>(Long id) { |
| </span></span><span style=display:flex><span> <span style=color:#719e07>this</span>.id <span style=color:#719e07>=</span> id; |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>并修改service方法：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span>RegistrationResult <span style=color:#268bd2>registerUser</span>(User user); |
| </span></span></code></pre></div><p>这样不但能够解决XML序列化的问题，而且使得返回的数据都符合XML和JSON的规范。例如，在JSON中，返回的将是如下形式：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-javascript data-lang=javascript><span style=display:flex><span>{<span style=color:#2aa198>"id"</span><span style=color:#719e07>:</span> <span style=color:#2aa198>1001</span>} |
| </span></span></code></pre></div><p>如果不加wrapper，JSON返回值将直接是</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-fallback data-lang=fallback><span style=display:flex><span>1001 |
| </span></span></code></pre></div><p>而在XML中，加wrapper后返回值将是：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><registrationResult></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><id></span>1002<span style=color:#268bd2></id></span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2></registrationResult></span> |
| </span></span></code></pre></div><p>这种wrapper对象其实利用所谓Data Transfer Object（DTO）模式，采用DTO还能对传输数据做更多有用的定制。</p><h3 id=定制序列化>定制序列化</h3><p>如上所述，REST的底层实现会在service的对象和JSON/XML数据格式之间自动做序列化/反序列化。但有些场景下，如果觉得这种自动转换不满足要求，可以对其做定制。</p><p>Dubbo中的REST实现是用JAXB做XML序列化，用Jackson做JSON序列化，所以在对象上添加JAXB或Jackson的annotation即可以定制映射。</p><p>例如，定制对象属性映射到XML元素的名字：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@XmlRootElement</span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2>@XmlAccessorType</span>(XmlAccessType.FIELD) |
| </span></span><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>User</span> <span style=color:#268bd2>implements</span> Serializable { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@XmlElement</span>(name<span style=color:#719e07>=</span><span style=color:#2aa198>"username"</span>) |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>private</span> String name; |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>定制对象属性映射到JSON字段的名字：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>User</span> <span style=color:#268bd2>implements</span> Serializable { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@JsonProperty</span>(<span style=color:#2aa198>"username"</span>) |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>private</span> String name; |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>更多资料请参考JAXB和Jackson的官方文档，或自行google。</p><h3 id=配置rest-server的实现>配置REST Server的实现</h3><p>目前在dubbo中，我们支持5种嵌入式rest server的实现，并同时支持采用外部应用服务器来做rest server的实现。rest server可以通过如下配置实现：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> server=<span style=color:#2aa198>"jetty"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>以上配置选用了嵌入式的jetty来做rest server，同时，如果不配置server属性，rest协议默认也是选用jetty。jetty是非常成熟的java servlet容器，并和dubbo已经有较好的集成（目前5种嵌入式server中只有jetty和后面所述的tomcat、tjws，与dubbo监控系统等完成了无缝的集成），所以，如果你的dubbo系统是单独启动的进程，你可以直接默认采用jetty即可。</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> server=<span style=color:#2aa198>"tomcat"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>以上配置选用了嵌入式的tomcat来做rest server。在嵌入式tomcat上，REST的性能比jetty上要好得多（参见后面的基准测试），建议在需要高性能的场景下采用tomcat。</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> server=<span style=color:#2aa198>"netty"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>以上配置选用嵌入式的netty来做rest server。（TODO more contents to add）</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> server=<span style=color:#2aa198>"tjws"</span><span style=color:#268bd2>/></span> (tjws is now deprecated) |
| </span></span><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> server=<span style=color:#2aa198>"sunhttp"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>以上配置选用嵌入式的tjws或Sun HTTP server来做rest server。这两个server实现非常轻量级，非常方便在集成测试中快速启动使用，当然也可以在负荷不高的生产环境中使用。 注：tjws目前已经被deprecated掉了，因为它不能很好的和servlet 3.1 API工作。</p><p>如果你的dubbo系统不是单独启动的进程，而是部署到了Java应用服务器中，则建议你采用以下配置：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> server=<span style=color:#2aa198>"servlet"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>通过将server设置为servlet，dubbo将采用外部应用服务器的servlet容器来做rest server。同时，还要在dubbo系统的web.xml中添加如下配置：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><web-app></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><context-param></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><param-name></span>contextConfigLocation<span style=color:#268bd2></param-name></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><param-value></span>/WEB-INF/classes/META-INF/spring/dubbo-demo-provider.xml<span style=color:#268bd2></param-value></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2></context-param></span> |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><listener></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><listener-class></span>org.apache.dubbo.remoting.http.servlet.BootstrapListener<span style=color:#268bd2></listener-class></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2></listener></span> |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><listener></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><listener-class></span>org.springframework.web.context.ContextLoaderListener<span style=color:#268bd2></listener-class></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2></listener></span> |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><servlet></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><servlet-name></span>dispatcher<span style=color:#268bd2></servlet-name></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><servlet-class></span>org.apache.dubbo.remoting.http.servlet.DispatcherServlet<span style=color:#268bd2></servlet-class></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><load-on-startup></span>1<span style=color:#268bd2></load-on-startup></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2></servlet></span> |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><servlet-mapping></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><servlet-name></span>dispatcher<span style=color:#268bd2></servlet-name></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><url-pattern></span>/*<span style=color:#268bd2></url-pattern></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2></servlet-mapping></span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2></web-app></span> |
| </span></span></code></pre></div><p>即必须将dubbo的BootstrapListener和DispatherServlet添加到web.xml，以完成dubbo的REST功能与外部servlet容器的集成。</p><blockquote><p>注意：如果你是用spring的ContextLoaderListener来加载spring，则必须保证BootstrapListener配置在ContextLoaderListener之前，否则dubbo初始化会出错。</p></blockquote><p>其实，这种场景下你依然可以坚持用嵌入式server，但外部应用服务器的servlet容器往往比嵌入式server更加强大（特别是如果你是部署到更健壮更可伸缩的WebLogic，WebSphere等），另外有时也便于在应用服务器做统一管理、监控等等。</p><h3 id=获取上下文context信息>获取上下文（Context）信息</h3><p>在远程调用中，值得获取的上下文信息可能有很多种，这里特别以获取客户端IP为例。</p><p>在dubbo的REST中，我们有两种方式获取客户端IP。</p><p>第一种方式，用JAX-RS标准的@Context annotation：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>public</span> User <span style=color:#268bd2>getUser</span>(<span style=color:#268bd2>@PathParam</span>(<span style=color:#2aa198>"id"</span>) Long id, <span style=color:#268bd2>@Context</span> HttpServletRequest request) { |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"Client address is "</span> <span style=color:#719e07>+</span> request.getRemoteAddr()); |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>用Context修饰getUser()的一个方法参数后，就可以将当前的HttpServletRequest注入进来，然后直接调用servlet api获取IP。</p><blockquote><p>注意：这种方式只能在将server设置为 tjws、tomcat、jetty 或者 servlet 的时候才能工作，因为只有这几种 server 的实现才提供了 servlet 容器。另外，标准的JAX-RS还支持用@Context修饰service类的一个实例字段来获取HttpServletRequest，但在dubbo中我们没有对此作出支持。</p></blockquote><p>第二种方式，用dubbo中常用的RpcContext：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>public</span> User <span style=color:#268bd2>getUser</span>(<span style=color:#268bd2>@PathParam</span>(<span style=color:#2aa198>"id"</span>) Long id) { |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"Client address is "</span> <span style=color:#719e07>+</span> RpcContext.getContext().getRemoteAddressString()); |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><blockquote><p>注意：这种方式只能在设置server=“jetty"或者server=“tomcat"或者server=“servlet"或者server=“tjws"的时候才能工作。另外，目前dubbo的RpcContext是一种比较有侵入性的用法，未来我们很可能会做出重构。</p></blockquote><p>如果你想保持你的项目对JAX-RS的兼容性，未来脱离dubbo也可以运行，请选择第一种方式。如果你想要更优雅的服务接口定义，请选用第二种方式。</p><p>此外，在最新的dubbo rest中，还支持通过RpcContext来获取HttpServletRequest和HttpServletResponse，以提供更大的灵活性来方便用户实现某些复杂功能，比如在dubbo标准的filter中访问HTTP Header。用法示例如下：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#719e07>if</span> (RpcContext.getContext().getRequest() <span style=color:#719e07>!=</span> <span style=color:#cb4b16>null</span> <span style=color:#719e07>&&</span> RpcContext.getContext().getRequest() <span style=color:#719e07>instanceof</span> HttpServletRequest) { |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"Client address is "</span> <span style=color:#719e07>+</span> ((HttpServletRequest) RpcContext.getContext().getRequest()).getRemoteAddr()); |
| </span></span><span style=display:flex><span>} |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span><span style=color:#719e07>if</span> (RpcContext.getContext().getResponse() <span style=color:#719e07>!=</span> <span style=color:#cb4b16>null</span> <span style=color:#719e07>&&</span> RpcContext.getContext().getResponse() <span style=color:#719e07>instanceof</span> HttpServletResponse) { |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"Response object from RpcContext: "</span> <span style=color:#719e07>+</span> RpcContext.getContext().getResponse()); |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><blockquote><p>注意：为了保持协议的中立性，RpcContext.getRequest()和RpcContext.getResponse()返回的仅仅是一个Object类，而且可能为null。所以，你必须自己做null和类型的检查。</p></blockquote><blockquote><p>注意：只有在设置server=“jetty"或者server=“tomcat"或者server=“servlet"的时候，你才能通过以上方法正确的得到HttpServletRequest和HttpServletResponse，因为只有这几种server实现了servlet容器。</p></blockquote><p>为了简化编程，在此你也可以用泛型的方式来直接获取特定类型的request/response：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#719e07>if</span> (RpcContext.getContext().getRequest(HttpServletRequest.class) <span style=color:#719e07>!=</span> <span style=color:#cb4b16>null</span>) { |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"Client address is "</span> <span style=color:#719e07>+</span> RpcContext.getContext().getRequest(HttpServletRequest.class).getRemoteAddr()); |
| </span></span><span style=display:flex><span>} |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span><span style=color:#719e07>if</span> (RpcContext.getContext().getResponse(HttpServletResponse.class) <span style=color:#719e07>!=</span> <span style=color:#cb4b16>null</span>) { |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"Response object from RpcContext: "</span> <span style=color:#719e07>+</span> RpcContext.getContext().getResponse(HttpServletResponse.class)); |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>如果request/response不符合指定的类型，这里也会返回null。</p><h3 id=配置端口号和context-path>配置端口号和Context Path</h3><p>dubbo中的rest协议默认将采用80端口，如果想修改端口，直接配置：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> port=<span style=color:#2aa198>"8888"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>另外，如前所述，我们可以用@Path来配置单个rest服务的URL相对路径。但其实，我们还可以设置一个所有rest服务都适用的基础相对路径，即java web应用中常说的context path。</p><p>只需要添加如下contextpath属性即可：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> port=<span style=color:#2aa198>"8888"</span> contextpath=<span style=color:#2aa198>"services"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>以前面代码为例：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@Path</span>(<span style=color:#2aa198>"users"</span>) |
| </span></span><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>UserServiceImpl</span> <span style=color:#268bd2>implements</span> UserService { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@POST</span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@Path</span>(<span style=color:#2aa198>"register"</span>) |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@Consumes</span>({MediaType.APPLICATION_JSON}) |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>public</span> <span style=color:#dc322f>void</span> <span style=color:#268bd2>registerUser</span>(User user) { |
| </span></span><span style=display:flex><span> <span style=color:#586e75>// save the user...</span> |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>现在registerUser()的完整访问路径为：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-fallback data-lang=fallback><span style=display:flex><span>http://localhost:8888/services/users/register |
| </span></span></code></pre></div><p>注意：如果你是选用外部应用服务器做rest server，即配置:</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> port=<span style=color:#2aa198>"8888"</span> contextpath=<span style=color:#2aa198>"services"</span> server=<span style=color:#2aa198>"servlet"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>则必须保证这里设置的port、contextpath，与外部应用服务器的端口、DispatcherServlet的上下文路径（即webapp path加上servlet url pattern）保持一致。例如，对于部署为tomcat ROOT路径的应用，这里的contextpath必须与web.xml中DispacherServlet的<code><url-pattern/></code>完全一致：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><servlet-mapping></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><servlet-name></span>dispatcher<span style=color:#268bd2></servlet-name></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><url-pattern></span>/services/*<span style=color:#268bd2></url-pattern></span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2></servlet-mapping></span> |
| </span></span></code></pre></div><h3 id=配置线程数和io线程数>配置线程数和IO线程数</h3><p>可以为rest服务配置线程池大小：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> threads=<span style=color:#2aa198>"500"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><blockquote><p>注意：目前线程池的设置只有当server=“netty"或者server=“jetty"或者server=“tomcat"的时候才能生效。另外，如果server=“servlet”，由于这时候启用的是外部应用服务器做rest server，不受dubbo控制，所以这里的线程池设置也无效。</p></blockquote><p>如果是选用netty server，还可以配置Netty的IO worker线程数：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> iothreads=<span style=color:#2aa198>"5"</span> threads=<span style=color:#2aa198>"100"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><h3 id=配置长连接>配置长连接</h3><p>Dubbo中的rest服务默认都是采用http长连接来访问，如果想切换为短连接，直接配置：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> keepalive=<span style=color:#2aa198>"false"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><blockquote><p>注意：这个配置目前只对server=“netty"和server=“tomcat"才能生效。</p></blockquote><h3 id=配置最大的http连接数>配置最大的HTTP连接数</h3><p>可以配置服务器提供端所能同时接收的最大HTTP连接数，防止REST server被过多连接撑爆，以作为一种最基本的自我保护机制：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> accepts=<span style=color:#2aa198>"500"</span> server=<span style=color:#2aa198>"tomcat/</span><span style=color:#268bd2>></span> |
| </span></span></code></pre></div><blockquote><p>注意：这个配置目前只对server=“tomcat"才能生效。</p></blockquote><h3 id=配置每个消费端的超时时间和http连接数>配置每个消费端的超时时间和HTTP连接数</h3><p>如果rest服务的消费端也是dubbo系统，可以像其他dubbo RPC机制一样，配置消费端调用此rest服务的最大超时时间以及每个消费端所能启动的最大HTTP连接数。</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:service</span> interface=<span style=color:#2aa198>"xxx"</span> ref=<span style=color:#2aa198>"xxx"</span> protocol=<span style=color:#2aa198>"rest"</span> timeout=<span style=color:#2aa198>"2000"</span> connections=<span style=color:#2aa198>"10"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>当然，由于这个配置针对消费端生效的，所以也可以在消费端配置：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:reference</span> id=<span style=color:#2aa198>"xxx"</span> interface=<span style=color:#2aa198>"xxx"</span> timeout=<span style=color:#2aa198>"2000"</span> connections=<span style=color:#2aa198>"10"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>但是，通常我们建议配置在服务提供端提供此类配置。按照dubbo官方文档的说法：“Provider上尽量多配置Consumer端的属性，让Provider实现者一开始就思考Provider服务特点、服务质量的问题。”</p><blockquote><p>注意：如果dubbo的REST服务是发布给非dubbo的客户端使用，则这里<code><dubbo:service/></code>上的配置完全无效，因为这种客户端不受dubbo控制。</p></blockquote><h3 id=用annotation取代部分spring-xml配置>用Annotation取代部分Spring XML配置</h3><p>以上所有的讨论都是基于dubbo在spring中的xml配置。但是，dubbo/spring本身也支持用annotation来作配置，所以我们也可以按dubbo官方文档中的步骤，把相关annotation加到REST服务的实现中，取代一些xml配置，例如：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>@Service</span>(protocol <span style=color:#719e07>=</span> <span style=color:#2aa198>"rest"</span>) |
| </span></span><span style=display:flex><span><span style=color:#268bd2>@Path</span>(<span style=color:#2aa198>"users"</span>) |
| </span></span><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>UserServiceImpl</span> <span style=color:#268bd2>implements</span> UserService { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@Autowired</span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>private</span> UserRepository userRepository; |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@POST</span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@Path</span>(<span style=color:#2aa198>"register"</span>) |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@Consumes</span>({MediaType.APPLICATION_JSON}) |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>public</span> <span style=color:#dc322f>void</span> <span style=color:#268bd2>registerUser</span>(User user) { |
| </span></span><span style=display:flex><span> <span style=color:#586e75>// save the user</span> |
| </span></span><span style=display:flex><span> userRepository.save(user); |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>annotation的配置更简单更精确，通常也更便于维护（当然现代IDE都可以在xml中支持比如类名重构，所以就这里的特定用例而言，xml的维护性也很好）。而xml对代码的侵入性更小一些，尤其有利于动态修改配置，特别是比如你要针对单个服务配置连接超时时间、每客户端最大连接数、集群策略、权重等等。另外，特别对复杂应用或者模块来说，xml提供了一个中心点来涵盖的所有组件和配置，更一目了然，一般更便于项目长时期的维护。</p><p>当然，选择哪种配置方式没有绝对的优劣，和个人的偏好也不无关系。</p><h3 id=添加自定义的filterinterceptor等>添加自定义的Filter、Interceptor等</h3><p>Dubbo的REST也支持JAX-RS标准的Filter和Interceptor，以方便对REST的请求与响应过程做定制化的拦截处理。</p><p>其中，Filter主要用于访问和设置HTTP请求和响应的参数、URI等等。例如，设置HTTP响应的cache header：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>CacheControlFilter</span> <span style=color:#268bd2>implements</span> ContainerResponseFilter { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>public</span> <span style=color:#dc322f>void</span> <span style=color:#268bd2>filter</span>(ContainerRequestContext req, ContainerResponseContext res) { |
| </span></span><span style=display:flex><span> <span style=color:#719e07>if</span> (req.getMethod().equals(<span style=color:#2aa198>"GET"</span>)) { |
| </span></span><span style=display:flex><span> res.getHeaders().add(<span style=color:#2aa198>"Cache-Control"</span>, <span style=color:#2aa198>"someValue"</span>); |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>Interceptor主要用于访问和修改输入与输出字节流，例如，手动添加GZIP压缩：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>GZIPWriterInterceptor</span> <span style=color:#268bd2>implements</span> WriterInterceptor { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>@Override</span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>public</span> <span style=color:#dc322f>void</span> <span style=color:#268bd2>aroundWriteTo</span>(WriterInterceptorContext context) |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>throws</span> IOException, WebApplicationException { |
| </span></span><span style=display:flex><span> OutputStream outputStream <span style=color:#719e07>=</span> context.getOutputStream(); |
| </span></span><span style=display:flex><span> context.setOutputStream(<span style=color:#719e07>new</span> GZIPOutputStream(outputStream)); |
| </span></span><span style=display:flex><span> context.proceed(); |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>在标准JAX-RS应用中，我们一般是为Filter和Interceptor添加@Provider annotation，然后JAX-RS runtime会自动发现并启用它们。而在dubbo中，我们是通过添加XML配置的方式来注册Filter和Interceptor：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> port=<span style=color:#2aa198>"8888"</span> extension=<span style=color:#2aa198>"xxx.TraceInterceptor, xxx.TraceFilter"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>在此，我们可以将Filter、Interceptor和DynamicFeature这三种类型的对象都添加到<code>extension</code>属性上，多个之间用逗号分隔。（DynamicFeature是另一个接口，可以方便我们更动态的启用Filter和Interceptor，感兴趣请自行google。）</p><p>当然，dubbo自身也支持Filter的概念，但我们这里讨论的Filter和Interceptor更加接近协议实现的底层，相比dubbo的filter，可以做更底层的定制化。</p><blockquote><p>注：这里的XML属性叫extension，而不是叫interceptor或者filter，是因为除了Interceptor和Filter，未来我们还会添加更多的扩展类型。</p></blockquote><p>如果REST的消费端也是dubbo系统（参见下文的讨论），则也可以用类似方式为消费端配置Interceptor和Filter。但注意，JAX-RS中消费端的Filter和提供端的Filter是两种不同的接口。例如前面例子中服务端是ContainerResponseFilter接口，而消费端对应的是ClientResponseFilter:</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>LoggingFilter</span> <span style=color:#268bd2>implements</span> ClientResponseFilter { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>public</span> <span style=color:#dc322f>void</span> <span style=color:#268bd2>filter</span>(ClientRequestContext reqCtx, ClientResponseContext resCtx) <span style=color:#268bd2>throws</span> IOException { |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"status: "</span> <span style=color:#719e07>+</span> resCtx.getStatus()); |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"date: "</span> <span style=color:#719e07>+</span> resCtx.getDate()); |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"last-modified: "</span> <span style=color:#719e07>+</span> resCtx.getLastModified()); |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"location: "</span> <span style=color:#719e07>+</span> resCtx.getLocation()); |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"headers:"</span>); |
| </span></span><span style=display:flex><span> <span style=color:#719e07>for</span> (Entry<span style=color:#719e07><</span>String, List<span style=color:#719e07><</span>String<span style=color:#719e07>>></span> header : resCtx.getHeaders().entrySet()) { |
| </span></span><span style=display:flex><span> System.out.print(<span style=color:#2aa198>"\t"</span> <span style=color:#719e07>+</span> header.getKey() <span style=color:#719e07>+</span> <span style=color:#2aa198>" :"</span>); |
| </span></span><span style=display:flex><span> <span style=color:#719e07>for</span> (String value : header.getValue()) { |
| </span></span><span style=display:flex><span> System.out.print(value <span style=color:#719e07>+</span> <span style=color:#2aa198>", "</span>); |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span> System.out.print(<span style=color:#2aa198>"\n"</span>); |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span> System.out.println(<span style=color:#2aa198>"media-type: "</span> <span style=color:#719e07>+</span> resCtx.getMediaType().getType()); |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><h3 id=添加自定义的exception处理>添加自定义的Exception处理</h3><p>Dubbo的REST也支持JAX-RS标准的ExceptionMapper，可以用来定制特定exception发生后应该返回的HTTP响应。</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>CustomExceptionMapper</span> <span style=color:#268bd2>implements</span> ExceptionMapper<span style=color:#719e07><</span>NotFoundException<span style=color:#719e07>></span> { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>public</span> Response <span style=color:#268bd2>toResponse</span>(NotFoundException e) { |
| </span></span><span style=display:flex><span> <span style=color:#719e07>return</span> Response.status(Response.Status.NOT_FOUND).entity(<span style=color:#2aa198>"Oops! the requested resource is not found!"</span>).type(<span style=color:#2aa198>"text/plain"</span>).build(); |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>和Interceptor、Filter类似，将其添加到XML配置文件中即可启用：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> port=<span style=color:#2aa198>"8888"</span> extension=<span style=color:#2aa198>"xxx.CustomExceptionMapper"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><h3 id=配置http日志输出>配置HTTP日志输出</h3><p>Dubbo rest支持输出所有HTTP请求/响应中的header字段和body消息体。</p><p>在XML配置中添加如下自带的REST filter：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> port=<span style=color:#2aa198>"8888"</span> extension=<span style=color:#2aa198>"org.apache.dubbo.rpc.protocol.rest.support.LoggingFilter"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>然后配置在logging配置中至少为org.apache.dubbo.rpc.protocol.rest.support打开INFO级别日志输出，例如，在log4j.xml中配置：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><logger</span> name=<span style=color:#2aa198>"org.apache.dubbo.rpc.protocol.rest.support"</span><span style=color:#268bd2>></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><level</span> value=<span style=color:#2aa198>"INFO"</span><span style=color:#268bd2>/></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><appender-ref</span> ref=<span style=color:#2aa198>"CONSOLE"</span><span style=color:#268bd2>/></span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2></logger></span> |
| </span></span></code></pre></div><p>当然，你也可以直接在ROOT logger打开INFO级别日志输出：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><root></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><level</span> value=<span style=color:#2aa198>"INFO"</span> <span style=color:#268bd2>/></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><appender-ref</span> ref=<span style=color:#2aa198>"CONSOLE"</span><span style=color:#268bd2>/></span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2></root></span> |
| </span></span></code></pre></div><p>然后在日志中会有类似如下的内容输出：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-fallback data-lang=fallback><span style=display:flex><span>The HTTP headers are: |
| </span></span><span style=display:flex><span>accept: application/json;charset=UTF-8 |
| </span></span><span style=display:flex><span>accept-encoding: gzip, deflate |
| </span></span><span style=display:flex><span>connection: Keep-Alive |
| </span></span><span style=display:flex><span>content-length: 22 |
| </span></span><span style=display:flex><span>content-type: application/json |
| </span></span><span style=display:flex><span>host: 192.168.1.100:8888 |
| </span></span><span style=display:flex><span>user-agent: Apache-HttpClient/4.2.1 (java 1.5) |
| </span></span></code></pre></div><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-fallback data-lang=fallback><span style=display:flex><span>The contents of request body is: |
| </span></span><span style=display:flex><span>{"id":1,"name":"dang"} |
| </span></span></code></pre></div><p>打开HTTP日志输出后，除了正常日志输出的性能开销外，也会在比如HTTP请求解析时产生额外的开销，因为需要建立额外的内存缓冲区来为日志的输出做数据准备。</p><h3 id=输入参数的校验>输入参数的校验</h3><p>dubbo的rest支持采用Java标准的bean validation annotation（JSR 303)来做输入校验http://beanvalidation.org/</p><p>为了和其他dubbo远程调用协议保持一致，在rest中作校验的annotation必须放在服务的接口上，例如：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>interface</span> <span style=color:#268bd2>UserService</span> { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> User <span style=color:#268bd2>getUser</span>(<span style=color:#268bd2>@Min</span>(value<span style=color:#719e07>=</span>1L, message<span style=color:#719e07>=</span><span style=color:#2aa198>"User ID must be greater than 1"</span>) Long id); |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>当然，在很多其他的bean validation的应用场景都是将annotation放到实现类而不是接口上。把annotation放在接口上至少有一个好处是，dubbo的客户端可以共享这个接口的信息，dubbo甚至不需要做远程调用，在本地就可以完成输入校验。</p><p>然后按照dubbo的标准方式在XML配置中打开验证：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:service</span> interface=<span style=color:#2aa198>xxx.UserService"</span> ref=<span style=color:#2aa198>"userService"</span> protocol=<span style=color:#2aa198>"rest"</span> validation=<span style=color:#2aa198>"true"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><p>在dubbo的其他很多远程调用协议中，如果输入验证出错，是直接将<code>RpcException</code>抛向客户端，而在rest中由于客户端经常是非dubbo，甚至非java的系统，所以不便直接抛出Java异常。因此，目前我们将校验错误以XML的格式返回：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><violationReport></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><constraintViolations></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><path></span>getUserArgument0<span style=color:#268bd2></path></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><message></span>User ID must be greater than 1<span style=color:#268bd2></message></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2><value></span>0<span style=color:#268bd2></value></span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2></constraintViolations></span> |
| </span></span><span style=display:flex><span><span style=color:#268bd2></violationReport></span> |
| </span></span></code></pre></div><p>稍后也会支持其他数据格式的返回值。至于如何对验证错误消息作国际化处理，直接参考bean validation的相关文档即可。</p><p>如果你认为默认的校验错误返回格式不符合你的要求，可以如上面章节所述，添加自定义的ExceptionMapper来自由的定制错误返回格式。需要注意的是，这个ExceptionMapper必须用泛型声明来捕获dubbo的RpcException，才能成功覆盖dubbo rest默认的异常处理策略。为了简化操作，其实这里最简单的方式是直接继承dubbo rest的RpcExceptionMapper，并覆盖其中处理校验异常的方法即可：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-java data-lang=java><span style=display:flex><span><span style=color:#268bd2>public</span> <span style=color:#268bd2>class</span> <span style=color:#268bd2>MyValidationExceptionMapper</span> <span style=color:#268bd2>extends</span> RpcExceptionMapper { |
| </span></span><span style=display:flex><span> |
| </span></span><span style=display:flex><span> <span style=color:#268bd2>protected</span> Response <span style=color:#268bd2>handleConstraintViolationException</span>(ConstraintViolationException cve) { |
| </span></span><span style=display:flex><span> ViolationReport report <span style=color:#719e07>=</span> <span style=color:#719e07>new</span> ViolationReport(); |
| </span></span><span style=display:flex><span> <span style=color:#719e07>for</span> (ConstraintViolation cv : cve.getConstraintViolations()) { |
| </span></span><span style=display:flex><span> report.addConstraintViolation(<span style=color:#719e07>new</span> RestConstraintViolation( |
| </span></span><span style=display:flex><span> cv.getPropertyPath().toString(), |
| </span></span><span style=display:flex><span> cv.getMessage(), |
| </span></span><span style=display:flex><span> cv.getInvalidValue() <span style=color:#719e07>==</span> <span style=color:#cb4b16>null</span> <span style=color:#719e07>?</span> <span style=color:#2aa198>"null"</span> : cv.getInvalidValue().toString())); |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span> <span style=color:#586e75>// 采用json输出代替xml输出</span> |
| </span></span><span style=display:flex><span> <span style=color:#719e07>return</span> Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(report).type(ContentType.APPLICATION_JSON_UTF_8).build(); |
| </span></span><span style=display:flex><span> } |
| </span></span><span style=display:flex><span>} |
| </span></span></code></pre></div><p>然后将这个ExceptionMapper添加到XML配置中即可：</p><div class=highlight><pre tabindex=0 style=color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-xml data-lang=xml><span style=display:flex><span><span style=color:#268bd2><dubbo:protocol</span> name=<span style=color:#2aa198>"rest"</span> port=<span style=color:#2aa198>"8888"</span> extension=<span style=color:#2aa198>"xxx.MyValidationExceptionMapper"</span><span style=color:#268bd2>/></span> |
| </span></span></code></pre></div><div id=pre-footer><h2>Feedback</h2><p class=feedback--prompt>Was this page helpful?</p><button class="btn btn-primary mb-4 feedback--yes">Yes</button> |
| <button class="btn btn-primary mb-4 feedback--no">No</button></div><script>const yes=document.querySelector(".feedback--yes"),no=document.querySelector(".feedback--no");document.querySelectorAll(".feedback--link").forEach(e=>{e.href=e.href+window.location.pathname});const sendFeedback=e=>{gtag||console.log("!gtag"),gtag("event","click",{event_category:"Helpful",event_label:window.location.pathname,value:e})},disableButtons=()=>{yes.disabled=!0,yes.classList.add("feedback--button__disabled"),no.disabled=!0,no.classList.add("feedback--button__disabled")};yes.addEventListener("click",()=>{sendFeedback(1),disableButtons(),document.querySelector(".feedback--response").classList.remove("feedback--response__hidden")}),no.addEventListener("click",()=>{sendFeedback(0),disableButtons(),document.querySelector(".feedback--response").classList.remove("feedback--response__hidden")})</script><br><div class="text-muted mt-5 pt-3 border-top">Last modified December 22, 2020: <a href=https://github.com/apache/dubbo-website/commit/6e41905afab4de2587b93c0da13729d50d757830>clean up website (6e41905afab)</a></div></div></main><div class="d-none d-xl-block col-xl-2 td-toc d-print-none"><div class="td-page-meta ml-2 pb-1 pt-2 mb-0"><a href=https://github.com/apache/dubbo-website/edit/master/content/en/docs/v2.7/user/references/protocol/rest.md target=_blank><i class="fa fa-edit fa-fw"></i> Edit this page</a> |
| <a href="https://github.com/apache/dubbo-website/new/master/content/en/docs/v2.7/user/references/protocol/rest.md?filename=change-me.md&value=---%0Atitle%3A+%22Long+Page+Title%22%0AlinkTitle%3A+%22Short+Nav+Title%22%0Aweight%3A+100%0Adescription%3A+%3E-%0A+++++Page+description+for+heading+and+indexes.%0A---%0A%0A%23%23+Heading%0A%0AEdit+this+template+to+create+your+new+page.%0A%0A%2A+Give+it+a+good+name%2C+ending+in+%60.md%60+-+e.g.+%60getting-started.md%60%0A%2A+Edit+the+%22front+matter%22+section+at+the+top+of+the+page+%28weight+controls+how+its+ordered+amongst+other+pages+in+the+same+directory%3B+lowest+number+first%29.%0A%2A+Add+a+good+commit+message+at+the+bottom+of+the+page+%28%3C80+characters%3B+use+the+extended+description+field+for+more+detail%29.%0A%2A+Create+a+new+branch+so+you+can+preview+your+new+file+and+request+a+review+via+Pull+Request.%0A" target=_blank><i class="fa fa-edit fa-fw"></i> Create child page</a> |
| <a href="https://github.com/apache/dubbo-website/issues/new?title=rest%20protocol" target=_blank><i class="fab fa-github fa-fw"></i> Create an issue</a> |
| <a href=https://github.com/apache/dubbo/issues/new target=_blank><i class="fas fa-tasks fa-fw"></i> Create project issue</a></div><nav id=TableOfContents><ul><li><a href=#快速入门>快速入门</a></li><li><a href=#rest服务提供端详解>REST服务提供端详解</a><ul><li><a href=#http-postget的实现>HTTP POST/GET的实现</a></li><li><a href=#annotation放在接口类还是实现类>Annotation放在接口类还是实现类</a></li><li><a href=#jsonxml等多数据格式的支持>JSON、XML等多数据格式的支持</a></li><li><a href=#中文字符支持>中文字符支持</a></li><li><a href=#xml数据格式的额外要求>XML数据格式的额外要求</a></li><li><a href=#定制序列化>定制序列化</a></li><li><a href=#配置rest-server的实现>配置REST Server的实现</a></li><li><a href=#获取上下文context信息>获取上下文（Context）信息</a></li><li><a href=#配置端口号和context-path>配置端口号和Context Path</a></li><li><a href=#配置线程数和io线程数>配置线程数和IO线程数</a></li><li><a href=#配置长连接>配置长连接</a></li><li><a href=#配置最大的http连接数>配置最大的HTTP连接数</a></li><li><a href=#配置每个消费端的超时时间和http连接数>配置每个消费端的超时时间和HTTP连接数</a></li><li><a href=#用annotation取代部分spring-xml配置>用Annotation取代部分Spring XML配置</a></li><li><a href=#添加自定义的filterinterceptor等>添加自定义的Filter、Interceptor等</a></li><li><a href=#添加自定义的exception处理>添加自定义的Exception处理</a></li><li><a href=#配置http日志输出>配置HTTP日志输出</a></li><li><a href=#输入参数的校验>输入参数的校验</a></li></ul></li></ul></nav></div></div></div></div><footer class="bg-dark py-5 row d-print-none footer-margin-0"><div class="container-fluid mx-sm-5"><div class=row><div class="col-6 col-sm-4 text-xs-center order-sm-2"><ul class="list-inline mb-0"><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title="Dubbo mailing list archive" aria-label="Dubbo mailing list archive"><a class=text-white target=_blank rel="noopener noreferrer" href=https://lists.apache.org/list.html?dev@dubbo.apache.org><i class="fa fa-envelope"></i></a></li></ul></div><div class="col-6 col-sm-4 text-right text-xs-center order-sm-3"><ul class="list-inline mb-0"><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title=GitHub aria-label=GitHub><a class=text-white target=_blank rel="noopener noreferrer" href=https://github.com/apache/dubbo><i class="fab fa-github"></i></a></li><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title="Subscribe to mailing list" aria-label="Subscribe to mailing list"><a class=text-white target=_blank rel="noopener noreferrer" href=mailto:dev-subscribe@dubbo.apache.org><i class="fa fa-envelope"></i></a></li></ul></div><div class="col-12 col-sm-4 text-center py-2 order-sm-2"><small class=text-white>© 2024 The Apache Software Foundation. Apache and the Apache feather logo are trademarks of The Apache Software Foundation. All Rights Reserved</small></div></div></div></footer><div class="row pt-2 pb-2 footer-margin-0"><div class="container-fluid mx-sm-5"><div class=text-center id=my-footer><img alt=apache_logo src=/imgs/apache_logo.png><ul><li><a href=https://www.apache.org>Foundation</a></li><li><a href=https://www.apache.org/licenses/>License</a></li><li><a href=https://dubbo.apache.org/en/overview/notices/>Security</a></li><li><a href=https://www.apache.org/events/current-event>Events</a></li><li><a href=https://www.apache.org/foundation/sponsorship.html>Sponsorship</a></li><li><a href=https://privacy.apache.org/policies/privacy-policy-public.html>Privacy</a></li><li><a href=https://www.apache.org/foundation/thanks.html>Thanks</a></li></ul></div></div></div><script src=/js/popper.min.js integrity=sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49 crossorigin=anonymous></script><script src=/js/bootstrap.min.js integrity=sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy crossorigin=anonymous></script><script src=/js/main.min.b075178d232d3b0039b3cb6af2fc2e9d90071820167a60f4eea3a79169975ee8.js integrity="sha256-sHUXjSMtOwA5s8tq8vwunZAHGCAWemD07qOnkWmXXug=" crossorigin=anonymous></script><script async src=https://widget.kapa.ai/kapa-widget.bundle.js data-website-id=d763c4f2-f871-400b-aeca-d986c4af73c2 data-project-name="Apache Dubbo" data-project-color=#E8442E data-button-text="Ask AI" data-search-mode-enabled=true data-modal-open-on-command-k=true data-modal-disclaimer="The AI supports multiple languages, but it may not be accessible in China due to recaptcha, a proxy is required." data-project-logo=https://pbs.twimg.com/profile_images/1011849068283191302/FJbH5vbF_400x400.jpg data-modal-example-questions="What is Apache Dubbo?,How to run Apache Dubbo?" data-button-position-top data-button-position-right=20px data-button-position-bottom=200px data-button-position-left></script><script>(function(e,t,n,s){e[s]=e[s]||[];var a=t.getElementsByTagName(n)[0],i=t.createElement(n);i.async=!0,i.id="beacon-aplus",i.setAttribute("exparams","userid=&aplus&sidx=aplusSidex&ckx=aplusCkx"),i.src="//g.alicdn.com/alilog/mlog/aplus_v2.js",i.crossorigin="anonymous",a.parentNode.insertBefore(i,a)})(window,document,"script","aplus_queue"),function(e){var t=e.createElement("script");t.type="text/javascript",t.async=!0,t.src="//g.alicdn.com/aes/??tracker/3.3.4/index.js,tracker-plugin-pv/3.0.5/index.js,tracker-plugin-event/3.0.0/index.js,tracker-plugin-autolog/3.0.3/index.js,tracker-plugin-survey/3.0.3/index.js,tracker-plugin-jserror/3.0.3/index.js,tracker-plugin-resourceError/3.0.3/index.js",t.onload=function(){window.AES_CONFIG=window.AES_CONFIG||{env:"prod"},window.aes=new AES({pid:"zN245h",user_type:6}),window.AESPluginAutologConfig={exposure:"auto"},window.AEMPluginInstances=[aes.use(AESPluginPV,window.AESPluginPVConfig||{enableHistory:!0}),aes.use(AESPluginEvent,window.AESPluginEventConfig||{}),aes.use(AESPluginSurvey,window.AESPluginEventConfig||{}),aes.use(AESPluginAutolog,window.AESPluginAutologConfig||{}),aes.use(AESPluginJSError,window.AESPluginJSError||{}),aes.use(AESPluginResourceError,window.AESPluginResourceError||{})]},setTimeout(function(){e.getElementsByTagName("body")[0].appendChild(t)},800)}(document)</script></body></html> |
