使用Mybatis generator生成mybatis 动态SQL代码

使用Mybatis generator生成mybatis 动态SQL代码

加入相关依赖

<dependency>
    <groupId>org.mybatis.dynamic-sql</groupId>
    <artifactId>mybatis-dynamic-sql</artifactId>
    <version>1.1.4</version>
</dependency>

<!-- MyBatis 生成器 -->
<dependency>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-core</artifactId>
    <version>1.4.0</version>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.2</version>
</dependency>

在resources下建立mybatis-generator.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>
    <!--Mybatis Generator目前有5种运行模式，分别为：MyBatis3DynamicSql、MyBatis3Kotlin、MyBatis3、MyBatis3Simple、MyBatis3DynamicSqlV1。-->
    <context id="MySql" targetRuntime="MyBatis3DynamicSql">
        <commentGenerator>
            <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true" />
        </commentGenerator>
        <jdbcConnection
                connectionURL="jdbc:mysql://127.0.0.1:3306/mybatisdynamic?serverTimezone=UTC&amp;useSSL=false"
                driverClass="com.mysql.cj.jdbc.Driver"
                userId="root"
                password="root"/>

        <javaTypeResolver>
            <!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer， 为 true时把JDBC DECIMAL
            和 NUMERIC 类型解析为java.math.BigDecimal -->
            <property name="forceBigDecimals" value="false" />
            <!--是否试用jdk8时间类-->
            <property name="useJSR310Types" value="true"/>
        </javaTypeResolver>

        <!-- targetProject:生成PO类的位置 -->
        <javaModelGenerator
                targetPackage="com.jun.mybatisdynamic.entity"
                targetProject="src/main/java">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>

        <!-- targetProject:mapper映射文件生成的位置 -->
        <sqlMapGenerator targetPackage="mybatis.mapping"
                         targetProject="src/main/resources">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>

        <!-- targetPackage：mapper接口生成的位置 -->
        <javaClientGenerator
                targetPackage="com.jun.mybatisdynamic.mapper"
                targetProject="src/main/java" type="XMLMAPPER">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>

        <!--生成全部表tableName设为%-->
<!--        <table tableName="%"/>-->

        <!-- 指定数据库表
  schema:数据库的schema,可以使用SQL通配符匹配。如果设置了该值，生成SQL的表名会变成如schema.tableName的形式。
  domainObjectName:生成对象的基本名称。如果没有指定，MBG会自动根据表名来生成名称。
  -->
        <!--<table schema="" tableName="" domainObjectName=""/>-->
        <table schema="mybatisdynamic" tableName="student"></table>
    </context>
</generatorConfiguration>

需要修改的地方：

运行时生成代码的模式 targetRuntime ： MyBatis3DynamicSql

因为我是需要生成mybatis dynamic sql 的代码文件，所以这里选择的是 MyBatis3DynamicSql，可以根据自己需要选择响应的模式。

数据库连接信息

根据自己的数据库连接地址，账号，密码进行修改。

修改生成文件的位置

先把对应的包名建好，再修改。

修改需要生成的数据库和表：

生成全部表tableName如果设为%时，将会根据所有表生成。

在java下新建util包和MybatisGenerator.java文件

package com.jun.mybatisdynamic.util;

/**
 * @Author XiaoJun
 * @Description TODO
 * @Date 下午 2021/9/11 6:17
 */
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.IOException;
import java.io.InputStream;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;

public class MybatisGenerator {
    public static void main(String[] args) throws IOException, XMLParserException, InvalidConfigurationException, SQLException, InterruptedException {
        //MBG 执行过程中的警告信息
        List<String> warnings = new ArrayList<>();
        //读取我们的 MBG 配置文件
        InputStream is = MybatisGenerator.class.getResourceAsStream("/mybatis/generatorConfig.xml");
        ConfigurationParser cp = new ConfigurationParser(warnings);
        Configuration config = cp.parseConfiguration(is);
        is.close();
        //当生成的代码重复时，不要覆盖原代码
        DefaultShellCallback callback = new DefaultShellCallback(false);
        //创建 MBG
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        //执行生成代码
        myBatisGenerator.generate(null);
        //输出警告信息
        for (String warning : warnings) {
            System.out.println(warning);
        }
    }
}

