blob: 3af0ffef1e011b9d165ebc8ac819154487114d01 [file] [log] [blame]
<!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 ServiceComb</title>
<meta name="description" content="动态配置">
<meta name="author" content="">
<meta property="og:locale" content="cn">
<meta property="og:site_name" content="Apache ServiceComb">
<meta property="og:title" content="动态配置">
<link rel="canonical" href="https://github.com/pages/apache/incubator-servicecomb-website/cn/docs/users/dynamic-config/">
<meta property="og:url" content="https://github.com/pages/apache/incubator-servicecomb-website/cn/docs/users/dynamic-config/">
<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 ServiceComb",
"url" : "https://github.com/pages/apache/incubator-servicecomb-website",
"sameAs" : null
}
</script>
<meta name="google-site-verification" content="HvJjNd7vvJ-yjSTHlBiIWEYxp_Hrz-PYEY5Idz9LRcA" />
<!-- end SEO -->
<link href="/feed.xml" type="application/atom+xml" rel="alternate" title="Apache ServiceComb Feed">
<!-- http://t.co/dKP3o1e -->
<meta name="HandheldFriendly" content="True">
<meta name="MobileOptimized" content="320">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<script>
document.documentElement.className = document.documentElement.className.replace(/\bno-js\b/g, '') + ' js ';
</script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js"></script>
<script src="/assets/vendor/prism/prism.js"></script>
<script type="text/javascript" async
src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-MML-AM_CHTML">
</script>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/css/bootstrap.min.css" integrity="sha384-/Y6pD6FV/Vv2HJnA6t+vslU6fwYXjCFtcEpHbNJ0lyAFsXTsjBbfaDjzALeQsN6M" crossorigin="anonymous">
<script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.11.0/umd/popper.min.js" integrity="sha384-b/U6ypiBEHpOf/4+1nzFpr53nxSS+GLCkfwBdFNTxtclqqenISfwAzpKaMNFNmj4" crossorigin="anonymous"></script>
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta/js/bootstrap.min.js" integrity="sha384-h0AbiXch4ZDo7tp9hKZ4TsHbi047NrKGLO3SEJAg45jXxnGIfYzk4Si90RDIqNm1" crossorigin="anonymous"></script>
<!-- For all browsers -->
<link rel="stylesheet" href="/assets/css/main.css">
<link rel="stylesheet" href="/assets/vendor/prism/prism.css">
<!--[if lte IE 9]>
<style>
/* old IE unsupported flexbox fixes */
.greedy-nav .site-title {
padding-right: 3em;
}
.greedy-nav button {
position: absolute;
top: 0;
right: 0;
height: 100%;
}
</style>
<![endif]-->
<meta http-equiv="cleartype" content="on">
<!-- start custom head snippets -->
<!-- insert favicons. use http://realfavicongenerator.net/ -->
<link href="https://fonts.loli.net/css?family=Roboto:400,500,700|Source+Code+Pro" rel="stylesheet">
<script src="/assets/js/custom.js"></script>
<!-- end custom head snippets -->
</head>
<body class="layout--single">
<!--[if lt IE 9]>
<div class="notice--danger align-center" style="margin: 0;">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</div>
<![endif]-->
<div class="masthead" onmouseleave="$('#childrenShow').css('display', 'none')">
<div class="masthead__inner-wrap">
<div class="masthead__menu">
<nav id="site-nav" class="greedy-nav">
<a class="site-title active" href="/cn"><img src="https://www.apache.org/img/servicecomb.png"></a>
<ul class="visible-links">
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/cn/">首页</a>
</li>
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/cn/developers/">项目</a>
</li>
<li class="def-nav-li" onmouseenter="$('#childrenShow').css('display', 'block')">
<a class="active" href="/cn/docs/users/">文档</a>
<ul id="childrenShow" class="def-children-show-cn" onmouseleave="$('#childrenShow').css('display', 'none')">
<li><a href="/cn/docs/getting-started/" class="">入门指南</a></li>
<li><a href="/cn/docs/users/" class="">用户手册</a></li>
<li><a href="/cn/slides/" class="">大咖视频</a></li>
<li><a href="/cn/faqs/" class="">常见问题</a></li>
</ul>
</li>
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/cn/developers/contributing/">社区</a>
</li>
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/cn/year-archive/">博文</a>
</li>
<li class="masthead__menu-item" onmouseenter="$('#childrenShow').css('display', 'none')">
<a href="/cn/release/">下载</a>
</li>
</ul>
<button><div class="navicon"></div></button>
<ul class="hidden-links hidden"></ul>
<div class="nav-lang">
<a href=/docs/users/dynamic-config/>English</a>
</div>
</nav>
</div>
</div>
</div>
<div id="main" role="main">
<div class="sidebar sticky">
<div class="back-to-home"><a href="/cn/">首页</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">Java-chassis用户手册</span>
<ul>
<li><a href="/references/java-chassis/en_US/" class="">2.3.0</a></li>
</ul>
</li>
<li>
<span class="nav__sub-title">Pack用户手册</span>
<ul>
<li><a href="https://github.com/apache/servicecomb-pack/blob/master/docs/user_guide.md" class="">0.5.0(英文版)</a></li>
</ul>
</li>
<li>
<span class="nav__sub-title">ServiceCenter用户手册</span>
<ul>
<li><a href="https://service-center.readthedocs.io/en/latest/user-guides.html" class="">2.0.0(英文版)</a></li>
</ul>
</li>
<li>
<span class="nav__sub-title">Kie 用户手册</span>
<ul>
<li><a href="https://kie.readthedocs.io/en/latest/" class="">0.2.0(英文版)</a></li>
</ul>
</li>
<li>
<span class="nav__sub-title">Mesher 用户手册</span>
<ul>
<li><a href="https://mesher.readthedocs.io/en/latest/" class="">1.6.3(英文版)</a></li>
</ul>
</li>
</ul>
</nav>
</div>
<article class="page" itemscope itemtype="http://schema.org/CreativeWork">
<meta itemprop="headline" content="动态配置">
<meta itemprop="description" content="动态配置">
<meta itemprop="dateModified" content="January 11, 2018">
<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> <ul>
<li><a href="#部署并启动apollo配置中心" id="markdown-toc-部署并启动apollo配置中心">部署并启动Apollo配置中心</a></li>
<li><a href="#通过apollo界面配置应用获取token" id="markdown-toc-通过apollo界面配置应用获取token">通过Apollo界面配置应用获取TOKEN</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>
</li>
</ul>
</nav>
</aside>
<h2 id="概念阐述">概念阐述</h2>
<p>动态配置能够在服务运行期间对服务自身和服务依赖的配置信息进行热修改。传统的配重信息处理方式是将配置信息写入xml、properties等配置文件中和应用一起打包,每次修改配置信息都需要重新打包部署,效率极低,且由于微服务架构中应用数量,应用依赖的配置数量会使配置信息的维护非常困难。动态配置功能就是为了解决这个问题。通过配置中心对服务依赖的配置信息进行修改,服务端主动查询或者配置中心下发都可以达到不用重新部署服务而改变其配置信息的目的。Java Chassis目前支持对接配置中心Apollo,用户可以通过实现Java Chassis提供的扩展接口很简单的对接到其他配置中心。</p>
<h2 id="使用步骤">使用步骤:</h2>
<h3 id="部署并启动apollo配置中心">部署并启动Apollo配置中心</h3>
<p>通过镜像方式启动Apollo配置中心请参考<a href="https://github.com/ctripcorp/apollo/wiki/Apollo-Quick-Start-Docker%E9%83%A8%E7%BD%B2">官方文档</a>,或者执行下面两个指令即可:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code> git clone https://github.com/lijasonvip/apollo-image-for-servicecomb.git
<span class="nb">cd </span>apollo-image-for-servicecomb <span class="o">&amp;&amp;</span> docker-compose up
</code></pre></div></div>
<p>等待出现 <code class="language-plaintext highlighter-rouge">Portal started. You can visit http://localhost:8070 now!</code> 后表示系统启动完成(启动时间基于机器性能可能需要1-3分钟),可以在浏览器中访问<code class="language-plaintext highlighter-rouge">http://localhost:8070</code>进入配置中心页面。 <code class="language-plaintext highlighter-rouge">docker-compose</code>安装请参考<a href="https://docs.docker.com/compose/install/">文档</a></p>
<h3 id="通过apollo界面配置应用获取token">通过Apollo界面配置应用获取TOKEN</h3>
<ul>
<li>
<h5 id="登录apollo配置中心创建项目">登录Apollo配置中心创建项目</h5>
<p>在浏览器中输入登录地址,地址是容器所在主机的<code class="language-plaintext highlighter-rouge">IP:PORT</code>端口默认8070,如<code class="language-plaintext highlighter-rouge">http://192.168.199.1:8070</code></p>
<p><img src="/assets/images/config/login.png" alt="登录配置中心" /></p>
<p>Apollo配置中心的默认登录账号是apollo/admin,点击登录后会跳转到下图中的配置中心首页。</p>
</li>
<li>
<h5 id="创建项目">创建项目</h5>
<p><img src="/assets/images/config/create_project.png" alt="创建项目" /></p>
<p>首页中默认展示一个示例项目SampleApp,用户可以点击创建项目自行创建一个,下图是创建项目页面,填入应用Id和应用名称,选择所在部门和应用负责人后点击提交即可。</p>
</li>
</ul>
<p><img src="/assets/images/config/create_project2.png" alt="项目信息" /></p>
<p>​ 需要注意的是,首次创建好一个项目后要发布之后客户端才能查询到该项目信息。如下图红框中的提示,点击发布即可。</p>
<p><img src="/assets/images/config/release_namespace.png" alt="release_namespace" /></p>
<ul>
<li>
<h5 id="生成token">生成TOKEN</h5>
</li>
</ul>
<p>打开地址<code class="language-plaintext highlighter-rouge">http://192.168.199.1:8070/open/manage.html</code>进入下图页面,填入刚才创建项目使的应用名选择相应的部门和项目负责人即可生成应用对应的TOKEN,保存这个TOKEN稍后配置到项目代码中即可。</p>
<p><img src="/assets/images/config/token.png" alt="生成TOKEN" /></p>
<h3 id="在应用中添加依赖">在应用中添加依赖</h3>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="nt">&lt;dependency&gt;</span>
<span class="nt">&lt;groupId&gt;</span>org.apache.servicecomb<span class="nt">&lt;/groupId&gt;</span>
<span class="nt">&lt;artifactId&gt;</span>config-apollo<span class="nt">&lt;/artifactId&gt;</span>
<span class="nt">&lt;/dependency&gt;</span>
</code></pre></div></div>
<h3 id="添加配置项">添加配置项</h3>
<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="na">apollo</span><span class="pi">:</span>
<span class="na">config</span><span class="pi">:</span>
<span class="na">serverUri</span><span class="pi">:</span> <span class="s">http://127.0.0.1:8070</span>
<span class="na">serviceName</span><span class="pi">:</span> <span class="s">SampleApp</span>
<span class="na">env</span><span class="pi">:</span> <span class="s">DEV</span>
<span class="na">clusters</span><span class="pi">:</span> <span class="s">default</span>
<span class="na">namespace</span><span class="pi">:</span> <span class="s">application</span>
<span class="na">token</span><span class="pi">:</span> <span class="s">testtoken</span>
<span class="na">refreshInterval</span><span class="pi">:</span> <span class="m">10</span>
</code></pre></div></div>
<p><code class="language-plaintext highlighter-rouge">apollo.config</code>下的配置项是用户创建的应用参数,包括服务地址,用户名,集群,namespace,token等参数。这些参数可以在配置中心页面项目信息栏中查到。需要注意的是<code class="language-plaintext highlighter-rouge">refreshInterval: 10</code>表示应用会每隔10秒去配置中心查询一次最新的配置信息,不配置此项默认刷新周期为30秒。
 <code class="language-plaintext highlighter-rouge">serviceName</code>对应Apollo中的第三发应用ID: <code class="language-plaintext highlighter-rouge">AppId</code>.</p>
