CN114416117A

CN114416117A - 一种代码模板管理方法及系统

Info

Publication number: CN114416117A
Application number: CN202210097723.2A
Authority: CN
Inventors: 王喆; 郭歌; 刘承亮; 朱韦桥
Original assignee: Institute of Computing Technologies of CARS
Current assignee: Institute of Computing Technologies of CARS
Priority date: 2022-01-27
Filing date: 2022-01-27
Publication date: 2022-04-29
Anticipated expiration: 2042-01-27
Also published as: CN114416117B

Abstract

本发明涉及代码升级技术领域，特别是涉及一种代码模板管理方法及系统，该方法包括：在第一级信息系统部署主引擎和主Git代码仓库；在多个第二级信息系统分别部署分引擎和分Git代码仓库；根据设定开发技术确定初始代码模板；将初始代码模板存储到主Git代码仓库并将初始代码模板的ID存储到代码模板列表中；代码模板列表用于存储各版本的代码模板；通过主引擎将初始代码模板发布消息发送到各分引擎；各分引擎根据接收的发布消息从主Git代码仓库获取初始代码模板，并将获取的初始代码模板保存到对应分Git代码仓库中。本发明提高了代码模板的统一性和规范性。

Description

一种代码模板管理方法及系统

技术领域

本发明涉及代码升级技术领域，特别是涉及一种代码模板管理方法及系统。

背景技术

国铁集团(中国国家铁路集团有限公司)信息系统研发体系主要包括两个层级：国铁集团本级和铁路局级。国铁集团本级研发机构主要包括铁科院和国铁集团信息中心，主要承担国铁集团统建信息系统开发工作。铁路局级研发机构主要是各铁路局信息技术所和附属软件企业，主要承担各铁路局级和站段级信息系统研发。两级研发体系之间也经常相互配合，共同参与项目研发。因此，为了提升信息系统研发的规范化，需要在两级研发体系之间共享代码模板，作为项目开发的初始代码。通过统一代码模板，可以对代码文件夹结构，变量命名、依赖引用、安全漏洞进行集中统一化，能够提升代码的合规性和安全性。

目前，由于缺乏这样的机制，无论国铁集团本级还是铁路局级研发机构，在各自组织内部管理代码模板，甚至组织内部的不同团队也采用不同的模板，导致技术升级困难，安全隐患较多等问题。

发明内容

本发明的目的是提供一种代码模板管理方法及系统，提高了代码模板的统一性和规范性。

为实现上述目的，本发明提供了如下方案：

一种代码模板管理方法，包括：

在第一级信息系统部署主引擎和主Git代码仓库；

在多个第二级信息系统分别部署分引擎和分Git代码仓库；

根据设定开发技术确定初始代码模板；

将所述初始代码模板存储到所述主Git代码仓库并将所述初始代码模板的ID存储到代码模板列表中；所述代码模板列表用于存储各版本的代码模板；

通过所述主引擎将所述初始代码模板发布消息发送到各所述分引擎；

各所述分引擎根据接收的所述发布消息从所述主Git代码仓库获取所述初始代码模板，并将获取的所述初始代码模板保存到对应分Git代码仓库中。

可选地，所述发布消息中包括所述初始代码模板的ID。

可选地，一种代码模板管理方法还包括：

通过所述主引擎更新第i版代码模板，获得更新后的第i版代码模板；

将更新后的第i版代码模板存储到所述主Git代码仓库并将更新后的第i版代码模板的ID存储到代码模板列表中；

通过所述主引擎将代码模板更新消息发送到各所述分引擎；

各所述分引擎根据接收的所述代码模板更新消息从所述主Git代码仓库获取更新后的第i版代码模板，并将获取的更新后的第i版代码模板保存到对应分Git代码仓库中。

可选地，一种代码模板管理方法还包括：

当用户从所述主Git代码仓库或各所述分Git代码仓库获取第i版代码模板时，记录第i版代码模板的使用次数；

在所述主引擎和各所述分引擎，根据各代码模板的使用次数从大到小的顺序推荐各代码模板。

可选地，所述设定开发技术包括VUE、Angular和springboot。

本发明还公开了一种代码模板管理系统，包括：

主引擎和主Git代码仓库部署模块，用于在第一级信息系统部署主引擎和主Git代码仓库；

分引擎和分Git代码仓库部署模块，用于在多个第二级信息系统分别部署分引擎和分Git代码仓库；

