SpringBoot整合mybatis-generator-maven-plugin的方法
阿新 • • 發佈：2020-11-09
前言:
SpringBoot版本 : 2.2.6
mybatis-generator-maven-plugin版本: 1.4.0
plugin 使用 mysql版本: 5.1.47
本次主要記錄日和使用該外掛自動生成pojo mapper xml檔案(單表)
1 建立SpringBoot工程
這裡不做具體記錄,建立工程往常教程很多,
下面貼出重要檔案和注意事項
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>
<!--日誌-->
<!--因為是基於AOP實現的所以這裡必須要調入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>
<!--外掛設定-->
<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 # 下面不配置就是採用預設配置 # 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: # 該配置項配置了MyBatis配置檔案儲存路徑 mapper-locations: classpath*:show/makey/dao/*.xml # 配置掃描對應實體所在包,將mapper的實現類注入容器我們在啟動器類上加了@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>
<!-- 是否生成註釋代時間戳-->
<property name="suppressDate" value="true"/>
<!-- 是否去除自動生成的註釋 true：是 ： false:否 -->
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!--資料庫連結地址賬號密碼-->
<jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1:3306/generaltor?serverTimezone=Asia/Shanghai" userId="root" password="lk0313">
</jdbcConnection>
<javaTypeResolver>
<!--該屬性可以控制是否強制DECIMAL和NUMERIC型別的欄位轉換為Java型別的java.math.BigDecimal,預設值為false，一般不需要配置。-->
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!--生成Model類存放位置-->
<javaModelGenerator targetPackage="show.mrkay.pojo" targetProject="src/main/java">
<!--enableSubPackages:如果true，MBG會根據catalog和schema來生成子包。如果false就會直接用targetPackage屬性。預設為false。-->
<property name="enableSubPackages" value="true"/>
<!--trimStrings:是否對資料庫查詢結果進行trim操作，如果設定為true就會生成類似這樣public void setUsername(String username) {this.username = username == null ? null : username.trim();}的setter方法。預設值為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 和相應的Mapper物件
type="XMLMAPPER",生成SQLMap XML檔案和獨立的Mapper介面
-->
<javaClientGenerator type="XMLMAPPER" targetPackage="show.mrkay.dao" targetProject="src/main/java">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!--生成對應表及類名-->
<table tableName="student" domainObjectName="Student" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false">
<!--useActualColumnNames:如果設定為true,那麼MBG會使用從資料庫元資料獲取的列名作為生成的實體物件的屬性。 如果為false(預設值)，MGB將會嘗試將返回的名稱轉換為駝峰形式。 在這兩種情況下，可以通過 元素顯示指定，在這種情況下將會忽略這個（useActualColumnNames）屬性。-->
<property name="useActualColumnNames" value="true"/>
<!-- 資料庫表主鍵 -->
<generatedKey column="id" sqlStatement="Mysql" identity="true" />
</table>
</context>
</generatorConfiguration>步驟:
1 匯入依賴
2 建立*generaltorConfig.xml配置檔案
3 配置yml配置檔案
注意:
pom中generalto-maven-plugs中必須指定mysql驅動,並且明確版本
generaltorConfig.xml中的
標籤中需要指定tableName和生成的實體名字
2 建立資料庫表
-- 建表語句: /* 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 執行
如果使用IDEA 我們只需要找到右邊側欄中的maven(沒有記得調出了)
找到plugins–>mybatis-generaltor–>mybatis-generaltor:generaltor 之後雙擊即可,此時重新整理一下專案就自動生成我們想要的,mapper和xml以及pojo
4 測試
建立穿點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介面所在包”)註解,這樣我們就不需要手動建立實現類了,mybatis會自動幫我們建立
啟動之後:
位址列輸入 localhost:8080/user/alllist
得到查詢結果:
[{"id":1,"name":"lk","sex":"男","phone":12345578}]
5 完整程式碼
https://gitee.com/mrkay0313/boot-mybatis-generaltor.git
6 總結
便於自己以後使用,做的一個demo
到此這篇關於SpringBoot整合mybatis-generator-maven-plugin的文章就介紹到這了,更多相關SpringBoot整合mybatis-generator-maven-plugin內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！