<h3 id="获取动态属性">获取动态属性</h3>
<p>​ 在配置中心中创建一个<code class="language-plaintext highlighter-rouge">timeout</code>的配置项,其值设置为<code class="language-plaintext highlighter-rouge">100</code>,并发布如下图: <img src="/assets/images/config/release_config.png" alt="动态属性timeout" /></p>
<p>​ 代码中可以使用<code class="language-plaintext highlighter-rouge">DynamicPropertyFactory.getInstance().getProperty()</code>方法来获取具体的配置项值,<code class="language-plaintext highlighter-rouge">getProperty</code>方法可以根据配置项具体的类型来灵活使用,比如<code class="language-plaintext highlighter-rouge">getIntProperty()</code>,<code class="language-plaintext highlighter-rouge">getStringProperty()</code>等。</p>
<div class="language-java highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="kd">public</span> <span class="kd">class</span> <span class="nc">XXX</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="nc">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="kd">throws</span> <span class="nc">Exception</span> <span class="o">{</span>
<span class="nc">Log4jUtils</span><span class="o">.</span><span class="na">init</span><span class="o">();</span>
<span class="nc">BeanUtils</span><span class="o">.</span><span class="na">init</span><span class="o">();</span>
<span class="k">while</span> <span class="o">(</span><span class="kc">true</span><span class="o">)</span> <span class="o">{</span>
<span class="nc">DynamicIntProperty</span> <span class="n">timeout</span> <span class="o">=</span> <span class="nc">DynamicPropertyFactory</span><span class="o">.</span><span class="na">getInstance</span><span class="o">().</span>
<span class="n">getIntProperty</span><span class="o">(</span><span class="s">"timeout"</span><span class="o">,</span> <span class="o">-</span><span class="mi">1</span><span class="o">);</span>
<span class="nc">System</span><span class="o">.</span><span class="na">out</span><span class="o">.</span><span class="na">println</span><span class="o">(</span><span class="n">timeout</span><span class="o">);</span>
<span class="nc">Thread</span><span class="o">.</span><span class="na">sleep</span><span class="o">(</span><span class="mi">3000</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
</code></pre></div></div>
<p>​ Apollo配置中心修改配置项并发布后,经过一个刷新周期后就会打印出最新的<code class="language-plaintext highlighter-rouge">timeout</code>值。</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/getting-started/">入门指南</a></li>
<li><a href="/cn/docs/users/">用户指南</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">ASF</p>
<li><a href="http://www.apache.org">基金会</a></li>
<li><a href="http://www.apache.org/licenses/">许可证</a></li>
<li><a href="http://www.apache.org/events/current-event">活动</a></li>
<li><a href="http://www.apache.org/foundation/sponsorship.html">赞助</a></li>
<li><a href="http://www.apache.org/foundation/thanks.html">鸣谢</a></li>
</ul>
</div>
<div class="col">
<ul>
<p class="header">贡献</p>
<li><a href="http://issues.apache.org/jira/browse/SCB">报告本网页问题</a></li>
<li><a href="https://github.com/apache/servicecomb-website/edit/master/_users/cn/dynamic-config.md">在Github上编辑此页</a></li>
<li><a href="/cn/developers/submit-codes/">代码提交指南</a></li>
<li><a href="/cn/security">安全</a></li>
</ul>
</div>
<div class="col">
<ul class="social-icons">
<p class="header">社区</p>
<li>
<a href="mailto:dev-subscribe@servicecomb.incubator.apache.org" rel="nofollow"><span class="mail">邮件列表</span></a>
</li>
<li>
<a href="https://github.com/apache?q=ServiceComb" target="_blank"><span class="github">Github</span></a>
</li>
<li>
<a href="https://twitter.com/ServiceComb" target="_blank"><span class="twitter">Twitter</span></a>
</li>
<li>
<a href="/feed.xml" target="_blank"><span class="rss">Feed</span></a>
</li>
</ul>
</div>
</div>
</div>
<div class="page__footer-bottom">
<div>&copy; 2021 Apache ServiceComb. 技术来自于 <a href="http://jekyllrb.com" rel="nofollow">Jekyll</a> &amp; <a href="https://mademistakes.com/work/minimal-mistakes-jekyll-theme/" rel="nofollow">Minimal Mistakes</a>.</div>
<div>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
</div>
</footer>
</div>
<script src="/assets/js/main.min.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-101622733-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>