You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ni...@apache.org on 2017/12/12 09:18:05 UTC
[08/57] [partial] incubator-servicecomb-website git commit: Generated
the static pages for asf-site
http://git-wip-us.apache.org/repos/asf/incubator-servicecomb-website/blob/08e1b43f/content/users/communicate-protocol/index.html
----------------------------------------------------------------------
diff --git a/content/users/communicate-protocol/index.html b/content/users/communicate-protocol/index.html
new file mode 100644
index 0000000..f31311d
--- /dev/null
+++ b/content/users/communicate-protocol/index.html
@@ -0,0 +1,1109 @@
+<!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>通信协议 - Apache incubator ServiceComb</title>
+
+
+
+
+<meta name="description" content="通信协议">
+
+
+
+
+<meta name="author" content="">
+
+<meta property="og:locale" content="en">
+<meta property="og:site_name" content="Apache incubator ServiceComb">
+<meta property="og:title" content="通信协议">
+
+
+ <link rel="canonical" href="http://github.com/pages/ServiceComb/servicesomb.github.io/users/communicate-protocol/">
+ <meta property="og:url" content="http://github.com/pages/ServiceComb/servicesomb.github.io/users/communicate-protocol/">
+
+
+
+ <meta property="og:description" content="通信协议">
+
+
+
+ <meta name="twitter:site" content="@ServiceComb">
+ <meta name="twitter:title" content="通信协议">
+ <meta name="twitter:description" content="通信协议">
+ <meta name="twitter:url" content="">
+
+
+ <meta name="twitter:card" content="summary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <script type="application/ld+json">
+ {
+ "@context" : "http://schema.org",
+ "@type" : "Person",
+ "name" : "Apache incubator ServiceComb",
+ "url" : "http://github.com/pages/ServiceComb/servicesomb.github.io",
+ "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 incubator 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/js/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/css/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.cat.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">
+ <div class="masthead__inner-wrap">
+ <div class="masthead__menu">
+ <nav id="site-nav" class="greedy-nav">
+
+ <a class="site-title active" href="/"><img src="//assets/images/ServiceComb-logo-1.png"></a>
+
+ <ul class="visible-links">
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/docs/quick-start/">Quick Start</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a class="active" href="/users/">Users</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/developers/">Developers</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/year-archive/">Blogs</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/faqs/">FAQ</a>
+
+ </li>
+
+ </ul>
+ <button><div class="navicon"></div></button>
+ <ul class="hidden-links hidden"></ul>
+ <div class="nav-lang">
+
+
+ <a href=/cn/users/communicate-protocol/>中文</a>
+
+ </div>
+ </nav>
+ </div>
+ </div>
+</div>
+
+
+
+
+
+
+<div id="main" role="main">
+
+ <div class="sidebar sticky">
+
+ <div class="back-to-home">Home > <a href="/">ServiceComb</a></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">User Guide</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/" class="">Java Chassis Architecture</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/setup-environment/" class="">Setup Environment</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Develop Service Provider</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/service-definition/" class="">Service Definition</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-contract/" class="">Service Contract</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-springmvc/" class="">Develop Microservice with SpringMVC</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-jax-rs/" class="">Develop Microservice with JAX-RS</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-transparent-rpc/" class="">Develop Microservice with Transparent RPC</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-interface-constraints/" class="">Service Interface Constraints</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-configurations/" class="">Service Configurations</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/communicate-protocol/" class="active">Communicate Protocol</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/application-boot-process/" class="">Application Boot Up Process</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-heartbeat/" class="">Service Heartbeat</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Develop Service Consumer</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-rest-template/" class="">Develop with Rest Template</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-rpc/" class="">Develop with Transparent RPC</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/use-service-contract/" class="">Use Service Contract</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/invoke-control/" class="">Invoke Control</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">General Development</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/local-develop-test/" class="">Develop and Test in Local Environment</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/use-servicecomb-in-spring-boot/" class="">Use ServiceComb in Spring Boot</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/distributed-tracing/" class="">Distributed Tracing</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/customized-tracing/" class="">Customized Tracing</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Edging Service</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/edging-service/nginx/" class="">confd and Nginx</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/edging-service/zuul/" class="">Zuul</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+
+
+
+ <a href="/users/metrics/"><span class="nav__sub-title nav__sub-title-with-url">Metrics</span></a>
+
+
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Deployment</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/run-mode/" class="">Run Mode</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Security</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/use-tls/" class="">Use TLS</a></li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+</nav>
+
+
+
+ </div>
+
+
+
+ <article class="page" itemscope itemtype="http://schema.org/CreativeWork">
+ <meta itemprop="headline" content="通信协议">
+ <meta itemprop="description" content="通信协议">
+
+ <meta itemprop="dateModified" content="August 15, 2017">
+
+ <div class="page__inner-wrap">
+
+
+ <header>
+ <h1 class="page__title" itemprop="headline">通信协议
+</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="#通信协议" id="markdown-toc-通信协议">通信协议</a> <ul>
+ <li><a href="#概念阐述" id="markdown-toc-概念阐述">概念阐述</a></li>
+ <li><a href="#注意事项" id="markdown-toc-注意事项">注意事项</a></li>
+ </ul>
+ </li>
+ <li><a href="#线程模型" id="markdown-toc-线程模型">线程模型</a> <ul>
+ <li><a href="#概念阐述-1" id="markdown-toc-概念阐述-1">概念阐述</a></li>
+ <li><a href="#完整线程" id="markdown-toc-完整线程">完整线程</a></li>
+ </ul>
+ </li>
+ <li><a href="#rest-over-servlet" id="markdown-toc-rest-over-servlet">REST over Servlet</a> <ul>
+ <li><a href="#配置说明" id="markdown-toc-配置说明">配置说明</a></li>
+ <li><a href="#示例代码" id="markdown-toc-示例代码">示例代码</a></li>
+ </ul>
+ </li>
+ <li><a href="#rest-over-vertx" id="markdown-toc-rest-over-vertx">REST over Vertx</a> <ul>
+ <li><a href="#配置说明-1" id="markdown-toc-配置说明-1">配置说明</a></li>
+ <li><a href="#示例代码-1" id="markdown-toc-示例代码-1">示例代码</a></li>
+ </ul>
+ </li>
+ <li><a href="#highway-rpc协议" id="markdown-toc-highway-rpc协议">Highway RPC协议</a> <ul>
+ <li><a href="#概念阐述-2" id="markdown-toc-概念阐述-2">概念阐述</a></li>
+ <li><a href="#配置说明-2" id="markdown-toc-配置说明-2">配置说明</a></li>
+ <li><a href="#示例代码-2" id="markdown-toc-示例代码-2">示例代码</a></li>
+ </ul>
+ </li>
+</ul>
+
+ </nav>
+</aside>
+
+<h2 id="通信协议">通信协议</h2>
+<h3 id="概念阐述">概念阐述</h3>
+
+<p>ServiceComb实现了两种网络通道，包括REST和Highway，均支持TLS加密传输。其中，REST网络通道将服务以标准RESTful形式发布，调用端兼容直接使用http client使用标准RESTful形式进行调用。</p>
+
+<h3 id="注意事项">注意事项</h3>
+
+<p>参数和返回值的序列化：</p>
+
+<p>当前REST通道的body参数只支持application/json序列化方式，如果要向服务端发送form类型的参数，那么需要在调用端构造好application/json格式的body，不能直接以multipart/form-data格式传递form类型参数。</p>
+
+<p>当前REST通道返回值支持application/json和text/plain两种格式，服务提供者通过produces声明可提供序列化能力，服务消费者通过请求的Accept头指明返回值序列化方式，默认返回application/json格式的数据。</p>
+
+<h2 id="线程模型">线程模型</h2>
+<h3 id="概念阐述-1">概念阐述</h3>
+
+<p>本小节主要介绍ServiceComb微服务的完整线程模型，介绍IO线程和业务线程之间的关系</p>
+
+<h3 id="完整线程">完整线程</h3>
+
+<p>ServicecComb微服务的完整线程模型如下图所示：</p>
+
+<p><img src="/assets/images/thread-model.png" alt="" /></p>
+
+<blockquote>
+ <ol>
+ <li>业务线程在第一次调用时会绑定某一个网络线程,避免在不同网络线程之间切换,无谓地增加线程冲突的概率</li>
+ <li>业务线程绑定网络线程后,会再绑定该网络线程内部的某个连接,同样是为了避免线程冲突</li>
+ </ol>
+</blockquote>
+
+<ul>
+ <li>客户端和服务器都可以配置多个网络线程(eventloop)，默认为CPU核数的两倍，每个网络线程可以配置多个连接，默认为1，支持Rest和Highway两种网络通道，具体配置请查看如下章节：
+ <ul>
+ <li><a href="/users/communicate-protocol#rest-over-servlet">REST over Servlet</a></li>
+ <li><a href="/users/communicate-protocol/#rest-over-vertx">REST over Vertx</a></li>
+ <li><a href="/users/communicate-protocol/#highway-rpc协议">Highway RPC协议</a></li>
+ </ul>
+ </li>
+ <li>客户端可配置业务线程池executor，线程粒度可细化至schemaId:operation，配置如下：</li>
+</ul>
+
+<p>在microservice.yaml中添加executors配置，为schemaId:operation配置单独的业务线程池：</p>
+
+<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">cse</span><span class="pi">:</span>
+ <span class="s">executors</span><span class="pi">:</span>
+ <span class="s">Provider</span><span class="pi">:</span>
+ <span class="pi">[</span><span class="nv">schemaId</span><span class="pi">]</span><span class="s">.[operation]</span>
+</code></pre>
+</div>
+
+<h2 id="rest-over-servlet">REST over Servlet</h2>
+<h3 id="配置说明">配置说明</h3>
+
+<p> REST over Servlet对应使用web容器模式部署运行，需要新建一个servlet工程将微服务包装起来，加载到web容器中启动运行，包装微服务的方法有两种，一种完全使用web.xml配置文件配置，另一种仅在web.xml文件中配置listener，在microservice.yaml文件中配置urlPattern，两种方式如下所示：</p>
+
+<ul>
+ <li>
+ <p>在web.xml文件中完成全部配置</p>
+
+ <p>web.xml文件配置在项目的src/main/webapp/WEB_INF目录，配置内容如下：</p>
+
+ <div class="language-xml highlighter-rouge"><pre class="highlight"><code> <span class="nt"><web-app</span> <span class="na">xmlns=</span><span class="s">"http://java.sun.com/xml/ns/javaee"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"</span> <span class="na">version=</span><span class="s">"3.0"</span><span class="nt">></span>
+ <span class="nt"><context-param></span>
+ <span class="nt"><param-name></span>contextConfigLocation<span class="nt"></param-name></span>
+ <span class="nt"><param-value></span>classpath*:META-INF/spring/*.bean.xml classpath*:app-config.xml<span class="nt"></param-value></span>
+ <span class="nt"></context-param></span>
+ <span class="nt"><listener></span>
+ <span class="nt"><listener-class></span>io.servicecomb.transport.rest.servlet.RestServletContextListener<span class="nt"></listener-class></span>
+ <span class="nt"></listener></span>
+ <span class="nt"><servlet></span>
+ <span class="nt"><servlet-name></span>RestServlet<span class="nt"></servlet-name></span>
+ <span class="nt"><servlet-class></span>io.servicecomb.transport.rest.servlet.RestServlet<span class="nt"></servlet-class></span>
+ <span class="nt"><load-on-startup></span>1<span class="nt"></load-on-startup></span>
+ <span class="nt"><async-supported></span>true<span class="nt"></async-supported></span>
+ <span class="nt"></servlet></span>
+ <span class="nt"><servlet-mapping></span>
+ <span class="nt"><servlet-name></span>RestServlet<span class="nt"></servlet-name></span>
+ <span class="nt"><url-pattern></span>/rest/*<span class="nt"></url-pattern></span>
+ <span class="nt"></servlet-mapping></span>
+ <span class="nt"></web-app></span>
+</code></pre>
+ </div>
+ </li>
+ <li>
+ <p>在web.xml文件中仅配置listener，在microservice.yaml文件中配置urlPattern</p>
+
+ <div class="language-xml highlighter-rouge"><pre class="highlight"><code> <span class="nt"><web-app</span> <span class="na">xmlns=</span><span class="s">"http://java.sun.com/xml/ns/javaee"</span> <span class="na">xmlns:xsi=</span><span class="s">"http://www.w3.org/2001/XMLSchema-instance"</span> <span class="na">xsi:schemaLocation=</span><span class="s">"http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"</span> <span class="na">version=</span><span class="s">"3.0"</span><span class="nt">></span>
+ <span class="nt"><context-param></span>
+ <span class="nt"><param-name></span>contextConfigLocation<span class="nt"></param-name></span>
+ <span class="nt"><param-value></span>classpath*:META-INF/spring/*.bean.xml classpath*:app-config.xml<span class="nt"></param-value></span>
+ <span class="nt"></context-param></span>
+ <span class="nt"><listener></span>
+ <span class="nt"><listener-class></span>io.servicecomb.transport.rest.servlet.RestServletContextListener<span class="nt"></listener-class></span>
+ <span class="nt"></listener></span>
+ <span class="nt"></web-app></span>
+</code></pre>
+ </div>
+
+ <p>在microservice.yaml文件中需要增加一行配置来指定urlPattern：</p>
+
+ <div class="language-yaml highlighter-rouge"><pre class="highlight"><code> <span class="s">servicecomb.rest.servlet.urlPattern</span><span class="pi">:</span> <span class="s">/rest/*</span>
+</code></pre>
+ </div>
+ </li>
+</ul>
+
+<p>以上两种方式是等效的，两种方式都需要在maven pom文件中添加如下依赖：</p>
+
+<div class="language-xml highlighter-rouge"><pre class="highlight"><code><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>io.servicecomb<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>transport-rest-servlet<span class="nt"></artifactId></span>
+<span class="nt"></dependency></span>
+</code></pre>
+</div>
+
+<p>REST over Servlet在microservice.yaml文件中的配置项见下表：</p>
+
+<p>表1 REST over Servlet配置项说明</p>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">配置项</th>
+ <th style="text-align: left">默认值</th>
+ <th style="text-align: left">取值范围</th>
+ <th style="text-align: left">是否必选</th>
+ <th style="text-align: left">含义</th>
+ <th style="text-align: left">注意</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left">cse.rest.address</td>
+ <td style="text-align: left">0.0.0.0:8080</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">服务监听地址</td>
+ <td style="text-align: left">-</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.rest.timeout</td>
+ <td style="text-align: left">3000</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">超时时间</td>
+ <td style="text-align: left">单位为毫秒</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.request.timeout</td>
+ <td style="text-align: left">30000</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">请求超时时间</td>
+ <td style="text-align: left">同REST over Vertx的配置</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.references.[服务名].transport</td>
+ <td style="text-align: left">rest</td>
+ <td style="text-align: left"> </td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">访问的transport类型</td>
+ <td style="text-align: left">同REST over Vertx的配置</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.references.[服务名].version-rule</td>
+ <td style="text-align: left">latest</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">访问实例的版本号</td>
+ <td style="text-align: left">同REST over Vertx的配置</td>
+ </tr>
+ </tbody>
+</table>
+
+<h3 id="示例代码">示例代码</h3>
+
+<p>microservice.yaml文件中的配置示例如下：</p>
+
+<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">cse</span><span class="pi">:</span>
+ <span class="s">rest</span><span class="pi">:</span>
+ <span class="s">address</span><span class="pi">:</span> <span class="s">0.0.0.0:8080</span>
+ <span class="s">timeout</span><span class="pi">:</span> <span class="s">3000</span>
+</code></pre>
+</div>
+
+<h2 id="rest-over-vertx">REST over Vertx</h2>
+<h3 id="配置说明-1">配置说明</h3>
+
+<p>REST over Vertx通信通道对应使用standalone部署运行模式，可直接通过main函数拉起。main函数中需要初始化日志和加载服务配置，代码如下：</p>
+
+<div class="language-java highlighter-rouge"><pre class="highlight"><code><span class="kn">import</span> <span class="nn">io.servicecomb.foundation.common.utils.BeanUtils</span><span class="o">;</span>
+<span class="kn">import</span> <span class="nn">io.servicecomb.foundation.common.utils.Log4jUtils</span><span class="o">;</span>
+
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">MainServer</span> <span class="o">{</span>
+ <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>
+ <span class="err"> </span><span class="n">Log4jUtils</span><span class="o">.</span><span class="na">init</span><span class="o">();</span><span class="c1">//日志初始化</span>
+ <span class="err"> </span><span class="n">BeanUtils</span><span class="o">.</span><span class="na">init</span><span class="o">();</span> <span class="c1">// Spring bean初始化</span>
+ <span class="o">}</span>
+<span class="o">}</span>
+</code></pre>
+</div>
+
+<p>使用REST over Vertx网络通道需要在maven pom文件中添加如下依赖：</p>
+
+<div class="language-xml highlighter-rouge"><pre class="highlight"><code><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>io.servicecomb<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>transport-rest-vertx<span class="nt"></artifactId></span>
+<span class="nt"></dependency></span>
+</code></pre>
+</div>
+
+<p>REST over Vertx通道在microservice.yaml文件中有以下配置项：</p>
+
+<p>表2 REST over Vertx配置项说明</p>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">配置项</th>
+ <th style="text-align: left">默认值</th>
+ <th style="text-align: left">取值范围</th>
+ <th style="text-align: left">是否必选</th>
+ <th style="text-align: left">含义</th>
+ <th style="text-align: left">注意</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left">cse.rest.address</td>
+ <td style="text-align: left">0.0.0.0:8080</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">服务监听地址</td>
+ <td style="text-align: left">仅服务提供者需要配置</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.rest.server.thread-count</td>
+ <td style="text-align: left">1</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">服务端线程数</td>
+ <td style="text-align: left">仅服务提供者需要配置</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.rest.client.thread-count</td>
+ <td style="text-align: left">1</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">客户端网络线程数</td>
+ <td style="text-align: left">仅服务消费者需要配置</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.rest.client.connection-pool-per-thread</td>
+ <td style="text-align: left">1</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">客户端每个网络线程中的连接池的个数</td>
+ <td style="text-align: left">仅服务消费者需要配置</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.request.timeout</td>
+ <td style="text-align: left">30000</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">请求超时时间</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.references.[服务名].transport</td>
+ <td style="text-align: left">rest</td>
+ <td style="text-align: left"> </td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">访问的transport类型</td>
+ <td style="text-align: left">仅服务消费者需要配置</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.references.[服务名].version-rule</td>
+ <td style="text-align: left">latest</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">访问实例的版本号</td>
+ <td style="text-align: left">仅服务消费者需要配置支持latest，1.0.0+，1.0.0-2.0.2，精确版本。详细参考服务中心的接口描述。</td>
+ </tr>
+ </tbody>
+</table>
+
+<h3 id="示例代码-1">示例代码</h3>
+
+<p>microservice.yaml文件中的配置示例：</p>
+
+<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">cse</span><span class="pi">:</span>
+ <span class="s">rest</span><span class="pi">:</span>
+ <span class="s">address</span><span class="pi">:</span> <span class="s">0.0.0.0:8080</span>
+ <span class="s">thread-count</span><span class="pi">:</span> <span class="s">1</span>
+ <span class="s">references</span><span class="pi">:</span>
+ <span class="s">hello</span><span class="pi">:</span>
+ <span class="s">transport</span><span class="pi">:</span> <span class="s">rest</span>
+ <span class="s">version-rule</span><span class="pi">:</span> <span class="s">0.0.1</span>
+</code></pre>
+</div>
+
+<h2 id="highway-rpc协议">Highway RPC协议</h2>
+<h3 id="概念阐述-2">概念阐述</h3>
+
+<p>Highway是ServiceComb的高性能私有协议，用户可在有特殊性能需求的场景下选用。</p>
+
+<h3 id="配置说明-2">配置说明</h3>
+
+<p>使用Highway网络通道需要在maven pom文件中添加如下依赖：</p>
+
+<div class="language-xml highlighter-rouge"><pre class="highlight"><code><span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>io.servicecomb<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>transport-highway<span class="nt"></artifactId></span>
+<span class="nt"></dependency></span>
+</code></pre>
+</div>
+
+<p>Highway通道在microservice.yaml文件中的配置项如下表所示：</p>
+
+<p>表3 Highway配置项说明</p>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">配置项</th>
+ <th style="text-align: left">默认值</th>
+ <th style="text-align: left">取值范围</th>
+ <th style="text-align: left">是否必选</th>
+ <th style="text-align: left">含义</th>
+ <th style="text-align: left">注意</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left">cse.highway.address</td>
+ <td style="text-align: left">0.0.0.0:7070</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">服务监听地址</td>
+ <td style="text-align: left">-</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.highway.server.thread-count</td>
+ <td style="text-align: left">1</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">服务端网络线程个数</td>
+ <td style="text-align: left">-</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.highway.client.thread-count</td>
+ <td style="text-align: left">1</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">客户端网络线程个数</td>
+ <td style="text-align: left">-</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.highway.client.connection-pool-per-thread</td>
+ <td style="text-align: left">1</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">客户端每个网络线程的连接池个数</td>
+ <td style="text-align: left">-</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.request.timeout</td>
+ <td style="text-align: left">30000</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">请求超时时间</td>
+ <td style="text-align: left">同REST over Vertx的配置</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.references.[服务名].transport</td>
+ <td style="text-align: left">rest</td>
+ <td style="text-align: left"> </td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">访问的transport类型</td>
+ <td style="text-align: left">同REST over Vertx的配置</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.references.[服务名].version-rule</td>
+ <td style="text-align: left">latest</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">访问实例的版本号</td>
+ <td style="text-align: left">同REST over Vertx的配置</td>
+ </tr>
+ </tbody>
+</table>
+
+<h3 id="示例代码-2">示例代码</h3>
+
+<p>microservice.yaml文件中的配置示例：</p>
+
+<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">cse</span><span class="pi">:</span>
+ <span class="s">highway</span><span class="pi">:</span>
+ <span class="s">address</span><span class="pi">:</span> <span class="s">0.0.0.0:7070</span>
+</code></pre>
+</div>
+
+
+ </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/quick-start/">Quick Start</a></li>
+ <li><a href="/users/user-guide/">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">Contribute</p>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/issues/new?title=Issue with _users/communicate-protocol.md">Report a Doc Issue</a></li>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/edit/master/_users/communicate-protocol.md">Edit This Page on Github</a></li>
+ <li><a href="/developers/submit-codes/">Code Submit Guide</a></li>
+ </ul>
+ </div>
+ <div class="col">
+ <ul class="social-icons">
+ <p class="header">Community</p>
+ <li>
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-developers" target="_blank"><span class="group">Dev</span></a> |
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-users" target="_blank">User</span></a>
+ </li>
+ <li>
+ <a href="http://github.com/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>© 2017 Apache incubator ServiceComb. Powered by <a href="http://jekyllrb.com" rel="nofollow">Jekyll</a> & <a href="https://mademistakes.com/work/minimal-mistakes-jekyll-theme/" rel="nofollow">Minimal Mistakes</a>.</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>
http://git-wip-us.apache.org/repos/asf/incubator-servicecomb-website/blob/08e1b43f/content/users/customized-tracing/index.html
----------------------------------------------------------------------
diff --git a/content/users/customized-tracing/index.html b/content/users/customized-tracing/index.html
new file mode 100644
index 0000000..476af44
--- /dev/null
+++ b/content/users/customized-tracing/index.html
@@ -0,0 +1,803 @@
+<!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>Customized Tracing - Apache incubator ServiceComb</title>
+
+
+
+
+<meta name="description" content="自定义调用链打点">
+
+
+
+
+<meta name="author" content="">
+
+<meta property="og:locale" content="en">
+<meta property="og:site_name" content="Apache incubator ServiceComb">
+<meta property="og:title" content="Customized Tracing">
+
+
+ <link rel="canonical" href="http://github.com/pages/ServiceComb/servicesomb.github.io/users/customized-tracing/">
+ <meta property="og:url" content="http://github.com/pages/ServiceComb/servicesomb.github.io/users/customized-tracing/">
+
+
+
+ <meta property="og:description" content="自定义调用链打点">
+
+
+
+ <meta name="twitter:site" content="@ServiceComb">
+ <meta name="twitter:title" content="Customized Tracing">
+ <meta name="twitter:description" content="自定义调用链打点">
+ <meta name="twitter:url" content="">
+
+
+ <meta name="twitter:card" content="summary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <script type="application/ld+json">
+ {
+ "@context" : "http://schema.org",
+ "@type" : "Person",
+ "name" : "Apache incubator ServiceComb",
+ "url" : "http://github.com/pages/ServiceComb/servicesomb.github.io",
+ "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 incubator 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/js/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/css/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.cat.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">
+ <div class="masthead__inner-wrap">
+ <div class="masthead__menu">
+ <nav id="site-nav" class="greedy-nav">
+
+ <a class="site-title active" href="/"><img src="//assets/images/ServiceComb-logo-1.png"></a>
+
+ <ul class="visible-links">
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/docs/quick-start/">Quick Start</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a class="active" href="/users/">Users</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/developers/">Developers</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/year-archive/">Blogs</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/faqs/">FAQ</a>
+
+ </li>
+
+ </ul>
+ <button><div class="navicon"></div></button>
+ <ul class="hidden-links hidden"></ul>
+ <div class="nav-lang">
+
+
+ <a href=/cn/users/customized-tracing/>中文</a>
+
+ </div>
+ </nav>
+ </div>
+ </div>
+</div>
+
+
+
+
+
+
+<div id="main" role="main">
+
+ <div class="sidebar sticky">
+
+ <div class="back-to-home">Home > <a href="/">ServiceComb</a></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">User Guide</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/" class="">Java Chassis Architecture</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/setup-environment/" class="">Setup Environment</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Develop Service Provider</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/service-definition/" class="">Service Definition</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-contract/" class="">Service Contract</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-springmvc/" class="">Develop Microservice with SpringMVC</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-jax-rs/" class="">Develop Microservice with JAX-RS</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-transparent-rpc/" class="">Develop Microservice with Transparent RPC</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-interface-constraints/" class="">Service Interface Constraints</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-configurations/" class="">Service Configurations</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/communicate-protocol/" class="">Communicate Protocol</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/application-boot-process/" class="">Application Boot Up Process</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-heartbeat/" class="">Service Heartbeat</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Develop Service Consumer</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-rest-template/" class="">Develop with Rest Template</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-rpc/" class="">Develop with Transparent RPC</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/use-service-contract/" class="">Use Service Contract</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/invoke-control/" class="">Invoke Control</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">General Development</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/local-develop-test/" class="">Develop and Test in Local Environment</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/use-servicecomb-in-spring-boot/" class="">Use ServiceComb in Spring Boot</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/distributed-tracing/" class="">Distributed Tracing</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/customized-tracing/" class="active">Customized Tracing</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Edging Service</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/edging-service/nginx/" class="">confd and Nginx</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/edging-service/zuul/" class="">Zuul</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+
+
+
+ <a href="/users/metrics/"><span class="nav__sub-title nav__sub-title-with-url">Metrics</span></a>
+
+
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Deployment</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/run-mode/" class="">Run Mode</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Security</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/use-tls/" class="">Use TLS</a></li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+</nav>
+
+
+
+ </div>
+
+
+
+ <article class="page" itemscope itemtype="http://schema.org/CreativeWork">
+ <meta itemprop="headline" content="Customized Tracing">
+ <meta itemprop="description" content="自定义调用链打点">
+
+ <meta itemprop="dateModified" content="August 15, 2017">
+
+ <div class="page__inner-wrap">
+
+
+ <header>
+ <h1 class="page__title" itemprop="headline">Customized Tracing
+</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="#概念阐述" id="markdown-toc-概念阐述">概念阐述</a></li>
+ <li><a href="#前提条件" id="markdown-toc-前提条件">前提条件</a></li>
+ <li><a href="#注意事项" id="markdown-toc-注意事项">注意事项</a></li>
+ <li><a href="#自定义调用链打点" id="markdown-toc-自定义调用链打点">自定义调用链打点</a></li>
+ <li><a href="#使用步骤" id="markdown-toc-使用步骤">使用步骤:</a> <ul>
+ <li><a href="#添加依赖" id="markdown-toc-添加依赖">添加依赖</a></li>
+ <li><a href="#启用自定义打点功能" id="markdown-toc-启用自定义打点功能">启用自定义打点功能</a></li>
+ <li><a href="#定制打点" id="markdown-toc-定制打点">定制打点</a></li>
+ </ul>
+ </li>
+ <li><a href="#定制上报的数据" id="markdown-toc-定制上报的数据">定制上报的数据</a></li>
+</ul>
+
+ </nav>
+</aside>
+
+<h2 id="概念阐述">概念阐述</h2>
+
+<p>分布式调用链追踪提供了服务间调用的时序信息，但服务内部的链路调用信息对开发者同样重要，如果能将两者合二为一，就能提供更完整的调用链，更容易定位错误和潜在性能问题。</p>
+
+<h2 id="前提条件">前提条件</h2>
+
+<ul>
+ <li>使用自定义打点功能需要首先配置并启用Java Chassis微服务调用链。</li>
+</ul>
+
+<h2 id="注意事项">注意事项</h2>
+
+<ul>
+ <li>使用<code class="highlighter-rouge">@Span</code>注释的自定义打点功能只支持和Java Chassis调用请求同一线程的方法调用。</li>
+ <li>添加<code class="highlighter-rouge">@Span</code>注释的方法必须是Spring管理的Bean，否则需要按这里<a href="https://stackoverflow.com/questions/41383941/load-time-weaving-for-non-spring-beans-in-a-spring-application">提到的方法</a>配置。</li>
+</ul>
+
+<h2 id="自定义调用链打点">自定义调用链打点</h2>
+
+<p>该功能集成了Zipkin，提供<code class="highlighter-rouge">@Span</code>注释为需要追踪的方法自定义打点。Java Chassis将自动追踪所有添加<code class="highlighter-rouge">@Span</code>注释的方法，把每个方法的本地调用信息与服务间调用信息连接起来。</p>
+
+<h2 id="使用步骤">使用步骤:</h2>
+
+<h3 id="添加依赖">添加依赖</h3>
+
+<p>基于 ServiceComb Java Chassis 的微服务只需要添加如下依赖到 pom.xml：</p>
+
+<div class="language-xml highlighter-rouge"><pre class="highlight"><code> <span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>io.servicecomb<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>tracing-zipkin<span class="nt"></artifactId></span>
+ <span class="nt"></dependency></span>
+</code></pre>
+</div>
+
+<h3 id="启用自定义打点功能">启用自定义打点功能</h3>
+
+<p>在应用入口或Spring配置类上添加<code class="highlighter-rouge">@EnableZipkinTracing</code>注释：</p>
+
+<div class="language-java highlighter-rouge"><pre class="highlight"><code><span class="nd">@SpringBootApplication</span>
+<span class="nd">@EnableZipkinTracing</span>
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">ZipkinSpanTestApplication</span> <span class="o">{</span>
+ <span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span>
+ <span class="n">SpringApplication</span><span class="o">.</span><span class="na">run</span><span class="o">(</span><span class="n">ZipkinSpanTestApplication</span><span class="o">.</span><span class="na">class</span><span class="o">);</span>
+ <span class="o">}</span>
+<span class="o">}</span>
+</code></pre>
+</div>
+
+<h3 id="定制打点">定制打点</h3>
+
+<p>在需要定制打点的方法上添加<code class="highlighter-rouge">@Span</code>注释：</p>
+
+<div class="language-java highlighter-rouge"><pre class="highlight"><code><span class="nd">@Component</span>
+<span class="kd">public</span> <span class="kd">class</span> <span class="nc">SlowRepoImpl</span> <span class="kd">implements</span> <span class="n">SlowRepo</span> <span class="o">{</span>
+ <span class="kd">private</span> <span class="kd">static</span> <span class="kd">final</span> <span class="n">Logger</span> <span class="n">logger</span> <span class="o">=</span> <span class="n">LoggerFactory</span><span class="o">.</span><span class="na">getLogger</span><span class="o">(</span><span class="n">SlowRepoImpl</span><span class="o">.</span><span class="na">class</span><span class="o">);</span>
+
+ <span class="kd">private</span> <span class="kd">final</span> <span class="n">Random</span> <span class="n">random</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Random</span><span class="o">();</span>
+
+ <span class="nd">@Span</span>
+ <span class="nd">@Override</span>
+ <span class="kd">public</span> <span class="n">String</span> <span class="nf">crawl</span><span class="o">()</span> <span class="kd">throws</span> <span class="n">InterruptedException</span> <span class="o">{</span>
+ <span class="n">logger</span><span class="o">.</span><span class="na">info</span><span class="o">(</span><span class="s">"in /crawl"</span><span class="o">);</span>
+ <span class="n">Thread</span><span class="o">.</span><span class="na">sleep</span><span class="o">(</span><span class="n">random</span><span class="o">.</span><span class="na">nextInt</span><span class="o">(</span><span class="mi">200</span><span class="o">));</span>
+ <span class="k">return</span> <span class="s">"crawled"</span><span class="o">;</span>
+ <span class="o">}</span>
+<span class="o">}</span>
+</code></pre>
+</div>
+
+<p>就这样，通过使用<code class="highlighter-rouge">@Span</code>注释，我们启动了基于 Zipkin 的自定义打点功能。</p>
+
+<h2 id="定制上报的数据">定制上报的数据</h2>
+
+<p>通过自定义打点上报的调用链包含两条数据：</p>
+
+<ul>
+ <li><strong>span name</strong> 默认为当前注释的方法全名。</li>
+ <li><strong>call.path</strong> 默认为当前注释的方法签名。</li>
+</ul>
+
+<p>例如，上述例子<code class="highlighter-rouge">SlowRepoImp</code>里上报的数据如下：</p>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">key</th>
+ <th style="text-align: left">value</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left">span name</td>
+ <td style="text-align: left">crawl</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">call.path</td>
+ <td style="text-align: left">public abstract java.lang.String io.servicecomb.tests.tracing.SlowRepo.crawl() throws java.lang.InterruptedException</td>
+ </tr>
+ </tbody>
+</table>
+
+<p>如果需要定制上报的数据内容，可以传入自定义的参数：</p>
+
+<div class="language-java highlighter-rouge"><pre class="highlight"><code> <span class="kd">public</span> <span class="kd">static</span> <span class="kd">class</span> <span class="nc">CustomSpanTask</span> <span class="o">{</span>
+ <span class="nd">@Span</span><span class="o">(</span><span class="n">spanName</span> <span class="o">=</span> <span class="s">"transaction1"</span><span class="o">,</span> <span class="n">callPath</span> <span class="o">=</span> <span class="s">"startA"</span><span class="o">)</span>
+ <span class="kd">public</span> <span class="n">String</span> <span class="nf">invoke</span><span class="o">()</span> <span class="o">{</span>
+ <span class="k">return</span> <span class="s">"invoke the method"</span><span class="o">;</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+</code></pre>
+</div>
+
+
+ </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/quick-start/">Quick Start</a></li>
+ <li><a href="/users/user-guide/">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">Contribute</p>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/issues/new?title=Issue with _users/customized-tracing.md">Report a Doc Issue</a></li>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/edit/master/_users/customized-tracing.md">Edit This Page on Github</a></li>
+ <li><a href="/developers/submit-codes/">Code Submit Guide</a></li>
+ </ul>
+ </div>
+ <div class="col">
+ <ul class="social-icons">
+ <p class="header">Community</p>
+ <li>
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-developers" target="_blank"><span class="group">Dev</span></a> |
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-users" target="_blank">User</span></a>
+ </li>
+ <li>
+ <a href="http://github.com/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>© 2017 Apache incubator ServiceComb. Powered by <a href="http://jekyllrb.com" rel="nofollow">Jekyll</a> & <a href="https://mademistakes.com/work/minimal-mistakes-jekyll-theme/" rel="nofollow">Minimal Mistakes</a>.</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>
http://git-wip-us.apache.org/repos/asf/incubator-servicecomb-website/blob/08e1b43f/content/users/develop-with-jax-rs/index.html
----------------------------------------------------------------------
diff --git a/content/users/develop-with-jax-rs/index.html b/content/users/develop-with-jax-rs/index.html
new file mode 100644
index 0000000..b22ae5c
--- /dev/null
+++ b/content/users/develop-with-jax-rs/index.html
@@ -0,0 +1,843 @@
+<!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>用JAX-RS开发微服务 - Apache incubator ServiceComb</title>
+
+
+
+
+<meta name="description" content="用JAX-RS开发微服务">
+
+
+
+
+<meta name="author" content="">
+
+<meta property="og:locale" content="en">
+<meta property="og:site_name" content="Apache incubator ServiceComb">
+<meta property="og:title" content="用JAX-RS开发微服务">
+
+
+ <link rel="canonical" href="http://github.com/pages/ServiceComb/servicesomb.github.io/users/develop-with-jax-rs/">
+ <meta property="og:url" content="http://github.com/pages/ServiceComb/servicesomb.github.io/users/develop-with-jax-rs/">
+
+
+
+ <meta property="og:description" content="用JAX-RS开发微服务">
+
+
+
+ <meta name="twitter:site" content="@ServiceComb">
+ <meta name="twitter:title" content="用JAX-RS开发微服务">
+ <meta name="twitter:description" content="用JAX-RS开发微服务">
+ <meta name="twitter:url" content="">
+
+
+ <meta name="twitter:card" content="summary">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <script type="application/ld+json">
+ {
+ "@context" : "http://schema.org",
+ "@type" : "Person",
+ "name" : "Apache incubator ServiceComb",
+ "url" : "http://github.com/pages/ServiceComb/servicesomb.github.io",
+ "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 incubator 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/js/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/css/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.cat.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">
+ <div class="masthead__inner-wrap">
+ <div class="masthead__menu">
+ <nav id="site-nav" class="greedy-nav">
+
+ <a class="site-title active" href="/"><img src="//assets/images/ServiceComb-logo-1.png"></a>
+
+ <ul class="visible-links">
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/docs/quick-start/">Quick Start</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a class="active" href="/users/">Users</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/developers/">Developers</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/year-archive/">Blogs</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/faqs/">FAQ</a>
+
+ </li>
+
+ </ul>
+ <button><div class="navicon"></div></button>
+ <ul class="hidden-links hidden"></ul>
+ <div class="nav-lang">
+
+
+ <a href=/cn/users/develop-with-jax-rs/>中文</a>
+
+ </div>
+ </nav>
+ </div>
+ </div>
+</div>
+
+
+
+
+
+
+<div id="main" role="main">
+
+ <div class="sidebar sticky">
+
+ <div class="back-to-home">Home > <a href="/">ServiceComb</a></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">User Guide</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/" class="">Java Chassis Architecture</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/setup-environment/" class="">Setup Environment</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Develop Service Provider</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/service-definition/" class="">Service Definition</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-contract/" class="">Service Contract</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-springmvc/" class="">Develop Microservice with SpringMVC</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-jax-rs/" class="active">Develop Microservice with JAX-RS</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-transparent-rpc/" class="">Develop Microservice with Transparent RPC</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-interface-constraints/" class="">Service Interface Constraints</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-configurations/" class="">Service Configurations</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/communicate-protocol/" class="">Communicate Protocol</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/application-boot-process/" class="">Application Boot Up Process</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/service-heartbeat/" class="">Service Heartbeat</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Develop Service Consumer</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-rest-template/" class="">Develop with Rest Template</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/develop-with-rpc/" class="">Develop with Transparent RPC</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/use-service-contract/" class="">Use Service Contract</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/invoke-control/" class="">Invoke Control</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">General Development</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/local-develop-test/" class="">Develop and Test in Local Environment</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/use-servicecomb-in-spring-boot/" class="">Use ServiceComb in Spring Boot</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/distributed-tracing/" class="">Distributed Tracing</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/customized-tracing/" class="">Customized Tracing</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Edging Service</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/edging-service/nginx/" class="">confd and Nginx</a></li>
+
+
+
+
+
+
+
+ <li><a href="/users/edging-service/zuul/" class="">Zuul</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+
+
+
+ <a href="/users/metrics/"><span class="nav__sub-title nav__sub-title-with-url">Metrics</span></a>
+
+
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Deployment</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/run-mode/" class="">Run Mode</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">Security</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/users/use-tls/" class="">Use TLS</a></li>
+
+ </ul>
+
+ </li>
+
+ </ul>
+</nav>
+
+
+
+ </div>
+
+
+
+ <article class="page" itemscope itemtype="http://schema.org/CreativeWork">
+ <meta itemprop="headline" content="用JAX-RS开发微服务">
+ <meta itemprop="description" content="用JAX-RS开发微服务">
+
+ <meta itemprop="dateModified" content="August 15, 2017">
+
+ <div class="page__inner-wrap">
+
+
+ <header>
+ <h1 class="page__title" itemprop="headline">用JAX-RS开发微服务
+</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="#概念阐述" id="markdown-toc-概念阐述">概念阐述</a></li>
+ <li><a href="#开发示例" id="markdown-toc-开发示例">开发示例</a></li>
+ <li><a href="#涉及api" id="markdown-toc-涉及api">涉及API</a></li>
+</ul>
+
+ </nav>
+</aside>
+
+<h2 id="概念阐述">概念阐述</h2>
+
+<p>ServiceComb支持开发者使用JAX-RS注解，使用JAX-RS模式开发服务。</p>
+
+<h2 id="开发示例">开发示例</h2>
+
+<ul>
+ <li>
+ <p><strong>步骤 1</strong> 定义服务接口。</p>
+
+ <p>根据开发之前定义好的契约，编写Java业务接口，代码如下：</p>
+
+ <div class="language-java highlighter-rouge"><pre class="highlight"><code> <span class="kd">public</span> <span class="kd">interface</span> <span class="nc">Hello</span> <span class="o">{</span>
+ <span class="err"> </span><span class="n">String</span> <span class="nf">sayHi</span><span class="o">(</span><span class="n">String</span> <span class="n">name</span><span class="o">);</span>
+ <span class="err"> </span><span class="n">String</span> <span class="nf">sayHello</span><span class="o">(</span><span class="n">Person</span> <span class="n">person</span><span class="o">);</span>
+ <span class="o">}</span>
+</code></pre>
+ </div>
+
+ <blockquote>
+ <p><strong>说明</strong>：
+ 该接口的位置需要与契约中x-java-interface所指定的路径一致。</p>
+ </blockquote>
+ </li>
+ <li>
+ <p><strong>步骤 2</strong> 实现服务。</p>
+
+ <p>使用JAX-RS注解开发业务代码，Hello的服务实现如下：</p>
+
+ <div class="language-java highlighter-rouge"><pre class="highlight"><code> <span class="kn">import</span> <span class="nn">javax.ws.rs.POST</span><span class="o">;</span>
+ <span class="kn">import</span> <span class="nn">javax.ws.rs.Path</span><span class="o">;</span>
+ <span class="kn">import</span> <span class="nn">javax.ws.rs.Produces</span><span class="o">;</span>
+ <span class="kn">import</span> <span class="nn">javax.ws.rs.core.MediaType</span><span class="o">;</span>
+ <span class="kn">import</span> <span class="nn">io.servicecomb.samples.common.schema.Hello</span><span class="o">;</span>
+ <span class="kn">import</span> <span class="nn">io.servicecomb.samples.common.schema.models.Person</span><span class="o">;</span>
+
+ <span class="nd">@Path</span><span class="o">(</span><span class="s">"/jaxrshello"</span><span class="o">)</span>
+ <span class="nd">@Produces</span><span class="o">(</span><span class="n">MediaType</span><span class="o">.</span><span class="na">APPLICATION_JSON</span><span class="o">)</span>
+ <span class="kd">public</span> <span class="kd">class</span> <span class="nc">JaxrsHelloImpl</span> <span class="kd">implements</span> <span class="n">Hello</span> <span class="o">{</span>
+ <span class="nd">@Path</span><span class="o">(</span><span class="s">"/sayhi"</span><span class="o">)</span>
+ <span class="nd">@POST</span>
+ <span class="nd">@Override</span>
+ <span class="kd">public</span> <span class="n">String</span> <span class="nf">sayHi</span><span class="o">(</span><span class="n">String</span> <span class="n">name</span><span class="o">)</span> <span class="o">{</span>
+ <span class="err"> </span><span class="k">return</span> <span class="s">"Hello "</span> <span class="o">+</span> <span class="n">name</span><span class="o">;</span>
+ <span class="o">}</span>
+
+ <span class="nd">@Path</span><span class="o">(</span><span class="s">"/sayhello"</span><span class="o">)</span>
+ <span class="nd">@POST</span>
+ <span class="nd">@Override</span>
+ <span class="kd">public</span> <span class="n">String</span> <span class="nf">sayHello</span><span class="o">(</span><span class="n">Person</span> <span class="n">person</span><span class="o">)</span> <span class="o">{</span>
+ <span class="k">return</span> <span class="s">"Hello person "</span> <span class="o">+</span> <span class="n">person</span><span class="o">.</span><span class="na">getName</span><span class="o">();</span>
+ <span class="o">}</span>
+ <span class="o">}</span>
+</code></pre>
+ </div>
+ </li>
+ <li>
+ <p><strong>步骤 3</strong> 发布服务。</p>
+
+ <p>在服务的实现类上打上注解<code class="highlighter-rouge">@RestSchema</code>，指定schemaId，表示该实现作为当前微服务的一个schema发布，代码如下：</p>
+
+ <div class="language-java highlighter-rouge"><pre class="highlight"><code> <span class="kn">import</span> <span class="nn">io.servicecomb.provider.rest.common.RestSchema</span><span class="o">;</span>
+ <span class="c1">// other code omitted</span>
+ <span class="nd">@RestSchema</span><span class="o">(</span><span class="n">schemaId</span> <span class="o">=</span> <span class="s">"jaxrsHello"</span><span class="o">)</span>
+ <span class="kd">public</span> <span class="kd">class</span> <span class="nc">JaxrsHelloImpl</span> <span class="kd">implements</span> <span class="n">Hello</span> <span class="o">{</span>
+ <span class="c1">// other code omitted</span>
+ <span class="o">}</span>
+</code></pre>
+ </div>
+
+ <p>然后在resources/META-INF/spring目录下创建jaxrsHello.bean.xml文件，配置spring进行服务扫描的base-package，文件内容如下：</p>
+
+ <div class="language-xml highlighter-rouge"><pre class="highlight"><code> <span class="cp"><?xml version="1.0" encoding="UTF-8"?></span>
+ <span class="nt"><beans</span> <span class="na">xmlns=</span><span class="s">" http://www.springframework.org/schema/beans "</span> <span class="na">xmlns:xsi=</span><span class="s">" http://www.w3.org/2001/XMLSchema-instance "</span>
+ <span class="na">xmlns:p=</span><span class="s">" http://www.springframework.org/schema/p "</span> <span class="na">xmlns:util=</span><span class="s">" http://www.springframework.org/schema/util "</span>
+ <span class="na">xmlns:cse=</span><span class="s">" http://www.huawei.com/schema/paas/cse/rpc "</span>
+ <span class="na">xmlns:context=</span><span class="s">" http://www.springframework.org/schema/context "</span>
+ <span class="na">xsi:schemaLocation=</span><span class="s">" http://www.springframework.org/schema/beans classpath:org/springframework/beans/factory/xml/spring-beans-3.0.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.0.xsd http://www.huawei.com/schema/paas/cse/rpc classpath:META-INF/spring/spring-paas-cse-rpc.xsd"</span><span class="nt">></span>
+
+ <span class="nt"><context:component-scan</span> <span class="na">base-package=</span><span class="s">"io.servicecomb.samples.jaxrs.provider"</span><span class="nt">/></span>
+ <span class="nt"></beans></span>
+</code></pre>
+ </div>
+ </li>
+</ul>
+
+<h2 id="涉及api">涉及API</h2>
+
+<p>JAX-RS开发模式当前支持如下注解，所有注解的使用方法参考<a href="https://jax-rs-spec.java.net/nonav/2.0-rev-a/apidocs/index.html">JAX-RS官方文档</a>。</p>
+
+<table>
+ <thead>
+ <tr>
+ <th style="text-align: left">注解</th>
+ <th style="text-align: left">位置</th>
+ <th style="text-align: left">描述</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="text-align: left">javax.ws.rs.Path</td>
+ <td style="text-align: left">schema/operation</td>
+ <td style="text-align: left">URL路径</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">javax.ws.rs.Produces</td>
+ <td style="text-align: left">schema/operation</td>
+ <td style="text-align: left">方法支持的编解码能力</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">javax.ws.rs.DELETE</td>
+ <td style="text-align: left">operation</td>
+ <td style="text-align: left">http method</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">javax.ws.rs.GET</td>
+ <td style="text-align: left">operation</td>
+ <td style="text-align: left">http method</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">javax.ws.rs.POST</td>
+ <td style="text-align: left">operation</td>
+ <td style="text-align: left">http method</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">javax.ws.rs.PUT</td>
+ <td style="text-align: left">operation</td>
+ <td style="text-align: left">http method</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">javax.ws.rs.QueryParam</td>
+ <td style="text-align: left">parameter</td>
+ <td style="text-align: left">从query string中获取参数</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">javax.ws.rs.PathParam</td>
+ <td style="text-align: left">parameter</td>
+ <td style="text-align: left">从path中获取参数，必须在path中定义该参数</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">javax.ws.rs.HeaderParam</td>
+ <td style="text-align: left">parameter</td>
+ <td style="text-align: left">从header中获取参数</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">javax.ws.rs.CookieParam</td>
+ <td style="text-align: left">parameter</td>
+ <td style="text-align: left">从cookie中获取参数</td>
+ </tr>
+ </tbody>
+</table>
+
+<blockquote>
+ <p><strong>说明</strong>：</p>
+ <ul>
+ <li>当方法参数没有注解，且不为HttpServletRequest类型参数时，默认为body类型参数，一个方法只支持最多一个body类型参数。</li>
+ <li>打在参数上面的注解建议显式定义出value值，否则将直接使用契约中的参数名，例如应该使用<code class="highlighter-rouge">@QueryParam\("name"\) String name</code>，而不是<code class="highlighter-rouge">@QueryParam String name</code>。</li>
+ </ul>
+</blockquote>
+
+
+ </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/quick-start/">Quick Start</a></li>
+ <li><a href="/users/user-guide/">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">Contribute</p>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/issues/new?title=Issue with _users/develop-with-jax-rs.md">Report a Doc Issue</a></li>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/edit/master/_users/develop-with-jax-rs.md">Edit This Page on Github</a></li>
+ <li><a href="/developers/submit-codes/">Code Submit Guide</a></li>
+ </ul>
+ </div>
+ <div class="col">
+ <ul class="social-icons">
+ <p class="header">Community</p>
+ <li>
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-developers" target="_blank"><span class="group">Dev</span></a> |
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-users" target="_blank">User</span></a>
+ </li>
+ <li>
+ <a href="http://github.com/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>© 2017 Apache incubator ServiceComb. Powered by <a href="http://jekyllrb.com" rel="nofollow">Jekyll</a> & <a href="https://mademistakes.com/work/minimal-mistakes-jekyll-theme/" rel="nofollow">Minimal Mistakes</a>.</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>