MyBatis逆向工程Generator和IDE Plugin

Posted 2021-11-24 花伤情犹在

逆向工程

mybatis逆向工程的作用是根据数据库里的表结构自动生成实体类，映射文件，和接口。
和hibernate的自动建表相反。

逆向工程需要的jar包：

1. mybatis-3.2.3.jar
2. mybatis-generator-core-1.3.2.jar
3. mysql-connector-java-8.0.27-bin.jar
4. log4j-1.2.17.jar

如果是Maven项目可以在pom文件中导入依赖：

<!--mysbatis-->
<dependency>
	<groupId>org.mybatis</groupId>
	<artifactId>mybatis</artifactId>
	<version>3.5.7</version>
</dependency>
<!--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>8.0.27</version>
</dependency>
<!--log4j-->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

配置log4j

log4j.properties

log4j.rootLogger=DEBUG, Console
#Console
log4j.appender.Console=org.apache.log4j.ConsoleAppender
log4j.appender.Console.layout=org.apache.log4j.PatternLayout
log4j.appender.Console.layout.ConversionPattern=%d [%t] %-5p [%c] - %m%n
log4j.logger.java.sql.ResultSet=INFO
log4j.logger.org.apache=INFO
log4j.logger.java.sql.Connection=DEBUG
log4j.logger.java.sql.Statement=DEBUG
log4j.logger.java.sql.PreparedStatement=DEBUG

另外加上一个启动类GeneratorSqlmap和一个稍微改动的配置文件 -generatorConfig,xml文件

使用Generator生成代码

GeneratorSqlmap启动类

---

java代码是通用的，只要修改你的配置文件的路径即可：

public class GeneratorSqlmap {
 public void generator() throws Exception{

    List<String> warnings = new ArrayList<String>();
    boolean overwrite = true;
    //指定 逆向工程配置文件
    File configFile = new File("generatorConfig.xml");
    ConfigurationParser cp = new ConfigurationParser(warnings);
    Configuration config = cp.parseConfiguration(configFile);
    DefaultShellCallback callback = new DefaultShellCallback(overwrite);
    MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config,
            callback, warnings);
    myBatisGenerator.generate(null);

} 
public static void main(String[] args) throws Exception {
    try {
        GeneratorSqlmap generatorSqlmap = new GeneratorSqlmap();
        generatorSqlmap.generator();
    } catch (Exception e) {
        e.printStackTrace();
    }
  }
}

配置文件 generatorConfig

MySQL8.0以上版本需要在"generatorConfig.xml"中的jdbcConnectio标签中添加以下代码：

 <property name="nullCatalogMeansCurrent" value="true"/>

否则会遇到此问题

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>
    <context id="testTables" targetRuntime="MyBatis3">
        <commentGenerator>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!--数据库连接的信息：驱动类、连接地址、用户名、密码 -->
        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/demo1?useSSL=false&amp;serverTimezone=UTC&amp;allowPublicKeyRetrieval=true"
                        userId="root"
                        password="root">
                        
        </jdbcConnection>
        <!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，为 true时把JDBC DECIMAL 和 
			NUMERIC 类型解析为java.math.BigDecimal -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- targetProject:生成PO类的位置 -->
        <javaModelGenerator targetPackage="com.demo.pojo"
                            targetProject=".\\src">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false"/>
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- targetProject:mapper映射文件生成的位置 -->
        <sqlMapGenerator targetPackage="com.demo.mapper"
                         targetProject=".\\src">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>
        <!-- targetPackage：mapper接口生成的位置 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.demo.mapper"
                             targetProject=".\\src">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>
        <!-- 指定数据库表 -->
        <table schema="" tableName="mysql"></table>
    </context>
</generatorConfiguration>

需要改动的地方有：

<jdbcConnection>	自定义数据库名，用户名和密码
<javaModelGenerator>	实体类路径。没有会新建
<sqlMapGenerator >	映射文件的路径
<javaClientGenerator >	接口的路径
<table>	需要映射的数据库的表名

注意：映射文件一般与接口的路径一致

数据据表：

运行效果：

项目结构：

实体类：

接口：

映射文件：

这个就有点多，足足快200多行了

插件启动maven-generator

如果使用maven项目就可以省去编写Java启动类，使用maven插件和配置文件.xml即可
在pow中加上如下代码来添加插件：

<plugin>
  <groupId>org.mybatis.generator</groupId>
  <artifactId>mybatis-generator-maven-plugin</artifactId>
  <version>1.3.2</version>
  <configuration>
      <verbose>true</verbose>
      <overwrite>true</overwrite>
      <configurationFile>${project.basedir}/generatorConfig.xml</configurationFile>
  </configuration>
  <dependencies>
      <dependency>
          <groupId>mysql</groupId>
          <artifactId>mysql-connector-java</artifactId>
          <version>8.0.27</version>
      </dependency>
  </dependencies>
</plugin>

配置完generatorConfig，找到IDE 上的该插件点击运行，效果是一样的：

注意事项

---

1.修改配置文件时，如果不想生成example使用

<context id="MysqlContext" targetRuntime="MyBatis3Simple" defaultModelType="flat">

代替

<context id="testTables" targetRuntime="MyBatis3"> 

2.重构时，多次运行逆向工程，除了.java文件是覆盖的，.xml文件都是累加的。所以，要重构就的将已存在的映射.xml文件删除或者清理成下面的样子：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" 
"http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="" >

</mapper>

3 .如果使用maven插件，<plugin>外层不可以用<pluginManagement>标签包裹，否则插件不显示。

4.如果使用maven插件,里面的<artifactId>mysql-connector-java</artifactId>不能省，即使上面配置了也不行，不然就告你驱动找不到!
除了这样配置，还可以在generatorConfig.xml里面配置驱动jar的路径，
如：<classPathEntry location="d:\\mshu\\mysql-connector-java-5.1.6-bin.jar"/>
哪个方便就用哪个吧。

---

IDE Plugin之Free MyBatis plugin

free-idea-mybais是一款增强idea对mybatis支持的插件，主要功能如下：

• 生成mapper xml文件
• 快速从代码跳转到mapper及从mapper返回代码
• mybatis自动补全及语法错误提示
• 集成mybatis generator gui界面
• 根据数据库注解，生成swagger mode注解
  

---

使用Free MyBatis plugin插件生成代码

安装Free MyBatis plugin插件

由于Free MyBatis plugin插件依赖于idea，需要在先在idea里面先连接到数据库：

选需要生成代码的数据库，点击generator：

功能面板

点击ok即可自动生成

pojo：
mapper接口：

mapper映射文件：