blob: d300cd32996645a1ee7bbb96710bbe9b283522de [file] [log] [blame]
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>使用服务中心 - ServiceComb Java Chassis 开发指南</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "\u4f7f\u7528\u670d\u52a1\u4e2d\u5fc3";
var mkdocs_page_input_path = "registry/service-center.md";
var mkdocs_page_url = null;
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> ServiceComb Java Chassis 开发指南
</a>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../toc.html">目录</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../index.html">概述</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../start/catalog.html">快速入门</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../start/design.html">设计选型参考</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../build-provider/definition/service-definition.html">微服务定义</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../build-provider/catalog.html">开发服务提供者</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../build-consumer/catalog.html">开发服务消费者</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../general-development/catalog.html">通用功能开发</a>
</li>
</ul>
<p class="caption"><span class="caption-text">多样化的通信协议功能参考</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../transports/introduction.html">多协议介绍</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../transports/rest-over-servlet.html">REST over Servlet</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../transports/rest-over-vertx.html">REST over Vertx</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../transports/http2.html">REST over HTTP2</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../transports/highway-rpc.html">Highway</a>
</li>
</ul>
<p class="caption"><span class="caption-text">多样化的服务注册与发现功能参考</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="introduction.html">注册发现说明</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="service-center.html">使用服务中心</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#rbac">使用 RBAC 认证</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#aksk">使用 AK/SK 认证</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="local-registry.html">本地注册发现</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="distributed.html">去中心化注册发现</a>
</li>
</ul>
<p class="caption"><span class="caption-text">管理服务配置</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../config/general-config.html">通用配置说明</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../config/read-config.html">在程序中读取配置信息</a>
</li>
</ul>
<p class="caption"><span class="caption-text">服务治理功能参考</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../references-handlers/intruduction.html">处理链介绍</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../references-handlers/loadbalance.html">负载均衡</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../references-handlers/ratelimit.html">限流</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../references-handlers/router.html">灰度发布</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../references-handlers/fault-injection.html">故障注入</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../references-handlers/governance.html">流量特征治理</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../references-handlers/fail-retry.html">快速失败和重试</a>
</li>
</ul>
<p class="caption"><span class="caption-text">网关功能参考</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../edge/open-service.html">介绍</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../edge/by-servicecomb-sdk.html">使用 Edge Service 做网关</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../edge/zuul.html">使用 `zuul` 和 `spring cloud gateway` 做网关</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../edge/nginx.html">nginx 网关简单介绍</a>
</li>
</ul>
<p class="caption"><span class="caption-text">安全特性参考</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../references-handlers/publickey.html">公钥认证</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../security/tls.html">使用TLS通信</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../security/shi-yong-rsa-ren-zheng.html">使用RSA认证</a>
</li>
</ul>
<p class="caption"><span class="caption-text">服务打包和运行</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../packaging/standalone.html">以standalone模式打包</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../packaging/web-container.html">以WEB容器模式打包</a>
</li>
</ul>
<p class="caption"><span class="caption-text">专题文章</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../using-java-chassis-in-spring-boot/using-java-chassis-in-spring-boot.html">在Spring Boot中使用java chassis</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../featured-topics/features.html">新功能介绍系列文章</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../featured-topics/compatibility.html">兼容问题和兼容性策略</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../featured-topics/upgrading.html">升级指导系列文章</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../featured-topics/performance.html">性能问题分析和调优</a>
</li>
</ul>
<p class="caption"><span class="caption-text">常用配置项参考</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../config-reference/rest-transport-client.html">REST Transport Client 配置项</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../config-reference/config-center-client.html">Config Center Client 配置项</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../config-reference/service-center-client.html">Service Center Client 配置项</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../config-reference/kie-client.html">ServiceComb Kie Client 配置项</a>
</li>
</ul>
<p class="caption"><span class="caption-text">常见问题</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../question-and-answer/faq.html">FAQ</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../question-and-answer/question_answer.html">Q & A</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../question-and-answer/interface-compatibility.html">微服务接口兼容常见问题</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">ServiceComb Java Chassis 开发指南</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>多样化的服务注册与发现功能参考 &raquo;</li>
<li>使用服务中心</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="_1">使用服务中心</h1>
<p>服务中心(servicecomb-service-center) 提供了完备的注册发现机制, 实现了所有 <code>Microservice</code><code>MicroserviceInstance</code> 信息的注册和发现,
是 servicecomb 缺省使用的注册发现机制。 </p>
<p>服务中心支持使用 <code>PULL</code><code>PUSH</code> 两种模式通知实例变化, 开发者可以配置服务中心集群地址、连接参数以及心跳管理等。</p>
<ul>
<li>表1-1 访问服务中心常用的配置项</li>
</ul>
<table>
<thead>
<tr>
<th align="left">配置项</th>
<th align="left">默认值</th>
<th align="left">是否必选</th>
<th align="left">含义</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left">servicecomb.service.registry.</p>address</td>
<td align="left">http://127.0.0.1:30100</td>
<td align="left"></td>
<td align="left">服务中心的地址信息,可以配置多个,用逗号分隔。</td>
</tr>
<tr>
<td align="left">servicecomb.service.registry.</p>instance.watch</td>
<td align="left">true</td>
<td align="left"></td>
<td align="left">是否采用PUSH模式监听实例变化。为false的时候表示使用PULL模式。</td>
</tr>
<tr>
<td align="left">servicecomb.service.registry.</p>autodiscovery</td>
<td align="left">false</td>
<td align="left"></td>
<td align="left">是否自动发现服务中心的地址。当需要配置部分地址,其他地址由配置的服务中心实例发现的时候,开启这个配置。</td>
</tr>
<tr>
<td align="left">servicecomb.service.registry.</p>instance.healthCheck.interval</td>
<td align="left">30</td>
<td align="left"></td>
<td align="left">心跳间隔。</td>
</tr>
<tr>
<td align="left">servicecomb.service.registry.</p>instance.healthCheck.times</td>
<td align="left">3</td>
<td align="left"></td>
<td align="left">允许的心跳失败次数。当连续第times+1次心跳仍然失败时则实例被sc下线。即interval * (times + 1)决定了实例被自动注销的时间。如果服务中心等待这么长的时间没有收取到心跳,会注销实例。</td>
</tr>
<tr>
<td align="left">servicecomb.service.registry.</p>instance.empty.protection</td>
<td align="left">true</td>
<td align="left"></td>
<td align="left">当从服务中心查询到的地址为空的时候,是否覆盖本地缓存。这个是一种可靠性保护机制,避免实例异常批量下线导致的请求失败。</td>
</tr>
</tbody>
</table>
<p>servicecomb 与服务中心采用 HTTP 进行交互, HTTP client 相关配置可以参
<a href="../config-reference/service-center-client.html">Service Center Client 配置项</a></p>
<p>使用服务中心需要确保下面的软件包引入:</p>
<pre><code> &lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;registry-service-center&lt;/artifactId&gt;
&lt;/dependency&gt;
</code></pre>
<p>也可以直接依赖:</p>
<pre><code> &lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;solution-basic&lt;/artifactId&gt;
&lt;/dependency&gt;
</code></pre>
<h2 id="rbac">使用 RBAC 认证</h2>
<p>服务中心支持<a href="https://service-center.readthedocs.io/en/latest/user-guides/rbac.html">RBAC认证</a>,服务中心开启RBAC认证之
后,客户端调用服务中心接口都需要先获取token,保证服务的安全可信。 使用 RBAC 认证, 需要使用 2.1.3 及其以上的版本。 </p>
<ul>
<li>服务配置</li>
</ul>
<p>使用 RBAC 认证,需要在配置文件中增加如下配置项, 指定连接服务中心的用户名和密码:</p>
<pre><code> ```
servicecomb:
credentials:
rbac.enabled: true # 使用启用 RBAC, 默认为 false
account:
name: root #服务中心支持的用户名
password: your-password #用户名对应的密码
cipher: default #账号密码加解密用的算法实现类
```
</code></pre>
<p>账号密码都是敏感信息,一般需要加密保存,使用的时候再解密,Java Chassis 提供了一个扩展机制,用户只需要实现接口
<code>org.apache.servicecomb.foundation.auth.Cipher</code>,并注册成Spring Bean,就会自动被使用,接口里面包含两个方法:</p>
<pre><code> ```java
String name();
char[] decrypt(char[] encrypted);
```
</code></pre>
<p>name方法返回cipher的名称,对应 <code>servicecomb.credentials.cipher</code> 的配置,decrypt是解密接口,用户名、密码使用的时候都会调用这个方法进行解密。
下面给了一个最简单的base64编解码的实现示例,用户使用base64编码把账号密码配置到配置文件即可。</p>
<p><strong><em>注意</em></strong>: base64 并不是安全加密算法,请勿在生产环境使用。 </p>
<pre><code> ```yaml
servicecomb:
credentials:
account:
name: cm9vdA==
password: eW91ci1wYXNzd29yZCA=
cipher: base64
```
```java
import java.util.Base64;
import org.apache.servicecomb.foundation.auth.Cipher;
import org.springframework.stereotype.Component;
/**
* Base64解码实现
*/
@Component
public class Base64Cipher implements Cipher {
@Override
public String name() {
return "base64";
}
@Override
public char[] decrypt(char[] encrypted) {
return new String(Base64.getDecoder().decode(new String(encrypted))).toCharArray();
}
}
```
</code></pre>
<h2 id="aksk">使用 AK/SK 认证</h2>
<p>华为云微服务引擎专业版的服务中心需要使用 AK/SK 认证, 使用 AK/SK 认证, 需要使用 2.1.3 及其以上的版本。
AK/SK 认证需要配置如下信息:</p>
<pre><code class="language-yaml">servciecomb:
credentials:
akskEnabled: true
accessKey: your access key
secretKey: your secrete key
akskCustomCipher: default # 加密算法, 和 RBAC 一样
project: cn-south-1 # 项目名称,根据实际情况填写
</code></pre>
<p>secreteKey 支持加密存储, 扩展方式同 RBAC 。</p>
<p>使用AK/SK 需要下面的软件包引入:</p>
<pre><code> &lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;servicestage&lt;/artifactId&gt;
&lt;/dependency&gt;
</code></pre>
<p>也可以直接依赖:</p>
<pre><code> &lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;solution-basic&lt;/artifactId&gt;
&lt;/dependency&gt;
</code></pre>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="introduction.html" class="btn btn-neutral float-left" title="注册发现说明"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="local-registry.html" class="btn btn-neutral float-right" title="本地注册发现">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span><a href="introduction.html" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="local-registry.html" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>