CN101727324A - 一种代码生成方法及装置 - Google Patents

Abstract

本发明公开了一种代码生成方法，包括：接收用户选择的业务场景、场景配置信息、为该业务场景选择的持久模型及界面配置信息，将所述业务场景和场景配置信息保存在场景模型中，将界面配置信息保存在界面模型中；根据所述持久模型，读取持久层代码所需的信息添加到预置的场景代码模板中相应的位置，生成持久层代码；读取界面配置信息添加到所述场景代码模板中相应的位置，生成界面层代码；结合所述场景模型、持久模型和界面模型，计算衍生出展现层及逻辑层代码所需的信息，保存在场景模型中；根据所述场景模型，读取展现层及逻辑层代码所需的信息添加到所述场景代码模板中相应的位置，生成展现层及逻辑层代码。本发明提高了生成代码的效率。

Description

一种代码生成方法及装置

技术领域

本发明涉及业务处理技术领域，特别是涉及一种代码生成方法及装置。

背景技术

在Web应用开发中，通常需要开发界面，创建数据库表，再通过业务逻辑把界面和数据库关联起来。当前国际上优秀的Web应用开发都采用了分层设计的理念，充分保证了各层之间的可替换性与可扩展性，也可以根据应用软件的需要对各层进行裁剪。一般按照职责可以分为界面层、展现层、逻辑层和持久层。

其中，界面层用于显示Web界面信息，例如一些查询条件输入框、按钮等。展现层的主要功能包括：用户点击了页面上的某个按钮之后，就会打开另外一个页面，这种按钮与页面之间的对应关系是由展现层来决定的。另外，打开的页面上是有数据的，这种把获取来数据显示在页面上的功能也是由展现层来提供的，或者用户在页面上输入或修改了一部分数据，如何把这些数据从页面上组织起来也是由展现层来提供的。逻辑层主要是在把数据提供给展现层之前，对数据进行逻辑处理，真正的增加、修改、删除、查询操作都是在逻辑层完成的。例如把用户上传的照片进行处理，使能够保存到数据库等，或者用户点击照片名称就能照片作为一个文件进行下载等。持久层主要是把前三层用到的数据与数据库中的表关联起来，从数据库中取数据，把数据写回数据库等。

为了实现一个完整的Web应用，开发人员就要分别编写各层的代码，以实现各层相应的功能。现有技术中为界面层和持久层提供了通用框架，开发人员可以利用通用框架生成界面层和持久层代码。但是通用框架仅仅保证了项目的质量，并不能减少编码量，某些框架甚至需要更多的编码。例如，对于持久层，框架需要一个包括表中每个字段的名称、字段类型，字段长度，字段是否为空等信息的配置文件，如果用户手动编码，就要在配置文件中为每个字段配置这4个信息，如果数据库表中有13个字段，就需要配置52次，因此，编写代码的效率非常低。而且，利用工具生成的界面层和持久层代码是相互独立的，开发人员还需要手动扩展实现展现层和逻辑层的代码，以便将界面层和持久层关联起来。

发明内容

有鉴于此，本发明的目的在于提供一种代码生成方法，以提高生成代码的效率。

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

一种代码生成方法，包括：

接收用户选择的业务场景、场景配置信息、为该业务场景选择的持久模型及界面配置信息，将所述业务场景和场景配置信息保存在场景模型中，将界面配置信息保存在界面模型中；

根据所述持久模型，读取持久层代码所需的信息添加到预置的场景代码模板中相应的位置，生成持久层代码；

读取界面配置信息添加到所述场景代码模板中相应的位置，生成界面层代码；

结合所述场景模型、持久模型和界面模型，计算衍生出展现层及逻辑层代码所需的信息，保存在场景模型中；根据所述场景模型，读取展现层及逻辑层代码所需的信息添加到所述场景代码模板中相应的位置，生成展现层及逻辑层代码。

优选的，所述持久模型与数据库中的表相对应，还包括：

将数据库表中的信息转化为通用代码框架所需的信息。

优选的，所述业务场景包括：

单表场景、主从表场景、树场景及Tab场景。

优选的，所述场景配置信息包括：

场景的名称、需要生成代码的项目及生成代码的存放路径。

一种代码生成装置，包括：

接收单元，用于接收用户选择的业务场景、场景配置信息、为该业务场景选择的持久模型及界面配置信息，将所述业务场景和场景配置信息保存在场景模型中，将界面配置信息保存在界面模型中；