初始代码模板确定模块，用于根据设定开发技术确定初始代码模板；

初始代码模板存储模块，用于将所述初始代码模板存储到所述主Git代码仓库并将所述初始代码模板的ID存储到代码模板列表中；所述代码模板列表用于存储各版本的代码模板；

初始代码模板发布模块，用于通过所述主引擎将所述初始代码模板发布消息发送到各所述分引擎；

初始代码模板分发模块，用于各所述分引擎根据接收的所述发布消息从所述主Git代码仓库获取所述初始代码模板，并将获取的所述初始代码模板保存到对应分Git代码仓库中。

可选地，所述发布消息中包括所述初始代码模板的ID。

可选地，一种代码模板管理系统，还包括：

代码模板更新模块，用于通过所述主引擎更新第i版代码模板，获得更新后的第i版代码模板；

更新后的代码模板存储模块，用于将更新后的第i版代码模板存储到所述主Git代码仓库并将更新后的第i版代码模板的ID存储到代码模板列表中；

更新消息发送模块，用于通过所述主引擎将代码模板更新消息发送到各所述分引擎；

更新后的代码模板分发模块，用于各所述分引擎根据接收的所述代码模板更新消息从所述主Git代码仓库获取更新后的第i版代码模板，并将获取的更新后的第i版代码模板保存到对应分Git代码仓库中。

可选地，一种代码模板管理系统，还包括：

代码模板使用次数记录模块，用于当用户从所述主Git代码仓库或各所述分Git代码仓库获取第i版代码模板时，记录第i版代码模板的使用次数；

代码模板推荐模块，用于在所述主引擎和各所述分引擎，根据各代码模板的使用次数从大到小的顺序推荐各代码模板。

可选地，所述设定开发技术包括VUE、Angular和springboot。

根据本发明提供的具体实施例，本发明公开了以下技术效果：

本发明通过在第一级信息系统部署主引擎和主Git代码仓库，在多个第二级信息系统分别部署分引擎和分Git代码仓库，实现代码模板的统一发布和更新，保证了代码模板源头的统一，提高了代码模板的统一性和规范性。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动性的前提下，还可以根据这些附图获得其他的附图。

图1为本发明一种代码模板管理方法流程示意图；

图2为本发明第一级信息系统和第二级信息系统之间的结构示意图；

图3为本发明一种代码模板管理系统结构示意图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

为使本发明的上述目的、特征和优点能够更加明显易懂，下面结合附图和具体实施方式对本发明作进一步详细的说明。

图1为本发明一种代码模板管理方法流程示意图，如图1所示，一种代码模板管理方法，包括：

步骤101：在第一级信息系统部署主引擎和主Git代码仓库。

步骤102：在多个第二级信息系统分别部署分引擎和分Git代码仓库。

各所述第二级信息系统为第一级信息系统的下级系统。

步骤103：根据设定开发技术确定初始代码模板。

初始代码模板作为设定开发技术的第1版代码模板。对第1版代码模板进行第一次修改后的代码模板为第2版代码模板。每个版本的代码模板均具有唯一的ID。

设定开发技术包括VUE、Angular和springboot。

步骤104：将初始代码模板存储到主Git代码仓库并将初始代码模板的ID存储到代码模板列表中；代码模板列表用于存储各版本的代码模板。

步骤105：通过主引擎将初始代码模板发布消息发送到各分引擎。

步骤106：各分引擎根据接收的发布消息从主Git代码仓库获取初始代码模板，并将获取的初始代码模板保存到对应分Git代码仓库中。

发布消息中包括初始代码模板的ID。

一种代码模板管理方法还包括：

通过主引擎更新第i版代码模板，获得更新后的第i版代码模板。

将更新后的第i版代码模板存储到主Git代码仓库并将更新后的第i版代码模板的ID存储到代码模板列表中。

通过主引擎将代码模板更新消息发送到各分引擎。

各分引擎根据接收的代码模板更新消息从主Git代码仓库获取更新后的第i版代码模板，并将获取的更新后的第i版代码模板保存到对应分Git代码仓库中。

一种代码模板管理方法还包括：

当用户从主Git代码仓库或各分Git代码仓库获取第i版代码模板时，记录第i版代码模板的使用次数。

在主引擎和各分引擎，根据各代码模板的使用次数从大到小的顺序推荐各代码模板。

一种代码模板管理方法还包括：

通过分引擎修订第i版代码模板，获得待修改的第i版代码模板。

