安装Mybatis-Generator插件
Mybatis-Generator是一个用于自动生成dao层接口、pojo以及mapper xml的一个Mybatis插件，该插件有三种用法：命令行运行、Eclipse插件、maven插件。个人觉得maven插件最方便，可以在eclipse/intellij idea等ide上通用，本文也是介绍在maven中配置并使用这个插件。
现在我mysql中有一个school数据库，该数据库有student、cls两张表格，表结构如下：
student表：
cls表：
首先在工程中的pom.xml文件，配置如下依赖及插件：
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 | <dependencies> <!-- MyBatis Generator --> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.4.0</version> </dependency> <!-- MySQL驱动包依赖 --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.49</version> </dependency></dependencies><build> <finalName>mybatis-05</finalName> <plugins> <!-- Mybatis-Generator插件，自动生成代码 --> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.4.0</version> <configuration> <configurationFile>${project.basedir}/src/main/resources/generatorConfig.xml</configurationFile> <verbose>true</verbose> <overwrite>true</overwrite> </configuration> </plugin> </plugins></build> |
在工程的resources目录下，创建一个属性配置文件：datasource.properties，配置内容如下：
1 2 3 4 5 | db.driverLocation=E:/MavenClassFile/mysql/mysql-connector-java/5.1.49/mysql-connector-java-5.1.49.jar // MySQL驱动包的本地路径，这个jar包的版本要和pom.xml里配置的版本一致db.driverClassName=com.mysql.jdbc.Driver // 驱动类的包名db.url=jdbc:mysql://127.0.0.1:3306/school?characterEncoding=utf8 // 连接数据库的urldb.username=root // 用户名db.password=123456 // 密码 |
然后继续在resources目录下，创建Mybatis-Generator插件的配置文件：generatorConfig.xml，配置内容如下：
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 | <?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="datasource.properties"/> <!--指定特定数据库的jdbc驱动jar包的位置--> <classPathEntry location="${db.driverLocation}"/> <!-- 选择运行的mybatis版本 --> <context id="default" targetRuntime="MyBatis3"> <!-- optional，旨在创建class时，对注释进行控制 --> <commentGenerator> <property name="suppressDate" value="true"/> <property name="suppressAllComments" value="true"/> </commentGenerator> <!--jdbc的数据库连接 --> <jdbcConnection driverClass="${db.driverClassName}" connectionURL="${db.url}" userId="${db.username}" password="${db.password}"> </jdbcConnection> <!-- 非必需，类型处理器，在数据库类型和Java类型之间的转换控制--> <javaTypeResolver> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类 targetPackage 指定生成的model生成所在的包名 targetProject 指定在该项目下所在的路径 --> <javaModelGenerator targetPackage="org.zero01.pojo" targetProject="./src/main/java"> <!-- 是否允许子包，即targetPackage.schemaName.tableName --> <property name="enableSubPackages" value="false"/> <!-- 是否对model添加 构造函数 --> <property name="constructorBased" value="true"/> <!-- 是否对类CHAR类型的列的数据进行trim操作 --> <property name="trimStrings" value="true"/> <!-- 建立的Model对象是否不可改变 即生成的Model对象不会有 setter方法，只有构造方法 --> <property name="immutable" value="false"/> </javaModelGenerator> <!--mapper xml映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 --> <sqlMapGenerator targetPackage="mappers" targetProject="./src/main/resources"> <property name="enableSubPackages" value="false"/> </sqlMapGenerator> <!-- 客户端代码，生成易于使用的针对Model对象和XML配置文件 的代码 type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象 type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象 type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口 --> <!-- targetPackage：dao层mapper接口生成的位置 --> <javaClientGenerator type="XMLMAPPER" targetPackage="org.zero01.dao" targetProject="./src/main/java"> <!-- enableSubPackages:是否让schema作为包的后缀 --> <property name="enableSubPackages" value="false" /> </javaClientGenerator> <!-- 配置表格映射 --> <table tableName="student" domainObjectName="Student" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/> <table tableName="cls" domainObjectName="Cls" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/> </context></generatorConfiguration> |
完成以上配置之后，点击右边的Maven Projects窗口，双击插件进行运行：
运行成功：
生成的dao层接口、pojo类以及mapper xml文件如下：
有了这个自动生成的插件之后，就不需要自己手动去创建dao接口、pojo类以及mapper xml文件了，大大提高了开发效率。
参考：
[博客园]利用mybatis-generator自动生成代码
[简书]使用Maven插件mybatis-generator生成代码配置
IDEA mybatis-generator:generate 代码自动生成
Mybatis-Generator使用笔记
1. 如果在IDEA右边的Maven Projects窗口，没有出现“mybatis-generator”插件选项，我们也可以直接使用如下命令行（注意：在项目的根目录下执行）：
1 | mvn mybatis-generator:generate -e |
这里加了 "-e"选项 是为了让该插件输出详细信息，帮助我们定位问题。
如果不想每次都输命令行，也可以把它做成IDEA的菜单按钮模式，操作步骤如下：
在intelli IDEA 的菜单栏，点击 Run -> Edit Configurations，点击弹出窗口左上角的+号，新增Maven，为当前配置配置一个名称，这里命名为"generator",然后在"Command line"选项中输入"mybatis-generator:generate -e"。
2. 特别注意：由于我们在 pom.xml 文件中，配置该插件为：<overwrite>true</overwrite>，即会把同名的文件给覆盖掉。
为防止误操作，模型文件等被覆盖，某个表的相关代码已经生成后，就把它在generatorConfig.xml 中的表格映射给注释掉，如：
1 2 | <!-- 配置表格映射 --><!-- <table tableName="student" domainObjectName="Student" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/> --> |
3. 工作中的generatorConfig.xml备份参考：
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 | <?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="D:\java\repository\mysql\mysql-connector-java\5.1.29\mysql-connector-java-5.1.29.jar"/> <context id="DB2Tables" targetRuntime="MyBatis3"> <commentGenerator> <property name="javaFileEncoding" value="UTF-8"/> <!-- 是否去除自动生成的注释 true：是 ： false:否 --> <property name="suppressAllComments" value="true"/> <property name="suppressDate" value="false"/> </commentGenerator> <!--MySQL数据库连接URL，用户名、密码 --> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3306/java_web?characterEncoding=utf8" userId="root" password="123456"/> <javaTypeResolver> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <!-- 生成Model实体类文件位置 --> <javaModelGenerator targetPackage="com.wenjianbao.entity" targetProject="src/main/java"> <property name="enableSubPackages" value="false"/> <property name="trimStrings" value="true"/> </javaModelGenerator> <!-- 生成Mapper.xml配置文件位置 --> <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources"> <property name="enableSubPackages" value="false"/> </sqlMapGenerator> <!-- 生成Mapper接口文件位置 --> <javaClientGenerator type="XMLMAPPER" targetPackage="com.wenjianbao.mapper" targetProject="src/main/java"> <property name="enableSubPackages" value="false"/> </javaClientGenerator> <!-- 需要生成的实体类对应的表名，多个实体类复制多份该配置即可 --> <table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"> </table> </context></generatorConfiguration> |