概念阐述

服务定义信息是微服务的身份标识，它定义了服务从属于哪个应用，以及名字和版本。服务定义信息中也可以有扩展信息，用于定义服务的属性元数据。

场景描述

当用户定义新的微服务或修改微服务的基本信息时，会涉及到服务定义信息的创建和修改操作。

配置说明

本章节介绍涉及microservice.yaml文件的以下配置项，文件在项目中的存放路径为src\main\resources\microservice.yaml。

表1-1配置项说明

配置项默认值取值范围是否必选含义注意
APPLICATIONID--是应用名-
service_description.name--是微服务名应确保app内部唯一。微服务名支持数字、大小写字母和"-"、""、"."三个特殊字符，但是不能以特殊字符作为首尾字符，命名规范为：^[a-zA-Z0-9]+$|^[a-zA-Z0-9][a-zA-Z0-9_-.]*[a-zA-Z0-9]$。
service_description.version--是微服务版本号-
service_description.description--否微服务描述
service_description.properties--否微服务元数据配置（通过microservice.yaml文件进行配置）-
service_description.propertyExtendedClass--否微服务元数据配置（通过实现接口PropertyExtended进行配置）接口返回的配置会覆盖配置文件中key相同的配置。
instance_description.properties--否服务实例元数据配置（通过microservice.yaml文件进行配置）
instance_description.propertyExtendedClass--否微服务元数据配置（通过实现接口PropertyExtended进行配置）同service_description.propertyExtendedClass
说明：- 服务的元数据会随服务一同注册到服务中心，如需修改，则要连同服务version一起变更。若想保持服务version不变，则需要通过服务管理中心统一变更元数据。- 虽然微服务名、契约名中可以使用"."字符，但是不推荐在命名中使用"."。这是由于ServiceComb使用的配置文件是yaml格式的，"."符号用于分割配置项名称，如果微服务名、契约名中也包含了"."可能会导致一些支持微服务、契约级别的配置无法正确被识别。

示例代码

  1. APPLICATION_ID: helloTest # 应用名
  2. service_description: # 服务描述
  3.   name: helloServer # 微服务名称
  4.   version: 0.0.1 # 服务版本号
  5.   properties: # 元数据
  6.     key1: value1
  7.     key2: value2
  8.   description: This is a description about the microservice # 微服务描述
  9.   propertyExtentedClass: org.apache.servicecomb.serviceregistry.MicroServicePropertyExtendedStub
  10. instance_description: #实例描述
  11.   properties: #元数据
  12.     key3: value3
  13.   propertyExtentedClass: org.apache.servicecomb.serviceregistry.MicroServicePropertyExtendedStub