SpringBoot整合Mybatis Generator自動生成代碼

Posted on by

Mybatis是目前主流的ORM框架，相比於hibernate的全自動，它是半自動化需要手寫sql語句、接口、實體對象，後來推出的Generator自動生成代碼,可以幫我們提高開發效率。

本文目的：SpringBoot 整合 Mybatis Generator自動生成dao、entity、mapper.xml實現單表增刪改查。

1.創建SpringBoot項目

File→New→Project… 選擇Spring Initializr，選擇JDK版本，默認初始化URL

1

填寫項目名稱，java版本，其他描述信息

2

選擇項目存放路徑

在這裡插入圖片描述

選擇web、mybatis、mysql依賴

6

Next–>Finish完成項目創建

2. mybatis-generator-maven插件的配置

打開項目的pom.xml文件添加

			<plugin>
				<groupId>org.mybatis.generator</groupId>
				<artifactId>mybatis-generator-maven-plugin</artifactId>
				<configuration>
					<verbose>true</verbose>
					<overwrite>true</overwrite>
				</configuration>
			</plugin>

完整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>com.xyz</groupId>
	<artifactId>mybatis</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>mybatis</name>
	<description>Spring Boot 整合 Mybatis</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.0.5.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</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>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-thymeleaf</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.mybatis.spring.boot</groupId>
			<artifactId>mybatis-spring-boot-starter</artifactId>
			<version>1.3.2</version>
		</dependency>

		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<scope>runtime</scope>
		</dependency>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>com.github.pagehelper</groupId>
			<artifactId>pagehelper-spring-boot-starter</artifactId>
			<version>1.2.5</version>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<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>
				<configuration>
					<verbose>true</verbose>
					<overwrite>true</overwrite>
				</configuration>
			</plugin>
		</plugins>
	</build>


</project>

3. 項目結構構建

在項目目錄下(這裡是mybatis)添加controller、service、dao、entity包，在resources下添加mapper包存放映射文件。

在這裡插入圖片描述

4. application.yml配置

#端口號配置
server:
  port: 8088
spring:
#模板引擎配置
  thymeleaf:
    prefix: classpath:/templates/
    suffix: .html
    mode: HTML
    encoding: UTF-8
    cache: false
    servlet:
      content-type: text/html
#靜態文件配置
  resources:
    static-locations: classpath:/static,classpath:/META-INF/resources,classpath:/templates/
#jdbc配置
  datasource:
    url: jdbc:mysql://localhost:3306/video?useUnicode=true&characterEncoding=utf8
    username: xyz
    password: xyz
    driver-class-name: com.mysql.jdbc.Driver
#mybatis配置
mybatis:
#映射文件路徑
  mapper-locations: classpath:mapper/*.xml
#模型所在的保命
  type-aliases-package: com.xyz.mybatis.entity

5. generatorConfig.xml配置

在resources文件下創建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>

    <!--classPathEntry:數據庫的JDBC驅動,換成你自己的驅動位置 可選 -->
    <classPathEntry location="E:\IdeaProjects\mysql-connector-java-5.1.47.jar"/>

    <!-- 一個數據庫一個context,defaultModelType="flat" 大數據字段，不分表 -->
    <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">

        <!-- 自動識別數據庫關鍵字，默認false，如果設置為true，根據SqlReservedWords中定義的關鍵字列表；一般保留默認值，遇到數據庫關鍵字（Java關鍵字），使用columnOverride覆蓋 -->
        <property name="autoDelimitKeywords" value="true"/>

        <!-- 生成的Java文件的編碼 -->
        <property name="javaFileEncoding" value="utf-8"/>

        <!-- beginningDelimiter和endingDelimiter：指明數據庫的用於標記數據庫對象名的符號，比如ORACLE就是雙引號，MYSQL默認是`反引號； -->
        <property name="beginningDelimiter" value="`"/>
        <property name="endingDelimiter" value="`"/>

        <!-- 格式化java代碼 -->
        <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>

        <!-- 格式化XML代碼 -->
        <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>

        <!-- 註釋 -->
        <commentGenerator>
            <property name="suppressAllComments" value="true"/><!-- 是否取消註釋 -->
            <property name="suppressDate" value="false"/> <!-- 是否生成註釋代時間戳-->
        </commentGenerator>

        <!-- jdbc連接-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/video?serverTimezone=UTC" userId="xyz"
                        password="xyz"/>

        <!-- 類型轉換 -->
        <javaTypeResolver>
            <!-- 是否使用bigDecimal， false可自動轉化以下類型（Long, Integer, Short, etc.） -->
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!-- 生成實體類地址 -->
        <javaModelGenerator targetPackage="com.xyz.mybatis.entity" targetProject="src/main/java">
            <!-- 是否讓schema作為包的後綴 -->
            <property name="enableSubPackages" value="false"/>
            <!-- 從數據庫返回的值去掉前後空格 -->
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!-- 生成map.xml文件存放地址 -->
        <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="false"/>
        </sqlMapGenerator>

        <!-- 生成接口dao -->
        <javaClientGenerator targetPackage="com.xyz.mybatis.dao" targetProject="src/main/java" type="XMLMAPPER">
            <property name="enableSubPackages" value="false"/>
        </javaClientGenerator>

        <!-- table可以有多個,每個數據庫中的表都可以寫一個table，tableName表示要匹配的數據庫表,也可以在tableName屬性中通過使用%通配符來匹配所有數據庫表,隻有匹配的表才會自動生成文件 enableSelectByPrimaryKey相應的配置表示是否生成相應的接口 -->
        <table tableName="t_manager" enableCountByExample="false" enableUpdateByExample="false"
               enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"
               enableSelectByPrimaryKey="true" enableUpdateByPrimaryKey="true"
               enableDeleteByPrimaryKey="true">
            <property name="useActualColumnNames" value="true"/>
        </table>

    </context>
</generatorConfiguration>

註意：
classPathEntry location=“E:\IdeaProjects\mysql-connector-java-5.1.47.jar”，建議用5.X系列的，否則可能生成的接口會缺少

6. 在idea中添加一個mybatis generator maven插件啟動選項，點擊Run，選擇Edit Configuration… 點擊加號”+”添加，選擇maven，填寫名稱(這裡用mybatis generator)，命令行：mybatis-generator:generate -e

在這裡插入圖片描述

在這裡插入圖片描述

7. 選擇 Mybatis Generator 啟動，自動在dao、entity、mapper包下生成代碼

在這裡插入圖片描述

註意：
利用Mybatis Generator自動生成代碼，對於已經存在的文件會存在覆蓋和在原有文件上追加的可能性，不宜多次生成。如需重新生成，需要刪除已生成的源文件。

到此這篇關於SpringBoot整合Mybatis Generator自動生成代碼的文章就介紹到這瞭,更多相關SpringBoot Mybatis Generator自動生成代碼內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：