Spring Boot配置和使用Mybatis(xml方式)

示例的各個文件如下：

 

在pom里加了mybatis的依賴后，在application.properties加上：

spring.datasource.url=jdbc:mysql://127.0.0.1:3306/test
spring.datasource.username=**
spring.datasource.password=**

mybatis.mapperLocations=classpath*:mapper/*Mapper.xml
mybatis.typeAliasesPackage=com.example.springmybatis.model
mybatis.config-location=classpath:mybatis-config.xml

 

mybatis-config.xml可以配置的選項如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">  
<configuration>  
    <!-- 參數設置 -->  
    <settings>  
        <!-- 這個配置使全局的映射器啟用或禁用緩存 -->  
        <setting name="cacheEnabled" value="true" />  
        <!-- 全局啟用或禁用延遲加載。當禁用時，所有關聯對象都會即時加載 -->  
        <setting name="lazyLoadingEnabled" value="true" />
        <!-- 當啟用時，有延遲加載屬性的對象在被調用時將會完全加載任意屬性。否則，每種屬性將會按需要加載 -->  
        <setting name="aggressiveLazyLoading" value="true" />  
        <!-- 允許或不允許多種結果集從一個單獨的語句中返回（需要適合的驅動） -->  
        <setting name="multipleResultSetsEnabled" value="true" />  
        <!-- 使用列標簽代替列名。不同的驅動在這方便表現不同。參考驅動文檔或充分測試兩種方法來決定所使用的驅動 -->  
        <setting name="useColumnLabel" value="true" />  
        <!-- 允許JDBC支持生成的鍵。需要適合的驅動。如果設置為true則這個設置強制生成的鍵被使用，盡管一些驅動拒絕兼容但仍然有效（比如Derby） -->  
        <setting name="useGeneratedKeys" value="true" />  
        <!-- 指定MyBatis如何自動映射列到字段/屬性。PARTIAL只會自動映射簡單，沒有嵌套的結果。FULL會自動映射任意復雜的結果（嵌套的或其他情況） -->  
        <setting name="autoMappingBehavior" value="PARTIAL" />  
        <!--當檢測出未知列（或未知屬性）時，如何處理，默認情況下沒有任何提示，這在測試的時候很不方便，不容易找到錯誤。
        NONE : 不做任何處理 (默認值)
        WARNING : 警告日志形式的詳細信息
        FAILING : 映射失敗，拋出異常和詳細信息
        -->
        <setting name="autoMappingUnknownColumnBehavior" value="WARNING"/>
        <!-- 配置默認的執行器。SIMPLE執行器沒有什么特別之處。REUSE執行器重用預處理語句。BATCH執行器重用語句和批量更新 -->  
        <setting name="defaultExecutorType" value="SIMPLE" /> 
        <!-- 設置超時時間，它決定驅動等待一個數據庫響應的時間 -->  
        <setting name="defaultStatementTimeout" value="25000" />  
        <!--設置查詢返回值數量，可以被查詢數值覆蓋  -->
        <setting name="defaultFetchSize" value="100"/>
        <!-- 允許在嵌套語句中使用分頁-->
        <setting name="safeRowBoundsEnabled" value="false"/>
        <!--是否開啟自動駝峰命名規則（camel case）映射，即從經典數據庫列名 A_COLUMN 到經典 Java 屬性名 aColumn 的類似映射。-->
        <setting name="mapUnderscoreToCamelCase" value="false"/>
        <!--MyBatis 利用本地緩存機制（Local Cache）防止循環引用（circular references）和加速重復嵌套查詢。 默認值為 SESSION，這種情況下會緩存一個會話中執行的所有查詢。 若設置值為 STATEMENT，本地會話僅用在語句執行上，對相同 SqlSession 的不同調用將不會共享數據。-->
        <setting name="localCacheScope" value="SESSION"/>
        <!-- 當沒有為參數提供特定的 JDBC 類型時，為空值指定 JDBC 類型。 某些驅動需要指定列的 JDBC 類型，多數情況直接用一般類型即可，比如 NULL、VARCHAR OTHER。-->
        <setting name="jdbcTypeForNull" value="OTHER"/>
        <!-- 指定哪個對象的方法觸發一次延遲加載。-->
        <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/> 
    </settings>  

    <!-- 別名定義 -->  
    <typeAliases>  
        <typeAlias alias="pageAccessURL" type="com.lgm.mybatis.model.PageAccessURL" />  
    </typeAliases>  

    <!--自定義類型處理器 -->
    <typeHandlers>
    <!-- <typeHandler handler="com.xhm.util.BooleanTypeHandlder" /> -->
        <!--掃描整個包下的自定義類型處理器-->
        <package name="com.xhm.util"/>
    </typeHandlers>

    <!--plugins插件之 分頁攔截器  -->
    <plugins>
        <plugin interceptor="com.xhm.util.PageInterceptor"></plugin>
    </plugins>

    <!--配置environment環境-->
    <environments default="development">  
        <!-- 環境配置1，每個SqlSessionFactory對應一個環境 -->  
        <environment id="development1">  
            <!-- 事務配置 type= JDBC、MANAGED 1.JDBC:這個配置直接簡單使用了JDBC的提交和回滾設置。它依賴於從數據源得到的連接來管理事務范圍。   
            2.MANAGED:這個配置幾乎沒做什么。它從來不提交或回滾一個連接。而它會讓容器來管理事務的整個生命周期（比如Spring或JEE應用服務器的上下文）。 默認情況下它會關閉連接。然而一些容器並不希望這樣，因此如果你需要從連接中停止它，將closeConnection屬性設置為false -->  
            <transactionManager type="JDBC" />  
            <!-- <transactionManager type="MANAGED">   
            <property name="closeConnection" value="false"/>   
            </transactionManager> -->  
                <!-- 數據源類型：type = UNPOOLED、POOLED、JNDI 1.UNPOOLED：這個數據源的實現是每次被請求時簡單打開和關閉連接。它有一點慢，這是對簡單應用程序的一個很好的選擇，因為它不需要及時的可用連接。   
                不同的數據庫對這個的表現也是不一樣的，所以對某些數據庫來說配置數據源並不重要，這個配置也是閑置的 2.POOLED：這是JDBC連接對象的數據源連接池的實現，用來避免創建新的連接實例時必要的初始連接和認證時間。   
                這是一種當前Web應用程序用來快速響應請求很流行的方法。 3.JNDI：這個數據源的實現是為了使用如Spring或應用服務器這類的容器，容器可以集中或在外部配置數據源，然后放置一個JNDI上下文的引用 -->  
            <dataSource type="UNPOOLED">  
                <property name="driver" value="com.mysql.jdbc.Driver" />  
                <property name="url" value="jdbc:mysql://localhost:3306/xhm" />  
                <property name="username" value="root" />  
                <property name="password" value="root" />  
                <!-- 默認連接事務隔離級別 <property name="defaultTransactionIsolationLevel" value=""   
                /> -->  
            </dataSource>  
        </environment>  
  
        <!-- 環境配置2 -->  
        <environment id="development2">  
            <transactionManager type="JDBC" />  
            <dataSource type="POOLED">  
                <property name="driver" value="com.mysql.jdbc.Driver" />  
                <property name="url" value="jdbc:mysql://localhost:3306/xhm" />  
                <property name="username" value="root" />  
                <property name="password" value="root" />  
                <!-- 在任意時間存在的活動（也就是正在使用）連接的數量 -->  
                <property name="poolMaximumActiveConnections" value="10" />  
                <!-- 任意時間存在的空閑連接數 -->  
                <property name="poolMaximumIdleConnections" value="5" />  
                <!-- 在被強制返回之前，池中連接被檢查的時間 -->  
                <property name="poolMaximumCheckoutTime" value="20000" />  
                <!-- 這是給連接池一個打印日志狀態機會的低層次設置，還有重新嘗試獲得連接，這些情況下往往需要很長時間（為了避免連接池沒有配置時靜默失敗） -->  
                <property name="poolTimeToWait" value="20000" />  
                <!-- 發送到數據的偵測查詢，用來驗證連接是否正常工作，並且准備接受請求。 -->  
                <property name="poolPingQuery" value="NO PING QUERY SET" />  
                <!-- 這是開啟或禁用偵測查詢。如果開啟，你必須用一個合法的SQL語句（最好是很快速的）設置poolPingQuery屬性 -->  
                <property name="poolPingEnabled" value="false" />  
                <!-- 這是用來配置poolPingQuery多次時間被用一次。這可以被設置匹配標准的數據庫連接超時時間，來避免不必要的偵測 -->  
                <property name="poolPingConnectionsNotUsedFor" value="0" />  
            </dataSource>  
        </environment>  
  
        <!-- 環境配置3 -->  
        <environment id="development3">  
            <transactionManager type="JDBC" />  
            <dataSource type="JNDI">  
                <property name="data_source" value="java:comp/env/jndi/mybatis" />  
                <property name="env.encoding" value="UTF8" />  
                <!-- <property name="initial_context" value=""/> <property name="env.encoding"   
                    value="UTF8"/> -->  
            </dataSource>  
        </environment>  
    </environments>  
  
    <!-- 映射文件，mapper的配置文件 -->  
    <mappers>
        <!--直接映射到相應的mapper文件-->
        <mapper resource="com/xhm/mapper/UserMapper.xml"/>
        <!--掃描包路徑下所有xxMapper.xml文件-->
        <package name="com.xhm.mapper"/>
    </mappers>  
</configuration>

 

 

在項目中，一般不需要特殊配置，主要是開啟駝峰命名。我使用的一般配置是：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>

    <settings>
        <!-- Globally enables or disables any caches configured in any mapper under this configuration -->
        <setting name="cacheEnabled" value="true"/>
        <!-- Sets the number of seconds the driver will wait for a response from the database -->
        <setting name="defaultStatementTimeout" value="3000"/>
        <!-- Enables automatic mapping from classic database column names A_COLUMN to camel case classic Java property names aColumn -->
        <setting name="mapUnderscoreToCamelCase" value="true"/>
        <!-- Allows JDBC support for generated keys. A compatible driver is required.
        This setting forces generated keys to be used if set to true,
         as some drivers deny compatibility but still work -->
        <setting name="useGeneratedKeys" value="true"/>
    </settings>

    <!-- Continue going here -->

</configuration>

 在resource文件夾新建CountryMapper.xml，用xml配置sql。內容如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
<mapper namespace="com.example.springmybatis.mapper.CountryMapper">
    <select id="selectAll" resultType="Country">
        select id,countryname,countrycode from country
    </select>
</mapper>

controller中使用

新建mapper包，創建CountryMapper接口文件，內容如下：

package com.example.springmybatis.mapper;

import com.example.springmybatis.model.Country;
import org.apache.ibatis.annotations.Mapper;

import java.util.List;

@Mapper
public interface CountryMapper {
    List<Country> selectAll();
}

同時新建controller和service包和類，如下：

controoller：

package com.example.springmybatis.controller;

import com.alibaba.fastjson.JSON;
import com.example.springmybatis.service.CountryService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class countryController {

    @Autowired
    private CountryService countryService;

    @RequestMapping("/selectAll")
    public String selectAll(){
        return JSON.toJSONString(countryService.selectAll());
    }
}

service：

package com.example.springmybatis.service;

import com.example.springmybatis.mapper.CountryMapper;
import com.example.springmybatis.model.Country;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class CountryService {

    @Autowired
    private CountryMapper countryMapper;

    public List<Country> selectAll(){
        return countryMapper.selectAll();
    }
}

model就省略了，只有id，countryName，countryCode三個屬性。