通过mybatis工具generatorConfig.xml自动生成实体,DAO,映射文件

简介

  Mybatis属于半自动ORM，可以利用mybatis工具generatorConfig.xml自动生成DAO、实体、映射文件的方式来代替手动书写的方式，这样既提高了工作效率也可以在项目避免出现的一些细微难调试的BUG。

前提条件：

1、需要准备的第三方jar包为：

mybatis-generator-core-1.3.2.jar和mysql-connector-java-5.1.39-bin.jar，

其中mybatis-generator-core-1.3.2.jar的下载地址为：

https://github.com/mybatis/generator/releases，

mysql-connector-java-5.1.39-bin.jar的下载地址为：

https://dev.mysql.com/downloads/connector/j/

2、项目自身的generatorConfig.xml文件需要和mybatis-generator-core-1.3.2.jar必须在同一个目录下。比如我的项目中对应的目录和文件为：

操作步骤：

1、generatorConfig.xml的基本配置（例子）为：

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

  PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
  "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
< generatorConfiguration >

    < classPathEntry  location = "E:\jar\mysql-connector-java-5.1.39\mysql-connector-java-5.1.39\mysql-connector-java-5.1.39-bin.jar"  />
< context  id = "MysqlTables"  targetRuntime = "MyBatis3" >

< commentGenerator >
< property  name = "suppressAllComments"  value = "true" />
< property  name = "suppressDate"  value = "true"  />
commentGenerator >

< jdbcConnection  driverClass = "com.mysql.jdbc.Driver"
connectionURL = "jdbc:mysql://127.0.0.1:3306/jycps?useUnicode=true&characterEncoding=UTF-8"
userId = "root"
password = "root" >
jdbcConnection >

< javaTypeResolver  >

< property  name = "forceBigDecimals"  value = "false"  />
javaTypeResolver >

< javaModelGenerator  targetPackage = "com.jiayou.cps.pojo"  targetProject = "D:\workspace\jy_cps\jy_cps\src\main\java" >
< property  name = "enableSubPackages"  value = "true"  />
< property  name = "trimStrings"  value = "true"  />
javaModelGenerator >

< sqlMapGenerator  targetPackage = "sqlmap/test"   targetProject = "D:\workspace\jy_cps\jy_cps\src\main\resources" >
< property  name = "enableSubPackages"  value = "true"  />
sqlMapGenerator >

< javaClientGenerator  type = "XMLMAPPER"  targetPackage = "com.jiayou.cps.dao"   targetProject = "D:\workspace\jy_cps\jy_cps\src\main\java" >
< property  name = "enableSubPackages"  value = "true"  />
javaClientGenerator >

< table  schema = ""  tableName = "tb_test"  domainObjectName = "Test"
   enableCountByExample = "true"
   enableUpdateByExample = "true"
   enableDeleteByExample = "true"
   enableSelectByExample = "true"
   selectByExampleQueryId = "true"  >
table >
context >
generatorConfiguration >

注意事项：

1）上述配置的XML文件千万不要有注释！暂时在我测试时是这个样子的，可能在执行生成实体、DAO、映射文件时会报以下错误：

2）中的mysql-connector-java-5.1.39-bin.jar版本一定要跟你项目中mysql的jar包版本一致，不然在执行生成实体、DAO、映射文件时可能会报下述错误，这个以前在java培训机构学习的时候，老师特意强调过：

3）生成DAO、实体、映射文件的路径要规范好，我自个的配置同上述generatorConfig.xml的配置，我的项目的基本目录结构为：

2、执行生成DAO、实体、映射文件的操作。

1）进入到项目对应generatorConfig.xml文件的路径下。

2）在该目录按住Shift键，右键鼠标选择"在此处打开命令窗口"。

把生成文件的语句“java -jar mybatis-generator-core-1.3.2.jar -configfile generatorConfig.xml -overwrite”复制到DOS命令行中，回车等待生成结果。

一般出现上述图片中的内容就基本上没问题。我的项目中对应生成的文件列表为：

上述标注蓝色勾状的文件是通过上述命令新生成的。

其中新生成的文件内容分别为：

TestMapper 

package  com.jiayou.cps.dao;
import  com.jiayou.cps.pojo.Test;
import  com.jiayou.cps.pojo.TestExample;
import  java.util.List;
import  org.apache.ibatis.annotations.Param;
public  interface  TestMapper {
    int  countByExample(TestExample example);
    int  deleteByExample(TestExample example);
    int  deleteByPrimaryKey(Integer tbId);
    int  insert(Test record);
    int  insertSelective(Test record);
    List selectByExample(TestExample example);
    Test selectByPrimaryKey(Integer tbId);
    int  updateByExampleSelective( @Param ( "record" ) Test record,  @Param ( "example" ) TestExample example);
    int  updateByExample( @Param ( "record" ) Test record,  @Param ( "example" ) TestExample example);
    int  updateByPrimaryKeySelective(Test record);
    int  updateByPrimaryKey(Test record);
}

Test

package  com.jiayou.cps.pojo;
public  class  Test {
    private  Integer tbId;
    private  String tbName;
    public  Integer getTbId() {
        return  tbId;
    }
    public  void  setTbId(Integer tbId) {
        this .tbId = tbId;
    }
    public  String getTbName() {
        return  tbName;
    }
    public  void  setTbName(String tbName) {
        this .tbName = tbName ==  null  ?  null  : tbName.trim();
    }
}

TestExample

