關於mybatis-config.xml文件的基礎解釋

時間  2019-11-24
標籤 關於 mybatis config.xml config xml 文件 基礎 解釋 欄目 MyBatis 简体版
原文   原文鏈接

今天是我第一天落戶博客園，想想從mybatis框架開始寫起吧。mybatis框架與Hibernate框架相比來講，專一於SQL語句，對SQL語句的要求比較高吧。java

我以爲，對於mybatis框架來講，最要緊的就是兩個配置文件，mybatis-config.xml和XxxxMapper.xml文件了，因此就從mybatis-config.xml開始提及吧。web

首先呢是mybatis-config.xml文件的頭部：sql

<?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">

能夠看出這個xml文件引用了一個DTD文件的約束，因此說對框架來講是個有效的xml文件，這個兩個文件均可以在官網上下載，mybatis框架也是個開源的框架，這一點是很好的數據庫

注意：！！！這個xml文件因爲dtd的約束使得標籤的順序惟一，標籤若是出現就必須按照嚴格的順序書寫（IDE是能夠聯網關聯的，也能夠本身設置）apache

咱們來看這個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>
</configuration>

configuration這個標籤中就是須要給框架配置的一系列標籤。服務器

首先是properties標籤：mybatis

屬性配置元素properties能夠將配置值寫死到mybatis-config.xml中，也能夠具體到一個屬性文件中,而且使用屬性文件的key名做爲佔位符，在下述的配置中，咱們將數據庫鏈接屬性配置到了application.properties文件中，而且爲driver，URL等屬性使用了佔位符。oracle

在applications.properties文件中配置數據庫鏈接參數，以下所示：
jdbc.driverClassName=oracle.jdbc.driver.OracleDriver
jdbc.url=jdbc:oracle:thin:@127.0.0.1:1521:XE
jdbc.username=xxx 
jdbc.password=xxxapp

<properties resource="application.properties"> 
    <!-- 這是設置優先級比較低的默認屬性 -->
    <property name="username" value="db_user" /> 
    <property name="password" value="verysecurepwd" /> 
</properties>

這樣咱們就能夠在environment標籤中調用上述配置文件中的K-V值了：

envionment標籤是環境相關設置標籤，使用以下：

<!-- 這裏的環境能夠有多個，環境id不一樣，做用不一樣，以下，第一個environment做用是開發，第一個environment做用是生產 -->
  <environments default="development"> 
     <!-- 這裏的id是指環境的id，經常寫爲本身的做用 -->
    <environment id="development"> 
    <!-- 這個屬性是鏈接管理類型 通常有2個值可選-->
      <!-- JDBC 是須要應用程序本身管理事務 -->
      <!-- 例如，部署到ApacheTomcat的應用程序，須要應用程序本身管理事務。由於ApacheTomcat不會幫咱們管理事務。 -->
      <!-- MANAGED 是讓服務器自動管理事務 像glassfish 服務器-->
      <transactionManager type="JDBC" /> 
      <!-- dataSource的類型type屬性能夠配置成其內置類型之一，如UNPOOLED，POOLED，JNDI。 -->
      <dataSource type="POOLED"> 
        <property name="driver" value="${jdbc.driverClassName}" /> 
        <property name="url" value="${jdbc.url}" /> 
        <property name="username" value="${jdbc.username}" /> 
        <property name="password" value="${jdbc.password}" /> 
      </dataSource> 
    </environment> 
    <environment id="production"> 
      <transactionManager type="MANAGED" /> 
      <dataSource type="JNDI"> 
        <property name="data_source" value="java:comp/jdbc/MyBatisDemoDS" /> 
      </dataSource> 
    </environment> 
  </environments>

typeAliases標籤：這個標籤是起個別名的做用

<!-- 這個屬性就是對pojo類起個別名 -->
<typeAliases> 
    <!-- 這裏的意思是將 pojo.Student 類別名爲 Student-->
    <typeAlias alias="Student" type="pojo.Student" /> 
    <!-- 這裏的意思是將 pojo包下的全部類進行別名，好比pojo.Student 就會別名爲student-->
    <!-- 優先級不高-->
    <package name="pojo" /> 
</typeAliases>

接下來是一個比較複雜的問題：

類型處理器，這是一個在mybatis中相對複雜的問題，分爲兩種狀況，一是內建的類型處理器，再者是本身定義的類型

MyBatis對於如下的類型使用內建的類型處理器
全部的基本數據類型、基本類型的包裹類型
byte[]、java.util.Date、java.sql.Date、java,sql.Time、java.sql.Timestamp、java枚舉類型等

若是是本身定義的類型,例子以下
假如在XxxxMapper.xml文件中配置一個insert插入語句，這裏的phone是Student的一個內置對象，類型爲PhoneNumber:

