CN105824619A - 基于Spring MVC、Apache Shiro、MyBatis框架整合的代码生成器 - Google Patents

Abstract

本发明提供一种基于Spring MVC、Apache Shiro、MyBatis框架整合的代码生成器，包括业务表配置模块、生成方案配置模块、代码生成引擎、数据持久层生成模块、业务层生成模块、控制器生成模块、Jsp生成模块；该代码生成器生成的代码基于Spring MVC框架、Apache Shiro框架和MyBatis框架的整合，可以处理常见的单表、多表、树形结构表以及实际系统中各种业务的关联逻辑，而且实现了基于角色和权限的用户访问控制和MyBatis mapper映射文件的自动生成，生成的代码能够开箱即用，并为后续的二次开发和扩展提供了便利，提高了系统开发效率和代码质量。

Description

基于Spring MVC、Apache Shiro、MyBatis框架整合的代码生成器

技术领域

本发明涉及软件设计领域，具体涉及一种基于SpringMVC、ApacheShiro、MyBatis框架整合的代码生成器。

背景技术

任何一个商业性的web软件项目，代码量一般都在几十万行甚至更多；而且在软件工程学科的指导下，几乎所有的项目负责人都对软件进行了合理的架构设计，即把表现层、控制层、业务层和数据层进行了分开设计。在这种背景下，为了提高开发效率以及软件代码的复用率、降低开发成本，同时解决开发人员代码不规范的问题，采用代码生成工具协助项目开发，是众多web软件项目必不可少的工具。

目前比较流行的持久层开发框架主要是Hibernate和MyBatis框架，而MyBatis在保留jdbc灵活性的同时，将大量的连接维护工作隐藏起来，降低了开发的复杂度。ApacheShiro是目前使用较多的开源安全管理框架，它提供了用户认证和授权等服务。在现有技术中，该三种代码生成器独立工作，系统开发效率和代码质量都较低。

发明内容

本发明的目的在于针对现有技术的不足，提供一种基于SpringMVC、ApacheShiro、MyBatis框架整合的代码生成器，该代码生成器很好地解决了系统开发效率和代码质量较低的问题。

为达到上述要求，本发明采取的技术方案是：提供一种基于SpringMVC、ApacheShiro、MyBatis框架整合的代码生成器，该基于SpringMVC、ApacheShiro、MyBatis框架整合的代码生成器包括：

业务表配置模块，用于在根据所设计的业务表模型识别出数据库业务表的基础上配置相应的代码生成信息；

生成方案配置模块，用于在完成业务表配置的基础上配置相应的代码生成方案信息；

代码生成引擎，用于根据代码生成信息生成业务代码；

数据持久层生成模块，用于读取代码生成信息和代码生成方案信息，并利用读取到的信息操作对应的业务数据表，根据业务数据表的数据结构，生成分别与代码生成信息中的实体名称对应的pojo类文件和DAO类文件；

业务层生成模块，用于为每个实体类定义对应的业务类，在业务类中实现业务对象的业务逻辑方法；

控制器生成模块，用于根据变量集中控件对象的属性、pojo类文件的实例及Dao类文件的实例，生成与pojo类名称对应的控制器java类文件；

Jsp生成模块，用于根据代码生成信息生成对应不同方案的控件对象，再根据javascript代码和静态表单的控件的代码，生成视图jsp文件。

该基于SpringMVC、ApacheShiro、MyBatis框架整合的代码生成器具有的优点如下：该代码生成器生成的代码基于SpringMVC框架、ApacheShiro框架和MyBatis框架的整合，可以处理常见的单表、多表、树形结构表以及实际系统中各种业务的关联逻辑，而且实现了基于角色和权限的用户访问控制和MyBatismapper映射文件的自动生成，生成的代码能够开箱即用，并为后续的二次开发和扩展提供了便利，提高了系统开发效率和代码质量。

附图说明

此处所说明的附图用来提供对本申请的进一步理解，构成本申请的一部分，在这些附图中使用相同的参考标号来表示相同或相似的部分，本申请的示意性实施例及其说明用于解释本申请，并不构成对本申请的不当限定。在附图中：

图1为本申请的结构示意图。

具体实施方式

为使本申请的目的、技术方案和优点更加清楚，以下结合附图及具体实施例，对本申请作进一步地详细说明。

在以下描述中，对“一个实施例”、“实施例”、“一个示例”、“示例”等等的引用表明如此描述的实施例或示例可以包括特定特征、结构、特性、性质、元素或限度，但并非每个实施例或示例都必然包括特定特征、结构、特性、性质、元素或限度。另外，重复使用短语“根据本申请的一个实施例”虽然有可能是指代相同实施例，但并非必然指代相同的实施例。

为简单起见，以下描述中省略了本领域技术人员公知的某些技术特征。

根据本申请的一个实施例，提供一种基于SpringMVC、ApacheShiro、MyBatis框架整合的代码生成器，如图1所示，包括：

业务表配置模块，用于在根据所设计的业务表模型识别出数据库业务表的基础上配置相应的代码生成信息；

生成方案配置模块，用于在完成业务表配置的基础上配置相应的代码生成方案信息；