通过分引擎将待修改的第i版代码模板提交到主Git代码仓库的一个设定分支中，并通过分引擎向主引擎发送修订消息。

通过主引擎对设定分支中待修改的第i版代码模板进行评审。

若通过评审，则将通过评审的待修改的第i版代码模板作为更新后的第i版代码模板，并将更新后的第i版代码模板的ID存储到代码模板列表中。

通过主引擎将更新后的第i版代码模板修订消息发送到各分引擎。

各分引擎根据接收的修订消息从主Git代码仓库获取更新后的第i版代码模板，并将获取的更新后的第i版代码模板保存到对应分Git代码仓库中。

若没有通过评审，删除设定分支。

下面以具体实施例说明本发明一种代码模板管理方法。

Step1、在国铁集团信息系统本级研发机构(第一级信息系统)，如铁科院、国铁集团信息中心等，部署代码模板管理的主引擎和主Git代码仓库；在各铁路局一级信息系统研发机构(第二级信息系统)，如铁路局信息技术所，部署代码模板管理分引擎和分Git代码仓库，如图2所示。

Step2、在主引擎中配置各分引擎的地址信息；在各分引擎中配置主引擎地址和主Git代码仓库地址和账户。

Step3、在两级体系场景下，代码模板的管理通过如下方式实现：

代码模板生成：代码模板规定了某一种开发技术(如前端VUE、前端Angular、后端springboot)对应的代码基本框架，包括依赖使用、代码目录文件夹结构等。

国铁集团本级研发机构的技术专家评估确定最初代码模板，每套模板有唯一ID。

代码模板发布：将确定的代码模板提交至主Git代码仓库并记录代码仓库地址，并将代码仓库地址以及关于代码模板的描述信息作为配置参数添加到主引擎。

代码模板的描述信息包括代码模板的开发语言类型、技术特点、提交人和提交时间。

主引擎将已经添加配置的代码模板通过代码模板列表对外展示和发布。

主Git代码仓库中的代码模板作为国铁集团级研发机构的代码模板依据。

代码模板分发：主引擎通过消息队列将代码模板变动信息发送至各分引擎；

分引擎接收到消息后，根据消息中包含的代码模板配置信息(地址、属性等)，从主Git代码仓库中pull(拉取)代码模板至本级，然后将拉取的代码模板通过push(推送)命令推送至对应的分Git仓库，作为本级研发人员开发所使用的代码模板依据。拉取到本级的代码模板保持ID不变。

代码模板使用：研发人员(国铁集团级或各铁路局级)分别获取主引擎和分引擎发布的代码模板，选择某一模板后可通过引擎使用cookiecutter技术生成项目代码，项目代码同样保存在Git代码仓库中。与此同时，引擎对本代码模板的使用计数加一；对于分引擎中代码模板的使用次数变更，分引擎会模板ID和新增次数通过消息队列通知主引擎，主引擎更新对应ID的代码模板的全局使用次数。

代码模板更新：更新发起方是国铁集团本级研发机构，接收方是各铁路局研发机构。国铁集团级代码模板因为需求变化或技术升级而对代码模板进行更新，需要在主Git代码仓库中更新对应的代码模板内容，并在主引擎中注册新版本的代码模板并生成新的模板ID，并由主引擎通知各分引擎同步变化。

代码模板修订：修订的发起方是各铁路局研发机构，接收方是国铁集团本级研发机构。各铁路局研发机构在日常开发工作中，从自身角度需要对代码模板做出修改，并且修改后的模板具有一定的通用性和推广价值，同样适用于国铁集团级研发机构和其他铁路局研发机构。分引擎为主Git代码仓库中待修改的代码模板创建一个Git分支，将修改后的代码模板提交至该分支，并通过消息队列通知主引擎本次修订。

代码模板评审：对于铁路局级研发机构提出的代码模板修订方案，作为原有代码模板的分支保存在主Git代码仓库中。国铁集团级研发机构需针对该分支中的代码模板进行技术评审以确认是否具备通用和推广价值；对于具备价值的代码模板修订，将合并修订分支和主分支形成新版本代码模板，然后执行“代码模板分发”；对于有问题的分支提交，将删除该分支并通知对应铁路局研发机构；对于没有技术问题，但尚不具有推广价值的代码模板分支，暂时维持该分支的存在。

代码模板推荐：无论对于主引擎还是分引擎，对代码模板的排列顺序按照各自全局被使用次数由高到低排序。

