4-Mybatis配置详解
1-核心配置文件
-
mybatis-config.xml
-
MyBatis 的配置文件configuration包含了會深深影響 MyBatis 行為的設置和屬性信息
properties(屬性) settings(設置) typeAliases(類型別名) typeHandlers(類型處理器) objectFactory(對象工廠) plugins(插件) environments(環境配置)environment(環境變量)transactionManager(事務管理器)dataSource(數據源) databaseIdProvider(數據庫廠商標識) mappers(映射器)
2-環境配置
2.1-environments元素定義配置環境
MyBatis可以配置成適應多種環境
盡管可以配置多個環境,但每個 SqlSessionFactory 實例只能選擇一種環境,通過environments標簽中的default去選擇其下的environment的id
如:選擇id為test的environment
<environments default="test"><environment id="development"><transactionManager type=""/><dataSource type=""><property name="" value=""/><property name="" value=""/><property name="" value=""/><property name="" value=""/></dataSource></environment><environment id="test"><transactionManager type=""></transactionManager><dataSource type=""><property name="" value=""/><property name="" value=""/><property name="" value=""/><property name="" value=""/></dataSource></environment> </environments>- 默認使用的環境ID(比如:default="development")
- 每個environment元素定義的環境ID(比如:id="development")
- 事務管理器的配置(比如:type="JDBC")
- 數據源的配置(比如:type="POOLED")
2.2-事務管理器transactionManager
MyBatis中有兩種類型的事務管理器
JDBC
默認
直接使用JDBC的提交和回滾機制,它依賴從數據源獲得的連接來管理事務作用域
MANAGED
幾乎沒做什么,不提交回滾一個連接,而是讓容器來管理事務的整個生命周期。默認情況下會關閉連接。然而一些容器并不希望連接被關閉,因此需要將closeConnection屬性設置為false來阻止默認的關閉行為
<transactionManager type="MANAGED"><property name="closeConnection" value="false"/> </transactionManager>如果使用Spring + MyBatis,就沒有必要配置事務管理器
2.3-數據源dataSource
dataSource元素使用標準的JDBC數據源接口來配置JDBC連接對象的資源。
有三種內建的數據源類型(也就是 type="[UNPOOLED|POOLED|JNDI]"):
type:
UNPOOLED
每次請求時打開和關閉連接,僅需要配置以下屬性
-
driver
這是 JDBC 驅動的 Java 類全限定名(并不是 JDBC 驅動中可能包含的數據源類)
-
url
這是數據庫的 JDBC URL 地址。
-
username
登錄數據庫的用戶名。
-
password
登錄數據庫的密碼。
-
defaultTransactionIsolationLevel
默認的連接事務隔離級別。
-
defaultNetworkTimeout
等待數據庫操作完成的默認網絡超時時間(單位:毫秒)。可以查看java.sql.Connection#setNetworkTimeout() 的 API 文檔以獲取更多信息。
作為可選項,可以傳遞屬性給數據庫驅動。只需在屬性名加上“driver.”前綴即可,例如:
-
driver.encoding=UTF8
這將通過DriverManager.getConnection(url, driverProperties)方法傳遞值為UTF8的encoding屬性給數據庫驅動
POOLED
連接池
<environments default="test"><environment id="development"><transactionManager type="JDBC"/><dataSource type="POOLED"><property name="driver" value="com.mysql.cj.jdbc.Driver"/><property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true&characterEncoding=UTF-8"/><property name="username" value="root"/><property name="password" value="ckj"/></dataSource></environment><environment id="test"><transactionManager type="JDBC"></transactionManager><dataSource type="POOLED"><property name="driver" value="com.mysql.cj.jdbc.Driver"/><property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true&characterEncoding=UTF-8"/><property name="username" value="root"/><property name="password" value="ckj"/></dataSource></environment> </environments>3-屬性.properties
可通過properties屬性,來實現引入配置文件
這些屬性可以在外部進行配置,并可以進行動態替換。既可以在典型的 Java 屬性文件中配置這些屬性,也可以在 properties 元素的子元素中設置。
從而,在dataSource標簽下,property屬性可以動態關聯
db.properties
注意:此處的配置鏈接僅為&,不是&
driver=com.mysql.cj.jdbc.Driver url=jdbc:mysql://localhost:3306/mybatis?useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true&characterEncoding=UTF-8 username=root password=ckj在核心文件mybatis-config.xml中引入
前提知識:在xml中,所有的標簽都可以規定其順序,在xml中,properties必須寫在<configuration>標簽下的第一行
并且,在該properties標簽下,可以通過子標簽property新建屬性,若屬性名與外部引用屬性重復,則以外部為準(即外部優先)
讀取順序:先讀取properties內部子標簽的屬性,再讀取外部引入的屬性,若沖突,則外部進行覆蓋
<!--引入外部配置文件--> <properties resource="db.properties"></properties>從而,mybatis-config.xml文件代碼變為:
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration><!--引入外部配置文件--><properties resource="db.properties"></properties><environments default="development"><environment id="development"><transactionManager type="JDBC"/><dataSource type="POOLED"><property name="driver" value="${driver}"/><property name="url" value="${url}"/><property name="username" value="${username}"/><property name="password" value="${password}"/></dataSource></environment></environments><mappers><mapper resource="config/dao/UserMapper.xml"></mapper></mappers> </configuration>4-類型別名
為Java類型設置一個縮寫名字
4.1-單個類型
在mybatis-config.xml中加入以下內容(位置在properties之后)
<typeAliases><typeAlias type="config.pojo.User" alias="Haha"></typeAlias> </typeAliases>mybatis-config.xml
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration><properties resource="db.properties"></properties><typeAliases><typeAlias type="config.pojo.User" alias="Haha"></typeAlias></typeAliases><environments default="development"><environment id="development"><transactionManager type="JDBC"/><dataSource type="POOLED"><property name="driver" value="${driver}"/><property name="url" value="${url}"/><property name="username" value="${username}"/><property name="password" value="${password}"/></dataSource></environment></environments><mappers><mapper resource="config/dao/UserMapper.xml"></mapper></mappers> </configuration>Mapper.xml
<select id="getUserList" resultType="Haha">select *from user; </select>4.2-多個類型
運用packge標簽,其中name屬性的值為包名,則會自動掃描其下的類型,在運用時,直接用類型名(可大寫可小寫),不需要加上包名,即不需要全路徑
<typeAliases><package name="config.pojo"/> </typeAliases>Mapper.xml
<select id="getUserList" resultType="User">select *from user; </select>5-設置.setting
| cacheEnabled | 全局性地開啟或關閉所有映射器配置文件中已配置的任何緩存。 | true | false | true |
| lazyLoadingEnabled | 延遲加載的全局開關。當開啟時,所有關聯對象都會延遲加載。 特定關聯關系中可通過設置 fetchType 屬性來覆蓋該項的開關狀態。 | true | false | false |
| aggressiveLazyLoading | 開啟時,任一方法的調用都會加載該對象的所有延遲加載屬性。 否則,每個延遲加載屬性會按需加載(參考 lazyLoadTriggerMethods)。 | true | false | false (在 3.4.1 及之前的版本中默認為 true) |
| multipleResultSetsEnabled | 是否允許單個語句返回多結果集(需要數據庫驅動支持)。 | true | false | true |
| useColumnLabel | 使用列標簽代替列名。實際表現依賴于數據庫驅動,具體可參考數據庫驅動的相關文檔,或通過對比測試來觀察。 | true | false | true |
| useGeneratedKeys | 允許 JDBC 支持自動生成主鍵,需要數據庫驅動支持。如果設置為 true,將強制使用自動生成主鍵。盡管一些數據庫驅動不支持此特性,但仍可正常工作(如 Derby)。 | true | false | False |
| autoMappingBehavior | 指定 MyBatis 應如何自動映射列到字段或屬性。 NONE 表示關閉自動映射;PARTIAL 只會自動映射沒有定義嵌套結果映射的字段。 FULL 會自動映射任何復雜的結果集(無論是否嵌套)。 | NONE, PARTIAL, FULL | PARTIAL |
| autoMappingUnknownColumnBehavior | 指定發現自動映射目標未知列(或未知屬性類型)的行為。NONE: 不做任何反應WARNING: 輸出警告日志('org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等級必須設置為 WARN)FAILING: 映射失敗 (拋出 SqlSessionException) | NONE, WARNING, FAILING | NONE |
| defaultExecutorType | 配置默認的執行器。SIMPLE 就是普通的執行器;REUSE 執行器會重用預處理語句(PreparedStatement); BATCH 執行器不僅重用語句還會執行批量更新。 | SIMPLE REUSE BATCH | SIMPLE |
| defaultStatementTimeout | 設置超時時間,它決定數據庫驅動等待數據庫響應的秒數。 | 任意正整數 | 未設置 (null) |
| defaultFetchSize | 為驅動的結果集獲取數量(fetchSize)設置一個建議值。此參數只可以在查詢設置中被覆蓋。 | 任意正整數 | 未設置 (null) |
| defaultResultSetType | 指定語句默認的滾動策略。(新增于 3.5.2) | FORWARD_ONLY | SCROLL_SENSITIVE | SCROLL_INSENSITIVE | DEFAULT(等同于未設置) | 未設置 (null) |
| safeRowBoundsEnabled | 是否允許在嵌套語句中使用分頁(RowBounds)。如果允許使用則設置為 false。 | true | false | False |
| safeResultHandlerEnabled | 是否允許在嵌套語句中使用結果處理器(ResultHandler)。如果允許使用則設置為 false。 | true | false | True |
| mapUnderscoreToCamelCase | 是否開啟駝峰命名自動映射,即從經典數據庫列名 A_COLUMN 映射到經典 Java 屬性名 aColumn。 | true | false | False |
| localCacheScope | MyBatis 利用本地緩存機制(Local Cache)防止循環引用和加速重復的嵌套查詢。 默認值為 SESSION,會緩存一個會話中執行的所有查詢。 若設置值為 STATEMENT,本地緩存將僅用于執行語句,對相同 SqlSession 的不同查詢將不會進行緩存。 | SESSION | STATEMENT | SESSION |
| jdbcTypeForNull | 當沒有為參數指定特定的 JDBC 類型時,空值的默認 JDBC 類型。 某些數據庫驅動需要指定列的 JDBC 類型,多數情況直接用一般類型即可,比如 NULL、VARCHAR 或 OTHER。 | JdbcType 常量,常用值:NULL、VARCHAR 或 OTHER。 | OTHER |
| lazyLoadTriggerMethods | 指定對象的哪些方法觸發一次延遲加載。 | 用逗號分隔的方法列表。 | equals,clone,hashCode,toString |
| defaultScriptingLanguage | 指定動態 SQL 生成使用的默認腳本語言。 | 一個類型別名或全限定類名。 | org.apache.ibatis.scripting.xmltags.XMLLanguageDriver |
| defaultEnumTypeHandler | 指定 Enum 使用的默認 TypeHandler 。(新增于 3.4.5) | 一個類型別名或全限定類名。 | org.apache.ibatis.type.EnumTypeHandler |
| callSettersOnNulls | 指定當結果集中值為 null 的時候是否調用映射對象的 setter(map 對象時為 put)方法,這在依賴于 Map.keySet() 或 null 值進行初始化時比較有用。注意基本類型(int、boolean 等)是不能設置成 null 的。 | true | false | false |
| returnInstanceForEmptyRow | 當返回行的所有列都是空時,MyBatis默認返回 null。 當開啟這個設置時,MyBatis會返回一個空實例。 請注意,它也適用于嵌套的結果集(如集合或關聯)。(新增于 3.4.2) | true | false | false |
| logPrefix | 指定 MyBatis 增加到日志名稱的前綴。 | 任何字符串 | 未設置 |
| logImpl | 指定 MyBatis 所用日志的具體實現,未指定時將自動查找。 | SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING | 未設置 |
| proxyFactory | 指定 Mybatis 創建可延遲加載對象所用到的代理工具。 | CGLIB | JAVASSIST | JAVASSIST (MyBatis 3.3 以上) |
| vfsImpl | 指定 VFS 的實現 | 自定義 VFS 的實現的類全限定名,以逗號分隔。 | 未設置 |
| useActualParamName | 允許使用方法簽名中的名稱作為語句參數名稱。 為了使用該特性,你的項目必須采用 Java 8 編譯,并且加上 -parameters 選項。(新增于 3.4.1) | true | false | true |
| configurationFactory | 指定一個提供 Configuration 實例的類。 這個被返回的 Configuration 實例用來加載被反序列化對象的延遲加載屬性值。 這個類必須包含一個簽名為static Configuration getConfiguration() 的方法。(新增于 3.2.3) | 一個類型別名或完全限定類名。 | 未設置 |
| shrinkWhitespacesInSql | 從SQL中刪除多余的空格字符。請注意,這也會影響SQL中的文字字符串。 (新增于 3.5.5) | true | false | false |
| defaultSqlProviderType | Specifies an sql provider class that holds provider method (Since 3.5.6). This class apply to the type(or value) attribute on sql provider annotation(e.g. @SelectProvider), when these attribute was omitted. | A type alias or fully qualified class name | Not set |
6-其他配置
- typerHandlers
- objectFactory
- plugins
7-映射器
MapperRgistry:注冊綁定我們的Mapper文件
映射方式
相對于類路徑的資源引用
mybatis-config.xml
<mappers><mapper resource="config/dao/UserMapper.xml"></mapper> </mappers>完全限定資源定位符(URL)——不使用
使用映射器接口實現類的完全限定類名
使用class文件方式綁定
<mappers><mapper class="config.dao.UserMapper"></mapper> </mappers>- 接口和Mapper配置文件必須同名
- 接口和Mapper配置文件必須在同一個包下(可在生成后的代碼文件中查看,如idea的target)
講包內的映射器接口實現全部注冊為映射器
8-生命周期和作用域
生命周期,作用域,是至關重要的,使用錯誤會導致非常嚴重的并發問題
8.1-SqlSessionFactoryBuilder
- 一旦創建了SqlSessionFactory,就不需要它了
- 局部變量
8.2-SqlSessionFactory
- 可以想象成,數據庫連接池
- SqlSessionFactory一旦被創建就應該在應用的運行期間一直存在,沒有任何理由丟棄它或重新創建另一個實例
- 多次重建SqlSessionFactory被視為一種代碼“壞習慣”
- 因此SqlSessionFactory的最佳作用域是應用作用域——一個Application
- 最簡單的就是使用單例模式或者靜態單例模式
8.3-SqlSession
- 連接到連接池的一個請求
- SqlSession的實例不是線程安全的,因此不能被共享,所以它的最佳的作用域是請求或方法作用域
- 用完之后需要趕緊關閉,否則資源被占用
- 不能講SqlSession實例的引用放在任何類型的托管作用域中,比如Servlet框架中的HttpSession
每一個Mapper,就對應一張表,代表一個具體的業務
9-最終代碼
代碼結構
代碼內容
-
UserMapper.java
package config.dao;import config.pojo.User;import java.util.List;public interface UserMapper {//查詢全部用戶List<User> getUserList();//根據Id查詢用戶User getUserById(int id);//insert 一個用戶int addUser(User user);//updateint updateUser(User user);//deleteint deleteUser(int id); } -
UserMapper.xml
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd"> <mapper namespace="config.dao.UserMapper"><select id="getUserList" resultType="config.pojo.User">select *from user;</select><select id="getUserById" parameterType="int" resultType="config.pojo.User">select *from userwhere id = #{id};</select><insert id="addUser" parameterType="config.pojo.User">insert into user (id, name, pwd) value (#{id},#{name},#{pwd});</insert><update id="updateUser" parameterType="config.pojo.User">update userset name = #{name},pwd= #{pwd}where id = #{id};</update><delete id="deleteUser" parameterType="int">deletefrom userwhere id = #{id};</delete> </mapper> -
User.java
package config.pojo;public class User {private int id;private String name;private String pwd;public User() {}public User(int id, String name, String pwd) {this.id = id;this.name = name;this.pwd = pwd;}public int getId() {return id;}public void setId(int id) {this.id = id;}public String getName() {return name;}public void setName(String name) {this.name = name;}public String getPwd() {return pwd;}public void setPwd(String pwd) {this.pwd = pwd;}@Overridepublic String toString() {return "User{" +"id=" + id +", name='" + name + '\'' +", pwd='" + pwd + '\'' +'}';} } -
MyabatisUtils
package config.utils;import org.apache.ibatis.io.Resources; import org.apache.ibatis.session.SqlSession; import org.apache.ibatis.session.SqlSessionFactory; import org.apache.ibatis.session.SqlSessionFactoryBuilder;import java.io.IOException; import java.io.InputStream;public class MybatisUtils {private static SqlSessionFactory sqlSessionFactory;static {try {String resource = "mybatis-config.xml";InputStream inputStream = Resources.getResourceAsStream(resource);sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);} catch (IOException e) {e.printStackTrace();}}public static SqlSession getSqlSession(){return sqlSessionFactory.openSession();} } -
db.properties
driver=com.mysql.cj.jdbc.Driver url=jdbc:mysql://localhost:3306/mybatis?useSSL=false&allowPublicKeyRetrieval=true&useUnicode=true&characterEncoding=UTF-8 username=root password=ckj -
mybatis-config.xml
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configurationPUBLIC "-//mybatis.org//DTD Config 3.0//EN""http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration><properties resource="db.properties"></properties><environments default="development"><environment id="development"><transactionManager type="JDBC"/><dataSource type="POOLED"><property name="driver" value="${driver}"/><property name="url" value="${url}"/><property name="username" value="${username}"/><property name="password" value="${password}"/></dataSource></environment></environments><mappers><mapper resource="config/dao/UserMapper.xml"></mapper></mappers> </configuration>
數據庫結構
數據庫名:mybatis
表名:user
字段及內容
總結
以上是生活随笔為你收集整理的4-Mybatis配置详解的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: mac搭建php审计环境,[docker
- 下一篇: BUU刷题记3