基于华为云CSE微服务接口兼容常见问题

微服务接口兼容常见问题

在进行微服务持续迭代开发的过程中，由于新特性在不停的加入，一些过时的特性在不停的修改，接口兼容问题面临巨大的挑战，特别是在运行环境多版本共存（灰度发布）的情况下。本章节主要描述接口兼容管理的一些实践建议，以及在使用CSE过程中碰到了兼容性问题的解决办法。由于微服务一般都通过REST接口对外提供服务，没有特殊说明的情况下，这里的接口都指REST接口。

保证接口兼容的实践

为了防止接口兼容问题，开发者在进行接口变更（新增、修改、删除等）的时候，建议遵循下面的一些原则。

1. 只增加接口，不修改、不删除接口。
2. 作为Provider，增加接口的时候，相应的将微服务版本号递增。比如将2.1.2修改为2.1.3。版本号按照规范使用x.y.z的格式，只包含数字便于管理，建议每位数字不大于125。
3. 作为Consumer，使用Provider的新接口时候，指定Provider的最小版本号。比如：cse.references.[serviceName].version-rule=2.1.3+，其中serviceName为Provider的微服务名称。
4. 在服务中心，定期清理不再使用的老版本的微服务信息。

ServiceComb还有如下一些注意事项：

1. 修改微服务信息，必须升级版本号，因为服务注册的时候，不会覆盖已经注册的微服务信息。

接口兼容常见问题及其解决办法

• 开发阶段，由于存在频繁的接口修改，又不想频繁修改版本号，容易本地和服务中心契约不一致，且契约未被允许更新到服务中心，导致调试的时候接口调用失败的情况。

推荐使用CSE提供了微服务按environment区分、隔离的能力(当前支持development和production)，允许处于development环境的微服务在不升级版本的情况下，仅需重启服务即可重新注册契约到服务中心。

所有微服务在microservice.yaml中增如下配置，且需要在Provider启动后，再重启Consumer(若请求走edge，需要重启edge服务)：

service_description:
  name: xxx-service
  version: 0.0.1
  environment: development

• 开发阶段，由于存在频繁的接口修改，也不会清理服务中心的数据，容易出现调试的时候接口调用失败的情况。

推荐使用华为公有云在线的服务中心，可以直接登录使用微服务引擎提供的微服务管理功能删除微服务或微服务实例。

微服务引擎也提供了本地轻量化服务中心，将服务停止后即可清理服务中心数据。服务中心及其frontend代码已开源，项目地址。

• 发布阶段，需要审视下接口兼容的实践的步骤，确保不在线上引入接口兼容问题。如果不小心漏了其中的某个步骤，则可能导致如下一些接口兼容问题：

• [ ] 如果修改、删除接口：导致一些老的Consumer将请求路由到新的Provider，调用失败。

解决办法：指定Provid