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:22 UTC
[25/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/cn/users/service-configurations/index.html
----------------------------------------------------------------------
diff --git a/content/cn/users/service-configurations/index.html b/content/cn/users/service-configurations/index.html
new file mode 100644
index 0000000..52c9ce7
--- /dev/null
+++ b/content/cn/users/service-configurations/index.html
@@ -0,0 +1,1095 @@
+<!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="cn" 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="cn">
+<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/cn/users/service-configurations/">
+ <meta property="og:url" content="http://github.com/pages/ServiceComb/servicesomb.github.io/cn/users/service-configurations/">
+
+
+
+ <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="/cn"><img src="//assets/images/ServiceComb-logo-1.png"></a>
+
+ <ul class="visible-links">
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/docs/quick-start/">快速入门</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a class="active" href="/cn/users/">用户手册</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/developers/">开发者手册</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/year-archive/">博文</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/faqs/">常见问题</a>
+
+ </li>
+
+ </ul>
+ <button><div class="navicon"></div></button>
+ <ul class="hidden-links hidden"></ul>
+ <div class="nav-lang">
+
+
+
+ <a href=/users/service-configurations/>English</a>
+
+ </div>
+ </nav>
+ </div>
+ </div>
+</div>
+
+
+
+
+
+
+<div id="main" role="main">
+
+ <div class="sidebar sticky">
+
+ <div class="back-to-home">首页 > <a href="/cn/">ServiceComb</a></div>
+
+
+
+
+
+
+
+
+
+
+
+<nav class="nav__list">
+
+ <input id="ac-toc" name="accordion-toc" type="checkbox" />
+ <label for="ac-toc">切换菜单</label>
+ <ul class="nav__items">
+
+ <li>
+
+ <span class="nav__sub-title">用户手册</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/" class="">Java Chassis系统架构</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/setup-environment/" class="">环境配置</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">开发服务提供者</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-definition/" class="">服务定义</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-contract/" class="">服务契约</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-springmvc/" class="">用SpringMVC开发微服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-jax-rs/" class="">用JAX-RS开发微服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-transparent-rpc/" class="">用透明RPC开发微服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-interface-constraints/" class="">服务接口约束</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-configurations/" class="active">服务配置</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/communicate-protocol/" class="">通信协议</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/application-boot-process/" class="">程序启动逻辑</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-heartbeat/" class="">服务心跳</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">开发服务消费者</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-rest-template/" class="">使用Rest Template方式开发</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-rpc/" class="">使用RPC方式开发</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/use-service-contract/" class="">使用服务契约</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/invoke-control/" class="">调用控制</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">通用开发</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/local-develop-test/" class="">本地开发与测试</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/use-servicecomb-in-spring-boot/" class="">在Spring Boot中使用ServiceComb</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/distributed-tracing/" class="">分布式调用链追踪</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/customized-tracing/" class="">自定义调用链打点</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">服务能力开放</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/edging-service/nginx/" class="">使用confd和Nginx做边缘服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/edging-service/zuul/" class="">使用Zuul做边缘服务</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+
+
+
+ <a href="/cn/users/metrics/"><span class="nav__sub-title nav__sub-title-with-url">监控</span></a>
+
+
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">部署</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/run-mode/" class="">运行模式</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">微服务安全</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/use-tls/" class="">使用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> 在本页上</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>
+ <li><a href="#示例代码" id="markdown-toc-示例代码">示例代码</a></li>
+ </ul>
+ </li>
+ <li><a href="#自定义路由策略" id="markdown-toc-自定义路由策略">自定义路由策略</a></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>
+ <li><a href="#配置说明-1" id="markdown-toc-配置说明-1">配置说明</a></li>
+ </ul>
+ </li>
+ <li><a href="#降级策略" id="markdown-toc-降级策略">降级策略</a> <ul>
+ <li><a href="#概念阐述" id="markdown-toc-概念阐述">概念阐述</a></li>
+ <li><a href="#场景描述-2" id="markdown-toc-场景描述-2">场景描述</a></li>
+ <li><a href="#配置说明-2" id="markdown-toc-配置说明-2">配置说明</a></li>
+ </ul>
+ </li>
+ <li><a href="#示例代码-1" id="markdown-toc-示例代码-1">示例代码</a></li>
+</ul>
+
+ </nav>
+</aside>
+
+<h2 id="负载均衡策略">负载均衡策略</h2>
+<h3 id="场景描述">场景描述</h3>
+
+<p> ServiceComb提供了基于Ribbon的负载均衡方案，用户可以通过配置文件配置负载均衡策略，当前支持随机、顺序、基于响应时间的权值等多种负载均衡路由策略。</p>
+
+<h3 id="配置说明">配置说明</h3>
+
+<p> 负载均衡策略在mocroservice.yaml文件中配置，配置项为<code class="highlighter-rouge">cse.loadbalance.[MicroServiceName].[property name]</code>，其中若省略MicroServiceName，则为全局配置；若指定MicroServiceName，则为针对特定微服务的配置。</p>
+
+<p> <strong>表1 配置项说明</strong></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.loadbalance.NFLoadBalancerRuleClassName</td>
+ <td style="text-align: left">com.netflix.loadbalancer.RoundRobinRule</td>
+ <td style="text-align: left">com.netflix.loadbalancer.RoundRobinRule（轮询）com.netflix.loadbalancer.RandomRule（随机）com.netflix.loadbalancer.WeightedResponseTimeRule（服务器响应时间权值）io.servicecomb.loadbalance.SessionStickinessRule（会话保持）</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.loadbalance.SessionStickinessRule.sessionTimeoutInSeconds</td>
+ <td style="text-align: left">30</td>
+ <td style="text-align: left">Integer</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">客户端闲置时间，超过限制后选择后面的服务器。</td>
+ <td style="text-align: left">暂不支持微服务配置。e.g. cse.loadbalance.SessionStickinessRule.sessionTimeoutInSeconds，不能配置为cse.loadbalance.DemoService.SessionStickinessRule.sessionTimeoutInSeconds</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.loadbalance.SessionStickinessRule.successiveFailedTimes</td>
+ <td style="text-align: left">5</td>
+ <td style="text-align: left">Integer</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.loadbalance.retryEnabled</td>
+ <td style="text-align: left">FALSE</td>
+ <td style="text-align: left">Boolean</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.loadbalance.retryOnNext</td>
+ <td style="text-align: left">0</td>
+ <td style="text-align: left">Integer</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.loadbalance.retryOnSame</td>
+ <td style="text-align: left">0</td>
+ <td style="text-align: left">Integer</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.loadbalance.isolation.enabled</td>
+ <td style="text-align: left">FALSE</td>
+ <td style="text-align: left">Boolean</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.loadbalance.isolation.enableRequestThreshold</td>
+ <td style="text-align: left">20</td>
+ <td style="text-align: left">Integer</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.loadbalance.isolation.errorThresholdPercentage</td>
+ <td style="text-align: left">20</td>
+ <td style="text-align: left">Integer，区间为(0,100]</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.loadbalance.isolation.singleTestTime</td>
+ <td style="text-align: left">10000</td>
+ <td style="text-align: left">Integer</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">故障实例单点测试时间</td>
+ <td style="text-align: left">单位为ms</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.loadbalance.transactionControl.policy</td>
+ <td style="text-align: left">io.servicecomb.loadbalance.filter.SimpleTransactionControlFilter</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.loadbalance.transactionControl.options</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">key/value pairs</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">针对SimpleTransactionControlFilter分流策略的配置项，可添加任意项过滤标签</td>
+ <td style="text-align: left">-</td>
+ </tr>
+ </tbody>
+</table>
+
+<h3 id="示例代码">示例代码</h3>
+
+<p> 负载均衡策略配置在src/main/resources/microservice.yaml文件中。</p>
+
+<p> 配置处理链：</p>
+
+<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">cse</span><span class="pi">:</span>
+ <span class="c1"># other configurations omitted</span>
+ <span class="s">handler</span><span class="pi">:</span>
+ <span class="s">chain</span><span class="pi">:</span>
+ <span class="s">Consumer</span><span class="pi">:</span>
+ <span class="s">default</span><span class="pi">:</span> <span class="s">loadbalance</span>
+ <span class="c1"># other configurations omitted</span>
+</code></pre>
+</div>
+
+<p> 增加路由策略：</p>
+
+<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">cse：</span>
+ <span class="s"># other configurations omitted</span>
+ <span class="s">loadbalance</span><span class="pi">:</span>
+ <span class="s">NFLoadBalancerRuleClassName</span><span class="pi">:</span> <span class="s">com.netflix.loadbalancer.RoundRobinRule</span>
+ <span class="c1"># other configurations omitted</span>
+</code></pre>
+</div>
+
+<h2 id="自定义路由策略">自定义路由策略</h2>
+
+<p> 用户可以在ServiceComb提供的路由策略框架下根据业务需要，通过编程的方式来开发路由策略。实施步骤如下：</p>
+
+<ul>
+ <li>
+ <p>实现接口<code class="highlighter-rouge">com.netflix.loadbalancer.IRule</code>中定义的接口方法。
+路由选择逻辑在public Server choose(Object key)方法中实现。LoadBalancerStats是一个封装了负载均衡器当前运行状态的一个结构。通过获取stats中各个实例的运行指标，在choose方法中，判定将当前请求路由到哪个实例上进行处理。处理风格可以参照<code class="highlighter-rouge">io.servicecomb.loadbalance.SessionStickinessRule</code>。</p>
+ </li>
+ <li>
+ <p>编译开发的策略，保证生成的class在classpath下。</p>
+ </li>
+ <li>
+ <p>通过SDK配置该路由策略，假如是<code class="highlighter-rouge">AbcRule</code>。则配置如下： <code class="highlighter-rouge">cse.loadbalance.NFLoadBalancerRuleClassName=io.servicecomb.ribbon.rule.AbcRule</code></p>
+ </li>
+</ul>
+
+<h2 id="限流策略">限流策略</h2>
+<h3 id="场景描述-1">场景描述</h3>
+
+<p>用户在provider端使用限流策略，可以限制指定微服务向其发送请求的频率，达到限制每秒钟最大请求数量的效果。</p>
+
+<h3 id="注意事项">注意事项</h3>
+
+<ol>
+ <li>限流策略的控制并不是绝对精确的，可能会有少量误差。</li>
+ <li>provider端的流量控制是业务层面的功能，不是安全意义上的流量控制，如需防止DDoS攻击，需要结合其他的一系列措施。</li>
+ <li>流量控制是微服务级的，不是进程级的。</li>
+</ol>
+
+<h3 id="配置说明-1">配置说明</h3>
+
+<p> 限流策略配置在microservice.yaml文件中，相关配置项见下表。要开启服务提供者端的限流策略，还需要在处理链中配置服务端限流handler，配置示例如下：</p>
+
+<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">cse</span><span class="pi">:</span>
+ <span class="s">handler</span><span class="pi">:</span>
+ <span class="s">chain</span><span class="pi">:</span>
+ <span class="s">Consumer</span><span class="pi">:</span>
+ <span class="s">default</span><span class="pi">:</span> <span class="s">qps-flowcontrol-provider</span>
+</code></pre>
+</div>
+
+<p> <strong>表2 QPS流控配置项说明</strong></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.flowcontrol.Provider.qps.enabled</td>
+ <td style="text-align: left">true</td>
+ <td style="text-align: left">true/false</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">是否启用Provider流控</td>
+ <td style="text-align: left">-</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.flowcontrol.Provider.qps.limit.[ServiceName]</td>
+ <td style="text-align: left">2147483647（max int）</td>
+ <td style="text-align: left">(0,2147483647]，整形</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">每秒钟允许的请求数</td>
+ <td style="text-align: left">仅支持microservice一个级别的配置</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.flowcontrol.Provider.qps.global.limit</td>
+ <td style="text-align: left">2147483647（max int）</td>
+ <td style="text-align: left">(0,2147483647]，整形</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">provider接受请求流量的全局配置</td>
+ <td style="text-align: left">没有具体到微服务的配置时，此配置生效</td>
+ </tr>
+ </tbody>
+</table>
+
+<h2 id="降级策略">降级策略</h2>
+<h3 id="概念阐述">概念阐述</h3>
+
+<p>降级策略是当服务请求异常时，微服务所采用的异常处理策略。降级策略有三个相关的技术概念：“隔离”、“熔断”、“容错”：</p>
+
+<p>降级策略有三个相关的技术概念：“隔离”、“熔断”、“容错”：</p>
+<ul>
+ <li>“隔离”是一种异常检测机制，常用的检测方法是请求超时、流量过大等。一般的设置参数包括超时时间、同时并发请求个数等。</li>
+ <li>“熔断”是一种异常反应机制，“熔断”依赖于“隔离”。熔断通常基于错误率来实现。一般的设置参数包括统计请求的个数、错误率等。</li>
+ <li>“容错”是一种异常处理机制，“容错”依赖于“熔断”。熔断以后，会调用“容错”的方法。一般的设置参数包括调用容错方法的次数等。</li>
+</ul>
+
+<p>把这些概念联系起来：当”隔离”措施检测到N次请求中共有M次错误的时候，”熔断”不再发送后续请求，调用”容错”处理函数。这个技术上的定义，是和Netflix Hystrix一致的，通过这个定义，非常容易理解它提供的配置项，参考：<a href="https://github.com/Netflix/Hystrix/wiki/Configuration">https://github.com/Netflix/Hystrix/wiki/Configuration</a>。当前ServiceComb提供两种容错方式，分别为返回null值和抛出异常。</p>
+
+<h3 id="场景描述-2">场景描述</h3>
+
+<p>用户通过配置降级策略，可以设置微服务的异常处理策略。</p>
+
+<h3 id="配置说明-2">配置说明</h3>
+
+<p> 配置项如表所示。</p>
+
+<p> <strong>表3 降级策略相关配置项说明</strong></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.isolation.timeout.enabled</td>
+ <td style="text-align: left">FALSE</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.isolation.timeoutInMilliseconds</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.isolation.maxConcurrentRequests</td>
+ <td style="text-align: left">10</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.circuitBreaker.enabled</td>
+ <td style="text-align: left">TRUE</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.circuitBreaker.forceOpen</td>
+ <td style="text-align: left">FALSE</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.circuitBreaker.forceClosed</td>
+ <td style="text-align: left">FALSE</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">任何时候都不熔断</td>
+ <td style="text-align: left">当与forceOpen同时配置时，forceOpen优先。</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.circuitBreaker.sleepWindowInMilliseconds</td>
+ <td style="text-align: left">15000</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.circuitBreaker.requestVolumeThreshold</td>
+ <td style="text-align: left">20</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">10s内统计错误发生次数阈值，超过阈值则触发熔断</td>
+ <td style="text-align: left">由于10秒还会被划分为10个1秒的统计周期，经过1s中后才会开始计算错误率，因此从调用开始至少经过1s，才会发生熔断。</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.circuitBreaker.errorThresholdPercentage</td>
+ <td style="text-align: left">50</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.fallback.enabled</td>
+ <td style="text-align: left">TRUE</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.fallback.maxConcurrentRequests</td>
+ <td style="text-align: left">10</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">并发调用容错处理措施（cse.fallbackpolicy.policy）的请求数，超过这个值则不再调用处理措施，直接返回异常</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left">cse.fallbackpolicy.policy</td>
+ <td style="text-align: left">throwexception</td>
+ <td style="text-align: left">returnnulll | throwexception</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">出错后的处理策略</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ </tbody>
+</table>
+
+<p class="notice--warning"><strong>注意：</strong> 谨慎使用cse.isolation.timeout.enabled=true。因为系统处理链都是异步执行，中间处理链的返回，会导致后面处理链的逻辑处理效果丢失。尽可能将cse.isolation.timeout.enabled保持默认值false，并且正确设置网络层超时时间cse.request.timeout=30000。</p>
+
+<h2 id="示例代码-1">示例代码</h2>
+
+<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">cse</span><span class="pi">:</span>
+ <span class="s">handler</span><span class="pi">:</span>
+ <span class="s">chain</span><span class="pi">:</span>
+ <span class="s">Consumer</span><span class="pi">:</span>
+ <span class="s">default</span><span class="pi">:</span> <span class="s">bizkeeper-consumer</span>
+ <span class="s">isolation</span><span class="pi">:</span>
+ <span class="s">Consumer</span><span class="pi">:</span>
+ <span class="s">timeout</span><span class="pi">:</span>
+ <span class="s">enabled</span><span class="pi">:</span> <span class="s">true</span>
+ <span class="s">timeoutInMilliseconds</span><span class="pi">:</span> <span class="s">30000</span>
+ <span class="s">circuitBreaker</span><span class="pi">:</span>
+ <span class="s">sleepWindowInMilliseconds</span><span class="pi">:</span> <span class="s">15000</span>
+ <span class="s">requestVolumeThreshold</span><span class="pi">:</span> <span class="s">20</span>
+ <span class="s">fallback</span><span class="pi">:</span>
+ <span class="s">enabled</span><span class="pi">:</span> <span class="s">true</span>
+ <span class="s">policy</span><span class="pi">:</span> <span class="s">throwexception</span>
+</code></pre>
+</div>
+
+<blockquote>
+ <p><strong>说明：</strong>
+降级策略需要启用服务治理能力，对应的服务提供者的handler是<code class="highlighter-rouge">bizkeeper-provider</code>，服务消费者的handler是<code class="highlighter-rouge">bizkeeper-consumer</code>。</p>
+</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">资源</p>
+ <li><a href="/cn/docs/quick-start/">快速入门</a></li>
+ <li><a href="/cn/users/user-guide/">用户指南</a></li>
+ <li><a href="/cn/slides/">资料</a></li>
+ <li><a href="/cn/users/faq/">常见问题</a></li>
+ </ul>
+ </div>
+ <div class="col">
+ <ul>
+ <p class="header">贡献</p>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/issues/new?title=Issue with _users/cn/service-configurations.md">报告本网页问题</a></li>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/edit/master/_users/cn/service-configurations.md">在Github上编辑此页</a></li>
+ <li><a href="/cn/developers/submit-codes/">代码提交指南</a></li>
+ </ul>
+ </div>
+ <div class="col">
+ <ul class="social-icons">
+ <p class="header">社区</p>
+ <li>
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-developers" target="_blank"><span class="group">开发者</span></a> |
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-users" target="_blank">用户</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. 技术来自于 <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/cn/users/service-contract/index.html
----------------------------------------------------------------------
diff --git a/content/cn/users/service-contract/index.html b/content/cn/users/service-contract/index.html
new file mode 100644
index 0000000..c48f8c8
--- /dev/null
+++ b/content/cn/users/service-contract/index.html
@@ -0,0 +1,802 @@
+<!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="cn" 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="cn">
+<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/cn/users/service-contract/">
+ <meta property="og:url" content="http://github.com/pages/ServiceComb/servicesomb.github.io/cn/users/service-contract/">
+
+
+
+ <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="/cn"><img src="//assets/images/ServiceComb-logo-1.png"></a>
+
+ <ul class="visible-links">
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/docs/quick-start/">快速入门</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a class="active" href="/cn/users/">用户手册</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/developers/">开发者手册</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/year-archive/">博文</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/faqs/">常见问题</a>
+
+ </li>
+
+ </ul>
+ <button><div class="navicon"></div></button>
+ <ul class="hidden-links hidden"></ul>
+ <div class="nav-lang">
+
+
+
+ <a href=/users/service-contract/>English</a>
+
+ </div>
+ </nav>
+ </div>
+ </div>
+</div>
+
+
+
+
+
+
+<div id="main" role="main">
+
+ <div class="sidebar sticky">
+
+ <div class="back-to-home">首页 > <a href="/cn/">ServiceComb</a></div>
+
+
+
+
+
+
+
+
+
+
+
+<nav class="nav__list">
+
+ <input id="ac-toc" name="accordion-toc" type="checkbox" />
+ <label for="ac-toc">切换菜单</label>
+ <ul class="nav__items">
+
+ <li>
+
+ <span class="nav__sub-title">用户手册</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/" class="">Java Chassis系统架构</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/setup-environment/" class="">环境配置</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">开发服务提供者</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-definition/" class="">服务定义</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-contract/" class="active">服务契约</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-springmvc/" class="">用SpringMVC开发微服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-jax-rs/" class="">用JAX-RS开发微服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-transparent-rpc/" class="">用透明RPC开发微服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-interface-constraints/" class="">服务接口约束</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-configurations/" class="">服务配置</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/communicate-protocol/" class="">通信协议</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/application-boot-process/" class="">程序启动逻辑</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-heartbeat/" class="">服务心跳</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">开发服务消费者</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-rest-template/" class="">使用Rest Template方式开发</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-rpc/" class="">使用RPC方式开发</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/use-service-contract/" class="">使用服务契约</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/invoke-control/" class="">调用控制</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">通用开发</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/local-develop-test/" class="">本地开发与测试</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/use-servicecomb-in-spring-boot/" class="">在Spring Boot中使用ServiceComb</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/distributed-tracing/" class="">分布式调用链追踪</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/customized-tracing/" class="">自定义调用链打点</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">服务能力开放</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/edging-service/nginx/" class="">使用confd和Nginx做边缘服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/edging-service/zuul/" class="">使用Zuul做边缘服务</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+
+
+
+ <a href="/cn/users/metrics/"><span class="nav__sub-title nav__sub-title-with-url">监控</span></a>
+
+
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">部署</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/run-mode/" class="">运行模式</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">微服务安全</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/use-tls/" class="">使用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> 在本页上</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> <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="#场景描述-1" id="markdown-toc-场景描述-1">场景描述</a></li>
+ <li><a href="#涉及api" id="markdown-toc-涉及api">涉及API</a></li>
+ </ul>
+ </li>
+</ul>
+
+ </nav>
+</aside>
+
+<h2 id="概念阐述">概念阐述</h2>
+
+<p>服务契约，指基于OpenAPI规范的微服务接口契约，是服务端与消费端对于接口的定义。</p>
+
+<h2 id="场景描述">场景描述</h2>
+
+<p>服务契约用于服务端和消费端的解耦，服务端围绕契约进行服务的实现，消费端根据契约进行服务的调用，可支持服务端和消费端采用不同的编程语言实现。</p>
+
+<h2 id="显式契约">显式契约</h2>
+
+<h3 id="配置说明">配置说明</h3>
+
+<p>ServiceComb使用yaml文件格式定义服务契约，推荐使用<a href="http://editor.swagger.io/#/">Swagger Editor</a>工具来编写契约，可检查语法格式及自动生成API文档。详细的契约文件格式请参考<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md">OpenAPI官方文档</a>。</p>
+
+<p>契约文件放置在”resources/microservices”或者”resources/applications”目录下，目录结构如下所示。</p>
+
+<pre><code class="language-txt">resources
+ - microservices
+ - serviceName #微服务名
+ - schemaId.yaml #schema接口的契约
+ - applications
+ - appId #应用ID
+ - serviceName #微服务名
+ - schemaId.yaml #schema接口的契约
+</code></pre>
+
+<h3 id="示例代码">示例代码</h3>
+
+<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">swagger</span><span class="pi">:</span> <span class="s1">'</span><span class="s">2.0'</span>
+<span class="s">info</span><span class="pi">:</span>
+ <span class="s">title</span><span class="pi">:</span> <span class="s">hello</span>
+ <span class="s">version</span><span class="pi">:</span> <span class="s">1.0.0</span>
+ <span class="s">x-java-interface</span><span class="pi">:</span> <span class="s">io.servicecomb.samples.common.schema.Hello</span>
+<span class="s">basePath</span><span class="pi">:</span> <span class="s">/springmvchello</span>
+<span class="s">produces</span><span class="pi">:</span>
+ <span class="pi">-</span> <span class="s">application/json</span>
+
+<span class="s">paths</span><span class="pi">:</span>
+ <span class="s">/sayhi</span><span class="pi">:</span>
+ <span class="s">post</span><span class="pi">:</span>
+ <span class="s">operationId</span><span class="pi">:</span> <span class="s">sayHi</span>
+ <span class="s">parameters</span><span class="pi">:</span>
+ <span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">name</span>
+ <span class="s">in</span><span class="pi">:</span> <span class="s">query</span>
+ <span class="s">required</span><span class="pi">:</span> <span class="s">true</span>
+ <span class="s">type</span><span class="pi">:</span> <span class="s">string</span>
+ <span class="s">responses</span><span class="pi">:</span>
+ <span class="s">200</span><span class="pi">:</span>
+ <span class="s">description</span><span class="pi">:</span> <span class="s">正确返回</span>
+ <span class="s">schema</span><span class="pi">:</span>
+ <span class="s">type</span><span class="pi">:</span> <span class="s">string</span>
+ <span class="s">default</span><span class="pi">:</span>
+ <span class="s">description</span><span class="pi">:</span> <span class="s">默认返回</span>
+ <span class="s">schema</span><span class="pi">:</span>
+ <span class="s">type</span><span class="pi">:</span> <span class="s">string</span>
+ <span class="s">/sayhello</span><span class="pi">:</span>
+ <span class="s">post</span><span class="pi">:</span>
+ <span class="s">operationId</span><span class="pi">:</span> <span class="s">sayHello</span>
+ <span class="s">parameters</span><span class="pi">:</span>
+ <span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">person</span>
+ <span class="s">in</span><span class="pi">:</span> <span class="s">body</span>
+ <span class="s">required</span><span class="pi">:</span> <span class="s">true</span>
+ <span class="s">schema</span><span class="pi">:</span>
+ <span class="s">$ref</span><span class="pi">:</span> <span class="s2">"</span><span class="s">#/definitions/Person"</span>
+ <span class="s">responses</span><span class="pi">:</span>
+ <span class="s">200</span><span class="pi">:</span>
+ <span class="s">description</span><span class="pi">:</span> <span class="s">正确返回</span>
+ <span class="s">schema</span><span class="pi">:</span>
+ <span class="s">type</span><span class="pi">:</span> <span class="s">string</span>
+ <span class="s">default</span><span class="pi">:</span>
+ <span class="s">description</span><span class="pi">:</span> <span class="s">默认返回</span>
+ <span class="s">schema</span><span class="pi">:</span>
+ <span class="s">type</span><span class="pi">:</span> <span class="s">string</span>
+<span class="s">definitions</span><span class="pi">:</span>
+ <span class="s">Person</span><span class="pi">:</span>
+ <span class="s">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">object"</span>
+ <span class="s">properties</span><span class="pi">:</span>
+ <span class="s">name</span><span class="pi">:</span>
+ <span class="s">type</span><span class="pi">:</span> <span class="s2">"</span><span class="s">string"</span>
+ <span class="s">description</span><span class="pi">:</span> <span class="s2">"</span><span class="s">person</span><span class="nv"> </span><span class="s">name"</span>
+ <span class="s">xml</span><span class="pi">:</span>
+ <span class="s">name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">Person"</span>
+</code></pre>
+</div>
+
+<blockquote>
+ <p><strong>注意</strong>：</p>
+ <ul>
+ <li>根据swagger标准，basePath配置的路径需要包括web server的webroot。</li>
+ <li>info.x-java-interface需要标明具体的接口路径，根据项目实际情况而定。</li>
+ </ul>
+</blockquote>
+
+<h2 id="隐式契约">隐式契约</h2>
+<h3 id="概念阐述-1">概念阐述</h3>
+
+<p> 隐式契约是指ServiceComb根据服务实现类自动生成的服务契约。</p>
+
+<h3 id="场景描述-1">场景描述</h3>
+
+<p> 用户通过隐式契约功能，可以不预先定义契约和接口，直接定义实现类，在服务启动时，根据实现类自动生成契约，并注册到服务中心。</p>
+
+<h3 id="涉及api">涉及API</h3>
+
+<p> 隐式契约可用于Spring MVC、JAX-RS、透明RPC三种开发模式，具体使用参见<a href="/cn/users/develop-with-springmvc/">用SpringMVC开发微服务</a>、<a href="/cn/users/develop-with-jax-rs/">用JAX-RS开发微服务</a>和<a href="/cn/users/develop-with-transparent-rpc/">用透明RPC开发微服务</a>。</p>
+
+<p> 使用透明RPC模式开发微服务时，由于从代码上无法分辨微服务开发人员期望如何定义契约，所以生成的契约全是POST方法，所有method的入参被包装为一个class，作为body参数传递，所以建议使用隐式契约开发provider时，选择SpringMVC或JAX-RS开发模式，可以得到完整的RESTful声明。</p>
+
+
+ </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">资源</p>
+ <li><a href="/cn/docs/quick-start/">快速入门</a></li>
+ <li><a href="/cn/users/user-guide/">用户指南</a></li>
+ <li><a href="/cn/slides/">资料</a></li>
+ <li><a href="/cn/users/faq/">常见问题</a></li>
+ </ul>
+ </div>
+ <div class="col">
+ <ul>
+ <p class="header">贡献</p>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/issues/new?title=Issue with _users/cn/define-service-contract.md">报告本网页问题</a></li>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/edit/master/_users/cn/define-service-contract.md">在Github上编辑此页</a></li>
+ <li><a href="/cn/developers/submit-codes/">代码提交指南</a></li>
+ </ul>
+ </div>
+ <div class="col">
+ <ul class="social-icons">
+ <p class="header">社区</p>
+ <li>
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-developers" target="_blank"><span class="group">开发者</span></a> |
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-users" target="_blank">用户</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. 技术来自于 <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/cn/users/service-definition/index.html
----------------------------------------------------------------------
diff --git a/content/cn/users/service-definition/index.html b/content/cn/users/service-definition/index.html
new file mode 100644
index 0000000..10772ef
--- /dev/null
+++ b/content/cn/users/service-definition/index.html
@@ -0,0 +1,794 @@
+<!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="cn" 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="cn">
+<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/cn/users/service-definition/">
+ <meta property="og:url" content="http://github.com/pages/ServiceComb/servicesomb.github.io/cn/users/service-definition/">
+
+
+
+ <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="/cn"><img src="//assets/images/ServiceComb-logo-1.png"></a>
+
+ <ul class="visible-links">
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/docs/quick-start/">快速入门</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a class="active" href="/cn/users/">用户手册</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/developers/">开发者手册</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/year-archive/">博文</a>
+
+ </li>
+
+
+ <li class="masthead__menu-item">
+
+
+
+ <a href="/cn/faqs/">常见问题</a>
+
+ </li>
+
+ </ul>
+ <button><div class="navicon"></div></button>
+ <ul class="hidden-links hidden"></ul>
+ <div class="nav-lang">
+
+
+
+ <a href=/users/service-definition/>English</a>
+
+ </div>
+ </nav>
+ </div>
+ </div>
+</div>
+
+
+
+
+
+
+<div id="main" role="main">
+
+ <div class="sidebar sticky">
+
+ <div class="back-to-home">首页 > <a href="/cn/">ServiceComb</a></div>
+
+
+
+
+
+
+
+
+
+
+
+<nav class="nav__list">
+
+ <input id="ac-toc" name="accordion-toc" type="checkbox" />
+ <label for="ac-toc">切换菜单</label>
+ <ul class="nav__items">
+
+ <li>
+
+ <span class="nav__sub-title">用户手册</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/" class="">Java Chassis系统架构</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/setup-environment/" class="">环境配置</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">开发服务提供者</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-definition/" class="active">服务定义</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-contract/" class="">服务契约</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-springmvc/" class="">用SpringMVC开发微服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-jax-rs/" class="">用JAX-RS开发微服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-transparent-rpc/" class="">用透明RPC开发微服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-interface-constraints/" class="">服务接口约束</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-configurations/" class="">服务配置</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/communicate-protocol/" class="">通信协议</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/application-boot-process/" class="">程序启动逻辑</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/service-heartbeat/" class="">服务心跳</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">开发服务消费者</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-rest-template/" class="">使用Rest Template方式开发</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/develop-with-rpc/" class="">使用RPC方式开发</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/use-service-contract/" class="">使用服务契约</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/invoke-control/" class="">调用控制</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">通用开发</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/local-develop-test/" class="">本地开发与测试</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/use-servicecomb-in-spring-boot/" class="">在Spring Boot中使用ServiceComb</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/distributed-tracing/" class="">分布式调用链追踪</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/customized-tracing/" class="">自定义调用链打点</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">服务能力开放</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/edging-service/nginx/" class="">使用confd和Nginx做边缘服务</a></li>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/edging-service/zuul/" class="">使用Zuul做边缘服务</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+
+
+
+ <a href="/cn/users/metrics/"><span class="nav__sub-title nav__sub-title-with-url">监控</span></a>
+
+
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">部署</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/run-mode/" class="">运行模式</a></li>
+
+ </ul>
+
+ </li>
+
+ <li>
+
+ <span class="nav__sub-title">微服务安全</span>
+
+
+
+ <ul>
+
+
+
+
+
+
+
+ <li><a href="/cn/users/use-tls/" class="">使用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> 在本页上</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>
+</ul>
+
+ </nav>
+</aside>
+
+<h2 id="概念阐述">概念阐述</h2>
+
+<p>服务定义信息是微服务的身份标识，它定义了服务从属于哪个应用，以及名字和版本。服务定义信息中也可以有扩展信息，用于定义服务的属性元数据。</p>
+
+<h2 id="场景描述">场景描述</h2>
+
+<p>当用户定义新的微服务或修改微服务的基本信息时，会涉及到服务定义信息的创建和修改操作。</p>
+
+<h2 id="配置说明">配置说明</h2>
+
+<p>介绍涉及microservice.yaml文件的以下配置项，文件在项目中的存放路径为src/main/resources/microservice.yaml。</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">APPLICATION_ID</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>
+ <td style="text-align: left">-</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">service_description.name</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>
+ <td style="text-align: left">应确保app内部唯一。微服务名支持数字、大小写字母和”-“、”_“、”.”三个特殊字符，但是不能以特殊字符作为首尾字符，命名规范为：^[a-zA-Z0-9]+$|^[a-zA-Z0-9][a-zA-Z0-9_-.]*[a-zA-Z0-9]$。</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">service_description.version</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>
+ <td style="text-align: left">-</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">service_description.properties</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">微服务元数据配置（通过microservice.yaml文件进行配置）</td>
+ <td style="text-align: left">-</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">service_description.propertyExtendedClass</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">微服务元数据配置（通过实现接口PropertyExtended进行配置）</td>
+ <td style="text-align: left">接口返回的配置会覆盖配置文件中key相同的配置。</td>
+ </tr>
+ <tr>
+ <td style="text-align: left">instance_description.properties</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">服务实例元数据配置（通过microservice.yaml文件进行配置）</td>
+ <td style="text-align: left"> </td>
+ </tr>
+ <tr>
+ <td style="text-align: left">instance_description.propertyExtendedClass</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">-</td>
+ <td style="text-align: left">否</td>
+ <td style="text-align: left">微服务元数据配置（通过实现接口PropertyExtended进行配置）</td>
+ <td style="text-align: left">同service_description.propertyExtendedClass</td>
+ </tr>
+ </tbody>
+</table>
+
+<blockquote>
+ <p>说明：</p>
+ <ul>
+ <li>服务的元数据会随服务一同注册到服务中心，如需修改，则要连同服务version一起变更。若想保持服务version不变，则需要通过服务管理中心统一变更元数据。</li>
+ <li>默认情况下，微服务只支持同一个app内部的服务调用。可在微服务的properties中配置allowCrossApp=true属性，开启可被跨app访问权限。</li>
+ </ul>
+</blockquote>
+
+<h2 id="示例代码">示例代码</h2>
+
+<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="s">APPLICATION_ID</span><span class="pi">:</span> <span class="s">helloTest</span> <span class="c1">#应用名</span>
+<span class="s">service_description</span><span class="pi">:</span> <span class="c1">#服务描述</span>
+ <span class="s">name</span><span class="pi">:</span> <span class="s">helloServer</span> <span class="c1">#微服务名称</span>
+ <span class="s">version</span><span class="pi">:</span> <span class="s">0.0.1</span> <span class="c1">#服务版本号</span>
+ <span class="s">properties</span><span class="pi">:</span> <span class="c1">#元数据</span>
+ <span class="s">allowCrossApp</span><span class="pi">:</span> <span class="s">false</span>
+ <span class="s">key1</span><span class="pi">:</span> <span class="s">value1</span>
+ <span class="s">key2</span><span class="pi">:</span> <span class="s">value2</span>
+ <span class="s">propertyExtentedClass</span><span class="pi">:</span> <span class="s">io.servicecomb.serviceregistry.MicroServicePropertyExtendedStub</span>
+<span class="s">instance_description</span><span class="pi">:</span> <span class="c1">#实例描述</span>
+ <span class="s">properties</span><span class="pi">:</span> <span class="c1">#元数据</span>
+ <span class="s">key3</span><span class="pi">:</span> <span class="s">value3</span>
+ <span class="s">propertyExtentedClass</span><span class="pi">:</span> <span class="s">io.servicecomb.serviceregistry.MicroServicePropertyExtendedStub</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">资源</p>
+ <li><a href="/cn/docs/quick-start/">快速入门</a></li>
+ <li><a href="/cn/users/user-guide/">用户指南</a></li>
+ <li><a href="/cn/slides/">资料</a></li>
+ <li><a href="/cn/users/faq/">常见问题</a></li>
+ </ul>
+ </div>
+ <div class="col">
+ <ul>
+ <p class="header">贡献</p>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/issues/new?title=Issue with _users/cn/service-definition.md">报告本网页问题</a></li>
+ <li><a href="https://github.com/ServiceComb/ServiceComb.github.io/edit/master/_users/cn/service-definition.md">在Github上编辑此页</a></li>
+ <li><a href="/cn/developers/submit-codes/">代码提交指南</a></li>
+ </ul>
+ </div>
+ <div class="col">
+ <ul class="social-icons">
+ <p class="header">社区</p>
+ <li>
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-developers" target="_blank"><span class="group">开发者</span></a> |
+ <a href="https://groups.google.com/forum/#!forum/servicecomb-users" target="_blank">用户</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. 技术来自于 <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>