遇到的问题

问题一：targetRuntime in context mybatis_model is invalid 异常问题

Connected to the target VM, address: '127.0.0.1:54553', transport: 'socket'
Exception in thread "main" org.mybatis.generator.exception.InvalidConfigurationException: targetRuntime in context MySql is invalid
	at org.mybatis.generator.config.Configuration.validate(Configuration.java:83)
	at org.mybatis.generator.api.MyBatisGenerator.<init>(MyBatisGenerator.java:114)
	at com.jun.springboot.util.MybatisGenerator.main(MybatisGenerator.java:33)
Disconnected from the target VM, address: '127.0.0.1:54553', transport: 'socket'

Process finished with exit code 1

问题原因：识别不了mybatis-generator.xml文件中配置的 targetRuntime=“MyBatis3DynamicSql”

网上说 将MyBatis3DynamicSql改为MyBatis3DynamicSQL 就可以了。

改完后还报错，猜想应该是 依赖版本问题，之前是 1.3.2 ,改成 1.4.0后就好了。
经验之谈：一般遇到这种固定的配置项识别不了而别人配置的没问题时，很可能都是由版本问题。

org.mybatis.generator mybatis-generator-core 1.4.0 true

问题二：references invalid table(s) or column(s) or function(s) or definer/invoker

Exception in thread "main" java.sql.SQLException: View 'worksheet.view_process_business_object' references invalid table(s) or column(s) or function(s) or definer/invoker of view lack rights to use them
	at com.mysql.cj.jdbc.exceptions.SQLError.createSQLException(SQLError.java:129)
	at com.mysql.cj.jdbc.exceptions.SQLError.createSQLException(SQLError.java:97)
	at com.mysql.cj.jdbc.exceptions.SQLExceptionsMapping.translateException(SQLExceptionsMapping.java:122)
	at com.mysql.cj.jdbc.StatementImpl.executeQuery(StatementImpl.java:1218)
	at com.mysql.cj.jdbc.DatabaseMetaData$2.forEach(DatabaseMetaData.java:2094)
	at com.mysql.cj.jdbc.DatabaseMetaData$2.forEach(DatabaseMetaData.java:2023)
	at com.mysql.cj.jdbc.IterateBlock.doForAll(IterateBlock.java:56)
	at com.mysql.cj.jdbc.DatabaseMetaData.getColumns(DatabaseMetaData.java:2199)
	at org.mybatis.generator.internal.db.DatabaseIntrospector.getColumns(DatabaseIntrospector.java:504)
	at org.mybatis.generator.internal.db.DatabaseIntrospector.introspectTables(DatabaseIntrospector.java:176)
	at org.mybatis.generator.config.Context.introspectTables(Context.java:409)
	at org.mybatis.generator.api.MyBatisGenerator.generate(MyBatisGenerator.java:250)
	at org.mybatis.generator.api.MyBatisGenerator.generate(MyBatisGenerator.java:132)
	at com.jun.springboot.util.MybatisGenerator.main(MybatisGenerator.java:35)

Process finished with exit code 1

问题原因：worksheet库下的视图view_process_business_object是非法的不被识别的。

很奇怪，我设置的连接数据库是 mybatisdynamic 库，为啥会连接到我另外的worksheet库呢？

重新检查看了下 mybatis-generator.xml 配置文件，地址没有连接错。

这时候往下检查时候，发现了在指定数据库和表的时候：

我配置的是：

%表示根据所有表进行代码生成。

我尝试改了下这里，指定具体的库和表：

<table schema="mybatisdynamic" tableName="student"></table>
然后重新执行下，ok了。

这里也需要指定下schema即数据库的名字，如果不指定直接用%的话，将连接连接到所有的库进行代码的生成（不知道其他人是否也遇到这样的问题）。