| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" > |
| <head> |
| <meta charset="utf-8" /> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="description" content="None" /> |
| <link rel="shortcut icon" href="img/favicon.ico" /> |
| <title>ServiceComb Java Chassis Developers Guide</title> |
| <link rel="stylesheet" href="css/theme.css" /> |
| <link rel="stylesheet" href="css/theme_extra.css" /> |
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" /> |
| |
| <script> |
| // Current page data |
| var mkdocs_page_name = "Introduction"; |
| var mkdocs_page_input_path = "index.md"; |
| var mkdocs_page_url = null; |
| </script> |
| |
| <script src="js/jquery-3.6.0.min.js" defer></script> |
| <!--[if lt IE 9]> |
| <script src="js/html5shiv.min.js"></script> |
| <![endif]--> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script> |
| <script>hljs.initHighlightingOnLoad();</script> |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search"> |
| <a href="." class="icon icon-home"> ServiceComb Java Chassis Developers Guide |
| </a><div role="search"> |
| <form id ="rtd-search-form" class="wy-form" action="./search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" title="Type search term here" /> |
| </form> |
| </div> |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="reference internal current" href=".">Introduction</a> |
| <ul class="current"> |
| </ul> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">Getting Started</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="start/terminology/">Glossary</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="start/architecture/">Architecture</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="start/development-environment/">Development environment</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="start/first-sample/">Develop the first microservice</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">Development Service Provider</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/definition/service-definition/">Service definition</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/define-contract/">Service contract definition</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/code-first/">Implicit API definition</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/swagger-annotation/">Use Swagger annotations</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/springmvc/">Develop with SpringMVC</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/jaxrs/">Develop with JAX-RS</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/transparent-rpc/">Develop with Transparent RPC</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/interface-constraints/">Interface definition and data type</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/listen-address-and-publish-address/">Service listening address and publishing address</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/thread-pool/">Thread pool</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="#">Service Configuration</a> |
| <ul> |
| <li class="toctree-l2"><a class="reference internal" href="build-provider/configuration/ratelimite-strategy/">Rate Limiting Policy</a> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="build-provider/configuration/downgrade-strategy/">Fallback Policy</a> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="build-provider/configuration/parameter-validator/">Parameter Validator</a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/bootup/">Boot-up Process</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-provider/access-log-configuration/">Access Log Configuration</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">Writing Service Consumer</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="build-consumer/common-configuration/">Consumer common configuration</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-consumer/using-resttemplate/">Using Rest Template</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-consumer/using-AsyncRestTemplate/">Using AsyncRestTemplate</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-consumer/develop-consumer-using-rpc/">Using with RPC</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-consumer/with-contract/">Contract</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="#">Invoke control</a> |
| <ul> |
| <li class="toctree-l2"><a class="reference internal" href="build-consumer/circuit-breaker/">Circuit Breaker</a> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="build-consumer/flow-control/">Flow Control</a> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="build-consumer/fault-injection/">Fault Injection</a> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="build-consumer/3rd-party-service-invoke/">Invoke 3rd-party REST services</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">Transports</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="transports/rest-over-servlet/">REST over Servlet</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="transports/rest-over-vertx/">REST over Vertx</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="transports/highway-rpc/">Highway</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="transports/http2/">HTTP2</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">General Development</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/visit-sc/">Access Service Center</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/metrics/">Metrics</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/microservice-invocation-chain/">Microservice invocation chain</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/customized-tracing/">Customized-Tracing</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/local-develop-test/">Local development and testing</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/http-filter/">Http Filter</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/file-upload/">File Uploading</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/file-download/">File Downloading</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/reactive/">Reactive Programing</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/dnsconfig/">DNS Custom Configuration</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/dai-li-she-zhi/">Proxy Settings</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/report-framework-version/">Report framework version</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/cross-app-invocation/">Cross-application invocation</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/secret-field/">Customized serialization and deserialization</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/context/">Using Context to pass control messages</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/produceprocess/">Return value serialization extension</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/CORS/">CORS mechanism</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/AlarmEvent/">Get fuse and instance isolation alarm event information</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/shutdown/">Shutdown gracefully</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/error-handling/">Handling exceptions</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/multienvironment/">Multi-environment isolation between microservice instances</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="general-development/thread-model/">Thread Model</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">Configuration</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="config/general-config/">General config</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="config/inject-config/">Configuration injection</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">Service Capability Open</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="edge/open-service/">Intruductions</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="edge/by-servicecomb-sdk/">Using Edge Service</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="edge/nginx/">Using confd and Nginx as edge services</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="edge/zuul/">Use zuul as edge services</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">Service Packing and Running</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="packaging/standalone/">Standalone mode</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="packaging/web-container/">WEB container mode</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">Micro Service Security</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="security/tls/">Using TLS</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="security/rsa/">Using RSA certification</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">Using java chassis in Spring Boot</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="using-java-chassis-in-spring-boot/using-java-chassis-in-spring-boot/">Intruductions</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using-java-chassis-in-spring-boot/components-for-spring-boot/">spring boot starter for java-chassis</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using-java-chassis-in-spring-boot/java-application/">JAVA application development</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using-java-chassis-in-spring-boot/web-application/">Web development method development</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using-java-chassis-in-spring-boot/diff-between-java-web/">The difference between JAVA application method and Web development method</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="using-java-chassis-in-spring-boot/diff-spring-mvc/">The difference in Spring MVC mode</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">Handlers reference</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="references-handlers/intruduction/">Intruductions</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="references-handlers/loadbalance/">Load Balancing</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="references-handlers/publickey/">Public key authentication</a> |
| </li> |
| </ul> |
| <p class="caption"><span class="caption-text">FAQ</span></p> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="question-and-answer/question_answer/">Q & A</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="question-and-answer/faq/">FAQ</a> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="question-and-answer/interface-compatibility/">Micro Service Interface Compatibility FAQ</a> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu"> |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href=".">ServiceComb Java Chassis Developers Guide</a> |
| |
| </nav> |
| <div class="wy-nav-content"> |
| <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="." class="icon icon-home" alt="Docs"></a> »</li> |
| <li>Introduction</li> |
| <li class="wy-breadcrumbs-aside"> |
| </li> |
| </ul> |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div class="section" itemprop="articleBody"> |
| |
| <h1 id="overview">Overview</h1> |
| <p>Apache ServiceComb Java Chassis provides developers with a Java SDK to quickly build microservices. It contains the following features:</p> |
| <ul> |
| <li>Multiple development styles, REST (JAX-RS, Spring MVC) and RPC</li> |
| <li>Multiple communication protocols, HTTP over Vert.x, Http Over Servlet, Highway, etc.</li> |
| <li>Uniform service providers, service consumer handler, and contract-based out-of-the-box service governance capabilities</li> |
| </ul> |
| <p>For other versions, please check the following table.</p> |
| <table> |
| <thead> |
| <tr> |
| <th align="left">version</th> |
| <th align="left">link</th> |
| <th align="left">notes</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td align="left">2.8.x</td> |
| <td align="left"><a href="https://servicecomb.apache.org/references/java-chassis/zh_CN/">中文</a>, <a href="https://servicecomb.apache.org/references/java-chassis/en_US/">English</a></td> |
| <td align="left"></td> |
| </tr> |
| <tr> |
| <td align="left">2.8.x</td> |
| <td align="left"><a href="https://servicecomb.gitee.io/servicecomb-java-chassis-doc/java-chassis/zh_CN/">中文</a>, <a href="https://servicecomb.gitee.io/servicecomb-java-chassis-doc/java-chassis/en_US/">English</a></td> |
| <td align="left">hosted by gitee pages</td> |
| </tr> |
| </tbody> |
| </table> |
| |
| </div> |
| </div><footer> |
| <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> |
| <a href="start/terminology/" class="btn btn-neutral float-right" title="Glossary">Next <span class="icon icon-circle-arrow-right"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <!-- Copyright etc --> |
| </div> |
| |
| Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| <div class="rst-versions" role="note" aria-label="Versions"> |
| <span class="rst-current-version" data-toggle="rst-current-version"> |
| |
| |
| |
| <span><a href="start/terminology/" style="color: #fcfcfc">Next »</a></span> |
| |
| </span> |
| </div> |
| <script>var base_url = '.';</script> |
| <script src="js/theme_extra.js" defer></script> |
| <script src="js/theme.js" defer></script> |
| <script src="search/main.js" defer></script> |
| <script defer> |
| window.onload = function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }; |
| </script> |
| |
| </body> |
| </html> |
| |
| <!-- |
| MkDocs version : 1.4.1 |
| Build Date UTC : 2022-10-29 01:01:20.932131+00:00 |
| --> |
