content/docs/users/edge-in-1.0.0-m1/index.html - servicecomb-website - Git at Google

 <!doctype html>
 <!--
   Minimal Mistakes Jekyll Theme 4.4.1 by Michael Rose
   Copyright 2017 Michael Rose - mademistakes.com | @mmistakes
   Free for personal and commercial use under the MIT license
   https://github.com/mmistakes/minimal-mistakes/blob/master/LICENSE.txt
 -->
 <html lang="en" class="no-js">
   <head>
     <meta charset="utf-8">

 <!-- begin SEO -->


 <title>ServiceComb Java Chassis Edge Service - Apache ServiceComb</title>


 <meta name="description" content="ServiceComb Java Chassis Edge Service">


 <meta name="author" content="">

 <meta property="og:locale" content="en">
 <meta property="og:site_name" content="Apache ServiceComb">
 <meta property="og:title" content="ServiceComb Java Chassis Edge Service">


   <link rel="canonical" href="https://github.com/pages/apache/incubator-servicecomb-website/docs/users/edge-in-1.0.0-m1/">
   <meta property="og:url" content="https://github.com/pages/apache/incubator-servicecomb-website/docs/users/edge-in-1.0.0-m1/">


   <meta property="og:description" content="ServiceComb Java Chassis Edge Service">


   <meta name="twitter:site" content="@ServiceComb">
   <meta name="twitter:title" content="ServiceComb Java Chassis Edge Service">
   <meta name="twitter:description" content="ServiceComb Java Chassis Edge Service">
   <meta name="twitter:url" content="">


     <meta name="twitter:card" content="summary">


   <script type="application/ld+json">
     {
       "@context" : "http://schema.org",
       "@type" : "Person",
       "name" : "Apache ServiceComb",
       "url" : "https://github.com/pages/apache/incubator-servicecomb-website",
       "sameAs" : null
     }
   </script>


   <meta name="google-site-verification" content="HvJjNd7vvJ-yjSTHlBiIWEYxp_Hrz-PYEY5Idz9LRcA" />


 <!-- end SEO -->


 <link href="/feed.xml" type="application/atom+xml" rel="alternate" title="Apache ServiceComb Feed">

 <!-- http://t.co/dKP3o1e -->
 <meta name="HandheldFriendly" content="True">
 <meta name="MobileOptimized" content="320">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">

 <script>
   document.documentElement.className = document.documentElement.className.replace(/\bno-js\b/g, '') + ' js ';
 </script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script>
 <script src="/assets/vendor/prism/prism.js"></script>

 <script type="text/javascript" async
   src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-MML-AM_CHTML">
 </script>

 <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/css/bootstrap.min.css" integrity="sha384-/Y6pD6FV/Vv2HJnA6t+vslU6fwYXjCFtcEpHbNJ0lyAFsXTsjBbfaDjzALeQsN6M" crossorigin="anonymous">

 <script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.11.0/umd/popper.min.js" integrity="sha384-b/U6ypiBEHpOf/4+1nzFpr53nxSS+GLCkfwBdFNTxtclqqenISfwAzpKaMNFNmj4" crossorigin="anonymous"></script>
 <script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/js/bootstrap.min.js" integrity="sha384-h0AbiXch4ZDo7tp9hKZ4TsHbi047NrKGLO3SEJAg45jXxnGIfYzk4Si90RDIqNm1" crossorigin="anonymous"></script>
 <!-- For all browsers -->
 <link rel="stylesheet" href="/assets/css/main.css">
 <link rel="stylesheet" href="/assets/vendor/prism/prism.css">

 <!--[if lte IE 9]>
   <style>
     /* old IE unsupported flexbox fixes */
     .greedy-nav .site-title {
       padding-right: 3em;
     }
     .greedy-nav button {
       position: absolute;
       top: 0;
       right: 0;
       height: 100%;
     }
   </style>
 <![endif]-->

 <meta http-equiv="cleartype" content="on">

     <!-- start custom head snippets -->

 <!-- insert favicons. use http://realfavicongenerator.net/ -->
 <link href="https://fonts.loli.net/css?family=Roboto:400,500,700|Source+Code+Pro" rel="stylesheet">
 <script src="/assets/js/custom.js"></script>
 <!-- end custom head snippets -->

   </head>

   <body class="layout--single">

     <!--[if lt IE 9]>
 <div class="notice--danger align-center" style="margin: 0;">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</div>
 <![endif]-->
     <div class="masthead" onmouseleave="$('#childrenShow').css('display', 'none')">
   <div class="masthead__inner-wrap">
     <div class="masthead__menu">
       <nav id="site-nav" class="greedy-nav">

           <a class="site-title active" href="/"><img src="https://www.apache.org/img/servicecomb.png"></a>

         <ul class="visible-links">


               <li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">

                   <a href="/">Home</a>

               </li>


               <li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">

                   <a href="/developers/">Projects</a>

               </li>


             <li class="def-nav-li" onmouseenter="$('#childrenShow').css('display', 'block')">


                 <a class="active" href="/docs/users/">Documentation</a>


               <ul id="childrenShow" class="def-children-show-en" onmouseleave="$('#childrenShow').css('display', 'none')">

                 <li><a href="/docs/getting-started/" class="">Getting started</a></li>

                 <li><a href="/docs/users/" class="">Docs</a></li>

                 <li><a href="/slides/" class="">Video</a></li>

                 <li><a href="/faqs/" class="">FAQ</a></li>

               </ul>
             </li>


               <li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">

                   <a href="/developers/contributing/">Community</a>

               </li>


               <li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">

                   <a href="/year-archive/">Blogs</a>

               </li>


               <li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">

                   <a href="/release/">Downloads</a>

               </li>


         </ul>
         <button><div class="navicon"></div></button>
         <ul class="hidden-links hidden"></ul>
         <div class="nav-lang">


             <a href=/cn/docs/users/edge-in-1.0.0-m1/>中文</a>

         </div>
       </nav>
     </div>
   </div>
 </div>


 <div id="main" role="main">

   <div class="sidebar sticky">

       <div class="back-to-home"><a href="/">Home</a> > ServiceComb Java Chassis Edge Service</div>


 <nav class="nav__list">

   <input id="ac-toc" name="accordion-toc" type="checkbox" />
   <label for="ac-toc">Toggle Menu</label>
   <ul class="nav__items">

       <li>

           <span class="nav__sub-title">Java Chassis User Guide</span>


         <ul>


             <li><a href="/references/java-chassis/zh_CN/" class="">2.3.0</a></li>

         </ul>

       </li>

       <li>

           <span class="nav__sub-title">Pack User Guide</span>


         <ul>


             <li><a href="https://github.com/apache/servicecomb-pack/blob/master/docs/user_guide.md" class="">0.5.0</a></li>

         </ul>

       </li>

       <li>

           <span class="nav__sub-title">ServiceCenter User Guide</span>


         <ul>


             <li><a href="https://service-center.readthedocs.io/en/latest/user-guides.html" class="">2.0.0</a></li>

         </ul>

       </li>

       <li>

           <span class="nav__sub-title">Kie User Guide</span>


         <ul>


             <li><a href="https://kie.readthedocs.io/en/latest/" class="">0.2.0</a></li>

         </ul>

       </li>

       <li>

           <span class="nav__sub-title">Mesher User Guide</span>


         <ul>


             <li><a href="https://mesher.readthedocs.io/en/latest/" class="">1.6.3</a></li>

         </ul>

       </li>

   </ul>
 </nav>


   </div>


   <article class="page" itemscope itemtype="http://schema.org/CreativeWork">
     <meta itemprop="headline" content="ServiceComb Java Chassis Edge Service">
     <meta itemprop="description" content="ServiceComb Java Chassis Edge Service">

     <meta itemprop="dateModified" content="April 03, 2018">

     <div class="page__inner-wrap">


           <header>
             <h1 class="page__title" itemprop="headline">ServiceComb Java Chassis Edge Service
 </h1>

           </header>


       <section class="page__content" itemprop="text">
         <aside class="sidebar__right">
 <nav class="toc">
     <!-- <header><h4 class="nav__title"><i class="fa fa-file-text"></i> On This Page</h4></header> -->
 <ul class="toc__menu" id="markdown-toc">
   <li><a href="#edge-features" id="markdown-toc-edge-features">Edge Features</a>    <ul>
       <li><a href="#loose-coupling" id="markdown-toc-loose-coupling">Loose Coupling</a></li>
       <li><a href="#auto-match-available-version" id="markdown-toc-auto-match-available-version">Auto Match Available Version</a></li>
       <li><a href="#support-consumer-handler" id="markdown-toc-support-consumer-handler">Support Consumer Handler</a></li>
       <li><a href="#use-reactive-mode-as-default" id="markdown-toc-use-reactive-mode-as-default">Use Reactive Mode As Default</a></li>
     </ul>
   </li>
   <li><a href="#develop-an-edge-service" id="markdown-toc-develop-an-edge-service">Develop An Edge Service</a>    <ul>
       <li><a href="#add-dependency" id="markdown-toc-add-dependency">Add Dependency</a></li>
       <li><a href="#develop-dispatcher" id="markdown-toc-develop-dispatcher">Develop Dispatcher</a></li>
       <li><a href="#load-dispatcher" id="markdown-toc-load-dispatcher">Load Dispatcher</a></li>
       <li><a href="#extend-handleroptional" id="markdown-toc-extend-handleroptional">Extend Handler(Optional)</a></li>
     </ul>
   </li>
   <li><a href="#other-reference" id="markdown-toc-other-reference">Other Reference</a></li>
 </ul>

   </nav>
 </aside>

 <p>We had provide an edge core module since 1.0.0-m1, please checkout the user guide and <a href="https://github.com/apache/servicecomb-java-chassis/releases">release note</a> for more information.Also subscribe ServiceComb mail-list(dev-subscribe@servicecomb.apache.org) and join discussion is welcome.</p>

 <h2 id="edge-features">Edge Features</h2>
 <h3 id="loose-coupling">Loose Coupling</h3>
 <p>Edge Service only redirect requests, no dependencies between services.</p>

 <h3 id="auto-match-available-version">Auto Match Available Version</h3>
 <p>Edge Service can auto match available versions, for example:</p>
 <ul>
   <li>In version 1.0.0 provided Operation1</li>
   <li>In version 1.1.0 provided both Operation1 and Operation2</li>
 </ul>

 <p>If Edge Service redirect the request of Operation1,both instances of version 1.0.0 and instances of version 1.1.0 are allowed, but if Edge Service redirect the request of Operation2, only instances of version 1.1.0 will be selected.</p>

 <h3 id="support-consumer-handler">Support Consumer Handler</h3>
 <p>Edge Service support all Java Chassis Consumer Handlers, also support user extend custom handlers.</p>

 <h3 id="use-reactive-mode-as-default">Use Reactive Mode As Default</h3>
 <p>Because Edge Service will proxy all requests, so high performance is required, it use reactive mode as default, please do not add any heavy cost(blocking) codes, such as:</p>
 <ul>
   <li>Database query, remote call etc..</li>
   <li>Sleep, wait etc..</li>
   <li>Loop or heavy cost operation etc..</li>
 </ul>

 <h2 id="develop-an-edge-service">Develop An Edge Service</h2>
 <h3 id="add-dependency">Add Dependency</h3>
 <p>Only need import edge-core:</p>
 <div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;dependency&gt;</span>
   <span class="nt">&lt;groupId&gt;</span>org.apache.servicecomb<span class="nt">&lt;/groupId&gt;</span>
   <span class="nt">&lt;artifactId&gt;</span>edge-core<span class="nt">&lt;/artifactId&gt;</span>
   <span class="nt">&lt;version&gt;</span>1.0.0-m1<span class="nt">&lt;/version&gt;</span>
 <span class="nt">&lt;/dependency&gt;</span>
 </code></pre></div></div>

 <h3 id="develop-dispatcher">Develop Dispatcher</h3>
 <p>For enable Edge Service redirection, we need develop Dispatcher,implement org.apache.servicecomb.transport.rest.vertx.VertxHttpDispatcher interface or extend org.apache.servicecomb.transport.rest.vertx.AbstractVertxHttpDispatcher class:</p>

 <h4 id="getorder-method">getOrder Method</h4>
 <p>This value returned will decide the priority of routing rules, the smaller value the higher priority.</p>

 <h4 id="init-method">init Method</h4>
 <p>Init routing rules of the Dispatcher, we use <a href="https://vertx.io/docs/vertx-web/java/#_routing_by_exact_path">Vertx Routing Rule</a>, for example we add two routing rules like:</p>
 <div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kd">public</span> <span class="kt">void</span> <span class="nf">init</span><span class="o">(</span><span class="nc">Router</span> <span class="n">router</span><span class="o">)</span> <span class="o">{</span>
   <span class="nc">String</span> <span class="n">regex</span> <span class="o">=</span> <span class="s">"/([^\\\\/]+)/([^\\\\/]+)/(.*)"</span><span class="o">;</span>
   <span class="n">router</span><span class="o">.</span><span class="na">routeWithRegex</span><span class="o">(</span><span class="n">regex</span><span class="o">).</span><span class="na">handler</span><span class="o">(</span><span class="nc">CookieHandler</span><span class="o">.</span><span class="na">create</span><span class="o">());</span>
   <span class="n">router</span><span class="o">.</span><span class="na">routeWithRegex</span><span class="o">(</span><span class="n">regex</span><span class="o">).</span><span class="na">handler</span><span class="o">(</span><span class="n">createBodyHandler</span><span class="o">());</span>
   <span class="n">router</span><span class="o">.</span><span class="na">routeWithRegex</span><span class="o">(</span><span class="n">regex</span><span class="o">).</span><span class="na">failureHandler</span><span class="o">(</span><span class="k">this</span><span class="o">::</span><span class="n">onFailure</span><span class="o">).</span><span class="na">handler</span><span class="o">(</span><span class="k">this</span><span class="o">::</span><span class="n">onRequest</span><span class="o">);</span>

   <span class="n">regex</span> <span class="o">=</span> <span class="s">"/([^\\\\/]+)/(.*)"</span><span class="o">;</span>
   <span class="n">router</span><span class="o">.</span><span class="na">routeWithRegex</span><span class="o">(</span><span class="n">regex</span><span class="o">).</span><span class="na">handler</span><span class="o">(</span><span class="nc">CookieHandler</span><span class="o">.</span><span class="na">create</span><span class="o">());</span>
   <span class="n">router</span><span class="o">.</span><span class="na">routeWithRegex</span><span class="o">(</span><span class="n">regex</span><span class="o">).</span><span class="na">handler</span><span class="o">(</span><span class="n">createBodyHandler</span><span class="o">());</span>
   <span class="n">router</span><span class="o">.</span><span class="na">routeWithRegex</span><span class="o">(</span><span class="n">regex</span><span class="o">).</span><span class="na">failureHandler</span><span class="o">(</span><span class="k">this</span><span class="o">::</span><span class="n">onFailure</span><span class="o">).</span><span class="na">handler</span><span class="o">(</span><span class="k">this</span><span class="o">::</span><span class="n">onRequest</span><span class="o">);</span>
 <span class="o">}</span>
 </code></pre></div></div>

 <ol>
   <li>/([^\/]+)/([^\/]+)/(.*) : this rule will match certain versions of instance for request, format like /user-service/v0/validate;</li>
   <li>/([^\/]+)/(.*) : this rule will match any versions of instance for request, format like /user-service/validate.</li>
 </ol>

 <h4 id="onrequest-method">onRequest Method</h4>
 <p>Implement of redirection:</p>
 <div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="kt">void</span> <span class="nf">onRequest</span><span class="o">(</span><span class="nc">RoutingContext</span> <span class="n">context</span><span class="o">)</span>
 </code></pre></div></div>

 <p>You can get micro-service name, path etc from context, then create and init a new EdgeInvocation for invoke:</p>
 <div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nc">EdgeInvocation</span> <span class="n">edgeInvocation</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">EdgeInvocation</span><span class="o">();</span>
 <span class="n">edgeInvocation</span><span class="o">.</span><span class="na">setVersionRule</span><span class="o">(</span><span class="n">versionRule</span><span class="o">);</span>
 <span class="n">edgeInvocation</span><span class="o">.</span><span class="na">init</span><span class="o">(</span><span class="n">serviceName</span><span class="o">,</span> <span class="n">context</span><span class="o">,</span> <span class="n">path</span><span class="o">,</span> <span class="n">httpServerFilters</span><span class="o">);</span>
 <span class="n">edgeInvocation</span><span class="o">.</span><span class="na">edgeInvoke</span><span class="o">();</span>
 </code></pre></div></div>

 <h3 id="load-dispatcher">Load Dispatcher</h3>
 <p>Edge Service use SPI(Service Provider Interface) to load custom VertxHttpDispatcher, create a folder named META-INF/services under resources folder, then add a file named org.apache.servicecomb.transport.rest.vertx.VertxHttpDispatcher in it, in this file , add full class name of our Dispatcher:</p>
 <div class="language-text highlighter-rouge"><div class="highlight"><pre class="highlight"><code>{your-package-path}.XXXDispatcher
 </code></pre></div></div>

 <h3 id="extend-handleroptional">Extend Handler(Optional)</h3>
 <p>Edge Service always use to provide monitoring, resiliency, security, and more, not only dynamic routing. We recommend extend custom handlers, there is an example named AuthHandler in demo-edge.</p>

 <h2 id="other-reference">Other Reference</h2>
 <p>In demo/demo-edge we had provided a simple demo to show abilities of Edge Service:</p>
 <ol>
   <li>edge-service:Edge Service, include AuthHandler;</li>
   <li>authentication:Simulate authentication, accept requests from AuthHandler;</li>
   <li>business-x.x.x:Simulate multi-version business instances;</li>
   <li>consumer:Simulate UI(user) request,include different version requirement.</li>
 </ol>


       </section>

       <footer class="page__meta">


       </footer>


     </div>


   </article>


 </div>


     <script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
     <div align="center" style="margin: 0 0;">
     <ins class="adsbygoogle"
          style="display:block; border-bottom: initial;"
          data-ad-client="ca-pub-7328585512091257"
          data-ad-slot="3049671934"
          data-ad-format="auto"></ins>
     </div>

     <div class="page__footer">
       <footer>
         <!-- start custom footer snippets -->

 <!-- end custom footer snippets -->

         <div class="container">
   <div class="row justify-content-md-center">

     <div class="col">
       <ul>
         <p class="header">Resources</p>
         <li><a href="/docs/getting-started/">Getting started</a></li>
         <li><a href="/docs/users/">User Guide</a></li>
         <li><a href="/slides/">Slides</a></li>
         <li><a href="/users/faq/">Common Questions</a></li>
       </ul>
     </div>
     <div class="col">
       <ul>
         <p class="header">ASF</p>
         <li><a href="http://www.apache.org">Foundation</a></li>
         <li><a href="http://www.apache.org/licenses/">License</a></li>
         <li><a href="http://www.apache.org/events/current-event">Events</a></li>
         <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
         <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
       </ul>
     </div>
     <div class="col">
       <ul>
         <p class="header">Contribute</p>
         <li><a href="http://issues.apache.org/jira/browse/SCB">Report a Doc Issue</a></li>
         <li><a href="https://github.com/apache/servicecomb-website/edit/master/_users/edge-in-1.0.0-m1.md">Edit This Page on Github</a></li>
         <li><a href="/developers/submit-codes/">Code Submit Guide</a></li>
         <li><a href="/security">Security</a></li>
       </ul>
     </div>
     <div class="col">
       <ul class="social-icons">
         <p class="header">Community</p>
         <li>
             <a href="mailto:dev-subscribe@servicecomb.incubator.apache.org" rel="nofollow"><span class="mail">Mailing List</span></a>
         </li>
         <li>
             <a href="https://github.com/apache?q=ServiceComb" target="_blank"><span class="github">Github</span></a>
         </li>
         <li>
             <a href="https://twitter.com/ServiceComb" target="_blank"><span class="twitter">Twitter</span></a>
         </li>
         <li>
             <a href="/feed.xml" target="_blank"><span class="rss">Feed</span></a>
         </li>
       </ul>
     </div>
   </div>
 </div>
 <div class="page__footer-bottom">
   <div>&copy; 2021 Apache ServiceComb. Powered by <a href="http://jekyllrb.com" rel="nofollow">Jekyll</a> &amp; <a href="https://mademistakes.com/work/minimal-mistakes-jekyll-theme/" rel="nofollow">Minimal Mistakes</a>.</div>
   <div>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
 </div>

       </footer>
     </div>

     <script src="/assets/js/main.min.js"></script>


   <script>
   (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
   (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
   m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
   })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');

   ga('create', 'UA-101622733-1', 'auto');
   ga('send', 'pageview');
 </script>


   </body>
 </html>