持久层代码生成单元，用于根据所述持久模型，读取持久层代码所需的信息添加到预置的场景代码模板中相应的位置，生成持久层代码；

界面层代码生成单元，用于读取界面配置信息添加到所述场景代码模板中相应的位置，生成界面层代码；

展现层及逻辑层代码生成单元，用于结合所述场景模型、持久模型和界面模型，计算衍生出展现层及逻辑层代码所需的信息，保存在场景模型中；根据所述场景模型，读取展现层及逻辑层代码所需的信息添加到所述场景代码模板中相应的位置，生成展现层及逻辑层代码。

优选的，所述持久模型与数据库中的表相对应，还包括：

转换单元，用于将数据库表中的信息转化为通用代码框架所需的信息。

优选的，所述业务场景包括：

单表场景、主从表场景、树场景及Tab场景。

优选的，所述场景配置信息包括：

场景的名称、需要生成代码的项目及生成代码的存放路径。

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

在本发明实施例中，能够根据所述持久模型，读取数据库表中的信息添加到通用代码框架中相应的位置，生成持久层代码；将所述界面配置信息添加到通用代码框架中相应的位置，生成界面层代码；还能根据所述场景配置信息计算出按钮的名称及与其关联的页面的路径，并添加到通用代码框架中相应的位置，生成展现层及逻辑层代码。因此，用户只需要选择需要的业务场景，并填写场景配置信息，再为该业务场景选择的持久模型，并选择界面配置信息，本发明即可生成一整套的完整的代码，包括界面层、展现层、逻辑层及持久层，因此，可以减少用户需要填写的配置信息，同时，不需要分别使用不同的工具去生成各层的代码，也不需要用户再手动扩展展现层及逻辑层的代码，因此，提高了生成代码的效率。

附图说明

图1是本发明实施例提供的方法的流程图；

图2是本发明实施例提供的装置的示意图。

具体实施方式

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

本发明人在实现本发明的过程中发现，当基于现有技术中提供的持久层或界面层框架进行Web应用开发时，就会发现代码的重复性很大：前端界面都是一些通用的Web组件，菜单、表格、树、图表、日历、级联下拉框等等；大部分的业务操作都是增加、修改、删除、查看，然后对这些操作不断地采用同一种方式进行重复；开发持久层的POJO类、hbm.xml配置文件和对应的SQL执行文件也是包括了一些重复操作。

因此代码生成方法是一种通过程序编程来解放编码生产力的技术，采用代码生成可以帮助程序员自动生成应用系统中重复性很高的代码，减少软件开发中枯燥重复的编码工作，同时提高代码的质量，进而缩短开发周期。

鉴于目前Web应用开发中存在大量重复性的编码工作，现有的一些工具也只能在界面层和持久层为用户减少代码量，而且生成的界面层和持久层代码是各自独立的，不是一套完整的代码，本发明设计实现了一种基于业务场景的代码生成方法，采用本方法可以针对某个业务场景生成包括界面层、展现层、业务层和持久层的一整套可运行的代码。

参见图1，本发明实施例提供的代码生成方法包括以下步骤：

S101：接收用户选择的业务场景、场景配置信息、为该业务场景选择的持久模型及界面配置信息，将所述业务场景和场景配置信息保存在场景模型中，将界面配置信息保存在界面模型中；

在本发明实施例中，首先对用户常用的业务模块进行分析和抽象，发现这些模块的代码在结构上高度类似，并且具有通用性或批量生成特性，因此归纳出了以下常用业务场景：单表场景、主从表场景、树场景、Tab场景。

其中，所述单表场景对应的主要业务是对数据库中的单表进行增加、删除、修改和查看；主从表场景的主要业务是对数据库中的主从表进行增加、删除、修改和查看，主表的一条记录对应零到多条从表记录；树场景的主要业务是以树形结构分级展示数据库中的一个表；Tab场景主要是把以上3种业务场景通过Tab的形式组合在一起。

同时，由于在实际的编码中，持久层及界面层代码除了具有一些公用的部分之外，还会有各自个性化的部分。因此，本发明实施例针对各个业务场景创建了相应的场景模型，每个业务场景的场景模型都包括持久模型和界面模型。其中持久模型对应Web应用中持久层，界面模型对应界面层。持久模型与数据库中的一张表相对应，生成代码时，由用户选择一种持久模型，用于生成持久层代码；同时还要选择界面配置信息，用于生成界面层代码。

