Mybatis Generator

最新推荐文章于 2025-10-30 12:30:19 发布

原创最新推荐文章于 2025-10-30 12:30:19 发布 · 399 阅读

0 ·

CC 4.0 BY-SA版权

java 专栏收录该内容

97 篇文章

订阅专栏

本文介绍MyBatisGenerator的配置及使用方法，包括代码模板、Java模型生成器、SQL映射文件生成器等内容，提供了三种生成代码的方式。

参考 https://enjoy.ke.qq.com/#category=-1 学习资料

MyBatis Generator：MyBatis 的开发团队提供了一个很强大的代码生成器，代码包含了数据库表对应的实体类、Mapper 接口类、 Mapper XML 文件和 Example 对象等，这些代码文件中几乎包含了全部的单表操作方法，使用 MBG 可以极大程度上方便我们使用 MyBatis，还可以减少很多重复操作；

代码模板

<?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>
   <!-- 引入配置文件 -->
   <properties resource="db.properties" />

   <!-- 加载数据库驱动 -->
   <classPathEntry location="${class_path}" />

   <!-- context:生成一组对象的环境
         id:必选，上下文id，用于在生成错误时提示
         defaultModelType:指定生成对象的样式
             1，conditional：类似hierarchical；
             2，flat：所有内容（主键，blob）等全部生成在一个对象中，推荐使用；
             3，hierarchical：主键生成一个XXKey对象(key class)，Blob等单独生成一个对象，其他简单属性在一个对象中(record class)
         targetRuntime:
             1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample；
               2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample；
     -->
   <context id="context1" targetRuntime="MyBatis3Simple"  defaultModelType="flat">

      <!-- 生成的Java文件的编码 -->
      <property name="javaFileEncoding" value="UTF-8"/>


      <commentGenerator>
         <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
         <property name="suppressAllComments" value="false" />
         <!-- 阻止注释中包含时间戳 true：是 ： false:否 -->
         <property name="suppressDate" value="true" />
         <!--  注释是否包含数据库表的注释信息  true：是 ： false:否 -->
         <property name="addRemarkComments" value="true" />
      </commentGenerator>

      <!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
      <jdbcConnection driverClass="${jdbc_driver}"
                  connectionURL="${jdbc_url}" userId="${jdbc_username}" password="${jdbc_password}" />


      <!-- java模型创建器，是必须要的元素   负责：1，key类（见context的defaultModelType）；2，java类；3，查询类
            targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制；
            targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录
         -->
      <javaModelGenerator targetPackage="com.enjoylearning.mybatis.entity" targetProject="${project_src}">
         <!-- 设置一个根对象，
                         如果设置了这个根对象，那么生成的keyClass或者recordClass会继承这个类；在Table的rootClass属性中可以覆盖该选项
                         注意：如果在key class或者record class中有root class相同的属性，MBG就不会重新生成这些属性了，包括：
                   1，属性名相同，类型相同，有相同的getter/setter方法；
            -->
         <property name="rootClass" value="com.enjoylearning.mybatis.entity.BaseEntity" />
      </javaModelGenerator>


      <!-- 生成SQL map的XML文件生成器，
            targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制；
           targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录
         -->
      <sqlMapGenerator targetPackage="." targetProject="${project_mapper_xml}">
      </sqlMapGenerator>


      <!-- 对于mybatis来说，即生成Mapper接口，注意，如果没有配置该元素，那么默认不会生成Mapper接口
               type：选择怎么生成mapper接口（在MyBatis3/MyBatis3Simple下）：
                   1，ANNOTATEDMAPPER：会生成使用Mapper接口+Annotation的方式创建（SQL生成在annotation中），不会生成对应的XML；
                   2，MIXEDMAPPER：使用混合配置，会生成Mapper接口，并适当添加合适的Annotation，但是XML会生成在XML中；
                   3，XMLMAPPER：会生成Mapper接口，接口完全依赖XML；
               注意，如果context是MyBatis3Simple：只支持ANNOTATEDMAPPER和XMLMAPPER
           -->
      <javaClientGenerator  targetPackage="com.enjoylearning.mybatis.mapper"
                       targetProject="${project_src}" type="XMLMAPPER" />




      <!-- shema 数据库 tableName表明 -->
      <table schema="${jdbc_username}" tableName="%" >
         <generatedKey column="id" sqlStatement="MySql"/>
      </table>


   </context>
