| <!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 = "\u672c\u5730\u6ce8\u518c\u53d1\u73b0"; |
| var mkdocs_page_input_path = "registry/local-registry.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"><a class="reference internal" href="service-center.html">使用服务中心</a> |
| </li> |
| <li class="toctree-l1 current"><a class="reference internal current" href="local-registry.html">本地注册发现</a> |
| <ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="#_2">注册过程</a> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#_3">发现过程</a> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#-">本地注册发现的应用 - 调用第三方服务</a> |
| </li> |
| </ul> |
| </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> »</li> |
| <li>多样化的服务注册与发现功能参考 »</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>本地注册发现是一种静态的服务发现机制。使用本地注册发现，需要在项目中引入如下依赖：</p> |
| <pre><code class="language-xml"> <dependency> |
| <groupId>org.apache.servicecomb</groupId> |
| <artifactId>registry-local</artifactId> |
| </dependency> |
| </code></pre> |
| <p>本地服务发现可以在很多不同的场景使用，能够帮助开发者解决很多系统集成问题，比如和网关的集成，和第三方服务的集成。</p> |
| <h2 id="_2">注册过程</h2> |
| <p>和使用服务中心一样， 系统会自动完成注册。系统会从配置文件中读取本微服务的信息和实例信息，以及本微服务发布的 |
| 契约信息，将信息注册到内存中。</p> |
| <h2 id="_3">发现过程</h2> |
| <p>发现过程也是从本地进行查找。因此系统需要配置本地的微服务信息和实例信息，以及契约信息。 提供了下面两种方式：</p> |
| <ul> |
| <li>使用配置文件的方式定义服务</li> |
| </ul> |
| <p>这种方式从配置文件(registry.yaml)中读取服务的 <code>Microservice</code> 和 |
| <code>MicroserviceInstance</code> 信息，从目录 <code>microservices/{serviceName}/{schemaId}.yaml</code> 或者 |
| <code>applications/{appId}/{serviceName}/{schemaId}.yaml</code> 读取微服务的契约 |
| 信息。</p> |
| <p>registry.yaml 格式：</p> |
| <pre><code> ```yaml |
| ms1: |
| - id: "001" |
| version: "1.0" |
| appid: exampleApp |
| environment: development |
| schemaIds: |
| - hello |
| instances: |
| - endpoints: |
| - rest://127.0.0.1:8080 |
| - id: "002" |
| version: "2.0" |
| environment: development |
| appid: exampleApp |
| schemaIds: |
| - hello |
| instances: |
| - endpoints: |
| - rest://127.0.0.2:8080 |
| ms2: |
| - id: "003" |
| version: "1.0" |
| environment: development |
| appid: exampleApp |
| schemaIds: |
| - hello |
| instances: |
| - endpoints: |
| - rest://127.0.0.1:8081 |
| ``` |
| </code></pre> |
| <p><code>registry.yaml</code> 指定了微服务的基本信息：应用ID (appId)， 微服务名称 (serviceName), |
| 微服务版本(version)，环境(environment) 和契约；微服务实例基本信息：网络地址(endpoints)。</p> |
| <ul> |
| <li>使用 <code>bean</code> 的方式定义服务<pre><code>```java |
| @Bean |
| public RegistryBean demoLocalRegistryServerBean2() { |
| List<String> endpoints = new ArrayList<>(); |
| endpoints.add("rest://localhost:8080"); |
| List<Instance> instances = new ArrayList<>(); |
| instances.add(new Instance().setEndpoints(endpoints)); |
| |
| return new RegistryBean() |
| .setServiceName("demo-local-registry-server-bean2") |
| .setId("003") |
| .setVersion("0.0.3") |
| .setAppId("demo-local-registry") |
| .addSchemaInterface("CodeFirstEndpoint2", CodeFirstService.class) |
| .setInstances(new Instances().setInstances(instances)); |
| } |
| ``` |
| </code></pre> |
| </li> |
| </ul> |
| <p><code>RegistryBean</code> 的信息和 <code>registry.yaml</code> 的信息类似， 可以添加 <code>Schema Interface</code> 来添加 |
| 契约信息， 如果没有添加契约信息，这种方式也会从本地配置文件查找契约。 CodeFirstService 是一个接口， |
| 和普通的 provider 接口定义类似：</p> |
| <pre><code> @Path("/register/url/codeFirst") |
| @Produces("application/json") |
| public interface CodeFirstService { |
| @GET |
| @Path("getName") |
| String getName(@QueryParam("name") String name); |
| } |
| </code></pre> |
| <h2 id="-">本地注册发现的应用 - 调用第三方服务</h2> |
| <p>可以有非常多的方式调用第三方服务，比如采用第三方提供的 Rest Client。 但是需要提供一种 |
| 透明的方式，让调用第三方服务的客户端代码和调用 servicecomb 微服务的 |
| 客户端代码风格完全一样，并且拥有所有 servicecomb 的客户端治理能力。</p> |
| <p>在<a href="../build-consumer/3rd-party-service-invoke.html">调用第三方服务</a>里面介绍了servicecomb提供的一种 |
| 调用第三方服务的使用方式，这种方式依赖于使用服务中心作为注册发现。 可以看出使用本地服务发现能够非常方便的调用第三方服务。</p> |
| <p>只需要在原来的项目中引入本地注册发现，按照上述两种方式之一定义第三方服务的信息。 定义完成后，可以像访问 servicecomb |
| 服务一样访问第三方服务，不用关心第三方服务是采用什么框架开发的。 下面代码片段来源于 demo， |
| 演示了通过 java chassis 的方式调用服务中心接口。</p> |
| <pre><code class="language-java">public interface IServiceCenterEndpoint { |
| // java name can not be `x-domain-name`, so interfaces define all parameters. |
| @GetMapping(path = "/instances") |
| Object getInstances(@RequestParam(name = "appId") String appId, |
| @RequestParam(name = "serviceName") String serviceName, |
| @RequestParam(name = "global") String global, |
| @RequestParam(name = "version") String version, |
| @RequestHeader(name = "x-domain-name") String domain); |
| } |
| |
| @Component |
| public class ServiceCenterTestCase implements CategorizedTestCase { |
| @RpcReference(microserviceName = "thirdParty-service-center", schemaId = "ServiceCenterEndpoint") |
| IServiceCenterEndpoint serviceCenterEndpoint; |
| |
| @Override |
| public void testRestTransport() throws Exception { |
| // invoke service-center(3rd-parties) |
| @SuppressWarnings("unchecked") |
| Map<String, List<?>> result = (Map<String, List<?>>) serviceCenterEndpoint.getInstances( |
| "demo-multi-registries", |
| "demo-multi-registries-server", |
| "true", |
| "0.0.2", |
| "default"); |
| TestMgr.check(result.get("instances").size(), 1); |
| } |
| } |
| </code></pre> |
| |
| </div> |
| </div><footer> |
| <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> |
| <a href="service-center.html" class="btn btn-neutral float-left" title="使用服务中心"><span class="icon icon-circle-arrow-left"></span> Previous</a> |
| <a href="distributed.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="service-center.html" style="color: #fcfcfc">« Previous</a></span> |
| |
| |
| <span><a href="distributed.html" style="color: #fcfcfc">Next »</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> |
