file-type

MyBatis代码自动生成的两种有效方法

ZIP文件

下载需积分: 28 | 8.36MB | 更新于2025-02-21 | 65 浏览量 | 2 下载量 举报 收藏
download 立即下载
MyBatis 是一个流行的 Java 持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解用于配置和原始映射,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录。 在使用 MyBatis 进行项目开发时,常常需要手动编写大量的 SQL 映射文件(XML)以及相应的 Java 接口和 POJO 类。这种工作是十分繁琐并且容易出错的。为了提高开发效率和减少重复劳动,MyBatis 提供了代码自动生成的机制,即通过一些工具可以自动生成 MyBatis 中所需的 POJO 类、SQL 映射文件以及 Java 接口,常见的自动生成工具包括 MyBatis Generator 和 MBG。 MyBatis 自动生成的两种方式,这里主要讨论的是 MyBatis Generator 和 MBG,虽然它们本质上是同一个工具的不同名称,但有时人们会把它们当成两种方式来区别。 ### MyBatis Generator(MBG) MyBatis Generator 是官方提供的一个代码生成工具,它可以通过配置生成 MyBatis 的映射文件、Mapper 接口和对应的 POJO 类。它读取数据库的元数据,并结合开发者提供的配置文件,自动生成所需的代码。 #### 主要特点: - 高度可配置:开发者可以通过编写 XML 或者 Java 格式的配置文件来控制生成器的行为。 - 支持多种数据库:MySQL、Oracle、SQL Server、DB2 等主流数据库均能得到支持。 - 可定制性强:可以根据需要生成全部代码,也可以只生成部分代码,甚至可以定制生成的代码模板。 #### 使用步骤: 1. 添加 MBG 依赖:在项目中引入 MyBatis Generator 的相关依赖库。 2. 配置 GeneratorConfig.xml:配置数据库连接信息、生成代码的表、生成的代码存放路径等。 3. 运行生成器:编写运行代码或者使用 IDE 插件来执行 MBG,自动生成代码。 ### 第三方自动生成工具 除了 MyBatis 官方提供的 Generator 之外,还有一些第三方工具也提供了 MyBatis 代码自动生成的功能,例如 MyBatis Plus。 #### MyBatis Plus MyBatis Plus 是 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。它除了提供 CRUD 接口和代码生成器以外,还内置了分页插件、性能分析插件、SQL 注入器等众多功能。 #### 主要特点: - 内置代码生成器:可以直接通过注解或 XML 的方式配置生成规则。 - 支持 CRUD 接口:为单表操作提供了一套通用的 CRUD 接口。 - 提供分页插件:分页功能无需编写复杂的 SQL,直接通过配置即可实现分页效果。 #### 使用步骤: 1. 添加 MyBatis Plus 依赖:在项目中引入 MyBatis Plus 相关依赖库。 2. 配置 Application.yml 或 application.properties:设置数据源和 MyBatis Plus 相关配置。 3. 使用代码生成器:通过注解或 XML 配置规则,使用 MyBatis Plus 提供的代码生成器生成 CRUD 接口和 SQL 映射文件。 ### 总结 MyBatis 通过代码自动生成的方式,极大地提升了开发效率,减少了重复代码的编写。无论是使用官方的 MyBatis Generator 还是第三方工具如 MyBatis Plus,开发者都需要根据项目的需求和偏好选择合适的工具。通常,MBG 更为灵活,支持自定义配置,而 MyBatis Plus 则提供了更为丰富的功能,可以视为 MBG 的一个扩展版本,特别适合于中大型项目。 MyBatis 自动化代码生成的关键点在于能够根据数据库表结构快速生成实体类、Mapper 接口以及对应的映射文件,这在软件开发生命周期中是一个重要的时间节省点。正确使用这些工具不仅能够提高项目的开发效率,还能够在后期维护中减少人力成本。对于数据库表结构变动的情况,自动生成工具同样可以快速响应,生成新的代码,从而保证开发进度和代码质量。

相关推荐

filetype
一. 生成器模板路径可以引用相关变量 如 ${basepackage}/${className}.java,根据该变量生成输出文件 二. 自动搜索某个目录所有模板文件,无需配置 三.代码生成器模板可以引用的相关变量 1. g.generateByTable("table_name") 方法可以引用的变量 table : cn.org.rapid_framework.generator.provider.db.table.model.Table 2. g.generateByClass(UserInfo.class) 方法可以引用的变量 clazz : cn.org.rapid_framework.generator.provider.java.model.JavaClass 3. g.generateBySql("select * from user_info where pwd=:pwd") 方法可以引用的变量 sql : cn.org.rapid_framework.generator.provider.db.sql.model.Sql 4.公共变量 env : 系统环境变量 System.getProperties() : 直接引用,没有前缀 generator.properties 文件中的所有属性,直接引用,没有前缀 gg : 模板控制变量, cn.org.rapid_framework.generator.GeneratorControl 四.每个模板有gg变量可以控制自身的自定义配置 (每一个模板都会创建新的gg实例) 如是否生成,是否覆盖目标文件,甚至是生成其它文件 ${gg.setIgnoreOutput(true)}: 如果为true则不生成输出文件 ${gg.generateFile(outputFile,content)} 在模板中生成其它文件 ${gg.getProperty(key,defaultValue)}: 得到proproty,如果没有找到,则返回默认值 ${gg.getInputProperty(key)}: 会弹出一个输入框,提示用户输入值 具体参考: http://code.google.com/p/rapid-framework/wiki/rapid_generator_gg 五.支持生成(gen)及删除操作(del),即生成的代码也可以很方便的删除 六. 自动删除模板扩展名: .ftl,.vm 举例: 如你有一个模板 SqlMap.xml.ftl 将变为 SqlMap.xml 所以你要生成ftl扩展名的文件,应该将文件名从 list.ftl => list.ftl.ftl 七. 模板自动include所有父目录的:macro.include文件,可以存放公共的macro 示例: 如你的模板为 com/project/UserDao.java, 将自动include: com/project/macro.include, com/macro.include, macro.include 八. generator.xml (或者generator.properties)配置文件 1.类似ant可以变量引用,引用环境变量使用${env.JAVA_HOME}, 引用System.getProperties()直接引用 2.自动替换generator.properties中的句号(.)为反斜杠,设置key为key+"_dir"后缀 示例: pkg=com.company => pkg_dir=com/company 九.自动拷贝二进制文件至输出目录 如模板目录下的 zip,rar,doc文件将会自动拷贝至输出目录,不会破坏文件格式 (通过扩展名自动识别) 十. 数据库表配置,用于自定义生成器模板引用的table变量,配置文件必须存放在classpath: generator_config/table/table_name.xml (该文件生成器可以生成,自己再自定义修改)