</generatorConfiguration>

targetRuntime:
    1，MyBatis3：默认的值，生成基于MyBatis3.x以上版本的内容，包括XXXBySample； 查询的时候就会如下那样  查询条件在Example里面。

如果是 targetRuntime="MyBatis3Simple" 2，MyBatis3Simple：类似MyBatis3，只是不生成XXXBySample；

那么查询就是

db.properties

jdbc_driver=com.mysql.jdbc.Driver
jdbc_url=jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf8&allowMultiQueries=true
jdbc_username=root
jdbc_password=root
project_src =src/main/java
project_mapper_xml =src/main/resources/sqlmapper
class_path=C:/Users/Administrator/.m2/repository/mysql/mysql-connector-java/5.1.18/mysql-connector-java-5.1.18.jar
#class_path=D:/devTools/LocalRepository/mysql/mysql-connector-java/5.1.18/mysql-connector-java-5.1.18.jar

第一种方式

通过代码生成文件的方法

package com.enjoylearning.mybatis;

import com.enjoylearning.mybatis.mapper.TUserMapper;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;
import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.exception.InvalidConfigurationException;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;

//@RunWith(SpringJUnit4ClassRunner.class)
//@ContextConfiguration("classpath:applicationContext.xml")
public class MybatisSpringTest {
    private SqlSessionFactory sqlSessionFactory;

    @Before
    public void init() throws IOException {

        String resource = "mybatis-config.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        // 1.读取mybatis配置文件创SqlSessionFactory
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        inputStream.close();
    }
   @Test
   public void testQuery(){
//    String email = "qq.com";
//    Byte sex = 1;
//    List<TUser> users = us.getUserByEmailAndSex(email, sex);
//    System.out.println(users.size());
   }
   
   @Test
   public void mybatisGeneratorTest() throws FileNotFoundException{
      List<String> warnings = new ArrayList<String>();  
        boolean overwrite = true;
        String genCfg = "generatorConfig.xml";  
        File configFile = new File(getClass().getClassLoader().getResource(genCfg).getFile());
        ConfigurationParser cp = new ConfigurationParser(warnings);  
        Configuration config = null;  
        try {  
            config = cp.parseConfiguration(configFile);  
        } catch (IOException e) {  
            e.printStackTrace();  
        } catch (XMLParserException 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();  
        }  
    }

    @Test
    public void testQueryExample(){
        // 2.获取sqlSession
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // 3.获取对应mapper
        TUserMapper mapper = sqlSession.getMapper(TUserMapper.class);
        mapper.selectByPrimaryKey(1);
        // 4.执行查询语句并返回结果
//        TUserExample example = new TUserExample();
//        TUserExample.Criteria criteria = example.createCriteria();
//        criteria.andEmailLike("%163.com");
//        criteria.andSexEqualTo((byte) 2);
//
//        List<TUser> selectByExample = mapper.selectByExample(example);
////        System.out.println(selectByExample);
//        selectByExample.forEach(user ->System.out.println(user.toString()));

    }
   

}

第二种方式

通过maven生成代码的方法

pom.xml

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>2.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>

        <plugin>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-maven-plugin</artifactId>
            <version>1.3.2</version>
            <configuration>
                <verbose>true</verbose>
                <overwrite>true</overwrite>
            </configuration>
        </plugin>


    </plugins>
</build>

作为 Maven Plugin
mvn mybatis-generator:generate 命令

第三种方式

从命令提示符使用 XML 配置文件
java -jar mybatis-generator-core-x.x.x.jar -configfile generatorConfig.xml