SpringBoot整合mybatis-generator-maven-plugin的方法

更新時(shí)間：2020年11月09日 09:45:20 作者：MrK啊

這篇文章主要介紹了SpringBoot整合mybatis-generator-maven-plugin,本文通過實(shí)例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

前言:

SpringBoot版本 : 2.2.6

mybatis-generator-maven-plugin版本: 1.4.0

plugin 使用 mysql版本: 5.1.47

本次主要記錄日和使用該插件自動生成pojo mapper xml文件(單表)

1 創(chuàng)建SpringBoot工程

這里不做具體記錄,創(chuàng)建工程往常教程很多,

下面貼出重要文件和注意事項(xiàng)

1.1 pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>show.mrkay</groupId>
  <artifactId>boot-mybatis-generator</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.6.RELEASE</version>
  </parent>
  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
  </properties>
  <dependencies>
    <!--springboot-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
    </dependency>
    <!--mysql-->
    <dependency>
      <groupId>mysql</groupId>
      <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <dependency>
      <groupId>com.alibaba</groupId>
      <artifactId>druid-spring-boot-starter</artifactId>
      <version>1.1.9</version>
    </dependency>
    <!--mybatis-->
    <dependency>
      <groupId>org.mybatis.spring.boot</groupId>
      <artifactId>mybatis-spring-boot-starter</artifactId>
      <version>2.1.0</version>
    </dependency>
    <!--日志-->
    <!--因?yàn)槭腔贏OP實(shí)現(xiàn)的所以這里必須要調(diào)入aop-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>
    <!--門面-->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>jcl-over-slf4j</artifactId>
    </dependency>
    <!--log4j12-->
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-log4j12</artifactId>
    </dependency>
  </dependencies>
  <build>
    <!--插件-->
    <plugins>
      <!--springboot的maven插件-->
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
      <plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.4.0</version>
        <!--插件設(shè)置-->
        <configuration>
          <!--允許移動生成的文件-->
          <verbose>true</verbose>
          <!--啟用覆蓋-->
          <overwrite>true</overwrite>
          <!--自動生成配置 如果名字是generatorConfig.xml可以省略配置-->
          <!--<configurationFile>src/main/resources/generatorConfig.xml</configurationFile>-->
        </configuration>
        <dependencies>
          <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.47</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
</project>

1.2 application.yml

server:
 port: 8080
spring:
 datasource:
  driver-class-name: com.mysql.jdbc.Driver
  url: jdbc:mysql://localhost:3306/generaltor?useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT
  username: root
  password: lk0313
  druid:
   db-type: com.alibaba.druid.pool.DruidDataSource
#  下面不配置就是采用默認(rèn)配置
#  filters: stat
#  maxActive: 20
#  initialSize: 1
#  maxWait: 60000
#  minIdle: 1
#  timeBetweenEvictionRunsMillis: 60000
#  minEvictableIdleTimeMillis: 300000
#  validationQuery: select 'x'
#  testWhileIdle: true
#  testOnBorrow: false
#  testOnReturn: false
#  poolPreparedStatements: true
#  maxOpenPreparedStatements: 20
mybatis:
# 該配置項(xiàng)配置了MyBatis配置文件保存路徑
 mapper-locations: classpath*:show/makey/dao/*.xml
# 配置掃描對應(yīng)實(shí)體所在包,將mapper的實(shí)現(xiàn)類注入容器我們在啟動器類上加了@MapperScan注解這里就不需要了
logging:
 file:
  path: /logs
# type-aliases-package: show.mrkay.dao

1.3 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="DB2Tables" targetRuntime="MyBatis3">
    <commentGenerator>
      <!-- 是否生成注釋代時(shí)間戳-->
      <property name="suppressDate" value="true"/>
      <!-- 是否去除自動生成的注釋 true：是 ： false:否 -->
      <property name="suppressAllComments" value="true"/>
    </commentGenerator>
    <!--數(shù)據(jù)庫鏈接地址賬號密碼-->
    <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3306/generaltor?serverTimezone=Asia/Shanghai" userId="root" password="lk0313">
    </jdbcConnection>
    <javaTypeResolver>
      <!--該屬性可以控制是否強(qiáng)制DECIMAL和NUMERIC類型的字段轉(zhuǎn)換為Java類型的java.math.BigDecimal,默認(rèn)值為false，一般不需要配置。-->
      <property name="forceBigDecimals" value="false"/>
    </javaTypeResolver>
    <!--生成Model類存放位置-->
    <javaModelGenerator targetPackage="show.mrkay.pojo" targetProject="src/main/java">
      <!--enableSubPackages:如果true，MBG會根據(jù)catalog和schema來生成子包。如果false就會直接用targetPackage屬性。默認(rèn)為false。-->
      <property name="enableSubPackages" value="true"/>
      <!--trimStrings:是否對數(shù)據(jù)庫查詢結(jié)果進(jìn)行trim操作，如果設(shè)置為true就會生成類似這樣public void setUsername(String username) {this.username = username == null ? null : username.trim();}的setter方法。默認(rèn)值為false。-->
      <property name="trimStrings" value="true"/>
    </javaModelGenerator>
    <!--生成映射xml文件存放位置-->
    <sqlMapGenerator targetPackage="show.mrkay.dao" targetProject="src/main/resources/">
      <property name="enableSubPackages" value="true"/>
    </sqlMapGenerator>
    <!--生成Dao類存放位置(*Mapper.java)-->
    <!-- 客戶端代碼，生成易于使用的針對Model對象和XML配置文件 的代碼
        type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper對象
        type="MIXEDMAPPER",生成基于注解的Java Model 和相應(yīng)的Mapper對象
        type="XMLMAPPER",生成SQLMap XML文件和獨(dú)立的Mapper接口
    -->
    <javaClientGenerator type="XMLMAPPER" targetPackage="show.mrkay.dao" targetProject="src/main/java">
      <property name="enableSubPackages" value="true"/>
    </javaClientGenerator>
    <!--生成對應(yīng)表及類名-->
    <table tableName="student" domainObjectName="Student" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
      <!--useActualColumnNames:如果設(shè)置為true,那么MBG會使用從數(shù)據(jù)庫元數(shù)據(jù)獲取的列名作為生成的實(shí)體對象的屬性。 如果為false(默認(rèn)值)，MGB將會嘗試將返回的名稱轉(zhuǎn)換為駝峰形式。 在這兩種情況下，可以通過 元素顯示指定，在這種情況下將會忽略這個（useActualColumnNames）屬性。-->
      <property name="useActualColumnNames" value="true"/>
      <!-- 數(shù)據(jù)庫表主鍵 -->
      <generatedKey column="id" sqlStatement="Mysql" identity="true" />
    </table>
  </context>
</generatorConfiguration>

步驟:

1 導(dǎo)入依賴

2 創(chuàng)建*generaltorConfig.xml配置文件

3 配置yml配置文件

注意:

pom中g(shù)eneralto-maven-plugs中必須指定mysql驅(qū)動,并且明確版本

generaltorConfig.xml中的
標(biāo)簽中需要指定tableName和生成的實(shí)體名字

2 創(chuàng)建數(shù)據(jù)庫表

-- 建表語句:
/*
SQLyog Enterprise v12.09 (64 bit)
MySQL - 5.5.40 : Database - generaltor
*********************************************************************
*/