代码生成引擎，用于根据代码生成信息生成业务代码；

数据持久层生成模块，用于读取代码生成信息和代码生成方案信息，并利用读取到的信息操作对应的业务数据表，根据业务数据表的数据结构，生成分别与代码生成信息中的实体名称对应的pojo类文件和DAO类文件，其中根据所述业务数据表的字段类型和字段名称，向所述pojo类文件写入与所述业务数据表的字段类型和字段名称对应的属性、java类文件中变量的获取（getter）应用和设置（setter）应用；

业务层生成模块，用于为每个实体类定义对应的业务类，称为Service类，在业务类中实现业务对象的业务逻辑方法，在Service类中，通过相应的DAO类中的增加、删除、修改、查询等方法实现数据表记录与实体对象的操作；

控制器生成模块，用于根据变量集中控件对象的属性、pojo类文件的实例及Dao类文件的实例，生成与pojo类名称对应的控制器java类文件，java类文件包括：处理查看表单请求和处理提交表单请求；同时根据增加、删除、修改、查询的操作对其添加相应的权限标识；

Jsp生成模块，用于根据代码生成信息生成对应不同方案的控件对象，再根据javascript代码和静态表单的控件的代码，生成视图jsp文件，jsp文件包括以类名+From命名的用于表单提交操作的jsp文件，和以类名+List命名的用于展现记录信息的jsp文件。

根据本申请的一个实施例，代码生成信息包括业务表表描述、生成表关联的实体类名称及字段说明信息。

根据本申请的一个实施例，代码生成方案信息包括生成方案名称、生成模板类别、生成模块名称、生成包的路径及生成的功能描述。

根据本申请的一个实施例，代码生成引擎包括：

模板生成模块，用于从若干个代码文件中提取他们公共的部分，并利用模板变量替换不一致的代码段，形成代码模板；本实施例采用模板引擎FreeMarker，FreeMarker是一个采用java语言开发的基于模板生成文本的通用工具，它可以利用模板标签引用到Java对象中的各种属性，将可变的数据与不变的代码处理逻辑合为一体，组装出系统所需要的各种组件代码，特别适应于MVC模式的Web应用。

代码生成模块，根据代码生成信息，替换代码模板中相应的模板变量生成业务代码。

根据本申请的一个实施例，代码模板的类型包括单表操作模板、一对多操作模板、仅持久层操作模板和树形结构表操作模板。

根据本申请的一个实施例，还包括Mapper文件生成模块，用于根据业务表自动生成对业务表操作的mapper映射文件，MyBatis属于半自动的ORM框架，MyBatis虽然灵活度较高但是其中工作量最大的就是书写Mapping映射文件，而且手动书写很容易出错，采用了Mapper文件生成模块后大大减少了工作量，提高了准确率，Mapper文件生成模块包括对不同数据库mysql、oracle、sqlserver中该业务表的增、删、改、查等操作。

本发明根据代码生成方案信息中的生成路径，代码生成器将所有生成的文件保存相对应的路径中。同时，考虑到系统的可扩展性和可维护性的需要，通过代码生成器生成的代码结构严格按照MVC架构来设计，保证各层代码组织的相对独立性，对于通用性代码的部分进行了封装，同时保留了固定代码的重复生成，以方便程序员后期根据各个业务的个性化需要。

根据本申请的一个实施例，还包括访问控制框架，访问控制框架采用Shiro框架，与spring框架进行整合，ApacheShiro是一个功能强大、灵活性较好的Java开源安全框架，提供了身份认证、访问授权、数据加密和会话管理等功能，它能够为任何应用提供安全认证及身份控制。Shiro具有易于使用、灵活性高、易于与Web集成、可插拔等诸多优点，具体的整合流程如下所示：