另外，由于在实际的编码中，根据场景及具体业务的不同，展现层和逻辑层代码也不是完全一样的，因此，在本发明实施例提供的方法中，还需要让用户对场景进行订制，并且在提供场景配置信息。所述场景配置信息包括场景的名称、需要生成代码的项目(由于需要将生成的代码放在具体的项目中，因此，需要指定生成的代码所在的项目)、生成代码的存放路径等。

在需要生成代码时，用户可以根据自己的业务需要，分析当前的业务模块，选择一种业务场景，然后对场景信息进行配置；接着选择该场景需要用到的持久模型，然后提供界面配置信息，即配置界面的展现形式，根据持久模型的字段类型选择采用哪种Web组件来展现。完成上述配置之后，代码生成工具就可以进行代码生成了。

S102：根据所述持久模型，读取持久层代码所需的信息添加到预置的场景代码模板中相应的位置，生成持久层代码；

S103：根据所述界面模型，读取界面配置信息添加到所述场景代码模板中相应的位置，生成界面层代码；

S104：结合所述场景模型、持久模型和界面模型，计算衍生出展现层及逻辑层代码所需的信息，保存在场景模型中；根据所述场景模型，读取展现层及逻辑层代码所需的信息添加到所述场景代码模板中相应的位置，生成展现层及逻辑层代码。

通过对选择的业务场景进行配置之后，对于每种场景代码的具体内容，则是通过为每种场景提供场景代码模板来决定的。场景代码模板中包含了场景的通用代码框架，利用代码引擎生成代码时需要结合用户的具体配置信息来生成界面层、展现层、业务层和持久层代码。具体在生成代码时，上述步骤S102、S103、S104的执行顺序不做限定，即各层代码生成的先后顺序可以根据具体的应用而任意调整。

也就是说，在场景代码模板中提供了具体的实现增、删、改、查等基本操作的代码框架性结构，但是由于具体的业务中，上述操作的具体对象是不同的，例如，具体是对哪个表中的什么数据进行增、删、改、查等是不同的，这些数据就需要用户通过具体的配置来提供，包括场景配置信息、持久模型、界面配置信息。

需要说明的是，在本发明实施例中，当用户指定持久模型之后，场景代码模板针对该持久模型需要表中字段的哪些属性是已知的(因为都已经体现在场景代码模板中，例如，需要每个字段的名称，则在场景代码模板中会有相应的语句)，因此，如果场景代码模板需要获取一个数据库表中各字段的某些属性，用户并不需要对逐个字段地进行配置。例如，对于持久层，场景代码模板需要数据库表中每个字段的名称、字段类型，字段长度，字段是否为空等信息，数据库表中包括部门、职位、入职时间、姓名、性别、籍贯、民族、身份证号、联系电话、户口所在地、档案所在地、毕业院校等13个字段，采用本发明实施例提供的方法生成代码时，用户只需要选择一个持久模型这一个操作即可，而不用针对数据库表中的13个字段、场景代码模板所需的4个字段属性进行52次配置。

另外需要说明的是，持久模型是本发明实施例的代码生成方法为持久层定义的一种模型，与数据库中的表对应。它主要包含的是表生成代码时所需要的信息，还可能需要增加一些表中没有，但是生成代码需要的信息。例如在数据库中表的字段对应的类型是Sq1类型，但是在场景代码模板中需要的是Hibernate类型和Java类型，因此还需要将数据库表中的信息转化为场景代码模板所需的信息，例如，在持久模型中对Sq1类型进行转换，获得持久模型的Hibernate类型和Java类型。

可见，通过本发明实施例，在进行业务应用开发中，把常用业务进行分类和抽象成业务场景，通过场景模型保存用户对业务场景的配置信息，再结合场景代码模板生成一套完整可运行的代码。生成的代码不经过任何修改就可以完成对用户抽象出来的业务场景实现增、删、改、查等基本操作。因此，用户只需要分析当前业务属于哪种业务场景，选择持久模型，配置界面展现形式，就可以针对当前业务场景生成一套完整的代码，用户基本不需要编码或者只需要进行少量的修改就可以现实业务模块中的增、删、改、查基本工作，这样可以让用户减少对一般编码工作的关注，而将大部分的精力投入到应用系统的核心功能部件的开发中，从而减少编码出错率和提高系统质量。

同时本发明实施例也为业务系统开发降低了难度，因为本发明实施例是通过对业务场景的配置来自动生成代码的，在开发过程中一些不太了解底层框架只了解业务需求的开发人员也可以使用这种方法快速地投入到业务开发工作中去。

