干货 | 以模型为中心,携程契约系统的演进
https://mp.weixin.qq.com/s/4suazm8Z3dheq9jO9g0bjQ
模型管理,是MOM底层的核心。模型是最小的管理单元,契约的节点树是在此基础上进行嵌套搭建的。MOM维护了基础数据类型,除此之外系统允许用户定义自定义模型和枚举类。
MOM参考了Java的设计,项目以文件夹形式进行管理,模型所处的文件路径,决定了模型最终的生成位置。为了更好的进行模型描述,MOM对模型抽象出了模型名称、字段、描述、注解等相关属性,通过构建绑定关系使得共享策略得以生效。
契约系统的模型共享,主要分为项目间的共享与外部jar包内的模型共享。项目间的主要使用场景是,用户构建自定义项目维护共享模型,该模型可以被其他项目中的接口访问,来避免触发冲突规则。外部jar包引用,是通过同包下的同名模型进行相关的替换操作,系统解析maven仓库中jar包中的原始文件, 提取类型的节点树信息,替换项目中的模型。
MOM参考了Java的设计,项目以文件夹形式进行管理,模型所处的文件路径,决定了模型最终的生成位置。为了更好的进行模型描述,MOM对模型抽象出了模型名称、字段、描述、注解等相关属性,通过构建绑定关系使得共享策略得以生效。
契约系统的模型共享,主要分为项目间的共享与外部jar包内的模型共享。项目间的主要使用场景是,用户构建自定义项目维护共享模型,该模型可以被其他项目中的接口访问,来避免触发冲突规则。外部jar包引用,是通过同包下的同名模型进行相关的替换操作,系统解析maven仓库中jar包中的原始文件, 提取类型的节点树信息,替换项目中的模型。
4.5 契约生成
契约生成是大多数用户比较关心的地方。能否满足各用户的使用场景,对系统而言也是一个重大挑战。
契约系统独立维护了一套描述性极强的模型结构,对于不同的生成契约类型,只需要根据不同契约的生成规则,定制不同的契约模板即可。随着系统的不断迭代,目前已经支持Java、TS、GraphQL、C#、XSD、Protobuf等文件的生成。
此外,光生成契约文件对于用户来说,易用性可能还不够。MOM还支持将生成好的契约,直接发布到代码仓库。目前,MOM已支持直接将契约部署到maven和NPM(Node Package Manager)仓库,只需简单配置仓库地址即可。至此,契约的编辑到部署,可以全在MOM的操作界面上完成,这极大的提高了开发效率。