MyBatis Generator的使用

MyBatis Generator
有两种方式生成

1、通过java代码方式生成:
提供一个模板配置文件,可以通过java代码的方式去生成那些dao,mapper映射文件,实体类。
通过代码方式生成:


/**
 * 代码的形式创建自动生成实体类、dao接口、mapper的xml文件。
 * 首先generatorConfig.xml这个文件必须要,因为这个文件中指定了要生成的内容放在哪个地方。
 */
public class Genertor {
    public static void main(String[] args) {
        List<String> warnings = new ArrayList<String>();
        boolean overwrite = true;
        //指定模板存放的位置,这里的位置是resource/generatorConfig.xml
        String genCfg = "/generatorConfig.xml";
        //这里需要替换%20是因为我电脑的这个路径有问题
        File configFile = new File(Genertor.class.getResource(genCfg).getFile().replace("%20"," "));
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = null;
        try {
            config = cp.parseConfiguration(configFile);
        } catch (IOException e) {
            e.printStackTrace();
        } catch (Exception e) {
            e.printStackTrace();
        }
        DefaultShellCallback callback = new DefaultShellCallback(overwrite);
        MyBatisGenerator myBatisGenerator = null;
        try {
            myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        } catch (InvalidConfigurationException e) {
            e.printStackTrace();
        }
        try {
            myBatisGenerator.generate(null);
        } catch (SQLException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }

}

2、通过maven插件也可以实现。
maven插件生成的话,需要在pom文件中插件里指定模板配置文件的路径。
pom.xml内容:

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.syzw.test</groupId>
  <artifactId>mybatis-gernerte-test</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>mybatis-gernerte-test Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>


  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <log.version>2.6.2</log.version>
    <junit.version>4.12</junit.version>
    <spring.version>4.3.3.RELEASE</spring.version>
    <jackson.version>2.8.2</jackson.version>
    <mybatis.spring.version>1.3.0</mybatis.spring.version>
    <dbcp.version>2.1.1</dbcp.version>
    <mybatis.version>3.4.1</mybatis.version>
    <mybatis.ehcache.version>1.0.3</mybatis.ehcache.version>
    <lombok.version>1.18.4</lombok.version>
    <spring-boot.version>2.1.3.RELEASE</spring-boot.version>
    <tomcat.version>9.0.13</tomcat.version>
    <java.version>1.8</java.version>
  </properties>

  <dependencies>
    <!--springboot启动默认需要的-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <version>${spring-boot.version}</version>
    </dependency>

    <!--springboot 支持web开发-->
    <dependency>
      <!-- 对全栈web开发的支持,包括Tomcat和 spring-webmvc -->
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
      <type>pom</type>
      <version>${spring-boot.version}</version>
    </dependency>


    <!--spring与mybatis整合的jar-->
    <dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>${mybatis.spring.version}</version>
    </dependency>

    <!-- 让tomcat支持jsp页面
     <dependency>
         <groupId>org.apache.tomcat.embed</groupId>
         <artifactId>tomcat-embed-jasper</artifactId>
         <scope>provided</scope>
         <version>${tomcat.version}</version>
     </dependency>
-->


    <!--junit用于测试使用,scope表示在测试环境下有效,不会打包出来-->
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>${junit.version}</version>
      <scope>test</scope>
    </dependency>


    <dependency>
      <groupId>jstl</groupId>
      <artifactId>jstl</artifactId>
      <version>1.2</version>
    </dependency>

    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>${lombok.version}</version>
      <scope>provided</scope>
    </dependency>

    <!-- spring 整合 数据访问操作的包 -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-jdbc</artifactId>
      <version>${spring.version}</version>
      <scope>runtime</scope>
    </dependency>

    <!-- 文件上传的依赖包 -->
    <dependency>
      <groupId>commons-fileupload</groupId>
      <artifactId>commons-fileupload</artifactId>
      <version>1.3.2</version>
    </dependency>

    <!-- spring整合的json处理框架 -->
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>${jackson.version}</version>
      <scope>runtime</scope>
    </dependency>

    <dependency>
      <groupId>com.google.code.gson</groupId>
      <artifactId>gson</artifactId>
      <version>2.7</version>
    </dependency>


    <!--连接mysql的驱动-->
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
      <version>5.1.40</version>
    </dependency>


    <dependency>
      <groupId>org.mybatis.generator</groupId>
      <artifactId>mybatis-generator-core</artifactId>
      <version>1.3.2</version>
    </dependency>


  </dependencies>

  <build>
    <finalName>zsxt</finalName>
    <plugins>
      <plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.2</version>
        <configuration>
          <configurationFile>${project.basedir}/src/main/resources/generatorConfig.xml</configurationFile>
          <verbose>true</verbose>
          <overwrite>true</overwrite>
        </configuration>
      </plugin>
    </plugins>
  </build>

</project>

配置文件内容:

<?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">
<!--这个文件是mybatis-generator生成所需要的模板-->
<generatorConfiguration>
    <!-- 引入配置文件 -->
    <properties resource="generatorInfo.properties"/>

    <!-- 指定数据库连接驱动jara地址 -->
    <classPathEntry
            location="${generator.location}" />

    <!-- 一个数据库一个context -->
    <context id="sqlserverTables">
        <!-- 生成的pojo,将implements Serializable -->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"></plugin>

