支持字段可选同步的多层业务代码自动生成方法、装置及介质与流程
本发明涉及计算机软件代码生成,特别是涉及一种支持字段可选同步的多层业务代码自动生成方法、装置及介质。
背景技术:
1、在现代企业级后端软件工程中,广泛采用领域驱动设计思想、命令查询职责分离(cqrs)模式以及基于同前缀的多项目分层架构进行代码组织。在该架构体系下,开发一个独立的业务功能模块通常需要在多个物理工程中同步维护多种职责各异的源码文件,包括控制器层接口、应用服务层接口与实现、消息契约层的命令与校验对象、领域层的处理器与仓储接口、数据传输对象(dto)以及对象关系映射(orm)持久化实体。现有软件工程常借助集成开发环境内置的代码生成脚手架、t4文本模板引擎或通用源生成器辅助生成基础代码。
2、然而,现有代码生成技术多以单工程或单实体模板为中心,无法自动解析并映射跨多项目的分层约定与模块命名规范;在处理领域实体中包含的关系导航属性(如单一引用对象或泛型实体集合)时,传统脚手架要么直接忽略导航属性,要么简单原样复写导致持久层类型定义不匹配,无法自动适配特定orm框架对于关系导航属性在类型与字段命名上的特殊修饰约定;此外,现有工具对于数据传输对象和命令对象的生成通常采取整实体全量映射,缺乏交互式细粒度字段选择能力,且列表查询与详情查询常混用同一种响应类型,造成接口契约与底层数据结构的过度耦合,极易在后续迭代演进中引发编译错误或运行期映射异常。
技术实现思路
1、本发明实施例提供了一种支持字段可选同步的多层业务代码自动生成方法、装置及介质,针对现有代码生成技术难以自适应跨多层项目的工程拓扑结构,且在生成跨层代码时无法对领域实体的普通业务字段与关系导航字段实施解耦控制及针对性的对象关系映射改写,导致跨层代码协同开发成本高、接口契约与数据持久层容易产生映射冲突与同步遗漏等问题。
2、本发明核心技术主要是通过自下而上回溯宿主项目自动索引同前缀多层工程目录,基于标量白名单将领域实体属性二分为普通业务字段与关系导航字段,并采用业务契约层仅消费交互勾选的普通业务字段、而对象关系映射实体层独立于勾选状态强制同步经类型递归前缀改写的全部关系导航字段的双轨生成机制。
3、第一方面,本发明提供了一种支持字段可选同步的多层业务代码自动生成方法,所述方法包括以下步骤:
4、接收模块名称输入,根据模块名称定位对应的领域实体文件;
5、解析领域实体文件中的公共属性,基于预设标量类型集合将所述公共属性区分为普通业务字段和关系导航字段:若属性类型包含泛型符号或数组符号,或者属性类型去除可空符号后不属于所述预设标量类型集合,则判定为关系导航字段;若属性类型去除可空符号后属于所述预设标量类型集合,则判定为普通业务字段;
6、展示普通业务字段供用户勾选,获取用户勾选的目标普通业务字段集合;
7、按照第一生成规则生成数据传输对象和命令对象,数据传输对象和命令对象仅包含目标普通业务字段集合中的字段,不包含关系导航字段;
8、按照第二生成规则生成对象关系映射实体,对象关系映射实体包含目标普通业务字段集合中的字段以及全部关系导航字段,并且对关系导航字段的字段名和类型名添加预定前缀,其中,关系导航字段在对象关系映射实体中的同步范围独立于用户对普通业务字段的勾选状态;
9、将生成的数据传输对象、命令对象和对象关系映射实体分别写入对应分层项目的目录中。
10、进一步地,根据模块名称定位对应的领域实体文件,包括:
11、以当前活动项目所在目录为起点,自下而上检索名称以预定web层后缀结尾的项目;
12、根据web层项目的名称去除预定web层后缀,得到根命名空间前缀;
13、在解决方案目录中索引名称以根命名空间前缀开头且分别具有预定分层后缀的多个分层项目;
14、当多个分层项目全部定位成功时返回定位结果,当仅定位到包含至少应用服务层和领域层的降级候选时返回降级候选并提示缺失的分层项目;
15、在定位到的领域层项目的实体目录中,查找与模块名称对应的领域实体文件。
16、进一步地,接收模块名称输入之后,还包括对模块名称进行解析:
17、当模块名称不包含下划线时,将模块名称同时作为模块目录名和实体名;
18、当模块名称包含下划线时,将第一个下划线之前的子串作为模块目录名,将第一个下划线之后的子串去除全部下划线后直接拼接作为实体名,且保持原始大小写不变;
19、领域实体的类型名保持模块名称的原始输入形态,在查找领域实体文件时,依次按照由模块名称原样、模块目录名加下划线加实体名、以及实体名构成的三种候选路径,匹配查找领域实体文件;
20、根据模块目录名和实体名确定各层生成文件的输出目录和类名。
21、进一步地,接收模块名称输入之后,还包括对模块名称进行实时校验:
22、在模块名称的输入文本每次发生变化时,执行合法性校验和工程条件校验,工程条件校验包括是否能定位到分层项目以及是否能找到对应的领域实体文件;
23、当合法性校验或工程条件校验失败时,显示错误信息并禁用确认操作,且不展示字段勾选界面;当校验成功时,展示普通业务字段供用户勾选并启用确认操作。
24、进一步地,解析领域实体文件中的公共属性,包括:
25、通过正则表达式匹配领域实体文件中具有公共访问修饰符且属性体由读取访问器和写入访问器构成的自动实现属性;
26、跳过属性名属于预定审计字段集合的属性;
27、在属性匹配位置向前扫描预定字符窗口,提取最近的可扩展标记语言文档注释作为字段说明,当文档注释与属性声明之间存在其他成员的访问修饰符时丢弃文档注释。
28、进一步地,对关系导航字段的字段名和类型名添加预定前缀,包括:
29、对关系导航字段的字段名,若字段名不以预定前缀开头则在字段名前添加预定前缀,若已以预定前缀开头则保持字段名不变;
30、对关系导航字段的类型名,若类型名为泛型类型,则保留外层泛型容器名称,对最外层泛型符号内的类型参数整段递归执行添加预定前缀的操作后重新拼接,直至类型名不再包含泛型符号时终止递归;若类型名为非泛型类型且去除可空符后不属于预定标量类型集合,则在类型名前添加预定前缀,并保留可空符;
31、保留关系导航字段的虚拟修饰符;
32、在生成对象关系映射实体时,固定生成重写的主键属性,主键属性附加对象关系映射主键特性。
33、进一步地,还包括:
34、数据传输对象包括创建请求对象、更新请求对象、详情响应对象和列表响应对象,其中,创建请求对象仅包含目标普通业务字段集合中的字段且不包含主键字段,更新请求对象、详情响应对象和列表响应对象包含主键字段及目标普通业务字段集合中的字段,且列表响应对象与详情响应对象为相互独立的类型;
35、在生成校验对象时,仅为目标普通业务字段集合中的字符串类型字段生成对应的校验方法,创建校验调用校验方法且不校验主键字段,更新校验在校验主键字段后调用校验方法,删除校验仅校验主键字段;
36、在生成处理器代码时,创建与更新操作中对对象关系映射实体的赋值语句仅覆盖目标普通业务字段集合中的字段;
37、将生成的文件内容与磁盘上已存在的对应文件内容进行全文逐字符比对,仅在内容发生变化时执行写入操作,内容未变化时跳过写入;
38、在将校验代码写入嵌套目录的同时,在预定历史扁平校验目录下仅针对与模块名称对应的预设固定名称集合的校验文件执行清除操作,且不递归检索其他目录。
39、第二方面,本发明提供了一种支持字段可选同步的多层业务代码自动生成装置,包括:
40、命令入口模块,用于接收模块名称输入,根据模块名称定位对应的领域实体文件;
41、解析模块,用于解析领域实体文件中的公共属性,基于预设标量类型集合将公共属性区分为普通业务字段和关系导航字段:若属性类型包含泛型符号或数组符号,或者属性类型去除可空符号后不属于所述预设标量类型集合,则判定为关系导航字段;若属性类型去除可空符号后属于所述预设标量类型集合,则判定为普通业务字段;
42、交互模块,用于展示普通业务字段供用户勾选,获取用户勾选的目标普通业务字段集合;
43、第一生成模块,用于按照第一生成规则生成数据传输对象和命令对象,所述数据传输对象和命令对象仅包含目标普通业务字段集合中的字段,不包含关系导航字段;
44、第二生成模块,用于按照第二生成规则生成对象关系映射实体,对象关系映射实体包含所述目标普通业务字段集合中的字段以及全部所述关系导航字段,并且对关系导航字段的字段名和类型名添加预定前缀,其中,关系导航字段在所述对象关系映射实体中的同步范围独立于用户对普通业务字段的勾选状态;
45、写入模块,用于将生成的数据传输对象、命令对象和对象关系映射实体分别写入对应分层项目的目录中。
46、第三方面,本发明提供了一种电子装置,包括存储器和处理器,存储器中存储有计算机程序,处理器被设置为运行计算机程序以执行上述的支持字段可选同步的多层业务代码自动生成方法。
47、第四方面,本发明提供了一种可读存储介质,可读存储介质中存储有计算机程序,计算机程序被处理器执行时实现如上述的支持字段可选同步的多层业务代码自动生成方法。
48、本发明的主要贡献和创新点如下:
49、1.跨层一致性方面,本发明通过一次模块名称输入即可同步生成控制器、服务、命令、校验、处理器、对象关系映射实体及数据传输对象等多层代码文件,各层文件基于同一字段解析结果生成,有效避免了因手工逐层修改导致的字段遗漏与命名不一致,降低了编译错误与运行期对象映射失败的风险。
50、2.企业分层约定适配方面,本发明能够以当前活动项目为起点自下而上自动检索入口层项目并推导根命名空间前缀,进而索引同前缀的多个分层项目,无需用户手工指定各层项目路径,降低了工具与工程环境的耦合度,提升了在多解决方案间迁移与复用的便利性。
51、3.关系导航字段映射自动化方面,本发明能够自动识别领域实体中的关系导航字段,并在生成对象关系映射实体时对关系导航字段的字段名与类型名执行预定前缀化改写,其中对泛型集合类型的泛型参数执行递归改写并保留虚拟修饰符,使生成的对象关系映射实体直接符合持久化框架的导航约定,消除了开发者手工二次修改关系导航字段的工作量。
52、4.生成粒度可控方面,本发明允许开发者在生成阶段以字段为粒度交互式勾选参与生成的普通业务字段,数据传输对象与命令对象仅包含勾选字段,且列表查询响应类型与详情查询响应类型相互独立,便于接口按业务需求独立演进。
53、5.工程友好性方面,本发明采用模块名称实时校验机制,在校验失败时阻断生成确认操作,避免了因输入不合法导致的无效生成;同时采用增量写入策略,通过全文逐字符比对仅在内容变化时执行写入,减少了无意义的文件覆盖,并能够自动清理历史版本遗留的旧路径校验文件,避免新旧目录结构冲突。
54、6.开发流程集成方面,本发明以集成开发环境扩展的形式提供,通过项目节点上下文菜单触发命令并以对话框完成模块名称输入与字段勾选,贴合开发者现有的操作习惯,无需切换至外部工具即可完成多层代码的生成。
55、本发明的一个或多个实施例的细节在以下附图和描述中提出,以使本发明的其他特征、目的和优点更加简明易懂。
版权声明:本站专利文献数据主要来源于国家知识产权局等公开渠道,由 技术新讯 进行整理汇编。页面设计及数据汇编的著作权归本站所有。全部内容仅供个人学习、科研评估与技术交流参考,严禁用于任何商业用途(包括但不限于直接生产制造、技术转让、倒卖数据等)。
免责条款:专利技术具有时效性,本站不对资料的绝对准确性、完整性和可实施性提供任何明示或暗示的担保。因参考本站内容造成的直接或间接损失,本站不承担相关法律责任。若您认为本站内容有侵权问题,请及时提供权属证明与我们联系,本站将在核实后依法处理。反馈意见:yyfuon@163.com