Mybatis-generator自动生成代码的步骤

使用MyBatis Generator自动生成MyBatis代码的步骤

1. 添加依赖

首先,确保你的项目中包含了MyBatis Generator的依赖。对于Maven项目,在pom.xml文件中添加如下依赖(请替换为适合你项目的版本号):

<dependency>  
    <groupId>org.mybatis.generator</groupId>  `在这里插入代码片`
    <artifactId>mybatis-generator-core</artifactId>  
    <version>你的版本号</version>  
</dependency>

对于Gradle项目,在build.gradle文件中添加相应的依赖项。

2. 创建配置文件

接下来,创建一个MyBatis Generator的配置文件(通常命名为generatorConfig.xml),该文件将以XML格式定义数据库连接信息、表映射以及生成代码的格式和位置。

示例配置文件内容(请替换为你的数据库连接信息和项目路径):

<?xml version="1.0" encoding="UTF-8"?>  
<!DOCTYPE generatorConfiguration  
    PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"  
    "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">  
<generatorConfiguration>  
    <context id="DB2Tables" targetRuntime="MyBatis3">  
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"  
                        connectionURL="jdbc:mysql://localhost:3306/yourdatabase?serverTimezone=UTC"  
                        userId="root"  
                        password="yourpassword"/>  
  
        <javaModelGenerator targetPackage="com.example.model" targetProject="src/main/java"/>  
        <sqlMapGenerator targetPackage="com.example.mapper" targetProject="src/main/resources"/>  
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.mapper" targetProject="src/main/java"/>  
  
        <table tableName="your_table_name" domainObjectName="YourModelClassName"/>  
    </context>  
</generatorConfiguration>

3. 配置构建工具(可选)

对于Maven:在pom.xml中添加MyBatis Generator Maven插件配置,以便在Maven构建过程中自动运行Generator。

<build>  
    <plugins>  
        <plugin>  
            <groupId>org.mybatis.generator</groupId>  
            <artifactId>mybatis-generator-maven-plugin</artifactId>  
            <version>你的版本号</version>  
            <configuration>  
                <configurationFile>src/main/resources/generatorConfig.xml</configurationFile>  
                <overwrite>true</overwrite>  
                <verbose>true</verbose>  
            </configuration>  
        </plugin>  
    </plugins>  
</build>

对于Gradle:由于Gradle官方没有直接支持MyBatis Generator的插件,你可能需要编写一个自定义任务来调用Generator的jar文件。

4. 运行MyBatis Generator

通过Maven:在项目根目录下执行mvn mybatis-generator:generate命令。
通过Gradle(如果设置了自定义任务):执行相应的Gradle任务。
通过命令行:直接使用Java命令运行MyBatis Generator的jar文件,并指定配置文件路径作为参数。

5. 检查生成的代码

运行MyBatis Generator后,检查在目标路径下生成的mapper XML文件、mapper接口和实体类。确保它们符合你的项目需求,并根据需要进行调整。

6. 集成到开发流程

将MyBatis Generator集成到你的开发流程中,以便在数据库结构变化时能够轻松地更新MyBatis代码。你可以将其配置为在每次构建时自动运行,或者根据需要手动触发。这样可以提高开发效率,减少重复工作。

一. 生成器模板路径可以引用相关变量 如 ${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 (该文件生成器可以生成,自己再自定义修改)
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值