为了更好地理解本发明实施例提供的方法，下面通过一个具体应用中的例子进行更加详细地介绍。

以单表场景为例，假设用户的业务应用中有这样一种场景：对公司员工的信息进行增加、修改、删除和查询，并假设员工的信息包括：部门，职位，入职时间，姓名，性别，籍贯，民族，身份证号，联系电话，户口所在地，档案所在地，毕业院校等。现采用单表场景进行代码生成，在生成的过程中，用户需要提供以下信息：

(1)场景名称：假如用户输入的是yuangong；

(2)需要生成代码的项目：假如用户输入的是MyProject；

(3)生成代码的存放路径：假如用户输入的是org.test；

(4)选择本场景需要用到的持久模型：假如选择的持久模型名称为Employee，对应数据库中的Employee表，包含部门、职位、入职时间、姓名、性别、籍贯、民族、身份证号、联系电话、户口所在地、档案所在地、毕业院校、照片这13个字段。

(5)配置界面的展现形式：在界面上的整体展现形式，是表单，列表，还是树，或者是这3者的组合。

(6)根据持久模型的字段类型选择采用哪种Web组件来展现：如果第(5)步选择的是表单或者表格，就根据在第(4)步选择的持久模型名称，获得持久模型中的13个字段，然后让用户为每一个字段设置选择采用哪种Web组件来展现，其中Web组件包括：文本输入框，下拉框，日期框，勾选框，密码框等等，比如姓名是一个简单的输入框，性别是包含“男，女”的选择按钮，入职时间是一个时间输入框，而照片则需要一个可以上传电子照片的文件的按钮等

对于单表场景，用户只需要提供以上这些信息，本发明实施例就可以根据这些配置信息生成界面层、展现层、逻辑层和持久层代码。

例如，对于持久层，场景代码模板需要数据库表中每个字段的名称、字段类型，字段长度，字段是否为空等信息，则，可以自动根据用户选择的持久模型，读取对应的数据库表中的每一个字段，再获取字段的名称、字段类型，字段长度，字段是否为空等信息填充到场景代码模板中相应的位置。

再如，对于展现层，需要把按钮和页面对应起来，即当用户点击某个按钮时需要执行哪个方法，转向哪个页面。生成代码时本发明实施例可以根据用户配置的场景名称和生成代码的存放路径等计算出按钮的名称(例如＜％＝request.getContextPath()％＞/yuangongEmployeeForm/forAdd.so)和对应的页面的路径(例如：appjsps/yuangong/yuangong_Employee_forAdd.jsp)，这样就把界面层和展现层关联起来了。

生成代码之后，各层的具体内容如下：

界面层：对于单表场景，可以设定为包括：增加页面、修改页面、明细页面和查询页面。根据用户输入的场景名yuangong，在结合框架的要求(框架也决定了项目的目录结构)，可以在项目某个放页面的目录下创建一个yuangong目录，并在这个目录下生成以下4个页面yuangong_Employee_forAdd.jsp yuangong_Employee_forUpdate.jsp，yuangong_Employee_detail.jsp，yuangong_Employee_query.jsp。

以查询页面yuangong_Employee_query.jsp为例，在这个页面展现的是一个列表，初始状态时显示所有的员工信息。页面最上方有查询条件输入框，比如用户输入“2009-1-1”这个入职时间，点击“查询”按钮，在列表中就会显示所有在2009-1-1之前入职的员工。此外页面上还有增加、修改、删除、明细按钮，点击“增加”按钮就会打开yuangong_Employee_forAdd.jsp页面，让用户增加一个员工的信息；或者从列表中选择一条记录，点击修改、明细按钮就会分别打开yuangong_Employee_forUpdate.jsp，yuangong_Employee_detail.jsp页面。

展现层：用户点击了页面上的某个按钮之后，就会打开另外一个页面，这种按钮与页面之间的对应关系是由展现层来决定的。另外，打开的页面上是有数据的，这种把获取来数据显示在页面上的功能也是由展现层来提供的，或者用户在页面上输入或修改了一部分数据，如何把这些数据从页面上组织起来也是由展现层来提供的。

逻辑层：逻辑层主要是在把数据提供给展现层之前，对数据进行逻辑处理，真正的增加、修改、删除、查询操作都是在逻辑层完成的。例如把用户上传的照片进行处理，使能够保存到数据库等，或者用户点击照片名称就能照片作为一个文件进行下载等。