package  com.jiayou.cps.pojo;
import  java.util.ArrayList;
import  java.util.List;
import  com.jiayou.cps.mybatis.page.BaseExample;
public  class  TestExample  extends  BaseExample{
    protected  String orderByClause;
    protected  boolean  distinct;
    protected  List oredCriteria;
    public  TestExample() {
        oredCriteria =  new  ArrayList();
    }
    public  void  setOrderByClause(String orderByClause) {
        this .orderByClause = orderByClause;
    }
    public  String getOrderByClause() {
        return  orderByClause;
    }
    public  void  setDistinct( boolean  distinct) {
        this .distinct = distinct;
    }
    public  boolean  isDistinct() {
        return  distinct;
    }
    public  List getOredCriteria() {
        return  oredCriteria;
    }
    public  void  or(Criteria criteria) {
        oredCriteria.add(criteria);
    }
    public  Criteria or() {
        Criteria criteria = createCriteriaInternal();
        oredCriteria.add(criteria);
        return  criteria;
    }
    public  Criteria createCriteria() {
        Criteria criteria = createCriteriaInternal();
        if  (oredCriteria.size() ==  0 ) {
            oredCriteria.add(criteria);
        }
        return  criteria;
    }
    protected  Criteria createCriteriaInternal() {
        Criteria criteria =  new  Criteria();
        return  criteria;
    }
    public  void  clear() {
        oredCriteria.clear();
        orderByClause =  null ;
        distinct =  false ;
    }
    protected  abstract  static  class  GeneratedCriteria {
        protected  List criteria;
        protected  GeneratedCriteria() {
            super ();
            criteria =  new  ArrayList();
        }
        public  boolean  isValid() {
            return  criteria.size() >  0 ;
        }
        public  List getAllCriteria() {
            return  criteria;
        }
        public  List getCriteria() {
            return  criteria;
        }
        protected  void  addCriterion(String condition) {
            if  (condition ==  null ) {
                throw  new  RuntimeException( "Value for condition cannot be null" );
            }
            criteria.add( new  Criterion(condition));
        }
        protected  void  addCriterion(String condition, Object value, String property) {
            if  (value ==  null ) {
                throw  new  RuntimeException( "Value for "  + property +  " cannot be null" );
            }
            criteria.add( new  Criterion(condition, value));
        }
        protected  void  addCriterion(String condition, Object value1, Object value2, String property) {
            if  (value1 ==  null  || value2 ==  null ) {
                throw  new  RuntimeException( "Between values for "  + property +  " cannot be null" );
            }
            criteria.add( new  Criterion(condition, value1, value2));
        }
        public  Criteria andTbIdIsNull() {
            addCriterion( "tb_id is null" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbIdIsNotNull() {
            addCriterion( "tb_id is not null" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbIdEqualTo(Integer value) {
            addCriterion( "tb_id =" , value,  "tbId" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbIdNotEqualTo(Integer value) {
            addCriterion( "tb_id <>" , value,  "tbId" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbIdGreaterThan(Integer value) {
            addCriterion( "tb_id >" , value,  "tbId" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbIdGreaterThanOrEqualTo(Integer value) {
            addCriterion( "tb_id >=" , value,  "tbId" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbIdLessThan(Integer value) {
            addCriterion( "tb_id <" , value,  "tbId" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbIdLessThanOrEqualTo(Integer value) {
            addCriterion( "tb_id <=" , value,  "tbId" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbIdIn(List values) {
            addCriterion( "tb_id in" , values,  "tbId" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbIdNotIn(List values) {
            addCriterion( "tb_id not in" , values,  "tbId" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbIdBetween(Integer value1, Integer value2) {
            addCriterion( "tb_id between" , value1, value2,  "tbId" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbIdNotBetween(Integer value1, Integer value2) {
            addCriterion( "tb_id not between" , value1, value2,  "tbId" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameIsNull() {
            addCriterion( "tb_name is null" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameIsNotNull() {
            addCriterion( "tb_name is not null" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameEqualTo(String value) {
            addCriterion( "tb_name =" , value,  "tbName" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameNotEqualTo(String value) {
            addCriterion( "tb_name <>" , value,  "tbName" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameGreaterThan(String value) {
            addCriterion( "tb_name >" , value,  "tbName" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameGreaterThanOrEqualTo(String value) {
            addCriterion( "tb_name >=" , value,  "tbName" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameLessThan(String value) {
            addCriterion( "tb_name <" , value,  "tbName" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameLessThanOrEqualTo(String value) {
            addCriterion( "tb_name <=" , value,  "tbName" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameLike(String value) {
            addCriterion( "tb_name like" , value,  "tbName" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameNotLike(String value) {
            addCriterion( "tb_name not like" , value,  "tbName" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameIn(List values) {
            addCriterion( "tb_name in" , values,  "tbName" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameNotIn(List values) {
            addCriterion( "tb_name not in" , values,  "tbName" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameBetween(String value1, String value2) {
            addCriterion( "tb_name between" , value1, value2,  "tbName" );
            return  (Criteria)  this ;
        }
        public  Criteria andTbNameNotBetween(String value1, String value2) {
            addCriterion( "tb_name not between" , value1, value2,  "tbName" );
            return  (Criteria)  this ;
        }
    }
    public  static  class  Criteria  extends  GeneratedCriteria {
        protected  Criteria() {
            super ();
        }
    }
    public  static  class  Criterion {
        private  String condition;
        private  Object value;
        private  Object secondValue;