您的位置: 首页  >  文章  >  学习笔记——Spring Boot（12）MyBatis逆向生成

学习笔记——Spring Boot（12）MyBatis逆向生成

分类: 文章 • 2024-05-22 19:15:40

MyBatis逆向生成工具generator

      我之前在使用持久层框架的时候，为了不使用xml的方法，通常都是直接使用spring data jpa或者是使用mybatis的注解形式（这两种方法我都在我的博客Spring Boot实战——数据交互页（涉及数据库）中有说明），但是如果我们编写的工程量变大的话，又或者在企业中编写企业级程序的时候，我们都会使用mybatis的xml形式，因为该形式下我们在xml文件中直接写sql语句会更为方便，而且程序的灵活性也更高。

   而我对写xml语句并不熟悉，而且当数据库多而关系复杂的时候，写mybatis便会复杂很多，所以这时候我们便可以使用mybatis逆向生成工具generator，所谓的逆向生成就是我们只要设计好数据库以后，我们引入generator即可自动生成我们所需要的实体类，mapper类和xml文件，这时候我们就不用再去写了（人都是越来越懒的（^-^））

 

  网上使用generator都是需要下载驱动jar包导入才可以使用，但我查阅了一下其他方法，在github上发现有更为简单的方法：

    https://github.com/abel533/MyBatis-Spring-Boot

  大家可以上该github上查看。

 

  下面我便说这个方法，首先我们肯定是要先导入依赖（pom.xml）:

<!--mybatis-->
<dependency>
     <groupId>org.mybatis.spring.boot</groupId>
     <artifactId>mybatis-spring-boot-starter</artifactId>
     <version>1.3.1</version>
</dependency>
<dependency>
      <groupId>org.mybatis.generator</groupId>
      <artifactId>mybatis-generator-core</artifactId>
      <version>1.3.2</version>
      <scope>compile</scope>
      <optional>true</optional>
</dependency>

<!--mapper-->
<dependency>
      <groupId>tk.mybatis</groupId>
      <artifactId>mapper-spring-boot-starter</artifactId>
      <version>1.2.4</version>
</dependency>

<!--pagehelper-->
<dependency>
      <groupId>com.github.pagehelper</groupId>
      <artifactId>pagehelper-spring-boot-starter</artifactId>
      <version>1.2.3</version>
 </dependency>

 其中pageheleper是分页插件的导入，并不是必须的。

 

  导入完依赖后，我们先看看我的程序的目录：

学习笔记——Spring Boot（12）MyBatis逆向生成

在程序中，我们要生成实体类，mapper类和xml文件，这时候我们先建立这三个文件夹（分别是java文件中的entity文件夹和mapper文件夹，resoruces文件中的mapper文件夹），然后我们通过generatorConfig.xml，MyMapper类和GeneratorDisplay类来生成我们所需的（注意我放generatorConfig.xml的位置）。

 

当然我们要先在配置文件（application.properties）中配置部分设置:

#mybatis逆向生成时候解决部分配置问题
restart.include.mapper=/mapper-[\\w-\\.]+jar
restart.include.pagehelper=/pagehelper-[\\w-\\.]+jar

#数据库设置
spring.datasource.url=jdbc:mysql://localhost:3306/user
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