持久层：主要是把前3层用到的数据与数据库中的表关联起来，从数据库中取数据，把数据写回数据库等。

与本发明实施例提供的代码生成方法相对应，本发明实施例还提供了一种代码生成装置，参见图2，该装置包括以下单元：

接收单元U201，用于接收用户选择的业务场景、场景配置信息、为该业务场景选择的持久模型及界面配置信息，将所述业务场景和场景配置信息保存在场景模型中，将界面配置信息保存在界面模型中；

持久层代码生成单元U202，用于根据所述持久模型，读取持久层代码所需的信息添加到预置的场景代码模板中相应的位置，生成持久层代码；

界面层代码生成单元U203，用于根据所述界面模型，读取界面配置信息添加到所述场景代码模板中相应的位置，生成界面层代码；

展现层及逻辑层代码生成单元U204，用于结合所述场景模型、持久模型和界面模型，计算衍生出展现层及逻辑层代码所需的信息，保存在场景模型中；根据所述场景模型，读取展现层及逻辑层代码所需的信息添加到所述场景代码模板中相应的位置，生成展现层及逻辑层代码。

通过本发明实施例提供的装置，用户只需要选择需要的业务场景，并填写场景配置信息，再为该业务场景选择的持久模型，并选择界面配置信息，本发明即可生成一整套的完整的代码，包括界面层、展现层、逻辑层及持久层，因此，可以减少用户需要填写的配置信息，同时，不需要分别使用不同的工具去生成各层的代码，也不需要用户再手动扩展展现层及逻辑层的代码，因此，提高了生成代码的效率。

其中，该装置还可以包括：

转换单元，用于将数据库表中的信息转化为通用代码框架所需的信息。

所述业务场景可以包括：单表场景、主从表场景、树场景及Tab场景。

所述场景配置信息可以包括：场景的名称、需要生成代码的项目及生成代码的存放路径。

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

Claims (8)

1.一种代码生成方法，其特征在于，包括：

接收用户选择的业务场景、场景配置信息、为该业务场景选择的持久模型及界面配置信息，将所述业务场景和场景配置信息保存在场景模型中，将界面配置信息保存在界面模型中；

根据所述持久模型，读取持久层代码所需的信息添加到预置的场景代码模板中相应的位置，生成持久层代码；

根据所述界面模型，读取界面配置信息添加到所述场景代码模板中相应的位置，生成界面层代码；

结合所述场景模型、持久模型和界面模型，计算衍生出展现层及逻辑层代码所需的信息，保存在场景模型中；根据所述场景模型，读取展现层及逻辑层代码所需的信息添加到所述场景代码模板中相应的位置，生成展现层及逻辑层代码。

2.根据权利要求1所述的方法，其特征在于，所述持久模型与数据库中的表相对应，还包括：

将数据库表中的信息转化为通用代码框架所需的信息。

3.根据权利要求1所述的方法，其特征在于，所述业务场景包括：

单表场景、主从表场景、树场景及Tab场景。

4.根据权利要求1所述的方法，其特征在于，所述场景配置信息包括：

场景的名称、需要生成代码的项目及生成代码的存放路径。

5.一种代码生成装置，其特征在于，包括：

接收单元，用于接收用户选择的业务场景、场景配置信息、为该业务场景选择的持久模型及界面配置信息，将所述业务场景和场景配置信息保存在场景模型中，将界面配置信息保存在界面模型中；

持久层代码生成单元，用于根据所述持久模型，读取持久层代码所需的信息添加到预置的场景代码模板中相应的位置，生成持久层代码；

界面层代码生成单元，用于根据所述界面模型，读取界面配置信息添加到所述场景代码模板中相应的位置，生成界面层代码；

展现层及逻辑层代码生成单元，用于结合所述场景模型、持久模型和界面模型，计算衍生出展现层及逻辑层代码所需的信息，保存在场景模型中；根据所述场景模型，读取展现层及逻辑层代码所需的信息添加到所述场景代码模板中相应的位置，生成展现层及逻辑层代码。

6.根据权利要求5所述的装置，其特征在于，所述持久模型与数据库中的表相对应，还包括：

转换单元，用于将数据库表中的信息转化为通用代码框架所需的信息。

7.根据权利要求5所述的装置，其特征在于，所述业务场景包括：

单表场景、主从表场景、树场景及Tab场景。

8.根据权利要求5所述的装置，其特征在于，所述场景配置信息包括：

场景的名称、需要生成代码的项目及生成代码的存放路径。

Images