SpringBoot基礎教程4-1-2 使用Mybatis操作數據庫

1 概述

爲什麼選擇Mybatis，一個很重要的原因是它，將封裝與開放的完美結合，高效的生成增刪改查的同時，又能滿足複雜的SQL場景，下面我們詳細介紹，SpringBoot如何快速接入Mybatis實現數據庫的增刪改查。

2 添加依賴

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.20</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>
        <!-- 分頁插件 -->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.2.5</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.9</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
        </dependency>
    </dependencies>

• pagehelper處理查詢分頁
• druid作爲數據庫連接池
• mybatis-spring-boot-starter，mybatis官方提供的starter

添加mybatis generator代碼自動生成插件

<plugin>
        <groupId>org.mybatis.generator</groupId>
        <artifactId>mybatis-generator-maven-plugin</artifactId>
        <version>1.3.2</version>
        <configuration>
                    <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
            <overwrite>true</overwrite>
            <verbose>true</verbose>
         </configuration>
</plugin>

2 mybatis generator配置文件解析

<?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  location="D:\apache-maven-3.2.5\repo\mysql\mysql-connector-java\5.1.35\mysql-connector-java-5.1.35.jar"/>
    <context id="DB2Tables"  targetRuntime="MyBatis3">
        <commentGenerator>
            <property name="suppressDate" value="true"/>
            <!-- 是否去除自動生成的註釋 true：是 ： false:否 -->
            <property name="suppressAllComments" value="true"/>
        </commentGenerator>
        <!--數據庫鏈接URL，用戶名、密碼 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1/springboot" userId="root" password="123456">
        </jdbcConnection>
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"/>
        </javaTypeResolver>
        <!-- 生成模型的包名和位置-->
        <javaModelGenerator targetPackage="com.mkeeper.entity" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
            <property name="trimStrings" value="true"/>
        </javaModelGenerator>
        <!-- 生成映射文件的包名和位置-->
        <sqlMapGenerator targetPackage="mapping" targetProject="src/main/resources">
            <property name="enableSubPackages" value="true"/>
        </sqlMapGenerator>
        <!-- 生成DAO的包名和位置-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.mkeeper.mapper" targetProject="src/main/java">
            <property name="enableSubPackages" value="true"/>
        </javaClientGenerator>
        <!-- 要生成的表 tableName是數據庫中的表名或視圖名 domainObjectName是實體類名-->
        <table tableName="t_user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
    </context>
</generatorConfiguration>

如何使用該插件？

• 新建數據庫與表
• 修改上面配置文件，使用你本地環境
• 運行插件
  

3 修改application.yml配置文件

數據源配置

spring:
    datasource:
        name: mysql_test
        type: com.alibaba.druid.pool.DruidDataSource
        #druid相關配置
        druid:
          #監控統計攔截的filters
          filters: stat
          driver-class-name: com.mysql.jdbc.Driver
          #基本屬性
          url: jdbc:mysql://127.0.0.1:3306/springboot?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true
          username: root
          password: 123456
          #配置初始化大小/最小/最大
          initial-size: 1
          min-idle: 1
          max-active: 20
          #獲取連接等待超時時間
          max-wait: 60000
          #間隔多久進行一次檢測，檢測需要關閉的空閒連接
          time-between-eviction-runs-millis: 60000
          #一個連接在池中最小生存的時間
          min-evictable-idle-time-millis: 300000
          validation-query: SELECT 'x'
          test-while-idle: true
          test-on-borrow: false
          test-on-return: false
          #打開PSCache，並指定每個連接上PSCache的大小。oracle設爲true，mysql設爲false。分庫分表較多推薦設置爲false
          pool-prepared-statements: false
          max-pool-prepared-statement-per-connection-size: 20

mybatis配置

mybatis:
  #Mapper.xml所在的位置
  mapper-locations: classpath:mapping/*.xml
  #entity掃描的包名
  type-aliases-package: com.mkeeper.entity

分頁配置

#pagehelper分頁插件配置
pagehelper:
    helperDialect: mysql
    reasonable: true
    supportMethodsArguments: true
    params: count=countSql
    returnPageInfo: check

4 分頁查詢和批量插入

完成上述配置以及自動生成代碼後，代碼結構大致如下：
可以參考源碼：本文源碼。

這裏我們不詳細介紹自動生成的基礎增刪改查功能；我們詳細介紹，分頁查詢和批量插入。

4.1 分頁查詢

修改 UserMapper，添加接口

    Page<User> findByPage();

修改UserMapper.xml，添加sql

<select id="findByPage" resultMap="BaseResultMap">
        select
        <include refid="Base_Column_List"/>
        from t_user
</select>

重點，修改UserService.java, UserServiceImpl.java

Page<User> findByPage(int pageNum, int pageSize);

/*
     * 這個方法中用到了我們開頭配置依賴的分頁插件pagehelper
     * 很簡單，只需要在service層傳入參數，然後將參數傳遞給一個插件的一個靜態方法即可；
     * pageNum 開始頁數
     * pageSize 每頁顯示的數據條數
     * */
    @Override
    public Page<User> findByPage(int pageNum, int pageSize) {
        //將參數傳給這個方法就可以實現物理分頁了，非常簡單。
        //只要這裏設置，就物理分頁，返回對應分頁數據
        PageHelper.startPage(pageNum, pageSize);
        return userMapper.findByPage();
    }

最後修改UserController.java，測試分頁效果

@GetMapping("/all/{pageNum}/{pageSize}")
    public R findAllUser(@PathVariable("pageNum") int pageNum, @PathVariable("pageSize") int pageSize){
        return R.isOk().data(new PageInfo<>(userService.findByPage(pageNum, pageSize)));
    }

4.2 批量插入

修改 UserMapper，添加接口

    /**
     * 批量插入
     * @param list
     * @return
     */
    int insertList(List<User> list);

修改UserMapper.xml，添加sql

<insert id="insertList">
        insert into t_user  (user_id, user_name, password, phone) VALUES
        <foreach item="item" collection="list" separator=",">
            (#{item.userId,jdbcType=INTEGER}, #{item.userName,jdbcType=VARCHAR}, #{item.password,jdbcType=VARCHAR},
            #{item.phone,jdbcType=VARCHAR})
        </foreach>
    </insert>

service和controller類似上文

5 測試結果

請讀者動動手

6 結束語

後續會介紹基於Mybatis、JPA、Mybatis Puls的數據庫操作，已經基於Sharding Jdbc分庫分表，讀寫分離操作，敬請期待。

---

歡迎關注博主公衆號，第一時間推送最新文章