（1）在web.xml中配置shiro监听过滤代理DelegatingFilterProxy。在web.xml中配置Spring监听过滤器，使用/*匹配所有的请求，让shiro过滤系统所接收到的请求；同时为了保证它在过滤器链中第一个起作用，将此filter-mapping放置到过滤器的最前面。

（2）自定义Web会话管理类。考虑到系统有可能部署到集群环境下，因此自定义会话管理器来管理会话的创建、维护、删除、失效、验证等工作。自定义的Web会话管理类需继承DefaultWebSessionManager抽象类，该类缺省使用MemorySessionDAO，采用基于内存的方式来保存和操作用户基本认证信息。如果系统内的用户数特别多，则需要采用CacheSessionDao基于缓存的方式进行操作。

（3）自定义CacheSessionDAO。在某些场景中，需要管理的用户较多，此时就需要将会话信息保存到缓存中，因此，通过继承EnterpriseCacheSessionDAO自定义CacheSessionDAO，实现session信息的创建、删除、更新和读取等管理操作，供会话管理类所调用。

（4）在spring的spring-context-shiro.xml文件中进行shiro的相关配置，其中主要配置与用户体系相关的5个bean：

①ShiroFilter，是Shiro的核心bean，提供认证鉴权bean的配置和URL模式与对应过滤器的匹配等配置；

②安全管理器SecurityManager，Shiro中所有具体的交互都要通过SecurityManager进行控制；它管理着所有的主体、且负责进行认证和授权、以及会话、缓存的管理，因此需要将cacheManager和SessionManager作为property配置到安全管理器下。本文采用默认的用于web环境的DefaultWebSecurityManager管理类；

③SessionManager，Shiro抽象了一个自己的Session类来管理主体与应用之间交互的数据，并通过sessionDAO实现数据的交互操作；

④配置sessionDAO。数据访问对象，用于实现会话信息的增删改查操作。为了将session会话信息被保存到ehcache，在此需要将缓存管理器作为property配置到此bean下；

⑤配置授权缓存管理器，EhCacheManager使用一个Shiro特定的ehcache.xml文件来建立Session缓存区以及确保Sessions正常存取的必要设置；

根据本申请的一个实施例，采用MyBatis-Spring类库来整合spring框架和MyBatis框架，具体的整合配置过程如下所示：

注册数据源DataSource。在Spring框架中可以通过以下三种方式获得数据源对象：从JNDI获得DataSource；从第三方的连接池获得DataSource；使用DriverManagerDataSource获得DataSource。本代码生成器采用阿里巴巴开源的DruidDataSource连接池获取数据源。

注册sqlSessionFactory。MyBatis的所有操作都是基于SqlSession的，而SqlSession是由SqlSessionFactory来产生的，而在MyBatis-Spring中SqlSessionFactory是基于SqlSessionFactoryBean来生成的，因此通过SqlSessionFactoryBean可以对其指定一些属性从而来为MyBatis提供一些配置信息。

dataSource：sqlSessionFactory用来创建SqlSession实例，而SqlSession包含了所有执行数据库SQL语句的方法，因此需要配置sqlSessionFactory所引用的数据源。

mapperLocations：指定SQLMapper文件的路径。

typeAliasesPackage：指定要映射的实体类的包路径，并自动注册不包含package名的别名。

configLocation：指定MyBatis自身的配置文件myatis-config.xml的路径。

③注册MapperScannerConfigurer。MapperScannerConfigurer就会自动扫描指定基包basePackage下面的所有接口，并把它们注册为一个个MapperFactoryBean对象。而MapperFactoryBean实现了Spring的FactoryBean接口，所以MapperFactoryBean是通过FactoryBean接口中定义的getObject()方法来获取相对应的Mapper对象。

以上所述实施例仅表示本发明的几种实施方式，其描述较为具体和详细，但并不能理解为对本发明范围的限制。应当指出的是，对于本领域的普通技术人员来说，在不脱离本发明构思的前提下，还可以做出若干变形和改进，这些都属于本发明保护范围。因此本发明的保护范围应该以所述权利要求为准。

Claims (8)

1.基于SpringMVC、ApacheShiro、MyBatis框架整合的代码生成器，其特征在于，包括：

业务表配置模块，用于在根据所设计的业务表模型识别出数据库业务表的基础上配置相应的代码生成信息；

生成方案配置模块，用于在完成业务表配置的基础上配置相应的代码生成方案信息；

代码生成引擎，用于根据所述代码生成信息生成业务代码；

数据持久层生成模块，用于读取所述代码生成信息和所述代码生成方案信息，并利用读取到的信息操作对应的业务数据表，根据所述业务数据表的数据结构，生成分别与所述代码生成信息中的实体名称对应的pojo类文件和DAO类文件；

业务层生成模块，用于为每个实体类定义对应的业务类，在所述业务类中实现业务对象的业务逻辑方法；

控制器生成模块，用于根据变量集中控件对象的属性、所述pojo类文件的实例及所述Dao类文件的实例，生成与pojo类名称对应的控制器java类文件；

Jsp生成模块，用于根据所述代码生成方案信息生成对应不同方案的控件对象，再根据javascript代码和静态表单的控件的代码，生成视图jsp文件。

2.根据权利要求1所述的代码生成器，其特征在于，所述代码生成信息包括业务表表描述、生成表关联的实体类名称及字段说明信息。

3.根据权利要求1所述的代码生成器，其特征在于，所述代码生成方案信息包括生成方案名称、生成模板类别、生成模块名称、生成包的路径及生成的功能描述。

4.根据权利要求1所述的代码生成器，其特征在于，所述代码生成引擎包括：

模板生成模块，用于从若干个代码文件中提取他们公共的部分，并利用模板变量替换不一致的代码段，形成代码模板；

代码生成模块，根据所述代码生成信息，替换所述代码模板中相应的模板变量生成业务代码。

5.根据权利要求4所述的代码生成器，其特征在于，所述代码模板的类型包括单表操作模板、一对多操作模板、仅持久层操作模板和树形结构表操作模板。

6.根据权利要求1所述的代码生成器，其特征在于，还包括Mapper文件生成模块，用于根据业务表自动生成对所述业务表操作的mapper映射文件。

7.根据权利要求1所述的代码生成器，其特征在于，还包括访问控制框架，所述访问控制框架采用Shiro框架，与spring框架进行整合。

8.根据权利要求1所述的代码生成器，其特征在于，采用MyBatis-Spring类库来整合spring框架和MyBatis框架。