本发明涉及软件研发与应用,具体为一种基于可变参数自动生成不同sdk与示例代码的方法。
背景技术:
1、如今敏捷开发、低代码、平台化等先进的开发理念,已经替代了以前强调结果交付、注重个人能力,而忽略标准化、组件化、快速交付的传统开发模式。很多软件系统或互联网应用,为了让应用接入或扩展开发变得快捷简单,都提供了相应的接口服务、sdk与示例代码,以为应用的使用者提供便利,简化基于应用进行扩展开发的过程。
2、但在sdk与示例代码(以下统称sdk)的提供过程中,往往还是存在sdk仍需二次修改,以及不同语言sdk的规范不通用,接口定义与代码结构差异较大,使用方式各不相同的问题。
3、这样的问题,既使得sdk提供方的代码管理与功能扩展更为麻烦,同时也给基于sdk进行开发的使用者带来了困扰和不便。从sdk提供方来说,首先缺少统一的sdk规划,导致提供的sdk出现规范不统一,结构不一致,质量参差不齐的问题,其次在制作sdk时,各语言sdk的编写者也缺少协调,不利于sdk的编写验证、能力扩展与改进优化;从sdk的使用者来讲,不同开发语言的sdk使用规范不同,有些sdk下载后还需要修改服务地址、认证信息等内容,有的sdk使用复杂或运行失败,这些情况都增加了sdk使用者的使用难度和工作量,为使用者带来诸多麻烦,导致sdk难以使用、bug频发等问题,进而提高sdk使用者的学习成本和应用成本,增加时间消耗。
技术实现思路
1、为了解决上述问题,本发明提供一种基于可变参数自动生成不同sdk与示例代码的方法,包括以下步骤:s1.定义规范并制作sdk模板;s2.sdk注入变参并提供下载。
2、进一步地,所述s1步骤包括以下子步骤:s11.定义sdk接口规范与sdk代码结构规范;s12.依照定义编写不同编程语言的sdk模板,并在sdk模板中设置可变参数;s13.将模板上传至模板文件中。
3、进一步地,所述s11步骤中sdk接口规范包括:包名称规范、类名称规范、接口名称规范、参数名称与类型规范、返回值类型规范。
4、进一步地,所述s12步骤中不同编程语言包括:python、java、c#、go、c/c++。
5、进一步地,所述s2步骤包括以下子步骤:s21.读取sdk模板的路径,并复制sdk模板至对应文件夹中;s22.将复制的sdk模板中的变参替换为用户对应信息;s23.将替换好的sdk打包发送至客户端以供下载。
6、进一步地,还包括步骤s24:用户在客户端中将sdk包下载,依据需求对sdk包进行配置,并对使用后的sdk包进行清理或缓存处理。
7、本发明提供了一种基于可变参数自动生成不同sdk与示例代码的方法,具有以下有益效果:
8、(1)本发明提高了应用sdk开发的规范性、可维护性、可扩展性,降低了sdk使用者的技术要求、开发复杂度、开发工作量和运行调试工时;可以更好地规范sdk的开发过程,提高各编程语言sdk开发的规范性、一致性,提升各sdk的代码质量。
9、(2)本发明可最大程度保持各sdk接口的一致、结构的相仿与代码的质量,使各sdk在维护与扩展时,避免因标准不同、代码混乱等原因带来的影响和不便。
1.一种基于可变参数自动生成不同sdk与示例代码的方法,其特征在于,包括以下步骤:
2.根据权利要求1所述的基于可变参数自动生成不同sdk与示例代码的方法,其特征在于,所述s1步骤包括以下子步骤:
3.根据权利要求2所述的基于可变参数自动生成不同sdk与示例代码的方法,其特征在于,所述s11步骤中sdk接口规范包括:包名称规范、类名称规范、接口名称规范、参数名称与类型规范、返回值类型规范。
4.根据权利要求2所述的基于可变参数自动生成不同sdk与示例代码的方法,其特征在于,所述s12步骤中不同编程语言包括:python、java、c#、go、c/c++。
5.根据权利要求1所述的基于可变参数自动生成不同sdk与示例代码的方法,其特征在于,所述s2步骤包括以下子步骤:
6.根据权利要求5所述的基于可变参数自动生成不同sdk与示例代码的方法,其特征在于,还包括步骤s24:用户在客户端中将sdk包下载,依据需求对sdk包进行配置,并对使用后的sdk包进行清理或缓存处理。