#mybatis设置
mybatis.type-aliases-package=com.xie.generator.entity
mybatis.mapper-locations=classpath:mapper/*.xml

#mappper
#mappers 多个接口时逗号隔开
mapper.mappers=com.xie.generator.untils.MyMapper
mapper.not-empty=false
mapper.identity=MYSQL

#pagehelper
pagehelper.helperDialect=mysql
pagehelper.reasonable=true
pagehelper.supportMethodsArguments=true
pagehelper.params=count=countSql

其中（1）第一个配置是在刚刚github上有说明，解决部分问题所需配置；（2）数据库设置中每个人的ip地址，数据库名，密码不同设置不同；（3）在mybatis设置中，第一个包是指生成的实体类放在的包下，我设置的是在entity包下，不同人也可以设置不同，而第二个是指放xml文件位置，一般都是设置在resources下的mapper包下，所以也不用做太多改变；（4）在mapper设置时候我们要指明MyMapper该类的位置，不同人不同编写；（5）分页插件根据自己需要编写

 

然后我们先看MyMapper类（直接复制即可）：

import tk.mybatis.mapper.common.Mapper;
import tk.mybatis.mapper.common.MySqlMapper;

public interface MyMapper<T> extends Mapper<T>, MySqlMapper<T> {
    //TODO
    //FIXME 特别注意，该接口不能被扫描到，否则会出错
}

 

再看generatorConfig.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.jdbc.Driver"
                connectionURL="jdbc:mysql://localhost:3306/user"
                userId="root"
                password="123456">
        </jdbcConnection>
        <!-- 默认false，把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer，为 true时把JDBC DECIMAL 和
            NUMERIC 类型解析为java.math.BigDecimal -->
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

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

    </context>
</generatorConfiguration>

在<context id="testTables" targetRuntime="MyBatis3">中注明的是生成的xml文件形式，该方法生成的xml文件较为复杂，可以改成以下形式生成的xml文件更为简单：

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

而在数据库连接信息中大伙也要改为你自己的配置；下面配置是有关生成文件位置：

        <!-- targetProject:生成entity类的位置 -->
        <javaModelGenerator
                targetPackage="com.xie.generator.entity"
                targetProject="src/main/java">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true" />
        </javaModelGenerator>
        <!-- targetProject:mapper映射文件生成的位置 -->
        <sqlMapGenerator
                targetPackage="mapper"
                targetProject="src/main/resources">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
        </sqlMapGenerator>
        <!-- targetPackage：mapper接口生成的位置 -->
        <javaClientGenerator
                type="XMLMAPPER"
                targetPackage="com.xie.generator.mapper"
                targetProject="src/main/java">
            <!-- enableSubPackages:是否让schema作为包的后缀 -->
            <property name="enableSubPackages" value="false" />
        </javaClientGenerator>

  在以上的配置中，是分别说明了生成的实体类，mapper类，xml文件存放的位置，也需要根据自己文件名修改，至于其他配置我都有注解说明其中含义。

  而在<table schema="" tableName="user"></table>是指明了我们需要生成的数据库表，不限于一个表，我们可以将设计好的数据库一个个填写上去即可：

<table tableName="表1"></table>
<table tableName="表2"></table>
<table tableName="表3"></table>
<table tableName="表4"></table>
<table tableName="表5"></table>
           ...

 

  下面是编写启动类generatorDisplay（运行该类即可生成所需）：

import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

public class GeneratorDisplay {

    public void generator() throws Exception{

        List<String> warnings = new ArrayList<String>();
        boolean overwrite = true;
        //指定 ****配置文件
        File configFile = new File("src/main/resources/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 {
            GeneratorDisplay generatorSqlmap = new GeneratorDisplay();
            generatorSqlmap.generator();
        } catch (Exception e) {
            e.printStackTrace();
        }

    }
}

  其中，由于我将generatorConfig.xml文件放置resources文件下，所以file设置是如此。

 

  然后直接运行该启动类generatorDisplay便可以得到我们所需：

学习笔记——Spring Boot（12）MyBatis逆向生成

 

而要使用这些mapper，我们需要在类GeneratorApplication中加入：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
//该mapperscan是来自tk包下
import tk.mybatis.spring.annotation.MapperScan;

//扫描com.xie.generator.mapper下的包
@MapperScan(basePackages = "com.xie.generator.mapper")
@SpringBootApplication
public class GeneratorApplication {

    public static void main(String[] args) {
        SpringApplication.run(GeneratorApplication.class, args);
    }

}

 

注意：我们可以将此作为一个工具项目，当我们需要生成mybatis时，我们仅需要通过该工具项目生成所需的文件，拷贝到我们的项目中即可，而不需要每次要生成都重新写这几个类和xml。而要注意的是复制的时候出来实体类，mapper类，xml文件以外，还要将MyMapper复制，同时在自己的项目的启动类中加入@MapperScan(basePackages = "com.xxx.xxx.mapper")

 

遇到的问题：

（1）

学习笔记——Spring Boot（12）MyBatis逆向生成

中http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd标红。

解决方法：File->Settings：

学习笔记——Spring Boot（12）MyBatis逆向生成

（2）Loading class `com.mysql.jdbc.Driver'. This is deprecated. The new driver class is `com.mysql.cj.jdbc.Driver'. The driver is automatically registered via the SPI and manual loading of the driver class is generally unnecessary.

由于数据库版本问题，我们需要在generatorConfig.xml中将原本

<jdbcConnection
    driverClass="com.mysql.jdbc.Driver"
    connectionURL="jdbc:mysql://localhost:3306/user"
    userId="root"
    password="123456">
</jdbcConnection>

com.mysql.jdbc.Driver修改成com.mysql.cj.jdbc.Driver

（3）ava.sql.SQLException: The server time zone value 'Öйú±ê׼ʱ¼ä' is unrecognized or represents more than one time zone. You must configure either the server or JDBC driver (via the serverTimezone configuration property) to use a more specifc time zone value if you want to utilize time zone support.

由于系统时间出现问题（也是版本提高后出现的问题），这时候我们也要将generatorConfig.xml中：

<jdbcConnection
    driverClass="com.mysql.jdbc.Driver"
    connectionURL="jdbc:mysql://localhost:3306/user"
    userId="root"
    password="123456">
</jdbcConnection>

jdbc:mysql://localhost:3306/user后添加?serverTimezone=GMT%2B8即可。

 

 

 

相关推荐