Google Git
Sign in
apache / servicecomb-website / 1222c4d5bba2e0b095aea09e6659fcc0da20d5e3 / . / content / references / java-chassis / zh_CN / config / general-config.html
blob: f9f97599b09adb6a4347c3a754cd3664486aa77e [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 = "\u901a\u7528\u914d\u7f6e\u8bf4\u660e";
var mkdocs_page_input_path = "config/general-config.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>
<li class="toctree-l1"><a class="reference internal" href="../registry/introduction.html">注册发现说明</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../registry/service-center.html">使用服务中心</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../registry/local-registry.html">本地注册发现</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../registry/distributed.html">去中心化注册发现</a>
</li>
</ul>
<p class="caption"><span class="caption-text">管理服务配置</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href="general-config.html">通用配置说明</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#_2">配置源层级</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#_3">配置文件</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#_4">环境变量</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#_5">配置中心（动态配置）</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#_6">进行配置项映射</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="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>应用程序一般通过配置文件、环境变量等管理配置信息。微服务架构对统一配置提出了更高的要求，很多配置信息需要在不启停服务的
情况下实现动态修改。 java-chassis 对不同的配置源进行了抽象， 开发者可以不关心配置项具体的配置源，采用统一的接口读取配置。</p>
<h2 id="_2">配置源层级</h2>
<p>ServiceComb提供了分层次的配置机制。按照优先级从高到低，分为：</p>
<ul>
<li>配置中心（动态配置）</li>
<li>Java System Property（-D参数）</li>
<li>环境变量</li>
<li>配置文件</li>
</ul>
<h3 id="_3">配置文件</h3>
<ul>
<li>microservice.yaml</li>
</ul>
<p>在使用Spring启动Java Chassis的场景下， 配置文件默认是classpath下的microservice.yaml文件。Java Chassis启动时会从classpath的各个jar包、磁盘
目录中加载microservice.yaml文件，并将这些文件合并为一份microservice.yaml配置。位于磁盘上的microservice.yaml
文件优先级高于jar包中的microservice.yaml文件。用户还可以通过在配置文件中指定<code>servicecomb-config-order</code>来指定优先级，
如果不同路径下的 microservice.yaml 包含一样的配置项，文件中 <code>servicecomb-config-order</code> 值大的配置项会覆盖值小的配置项。</p>
<blockquote>
<p>Tips：由于磁盘上的microservice.yaml文件优先级较高，我们可以在打包时在服务可执行jar包的classpath里加上<code>.</code>目录，这样就可以在服务jar包所在的目录里放置一份microservice.yaml来覆盖jar包内的配置文件。</p>
</blockquote>
<p>默认的配置文件名为microservice.yaml，但是我们可以通过设置Java System Property来增加其他的配置文件，或修改默认的配置文件名：</p>
<table>
<thead>
<tr>
<th>Java System Property变量名</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>servicecomb.configurationSource.additionalUrls</td>
<td>配置文件的列表，以<code>,</code>分隔的多个包含具体位置的完整文件名</td>
</tr>
<tr>
<td>servicecomb.configurationSource.defaultFileName</td>
<td>默认配置文件名</td>
</tr>
</tbody>
</table>
<ul>
<li>application.yaml</li>
</ul>
<p>在使用Spring Boot启动Java Chassis的场景下，可以使用Spring Boot提供的配置机制。通常会通过application.yaml等文件定义配置。在Spring Boot
场景下，microservice.yaml的配置依然有效，优先级比application.yaml低。</p>
<h3 id="_4">环境变量</h3>
<p>Linux的环境变量名不允许带<code>.</code>符号，因此某些配置项无法直接配置在环境变量里。可以将配置项key的<code>.</code>符号改为下划线<code>_</code>，将转换后的配置项配在环境变量里，ServiceComb-Java-Chassis可以自动将环境变量匹配到原配置项上。</p>
<p>例如：对于microservice.yaml中配置的</p>
<pre><code class="language-yaml">servicecomb:
rest:
address: 0.0.0.0:8080
</code></pre>
<p>可以在环境变量中设置<code>servicecomb_rest_address=0.0.0.0:9090</code>来将服务监听的端口覆写为9090。这种下划线转点号的机制也适用于其他的配置层级。</p>
<h3 id="_5">配置中心（动态配置）</h3>
<p>配置中心是微服务架构下一个非常重要的中间件，通过配置中心用户可以增加和删除配置信息，配置信息会通过不同的通知机制（通常包括
PULL 和 PUSH）， 将配置的变化推送到微服务实例。 java-chassis 允许用户使用不同的配置中心， 目前支持用户使用如下几种配置中心：</p>
<ul>
<li>华为云配置中心</li>
</ul>
<p>华为云配置中心是华为云CSE产品的一个部件，java-chassis 最早使用它作为配置中心。 对接这个配置中心的代码在 config-cc 模块实现。
可以从<a href="https://cse-bucket.obs.myhwclouds.com/LocalCSE/Local-CSE-1.0.3.zip">轻量化微服务引擎</a>下载本地使用的版本。也可以
直接访问华为云 <a href="https://console.huaweicloud.com/servicestage">ServiceStage</a> 产品，使用在线的版本。</p>
<p>使用华为云配置中心，需要在项目中引入如下依赖：</p>
<pre><code class="language-xml">&lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;config-cc&lt;/artifactId&gt;
&lt;/dependency&gt;
</code></pre>
<p>然后在配置文件 microservice.yaml 中增加如下配置项：</p>
<pre><code class="language-yaml">servicecomb:
config:
client:
serverUri: http://127.0.0.1:30113
refreshMode: 0
refresh_interval: 5000
refreshPort: 30114
</code></pre>
<p>华为云配置中心的其他配置项含义如下：</p>
<table>
<thead>
<tr>
<th>配置项名</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>servicecomb.config.client.refreshMode</td>
<td>应用配置的刷新方式，<code>0</code>为config-center主动push，<code>1</code>为client周期pull，默认为<code>0</code></td>
</tr>
<tr>
<td>servicecomb.config.client.refreshPort</td>
<td>config-center推送配置的端口</td>
</tr>
<tr>
<td>servicecomb.config.client.tenantName</td>
<td>应用的租户名称</td>
</tr>
<tr>
<td>servicecomb.config.client.serverUri</td>
<td>config-center访问地址，格式为<code>http(s)://{ip}:{port}</code>，以<code>,</code>分隔多个地址</td>
</tr>
<tr>
<td>servicecomb.config.client.refresh_interval</td>
<td>pull模式下刷新配置项的时间间隔，单位为毫秒，默认值为15000</td>
</tr>
<tr>
<td>servicecomb.config.client.fileSource</td>
<td>指定该配置项的内容为yaml文件，多个配置文件可以用<code>,</code>分隔</td>
</tr>
</tbody>
</table>
<ul>
<li>使用 servicecomb-kie</li>
</ul>
<p><a href="https://github.com/apache/servicecomb-kie">servicecomb-kie</a> 是全新设计的配置中心。 从 2.0.0 版本开始， java-chassis 支持使用 servicecomb-kie。
servicecomb-kie 的安装指导可以参考官网文档。 在 java-chassis 中使用 servicecomb-kie， 需要引入下面的依赖：</p>
<pre><code class="language-xml">&lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;config-kie&lt;/artifactId&gt;
&lt;/dependency&gt;
</code></pre>
<p>然后在配置文件 microservice.yaml 中增加如下配置项：</p>
<pre><code class="language-yaml">servicecomb:
kie:
serverUri: http://127.0.0.1:30110
refresh_interval: 5000
firstRefreshInterval: 5000
enableLongPolling: true
domainName: default
</code></pre>
<p>servicecomb-kie 的配置项及其含义如下：</p>
<table>
<thead>
<tr>
<th>配置项名</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>servicecomb.kie.domainName</td>
<td>区域名称，默认为default</td>
</tr>
<tr>
<td>servicecomb.kie.serverUri</td>
<td>servicecomb-kie访问地址，格式为<code>http(s)://{ip}:{port}</code>，以<code>,</code>分隔多个地址</td>
</tr>
<tr>
<td>servicecomb.kie.refresh_interval</td>
<td>interval pull模式下刷新配置项的时间间隔，单位为毫秒，默认值为15000</td>
</tr>
<tr>
<td>servicecomb.kie.firstRefreshInterval</td>
<td>interval pull模式下启动过程中首次刷新时间间隔，单位为毫秒，默认值为3000</td>
</tr>
<tr>
<td>servicecomb.kie.enableLongPolling</td>
<td>long pulling模式是否开启，默认值为true</td>
</tr>
</tbody>
</table>
<p><strong><em>说明：</em></strong> kie 的 yaml 和 properties 类型会映射为多个配置项， 其他类型，比如 json, text，
只会映射为一个配置项。开发者需要读取配置项自己解析内容。 </p>
<ul>
<li>使用 nacos</li>
</ul>
<p><a href="https://github.com/alibaba/nacos">nacos</a> 是 alibaba 提供的配置中心。 java-chassis 从 2.1.0 版本支持 nacos。
nacos的下载安装请参考官网介绍。 </p>
<p>使用nacos，需要在项目中引入如下依赖：</p>
<pre><code class="language-xml">&lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;config-nacos&lt;/artifactId&gt;
&lt;/dependency&gt;
</code></pre>
<p>然后在配置文件 microservice.yaml 中增加如下配置项：</p>
<pre><code class="language-yaml">servicecomb:
nacos:
serverAddr: http://127.0.0.1:8848
group: jaxrstest
dataId: jaxrsclient
namespace: public
# contentType 可以为 properties, yaml, raw.
# raw： 只增加一个配置项 [group].[dataId]=value. nacos 的 JSON/TEXT/HTML等都对应这种类型
# properties： 增加多个配置项。 配置项前缀为 [group].[dataId]
# yaml： 增加多个配置项。 配置项前缀为 [group].[dataId]
contentType: properties
# if true [group].[dataId] will added as properties/yaml
# items prefix. Will not influence raw.
addPrefix: true
</code></pre>
<ul>
<li>使用 Apollo</li>
</ul>
<p><a href="https://github.com/ctripcorp/apollo">Apollo</a> 是携程框架部门研发的分布式配置中心。 Apollo的下载安装请参考官网介绍。 </p>
<pre><code class="language-xml">&lt;dependency&gt;
&lt;groupId&gt;org.apache.servicecomb&lt;/groupId&gt;
&lt;artifactId&gt;config-apollo&lt;/artifactId&gt;
&lt;/dependency&gt;
</code></pre>
<p>然后在配置文件 microservice.yaml 中增加如下配置项：</p>
<pre><code class="language-yaml">apollo:
config:
serverUri: http://127.0.0.1:8070
serviceName: apollo-test
env: DEV
clusters: test-cluster
namespace: application
token: xxx
refreshInterval: 30
firstRefreshInterval: 0
</code></pre>
<h2 id="_6">进行配置项映射</h2>
<p>配置项映射可以用于给配置项取一个别名，在使用环境变量覆盖业务配置、兼容性场景广泛使用。
进行配置项映射通过classpath下的mapping.yaml定义：</p>
<pre><code class="language-yaml">PAAS_CSE_SC_ENDPOINT:
- servicecomb.service.registry.address
</code></pre>
<p>假设<code>PAAS_CSE_SC_ENDPOINT</code>是环境变量，应用程序读取<code>servicecomb.service.registry.address</code>的地方，
会取到环境变量<code>PAAS_CSE_SC_ENDPOINT</code>的值。</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../registry/distributed.html" class="btn btn-neutral float-left" title="去中心化注册发现"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="read-config.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="../registry/distributed.html" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="read-config.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>