<insert id="insertStudent" parameter Type="Student"> insert into students(name,email,phone) values(#{name},#{email},#{phone}) </insert>

爲了讓MyBatis明白怎樣處理這個自定義的Java對象類型，如PhoneNumber，咱們能夠建立一個自定義的類型處理器，首先咱們須要處理PhoneNumber類，加入一個getAsString方法

public class PhoneNumber{ private String countryCode; private String stateCode; private String number; public PhoneNumber(){} public PhoneNumber(String countryCode, String stateCode, String number){ this.countryCode = countryCode; this.stateCode = stateCode; this.number = number; } public PhoneNumber(String str){ if(str!=null){ String[] args = str.split("-"); this.countryCode = args[0]; this.stateCode = args[1]; this.number = args[2]; } } public String getAsString() { return countryCode + "-" + stateCode + "-" + number; } // Setters and getters 
}

MyBatis提供了抽象類BaseTypeHandler<T> ，咱們能夠繼承此類建立自定義類型處理器。

public class PhoneTypeHandler extends BaseTypeHandler<PhoneNumber>{ //遇到PhoneNumber參數的時候應該如何在ps中設置值
 @Override public void setNonNullParameter(PreparedStatement ps, int i, PhoneNumber parameter, JdbcType jdbcType) throws SQLException { //這個方法就是調用了PhoneNumber類中的getAsString方法 //將這個對象以一個字符串的方式存入對應的表字段中
 ps.setString(i, parameter.getAsString()); } //查詢中遇到PhoneNumber類型的應該如何封裝(使用列名封裝)
 @Override public PhoneNumber getNullableResult(ResultSet rs, String columnName) throws SQLException { //由上面的方法能夠知道 //這個方法能夠將以字符串的方式存入對應的表字段中的PhoneNumber對象取出來 //調用了PhoneNumber類中的一參構造器從新封裝爲對象
            return new PhoneNumber(rs.getString(columnName)); } //查詢中遇到PhoneNumber類型的應該如何封裝(使用列的下標)
 @Override public PhoneNumber getNullableResult(ResultSet rs, int columnIndex) throws SQLException { return new PhoneNumber(rs.getString(columnIndex)); } //CallableStatement使用中遇到了PhoneNumber類型的應該如何封裝
 @Override public PhoneNumber getNullableResult(CallableStatement cs, int columnIndex) throws SQLException { return new PhoneNumber(cs.getString(columnIndex)); } }

 

最後就須要在mybatis-config.xml文件中配置一下

  <typeHandlers> 
    <typeHandler handler="typehandlers.PhoneTypeHandler" /> 
    <!--這個標籤貌似也是個別名的做用，不過我沒用過-->
    <package name="typehandlers" /> 
  </typeHandlers>

接下來是mappers元素，主要用於 SQL映射

SQLMapper文件中主要是對SQL語句的映射，代表這個sql語句對應哪一個方法的調用。咱們須要在mybatis-config.xml文件中配置 SQLMapper文件的位置。

resource屬性用來指定在classpath中的mapper文件。
url屬性用來經過徹底文件系統路徑或者web URL地址來指向mapper文件
class屬性用來指向一個mapper接口
package屬性用來指向能夠找到Mapper接口的包名 

其實在項目中經常只要一個屬性就足夠定位了

  <mappers> 
    <mapper resource="mappers/StudentMapper.xml" /> 
    <mapper url="file:///D:/mybatisdemo/app/mappers/StudentMapper.xml" /> 
    <mapper class="mappers.StudentMapper" /> 
    <package name="com.mappers" /> 
  </mappers>

最後是settings元素： 全局參數設置

settings元素有好多的參數設置

注意:大多數狀況下，【這些參數使用它們的默認值便可】

<settings>
          <!-- 這個配置使全局的映射文件啓用或禁用緩存 -->
          <setting name="cacheEnabled" value="true" />
          <!-- 全局啓用或禁用延遲加載。當禁用時，全部關聯對象都會即時加載 -->
          <setting name="lazyLoadingEnabled" value="true" />
          <!-- 容許或不容許多種結果集從一個單獨的語句中返回（須要適合的驅動） -->
          <setting name="multipleResultSetsEnabled" value="true" /> 
          <!-- 使用列標籤代替列名。不一樣的驅動在這方便表現不一樣。參考驅動文檔或充分測試兩種方法來決定所使用的驅動 -->
          <setting name="useColumnLabel" value="true" /> 
          <!-- 容許JDBC支持生成的鍵。須要適合的驅動。 -->
          <setting name="useGeneratedKeys" value="false" /> 
          <!-- 指定MyBatis如何自動映射列到字段/屬性。PARTIAL只會自動映射簡單、沒有嵌套的結果。FULL會自動映射任意複雜的結果（嵌套的或其餘狀況） -->
          <setting name="autoMappingBehavior" value="PARTIAL" />
          <!-- 配置默認的執行器。SIMPLE執行器沒有什麼特別之處。REUSE執行器重用預處理語句。BATCH執行器重用語句和批量更新 -->
          <setting name="defaultExecutorType" value="SIMPLE" /> 
          <!-- 設置超時時間，它決定驅動等待一個數據庫響應的時間 -->
          <setting name="defaultStatementTimeout" value="25000" />         
          <!-- 容許在嵌套語句中使用分頁（RowBounds）默認false -->
          <setting name="safeRowBoundsEnabled" value="false" /> 
          <!-- 是否開啓自動駝峯命名規則（camel case）映射，即從經典數據庫列名 A_COLUMN 到經典 Java 屬性名 aColumn 的相似映射。默認false -->
          <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="NULL" />
          <!-- 指定對象的哪一個方法觸發一次延遲加載。 -->
          <setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode ,toString" /> 
          <!-- CGLIB | JAVASSIST 默認JAVASSIST(MyBatis 3.3 or above) -->
          <!-- 指定 Mybatis 建立具備延遲加載能力的對象所用到的代理工具。 -->
          <setting name="proxyFactory" value="JAVASSIST" /> 
          <!-- 當啓用時，對任意延遲屬性的調用會使帶有延遲加載屬性的對象完整加載；反之，每種屬性將會按需加載。 -->
          <setting name="aggressiveLazyLoading" value="true" />           
          <!-- 指定 MyBatis 所用日誌的具體實現，未指定時將自動查找。 -->
          <setting name="logImpl" value="LOG4J " /> 
          <!-- 指定 MyBatis 增長到日誌名稱的前綴。值能夠是任意字符串 -->
          <setting name="logPrefix" value="LOG4J " /> 
          <!-- 指定當結果集中值爲 null 的時候是否調用映射對象的 setter（map 對象時爲 put）方法，這對於有 Map.keySet() 依賴或 null 值初始化的時候是有用的。注意基本類型（int、boolean等）是不能設置成 null 的。 默認false-->
          <setting name="callSettersOnNulls" value="false " /> 
</settings>

拿其中的一個我認爲最經常使用的，好比 <setting name="jdbcTypeForNull" value="NULL" /> 這個設置就能夠有效的幫助咱們避免「1111」錯誤

這個配置是說若是當插入的值爲空時給一個NULL屬性，就避免了「1111」錯誤，好比我在將一個對象插入到表中的時候，一個屬性沒有值，在有些環境中數據庫沒法解析這個空的指向，就會報出「1111」錯誤，若是設置了這個屬性這個空的指向就能夠設爲空

在package org.apache.ibatis.type包中中有一個枚舉JdbcType,定義了一系列類型，可是一個數據庫不可能徹底支持這些類型，源碼以下：

package org.apache.ibatis.type;

import java.sql.Types;
import java.util.HashMap;
import java.util.Map;

/**
* @author Clinton Begin
*/
public enum JdbcType {
/*
* This is added to enable basic support for the
* ARRAY data type - but a custom type handler is still required
*/
ARRAY(Types.ARRAY),
BIT(Types.BIT),
TINYINT(Types.TINYINT),
SMALLINT(Types.SMALLINT),
INTEGER(Types.INTEGER),
BIGINT(Types.BIGINT),
FLOAT(Types.FLOAT),
REAL(Types.REAL),
DOUBLE(Types.DOUBLE),
NUMERIC(Types.NUMERIC),
DECIMAL(Types.DECIMAL),
CHAR(Types.CHAR),
VARCHAR(Types.VARCHAR),
LONGVARCHAR(Types.LONGVARCHAR),
DATE(Types.DATE),
TIME(Types.TIME),
TIMESTAMP(Types.TIMESTAMP),
BINARY(Types.BINARY),
VARBINARY(Types.VARBINARY),
LONGVARBINARY(Types.LONGVARBINARY),
NULL(Types.NULL),
OTHER(Types.OTHER),
BLOB(Types.BLOB),
CLOB(Types.CLOB),
BOOLEAN(Types.BOOLEAN),
CURSOR(-10), // Oracle
UNDEFINED(Integer.MIN_VALUE + 1000),
NVARCHAR(Types.NVARCHAR), // JDK6
NCHAR(Types.NCHAR), // JDK6
NCLOB(Types.NCLOB), // JDK6
STRUCT(Types.STRUCT),
JAVA_OBJECT(Types.JAVA_OBJECT),
DISTINCT(Types.DISTINCT),
REF(Types.REF),
DATALINK(Types.DATALINK),
ROWID(Types.ROWID), // JDK6
LONGNVARCHAR(Types.LONGNVARCHAR), // JDK6
SQLXML(Types.SQLXML), // JDK6
DATETIMEOFFSET(-155); // SQL Server 2008

public final int TYPE_CODE;
private static Map<Integer,JdbcType> codeLookup = new HashMap<Integer,JdbcType>();

static {
for (JdbcType type : JdbcType.values()) {
codeLookup.put(type.TYPE_CODE, type);
}
}

JdbcType(int code) {
this.TYPE_CODE = code;
}

public static JdbcType forCode(int code) {
return codeLookup.get(code);
}

}

經常使用的標籤就這些了，這些標籤的順序爲

properties,settings,typeAliases,typeHandlers,environments,mappers

有任何不足的地方歡迎你們指出，我會學習而且修改

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程