1.概述 Mybatis Generator是一个很强大的代码生成器，代码包含了数据库表对应的实体类、Mapper接口类、Mapper XML文件和Example对象等，这些代码文件中几乎包含了全部的单表操作方法，使用MBG可以极大地方便我们使用MyBatis，减少很多重复工作。
2.配置文件 generatorConfig.xml
<?xml version="1.0" encoding="UTF-8" ?> <!-- 加载数据库驱动 --> <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> 2.1 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；
java模型创建器，是必须要的元素 负责： 1）key类（见context的defaultModelType）； 2）java类； 3）查询类 targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制； targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录
设置一个根对象 如果设置了这个根对象，那么生成的keyClass或者recordClass会继承这个类；在Table的rootClass属性中可以覆盖该选项 注意：如果在key class或者record class中有root class相同的属性，MBG就不会重新生成这些属性了，包括： 1）属性名相同，类型相同，有相同的getter/setter方法；
生成SQL map的XML文件生成器 targetPackage：生成的类要放的包，真实的包受enableSubPackages属性控制； targetProject：目标项目，指定一个存在的目录下，生成的内容会放到指定目录中，如果目录不存在，MBG不会自动建目录
对于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
3 运行MBG
3.1 作为Maven Plugin pom.xml中要加入插件：
<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>maven运行配置如下：
mybatis-generator:generate
结果：
[INFO] Saving file TUserRoleMapper.java [WARNING] Column id, specified as a generated key column in table t_user_role, does not exist in the table. [WARNING] Root class com.enjoylearning.mybatis.entity.BaseEntity cannot be loaded, checking for member overrides is disabled for this class [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 1.773 s [INFO] Finished at: 2018-09-24T20:39:07+08:00 [INFO] ------------------------------------------------------------------------ 需要加入com.enjoylearning.mybatis.entity.BaseEntity。
3.2 在Java中使用XML配置文件 MybatisSpringTest.java
@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(); } }3.3 从命令行使用xml配置文件 准备好指定的文件夹、generatorConfig.xml配置文件和相应的jar包。
执行如下命令
java -Dfile.encoding=UTF-8 -jar mybatis-generator-core-1.3.5.jar -configfile generatorConfig.xml -overwrite参考 1）享学课堂Lison老师笔记作者：王侦链接：https://www.jianshu.com/p/590d372a73fd来源：简书著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
