簡介

MyBatis 是一款優秀的持久層框架，它支援定製化 SQL、儲存過程以及高階對映。MyBatis 避免了幾乎所有的 JDBC 程式碼和手動設定引數以及獲取結果集。MyBatis 可以使用簡單的 XML 或註解來配置和對映原生資訊，將介面和 Java 的 POJOs(Plain Old Java Objects,普通的 Java物件)對映成資料庫中的記錄。

 MyBatis Generator 是一款MyBatis 的程式碼生成器外掛，可以根據資料庫表字段自動生成對應的pojo類、mapper.xml檔案、dao介面。自動生成的mapper.xml檔案有常用的sql語句，能省去我們一大堆工作量。

引入依賴

Spring Boot整合Mybatis需要引入以下依賴：

<!--spring boot與mybatis的整合-->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.2</version>
</dependency>
<!--mysql驅動-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
 

引入generator外掛

在maven的plugins節點下引入該generator的外掛：

<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <version>1.3.5</version>
    <dependencies>
        <dependency>
            <groupId> mysql</groupId>
            <artifactId> mysql-connector-java</artifactId>
            <version> 5.1.39</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.5</version>
        </dependency>
    </dependencies>
    <executions>
        <execution>
            <id>Generate MyBatis Artifacts</id>
            <phase>package</phase>
            <goals>
                <goal>generate</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <!--允許移動生成的檔案 -->
        <verbose>true</verbose>
        <!-- 是否覆蓋 -->
        <overwrite>true</overwrite>
        <!-- 自動生成的配置 -->
        <configurationFile>
            src/main/resources/mybatis-generator.xml</configurationFile>
    </configuration>
</plugin>
 

表結構

tbl_user表的結構與資料如下：

基本配置

在application.yml中配置資料庫連線資訊與mybatis的相關配置：

spring:
  datasource: #資料來源配置
    url: jdbc:mysql://localhost:3306/ssm-crud?characterEncoding=utf-8&useSSL=false
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
mybatis:
  type-aliases-package: com.huang.bean #配置pojo類的位置
  mapper-locations: classpath:mapper/*.xml #配置mapper.xml的位置
  configuration:
    map-underscore-to-camel-case: true #開啟駝峰命名

generator配置

在src\main\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>
    <context id="DB2Tables" targetRuntime="MyBatis3">

        <!--不生成註釋-->
        <commentGenerator>
            <property name="suppressAllComments" value="true" />
        </commentGenerator>

        <!--配置資料庫連線-->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/ssm-crud?useSSL=false"
                        userId="root"
                        password="123456">
        </jdbcConnection>

        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>

        <!--
            指定javaBean生成的位置
            targetPackage:生成的包的位置
            targetProject:生成在哪個工程下
        -->
        <javaModelGenerator targetPackage="com.huang.bean" targetProject=".\src\main\java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>

        <!--指定sql對映檔案生成的位置-->
        <sqlMapGenerator targetPackage="mapper" targetProject=".\src\main\resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>

        <!--指定dao介面生成的位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.huang.dao" targetProject=".\src\main\java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>

        <!--
            指定每個表的生成策略
            tableName:表明
            domainObjectName:javabean的類名
        -->
        <table tableName="tbl_user" domainObjectName="User"/>

    </context>
</generatorConfiguration>

執行generator

根據上面再mybatis-generator.xml配置的路徑，建立對應的package，雙擊maven外掛執行generator外掛：

控制檯輸出BUILD SUCCESS則證明generator外掛執行成功：

[INFO] Scanning for projects...
[INFO] 
[INFO] --------------------< com.huang:springbootmybatis >---------------------
[INFO] Building springbootmybatis 0.0.1-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- mybatis-generator-maven-plugin:1.3.5:generate (default-cli) @ springbootmybatis ---
[INFO] Connecting to the Database
[INFO] Introspecting table tbl_user
[INFO] Generating Example class for table tbl_user
[INFO] Generating Record class for table tbl_user
[INFO] Generating Mapper Interface for table tbl_user
[INFO] Generating SQL Map for table tbl_user
[INFO] Saving file UserMapper.xml
[INFO] Saving file UserExample.java
[INFO] Saving file User.java
[INFO] Saving file UserMapper.java
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.926 s
[INFO] Finished at: 2018-11-02T19:55:25+08:00
[INFO] ------------------------------------------------------------------------

執行完generator外掛後，會在對應的包生成對應的檔案：

編寫程式碼

IUserService.java

public interface IUserService {
    User get(Integer id);
}

UserServiceImpl.java

@Service("iUserService")
public class UserServiceImpl implements IUserService {
    @Autowired
    private UserMapper userMapper;
    
    @Override
    public User get(Integer id) {
        return userMapper.selectByPrimaryKey(id);
    }
}

 UserController.java

@RestController
public class UserController {

    @Autowired
    private IUserService iUserService;

    @GetMapping("/get_user/{userId}")
    public User getUser(@PathVariable("userId") Integer userId){
        User user =iUserService.get(userId);
        return user;
    }
}

測試

執行專案，訪問localhost:8080/get_user/1，瀏覽器輸出資訊如下，整合成功：