| <!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 = "\u5fae\u670d\u52a1\u5b9a\u4e49"; |
| var mkdocs_page_input_path = "build-provider/definition/service-definition.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 class="current"> |
| <li class="toctree-l1 current"><a class="reference internal current" href="service-definition.html">微服务定义</a> |
| <ul class="current"> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../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> |
| <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 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 微服务定义包括两个基础模型 <code>Microservice</code> 和 <code>MicroserviceInstance</code>。 这些信息定义了 |
| 微服务标识，从属于哪个应用，以及名字和版本。</p> |
| <ul> |
| <li>微服务信息</li> |
| </ul> |
| <p>servicecomb 的微服务信息在类 <code>Microservice</code> 中定义。 它主要包含应用 ID (appId)， 微服务名称 (serviceName), |
| 微服务版本(version)，环境(environment) 等信息。 </p> |
| <ul> |
| <li>实例信息</li> |
| </ul> |
| <p>servicecomb 的实例信息在类 <code>MicroserviceInstance</code> 中定义。 它主要包含网络地址(endpoints) 信息。</p> |
| <p>微服务的定义会用于微服务管理、微服务的发现、治理等多种场景。专题文章<a href="../../general-development/multienvironment.html">微服务实例间多环境隔离</a>介绍 |
| 了微服务定义的一些常见应用场景。</p> |
| <h1 id="_2">场景描述</h1> |
| <p>开发一个微服务，需要在 <code>microservice.yaml</code> 文件中配置微服务的基本信息。 如果使用 spring boot，也可以在 |
| <code>application.yml</code> 文件中配置微服务的基本信息。 <code>microservice.yaml</code> 文件在项目中的存放路径为 <code>src\main\resources\microservice.yaml</code>。 |
| 微服务信息和实例信息属于基础元数据信息， 只能够在配置文件指定，无法通过配置中心指定。</p> |
| <p><strong><em>表1-1 微服务信息配置项说明</em></strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th align="left">配置项</th> |
| <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.application</td> |
| <td align="left">2.1.2</td> |
| <td align="left">default</td> |
| <td align="left">是</td> |
| <td align="left">应用名</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.service.name</td> |
| <td align="left">2.1.2</td> |
| <td align="left">defaultMicroservice</td> |
| <td align="left">是</td> |
| <td align="left">微服务名, 应确保应用内部唯一。微服务名支持数字、大小写字母和"-"、"_"、"."三个特殊字符，但是不能以特殊字符作为首尾字符，命名规范为：^[a-zA-Z0-9]+$|^[a-zA-Z0-9][a-zA-Z0-9_-.]*[a-zA-Z0-9]$。</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.service.version</td> |
| <td align="left">2.1.2</td> |
| <td align="left">1.0.0.0</td> |
| <td align="left">是</td> |
| <td align="left">微服务版本号</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.service.role</td> |
| <td align="left">2.1.2</td> |
| <td align="left">FRONT</td> |
| <td align="left">否</td> |
| <td align="left">服务类型</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.service.description</td> |
| <td align="left">2.1.2</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">微服务描述</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.service.environment</td> |
| <td align="left">2.1.2</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">运行环境，比如 development, production 等</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.service.propertyExtendedClass</td> |
| <td align="left">2.1.2</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">微服务元数据配置扩展信息， 接口返回的配置会覆盖配置文件中key相同的配置。</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.service.properties</td> |
| <td align="left">2.1.2</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">服务实例元数据配置（通过microservice.yaml文件进行配置）</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.service.paths</td> |
| <td align="left">2.1.2</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">URL 前缀列表</td> |
| </tr> |
| <tr> |
| <td align="left">APPLICATION_ID</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">default</td> |
| <td align="left">是</td> |
| <td align="left">应用名</td> |
| </tr> |
| <tr> |
| <td align="left">service_description.name</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">defaultMicroservice</td> |
| <td align="left">是</td> |
| <td align="left">微服务名, 应确保应用内部唯一。微服务名支持数字、大小写字母和"-"、"_"、"."三个特殊字符，但是不能以特殊字符作为首尾字符，命名规范为：^[a-zA-Z0-9]+$|^[a-zA-Z0-9][a-zA-Z0-9_-.]*[a-zA-Z0-9]$。</td> |
| </tr> |
| <tr> |
| <td align="left">service_description.version</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">1.0.0.0</td> |
| <td align="left">是</td> |
| <td align="left">微服务版本号</td> |
| </tr> |
| <tr> |
| <td align="left">service_description.role</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">FRONT</td> |
| <td align="left">否</td> |
| <td align="left">服务类型</td> |
| </tr> |
| <tr> |
| <td align="left">service_description.description</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">微服务描述</td> |
| </tr> |
| <tr> |
| <td align="left">service_description.environment</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">运行环境，比如 development, production 等</td> |
| </tr> |
| <tr> |
| <td align="left">service_description.propertyExtendedClass</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">微服务元数据配置扩展信息， 接口返回的配置会覆盖配置文件中key相同的配置。</td> |
| </tr> |
| <tr> |
| <td align="left">service_description.properties</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">服务元数据配置</td> |
| </tr> |
| <tr> |
| <td align="left">service_description.paths</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">URL 前缀列表</td> |
| </tr> |
| </tbody> |
| </table> |
| <blockquote> |
| <p>说明：</p> |
| <ul> |
| <li>服务的元数据会随服务一同注册到服务中心，如需修改，则要连同服务version一起变更。若想保持服务version不变，则需要通过服务管理中心统一变更元数据。</li> |
| <li>虽然微服务名、契约名中可以使用"."字符，但是不推荐在命名中使用"."。这是由于ServiceComb使用的配置文件是yaml格式的，"."符号用于分割配置项名称， |
| 如果微服务名、契约名中也包含了"."可能会导致一些支持微服务、契约级别的配置无法正确被识别。</li> |
| </ul> |
| </blockquote> |
| <p><strong><em>表1-2 微服务实例信息配置项说明</em></strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th align="left">配置项</th> |
| <th align="left">版本</th> |
| <th align="left">默认值</th> |
| <th align="left">是否必选</th> |
| <th align="left">含义</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td align="left">servicecomb.instance.properties</td> |
| <td align="left">2.1.2</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">服务实例元数据配置</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.instance.propertyExtendedClass</td> |
| <td align="left">2.1.2</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">微服务实例元数据配置扩展信息， 接口返回的配置会覆盖配置文件中key相同的配置。</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.instance.initialStatus</td> |
| <td align="left">2.1.2</td> |
| <td align="left">UP</td> |
| <td align="left">否</td> |
| <td align="left">实例初始状态</td> |
| </tr> |
| <tr> |
| <td align="left">servicecomb.instance.properties.tags</td> |
| <td align="left">2.1.2</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">标签</td> |
| </tr> |
| <tr> |
| <td align="left">instance_description.properties</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">服务实例云数据配置</td> |
| </tr> |
| <tr> |
| <td align="left">instance_description.propertyExtendedClass</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">微服务实例元数据配置扩展信息， 接口返回的配置会覆盖配置文件中key相同的配置。</td> |
| </tr> |
| <tr> |
| <td align="left">instance_description.initialStatus</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">UP</td> |
| <td align="left">否</td> |
| <td align="left">实例初始状态</td> |
| </tr> |
| <tr> |
| <td align="left">instance_description.properties.tags</td> |
| <td align="left">2.1.2之前</td> |
| <td align="left">-</td> |
| <td align="left">否</td> |
| <td align="left">标签</td> |
| </tr> |
| </tbody> |
| </table> |
| <p>下面是一个配置示例：</p> |
| <pre><code class="language-yaml">servicecomb: |
| service: |
| application: helloTest # 应用名 |
| name: helloServer # 微服务名称 |
| version: 0.0.1 # 服务版本号 |
| properties: # 元数据 |
| key1: value1 |
| key2: value2 |
| description: This is a description about the microservice # 微服务描述 |
| instance: |
| properties: #元数据 |
| key3: value3 |
| propertyExtentedClass: org.apache.servicecomb.serviceregistry.MicroServicePropertyExtendedStub |
| </code></pre> |
| |
| </div> |
| </div><footer> |
| <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> |
| <a href="../../start/design.html" class="btn btn-neutral float-left" title="设计选型参考"><span class="icon icon-circle-arrow-left"></span> Previous</a> |
| <a href="../catalog.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="../../start/design.html" style="color: #fcfcfc">« Previous</a></span> |
| |
| |
| <span><a href="../catalog.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> |