        <!-- 注释 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true" /><!-- 是否取消注释 -->
            <!-- <property name="suppressDate" value="true" />  是否生成注释代时间戳 -->
        </commentGenerator>

        <!-- 数据库链接URL、用户名、密码 -->
        <jdbcConnection driverClass="${db.example.driver}"
                        connectionURL="${db.example.url}" userId="${db.example.username}"
                        password="${db.example.password}">
        </jdbcConnection>

        <!-- 类型转换 -->
        <javaTypeResolver>
            <!-- 默认false,把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer true,把JDBC DECIMAL
                和 NUMERIC 类型解析为java.math.BigDecimal -->
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- 生成model模型,对应的包路径,以及文件存放路径(targetProject),targetProject可以指定具体的路径,如./src/main/java,
            也可以使用“MAVEN”来自动生成,这样生成的代码会在target/generatord-source目录下 -->
        <!--javaModelGenerator中的targetPackage属性指定实体类的具体包名位置-->
        <javaModelGenerator targetPackage="com.syzw.test.user.entity"
                            targetProject="./src/main/java">
            <!-- 是否在当前路径下新加一层schema,eg:fase路径com.oop.eksp.user.model, true:com.oop.eksp.user.model.[schemaName] -->
            <property name="enableSubPackages" value="false" />
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!--对应的mapper.xml文件,所在的包位置 -->
        <sqlMapGenerator targetPackage="user"
                         targetProject="./src/main/resources">
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>

        <!-- 对应的Mapper接口类文件,所存放的位置-->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.syzw.test.user.dao" targetProject="./src/main/java">
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>


        <!-- 列出要生成代码的所有表,这里配置的是不生成Example文件 -->
        <!-- schema即为数据库名 tableName为对应的数据库表 domainObjectName是要生成的实体类 enable*ByExample
                   是否生成 example类   -->
        <table tableName="${gererator.tableName}" domainObjectName="${gererator.objectName}"
               schema="${gererator.schema}"
               enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false"
               selectByExampleQueryId="false">
            <!-- 忽略列,不生成bean 字段
            <ignoreColumn column="FRED" />-->
            <!-- 指定列的java数据类型
            <columnOverride column="LONG_VARCHAR_FIELD" jdbcType="VARCHAR" />  -->
            <!-- 用于指定生成实体类时是否使用实际的列名作为实体类的属性名。false是 Camel Case风格-->
            <property name="useActualColumnNames" value="false" />
        </table>
    </context>
</generatorConfiguration>

数据库连接信息文件:

#这个文件是用于自动生成mapper的信息文件,在generatorConfig.xml文件中会使用的这个文件。
db.example.type=mysql
db.example.driver=com.mysql.jdbc.Driver
db.example.url=jdbc:mysql://localhost:3306/test
db.example.username=root
db.example.password=root

#MBGInfo
generator.location=D:/Program Files/Java/framework/mysql-connector-java-5.1.8-bin.jar
generator.targetPackage=com.syzw.test
gererator.schema=fbp
gererator.tableName=t_user
gererator.objectName=User

这里将数据库的连接信息单独放在一个文件了,也可以直接写在generatorConfiguration.xml中。

注意:就算是使用java代码的方式生成,也是需要哪个generatorConfiguration.xml文件的。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
MyBatis Generator 是一个代码生成器,它可以根据数据库表结构自动生成 MyBatis 的 Mapper 文件、Java 实体类和 XML 映射文件等代码。使用 MyBatis Generator 可以大大减少开发人员的工作量,提高开发效率。 下面是使用 MyBatis Generator 的步骤: 1. 配置 generatorConfig.xml 文件,该文件用于配置生成代码的详细信息,包括数据库连接信息、生成的文件类型、生成的表等。 2. 运行 MyBatis Generator,生成代码。 3. 在项目中引入生成的代码,例如 Mapper 接口、实体类等。 以下是一个简单的 generatorConfig.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> <classPathEntry location="mysql-connector-java-5.1.39-bin.jar" /> <context id="MysqlTables" targetRuntime="MyBatis3"> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/mybatis" userId="root" password=""> </jdbcConnection> <javaTypeResolver > <property name="forceBigDecimals" value="false" /> </javaTypeResolver> <javaModelGenerator targetPackage="com.mybatis.example.model" targetProject="src/main/java"> <property name="enableSubPackages" value="true" /> <property name="trimStrings" value="true" /> </javaModelGenerator> <sqlMapGenerator targetPackage="com.mybatis.example.mapper" targetProject="src/main/resources"> <property name="enableSubPackages" value="true" /> </sqlMapGenerator> <javaClientGenerator type="XMLMAPPER" targetPackage="com.mybatis.example.mapper" targetProject="src/main/java"> <property name="enableSubPackages" value="true" /> </javaClientGenerator> <table tableName="user" domainObjectName="User" > </table> </context> </generatorConfiguration> ``` 这个示例配置文件会生成一个 UserMapper 接口、一个 User 实体类和一个 user.xml 文件。其中,User 实体类的包路径为 com.mybatis.example.model,UserMapper 接口和 user.xml 文件的包路径为 com.mybatis.example.mapper。 在运行 MyBatis Generator 之后,可以在项目中引入生成的代码,例如: ``` @Autowired private UserMapper userMapper; ``` 以上代码会注入一个 UserMapper 对象,可以通过该对象来操作数据库表。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值