本发明一种代码模板管理方法达到的技术效果如下：

1、代码模板统一规范

两级研发机构分别部署代码模板管理主引擎和分引擎并通过消息队列传递消息。主引擎负责代码模板的统一生成分发至各分引擎，保证了代码模板源头的统一，规范了两级研发机构的代码模板。

2、代码模板的可动态更新

由于代码模板不是一成不变的，各级研发机构对技术更新的需求不完全同步，因此通过本方案的代码更新(主引擎发起，分引擎接收)和代码修订(分引擎发起，主引擎接收)机制，实现了代码模板的动态更新。并通过评审等手段实现了代码模板的确认和推广发布。

3、代码模板的推荐机制

通过记录两级引擎所管理的代码模板的使用次数，在代码模板列表发布时，以使用次数为依据进行推荐。

图3为本发明一种代码模板管理系统结构示意图，如图3所示，本发明还公开了一种代码模板管理系统，包括：

主引擎和主Git代码仓库部署模块201，用于在第一级信息系统部署主引擎和主Git代码仓库。

分引擎和分Git代码仓库部署模块202，用于在多个第二级信息系统分别部署分引擎和分Git代码仓库。

初始代码模板确定模块203，用于根据设定开发技术确定初始代码模板。

初始代码模板存储模块204，用于将初始代码模板存储到主Git代码仓库并将初始代码模板的ID存储到代码模板列表中；代码模板列表用于存储各版本的代码模板。

初始代码模板发布模块205，用于通过主引擎将初始代码模板发布消息发送到各分引擎。

初始代码模板分发模块206，用于各分引擎根据接收的发布消息从主Git代码仓库获取初始代码模板，并将获取的初始代码模板保存到对应分Git代码仓库中。

发布消息中包括初始代码模板的ID。

一种代码模板管理系统，还包括：

代码模板更新模块，用于通过主引擎更新第i版代码模板，获得更新后的第i版代码模板。

更新后的代码模板存储模块，用于将更新后的第i版代码模板存储到主Git代码仓库并将更新后的第i版代码模板的ID存储到代码模板列表中。

更新消息发送模块，用于通过主引擎将代码模板更新消息发送到各分引擎。

更新后的代码模板分发模块，用于各分引擎根据接收的代码模板更新消息从主Git代码仓库获取更新后的第i版代码模板，并将获取的更新后的第i版代码模板保存到对应分Git代码仓库中。

一种代码模板管理系统，还包括：

代码模板使用次数记录模块，用于当用户从主Git代码仓库或各分Git代码仓库获取第i版代码模板时，记录第i版代码模板的使用次数。

代码模板推荐模块，用于在主引擎和各分引擎，根据各代码模板的使用次数从大到小的顺序推荐各代码模板。

设定开发技术包括VUE、Angular和springboot。

本说明书中各个实施例采用递进的方式描述，每个实施例重点说明的都是与其他实施例的不同之处，各个实施例之间相同相似部分互相参见即可。对于实施例公开的系统而言，由于其与实施例公开的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。

本文中应用了具体个例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想；同时，对于本领域的一般技术人员，依据本发明的思想，在具体实施方式及应用范围上均会有改变之处。综上所述，本说明书内容不应理解为对本发明的限制。

Claims

1.一种代码模板管理方法，其特征在于，包括：

在第一级信息系统部署主引擎和主Git代码仓库；

在多个第二级信息系统分别部署分引擎和分Git代码仓库；

根据设定开发技术确定初始代码模板；

2.根据权利要求1所述的代码模板管理方法，其特征在于，所述发布消息中包括所述初始代码模板的ID。

3.根据权利要求1所述的代码模板管理方法，其特征在于，还包括：

通过所述主引擎将代码模板更新消息发送到各所述分引擎；

4.根据权利要求1所述的代码模板管理方法，其特征在于，还包括：

5.根据权利要求1所述的代码模板管理方法，其特征在于，所述设定开发技术包括VUE、Angular和springboot。

6.一种代码模板管理系统，其特征在于，包括：

7.根据权利要求6所述的代码模板管理系统，其特征在于，所述发布消息中包括所述初始代码模板的ID。

8.根据权利要求6所述的代码模板管理系统，其特征在于，还包括：

9.根据权利要求6所述的代码模板管理系统，其特征在于，还包括：

10.根据权利要求6所述的代码模板管理系统，其特征在于，所述设定开发技术包括VUE、Angular和springboot。