/*!40101 SET NAMES utf8 */;

/*!40101 SET SQL_MODE=''*/;

/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
CREATE DATABASE /*!32312 IF NOT EXISTS*/`generaltor` /*!40100 DEFAULT CHARACTER SET utf8 */;

/*Table structure for table `student` */

DROP TABLE IF EXISTS `student`;

CREATE TABLE `student` (
 `id` int(32) NOT NULL AUTO_INCREMENT,
 `name` varchar(15) DEFAULT NULL,
 `sex` varchar(2) DEFAULT NULL,
 `phone` int(15) DEFAULT NULL,
 PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

/*Data for the table `student` */

insert into `student`(`id`,`name`,`sex`,`phone`) values (1,'lk','男',12345578);

/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;

3 運(yùn)行

如果使用IDEA 我們只需要找到右邊側(cè)欄中的maven(沒有記得調(diào)出了)

找到plugins–>mybatis-generaltor–>mybatis-generaltor:generaltor 之后雙擊即可,此時(shí)刷新一下項(xiàng)目就自動生成我們想要的,mapper和xml以及pojo

4 測試

創(chuàng)建穿點(diǎn)controller和service 來完成一次測試,

package show.mrkay.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.Mapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.support.JstlUtils;
import show.mrkay.dao.StudentMapper;
import show.mrkay.pojo.Student;
import show.mrkay.service.UserService;

import java.util.List;

/**
 * @ClassName: UserController
 * @description: 用戶Controller
 * @Author: MrKay
 * @Date: 2020/11/8
 */
@RestController
@RequestMapping("/user")
public class UserController {
  @Autowired
  private UserService userService;
  @GetMapping("/alllist")
  public List<Student> selectAll(){
    return userService.selectAll();
  }
}

package show.mrkay.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import show.mrkay.dao.StudentMapper;
import show.mrkay.pojo.Student;

import java.util.List;

/**
 * @ClassName: UserService
 * @description: UserService
 * @Author: MrKay
 * @Date: 2020/11/8
 */
@Service
public class UserService {
  @Autowired
  private StudentMapper studentMapper;
  public List<Student> selectAll(){
    List<Student> students = studentMapper.selectAll();
    return students;
  }
}

package show.mrkay;

import org.mybatis.spring.annotation.MapperScan;
import org.mybatis.spring.annotation.MapperScans;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("show.mrkay.dao")
public class GeneratorApplication {
  public static void main(String[] args) {
    SpringApplication.run(GeneratorApplication.class, args);
  }
}

注意:

啟動器類中需要加入@MapperScan(“mapper接口所在包”)注解,這樣我們就不需要手動創(chuàng)建實(shí)現(xiàn)類了,mybatis會自動幫我們創(chuàng)建

啟動之后:

地址欄輸入 localhost:8080/user/alllist

得到查詢結(jié)果:

[{"id":1,"name":"lk","sex":"男","phone":12345578}]

5 完整代碼

https://gitee.com/mrkay0313/boot-mybatis-generaltor.git

6 總結(jié)

便于自己以后使用,做的一個demo

到此這篇關(guān)于SpringBoot整合mybatis-generator-maven-plugin的文章就介紹到這了,更多相關(guān)SpringBoot整合mybatis-generator-maven-plugin內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: