关于微服务:微服务的版本号要怎么设计

5次阅读

共计 3746 个字符，预计需要花费 10 分钟才能阅读完成。

明天咱们来聊一下微服务项目中的版本号要怎么设计。

小伙伴们平时看到的我的项目版本号，基本上都是分为了三局部 X.Y.Z，版本升级的时候版本号都会变，那么版本号怎么变，这可不是拍脑门决定的，明天咱们就一起来探讨一下这个话题。

版本号该如何管制？其实是有一个标准规范的，标准地址：

https://semver.org/lang/zh-CN/

这个标准十分敌对的提供了中文版的内容。

语义化的版本控制标准要求版本号由三局部形成：

MAJOR（X）：这个是主版本号，个别是波及到不兼容的 API 更改时，这个会变动。
MINOR（Y）：这个是次版本号，当咱们对 API 进行向后兼容的加强时，这个版本号会变动，换句话说，也就是有新增的性能时，这里会变动。
PATCH（Z）：这个是订正号，当咱们进行一些 BUG 的修复，而后要发版的时候，这里会发生变化。

语义化的版本控制标准次要做了如下一些要求：

应用语义化版本控制的软件必须（MUST）定义公共 API。该 API 能够在代码中被定义或呈现于谨严的文档内。无论何种模式都应该力求准确且残缺。
规范的版本号必须（MUST）采纳 X.Y.Z 的格局，其中 X、Y 和 Z 为非负的整数，且禁止（MUST NOT）在数字后方补零。X 是主版本号、Y 是次版本号、而 Z 为订正号。每个元素必须（MUST）以数值来递增。例如：1.9.1 -> 1.10.0 -> 1.11.0。
标记版本号的软件发行后，禁止（MUST NOT）扭转该版本软件的内容。任何批改都必须（MUST）以新版本发行。有的小伙伴可能会说咱们的我的项目处于疾速开发阶段，API 不稳固，天天变，要是依照这个要求来得发多少个版本才够用呀！其实，个别 API 疾速变动次要有两种状况，一种是我的项目刚立项的时候，此时主版本号为 0，那么这个时候的 API 就不能算是稳固的 API；另外一种状况则是下个主版本处于疾速开发中，然而这种状况个别会有一个新的分支用来治理下个版本的代码，所以和这里的要求实际上并不抵触（具体参见第 4、5 条）。
主版本号为零（0.y.z）的软件处于开发初始阶段，所有都可能随时被扭转。这样的公共 API 不应该被视为稳定版。
1.0.0 的版本号用于界定公共 API 的造成。这一版本之后所有的版本号更新都基于公共 API 及其批改内容。那么有的小伙伴可能会纠结什么时候版本号从 0.Y.Z 变为 1.Y.Z 呢？一般来说，当你的我的项目曾经上了生产环境或者说有稳固的 API 提供给他人应用的时候，基本上就能够算是 1.Y.Z 了。
订正号 Z（x.y.Z | x > 0）必须（MUST）在只做了向下兼容的修改时才递增。这里的修改指的是针对不正确后果而进行的外部批改。
次版本号 Y（x.Y.z | x > 0）必须（MUST）在有向下兼容的新性能呈现时递增。在任何公共 API 的性能被标记为弃用时也必须（MUST）递增。也能够（MAY）在外部程序有大量新性能或改良被退出时递增，其中能够（MAY）包含订正级别的扭转。每当次版本号递增时，订正号必须（MUST）归零。
主版本号 X（X.y.z | X > 0）必须（MUST）在有任何不兼容的批改被退出公共 API 时递增。其中能够（MAY）包含次版本号及订正级别的扭转。每当主版本号递增时，次版本号和订正号必须（MUST）归零。
后行版本号能够（MAY）被标注在修订版之后，先加上一个连接号再加上一连串以句点分隔的标识符来润饰。标识符必须（MUST）由 ASCII 字母数字和连接号 [0-9A-Za-z-] 组成，且禁止（MUST NOT）留白。数字型的标识符禁止（MUST NOT）在后方补零。后行版的优先级低于相关联的规范版本。被标上后行版本号则示意这个版本并非稳固而且可能无奈满足预期的兼容性需要。范例：1.0.0-alpha、1.0.0-alpha.1、1.0.0-0.3.7、1.0.0-x.7.z.92。
版本编译信息能够（MAY）被标注在修订版或后行版本号之后，先加上一个加号再加上一连串以句点分隔的标识符来润饰。标识符必须（MUST）由 ASCII 字母数字和连接号 [0-9A-Za-z-] 组成，且禁止（MUST NOT）留白。当判断版本的优先层级时，版本编译信息可（SHOULD）被疏忽。因而当两个版本只有在版本编译信息有差异时，属于雷同的优先层级。范例：1.0.0-alpha+001、1.0.0+20130313144700、1.0.0-beta+exp.sha.5114f85。
版本的优先层级指的是不同版本在排序时如何比拟。
1. 判断优先层级时，必须（MUST）把版本依序拆分为主版本号、次版本号、订正号及后行版本号后进行比拟（版本编译信息不在这份比拟的列表中）。
2. 由左到右依序比拟每个标识符，第一个差别值用来决定优先层级：主版本号、次版本号及订正号以数值比拟。例如：1.0.0 < 2.0.0 < 2.1.0 < 2.1.1。
3. 当主版本号、次版本号及订正号都雷同时，改以优先层级比拟低的后行版本号决定。例如：1.0.0-alpha < 1.0.0。
4. 有雷同主版本号、次版本号及订正号的两个后行版本号，其优先层级必须（MUST）透过由左到右的每个被句点分隔的标识符来比拟，直到找到一个差别值后决定：
  1. 只有数字的标识符以数值高下比拟。
  2. 有字母或连接号时则逐字以 ASCII 的排序来比拟。
  3. 数字的标识符比非数字的标识符优先层级低。
  4. 若结尾的标识符都雷同时，栏位比拟多的后行版本号优先层级比拟高。
    例如：1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-alpha.beta < 1.0.0-beta < 1.0.0-beta.2 < 1.0.0-beta.11 < 1.0.0-rc.1 < 1.0.0。

那么在微服务中，咱们的版本号该怎么设计呢？

首先，整体上的思路，就是依照上文所说的语义化版本控制标准来。

其次，下面尽管给出了很多条条框框，然而咱们理论开发中，个别只须要从以下几个方面简略思考即可，每次发版的时候都去翻这个标准显然也不事实：

现实状况下，咱们应该只进行向后兼容的更新。

咱们要为我的项目增加新性能、新个性，咱们必须要思考到我的项目的兼容性。例如接口中新加了一个参数，那么为了老版本的客户端可能顺利拜访这个接口，服务端应该思考为老版本客户端短少的申请参数提供一个默认值。咱们也可能为响应增加新的属性，或者提供了一些新的接口，当然这些个别都不影响老客户端。

必须进行不兼容的降级。

有时候咱们必须进行一些不兼容的降级，对 API 做一些次要的批改，思考到微服务之间的松耦合性，咱们没法强制客户端进行立马降级，此时可能会思考在某一个时间段内，两个版本的 API 共存。

多个 API 共存的时候，一个比较简单的方法是在 API 设计的时候，加上版本号，例如 /v1/xxx 或者 /v2/xxx，不过这种写法有一个小小的缺点，就是门路中加了版本号之后，这个门路看起来就不是一个完满的 REST 门路了。

所以这块还有一个计划，就是把申请的 API 的版本号写到申请头中。

具体的实现思路是这样：

首先，在微服务中，咱们所有的申请一般来说都会通过网关，咱们能够在网关中提取出申请头的 Accept 参数，而后依据 Accept 中的申请版本号，做不同的申请转发，如果版本号是 1.0，就转发到 1.0 的服务下来；如果版本号是 2.0，则转发到 2.0 的服务下来。基本上就是这个样子。

以当初微服务中支流的网关 Spring Cloud Gateway 为例，咱们能够做如下配置：

spring:
  application:
    name: gateway
  cloud:
    nacos:
      discovery:
        password: nacos
        username: nacos
        server-addr: a.b.c.d:8848
        namespace: public
    gateway:
      discovery:
        locator:
#          enabled: true
          lower-case-service-id: true
      routes:
        - id: v1_provider
          uri: lb://provider
          predicates:
            - Path=/p/**
            - Header=Accept,.*;?version=1\.0(|;.*)
          filters:
            - StripPrefix=1
server:
  port: 8082

大家看一下这个配置：

首先记得敞开服务主动发现，否则通过默认的服务名进行代理就不会通过咱们配置的过滤器了。
而后咱们手动配置服务转发，下面的配置基本上都是惯例配置，跟版本号相干的配置是 Header=Accept,.*;?version=1\.0(|;.*)，这个配置就是对申请头提出要求，首先后面的 Accept 示意这里是要判断申请头中的 Accept 字段，而后前面紧跟着的是 value（两者之间用 , 隔开），这个 value 是一个正则表达式 .*;?version=1\.0(|;.*)，意思就是在 version=1.0 之前和之后能够有任意字符串，只有 value 中蕴含 version=1.0 就算匹配上了。只有匹配上了，才会进行申请转发，否则不会进行申请转发。
最初，咱们在发送申请的时候，设置如下申请头即可：
如果版本号是 version=2.0，则会报一个 404 谬误：

好啦，一个小小的版本号话题，感兴趣的小伙伴能够试试最初这段代码哦～

正文完