4-Mybatis配置详解
1-核心配置文件
-
mybatis-config.xml
-
MyBatis 的配置文件configuration包含了會(huì)深深影響 MyBatis 行為的設(shè)置和屬性信息
properties(屬性) settings(設(shè)置) typeAliases(類型別名) typeHandlers(類型處理器) objectFactory(對(duì)象工廠) plugins(插件) environments(環(huán)境配置)environment(環(huán)境變量)transactionManager(事務(wù)管理器)dataSource(數(shù)據(jù)源) databaseIdProvider(數(shù)據(jù)庫廠商標(biāo)識(shí)) mappers(映射器)
2-環(huán)境配置
2.1-environments元素定義配置環(huán)境
MyBatis可以配置成適應(yīng)多種環(huán)境
盡管可以配置多個(gè)環(huán)境,但每個(gè) SqlSessionFactory 實(shí)例只能選擇一種環(huán)境,通過environments標(biāo)簽中的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>- 默認(rèn)使用的環(huán)境ID(比如:default="development")
- 每個(gè)environment元素定義的環(huán)境ID(比如:id="development")
- 事務(wù)管理器的配置(比如:type="JDBC")
- 數(shù)據(jù)源的配置(比如:type="POOLED")
2.2-事務(wù)管理器transactionManager
MyBatis中有兩種類型的事務(wù)管理器
JDBC
默認(rèn)
直接使用JDBC的提交和回滾機(jī)制,它依賴從數(shù)據(jù)源獲得的連接來管理事務(wù)作用域
MANAGED
幾乎沒做什么,不提交回滾一個(gè)連接,而是讓容器來管理事務(wù)的整個(gè)生命周期。默認(rèn)情況下會(huì)關(guān)閉連接。然而一些容器并不希望連接被關(guān)閉,因此需要將closeConnection屬性設(shè)置為false來阻止默認(rèn)的關(guān)閉行為
<transactionManager type="MANAGED"><property name="closeConnection" value="false"/> </transactionManager>如果使用Spring + MyBatis,就沒有必要配置事務(wù)管理器
2.3-數(shù)據(jù)源dataSource
dataSource元素使用標(biāo)準(zhǔn)的JDBC數(shù)據(jù)源接口來配置JDBC連接對(duì)象的資源。
有三種內(nèi)建的數(shù)據(jù)源類型(也就是 type="[UNPOOLED|POOLED|JNDI]"):
type:
UNPOOLED
每次請(qǐng)求時(shí)打開和關(guān)閉連接,僅需要配置以下屬性
-
driver
這是 JDBC 驅(qū)動(dòng)的 Java 類全限定名(并不是 JDBC 驅(qū)動(dòng)中可能包含的數(shù)據(jù)源類)
-
url
這是數(shù)據(jù)庫的 JDBC URL 地址。
-
username
登錄數(shù)據(jù)庫的用戶名。
-
password
登錄數(shù)據(jù)庫的密碼。
-
defaultTransactionIsolationLevel
默認(rèn)的連接事務(wù)隔離級(jí)別。
-
defaultNetworkTimeout
等待數(shù)據(jù)庫操作完成的默認(rèn)網(wǎng)絡(luò)超時(shí)時(shí)間(單位:毫秒)??梢圆榭磈ava.sql.Connection#setNetworkTimeout() 的 API 文檔以獲取更多信息。
作為可選項(xiàng),可以傳遞屬性給數(shù)據(jù)庫驅(qū)動(dòng)。只需在屬性名加上“driver.”前綴即可,例如:
-
driver.encoding=UTF8
這將通過DriverManager.getConnection(url, driverProperties)方法傳遞值為UTF8的encoding屬性給數(shù)據(jù)庫驅(qū)動(dòng)
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屬性,來實(shí)現(xiàn)引入配置文件
這些屬性可以在外部進(jìn)行配置,并可以進(jìn)行動(dòng)態(tài)替換。既可以在典型的 Java 屬性文件中配置這些屬性,也可以在 properties 元素的子元素中設(shè)置。
從而,在dataSource標(biāo)簽下,property屬性可以動(dòng)態(tài)關(guān)聯(lián)
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中引入
前提知識(shí):在xml中,所有的標(biāo)簽都可以規(guī)定其順序,在xml中,properties必須寫在<configuration>標(biāo)簽下的第一行
并且,在該properties標(biāo)簽下,可以通過子標(biāo)簽property新建屬性,若屬性名與外部引用屬性重復(fù),則以外部為準(zhǔn)(即外部優(yōu)先)
讀取順序:先讀取properties內(nèi)部子標(biāo)簽的屬性,再讀取外部引入的屬性,若沖突,則外部進(jìn)行覆蓋
<!--引入外部配置文件--> <properties resource="db.properties"></properties>從而,mybatis-config.xml文件代碼變?yōu)?#xff1a;
<?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類型設(shè)置一個(gè)縮寫名字
4.1-單個(gè)類型
在mybatis-config.xml中加入以下內(nèi)容(位置在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-多個(gè)類型
運(yùn)用packge標(biāo)簽,其中name屬性的值為包名,則會(huì)自動(dòng)掃描其下的類型,在運(yùn)用時(shí),直接用類型名(可大寫可小寫),不需要加上包名,即不需要全路徑
<typeAliases><package name="config.pojo"/> </typeAliases>Mapper.xml
<select id="getUserList" resultType="User">select *from user; </select>5-設(shè)置.setting
| cacheEnabled | 全局性地開啟或關(guān)閉所有映射器配置文件中已配置的任何緩存。 | true | false | true |
| lazyLoadingEnabled | 延遲加載的全局開關(guān)。當(dāng)開啟時(shí),所有關(guān)聯(lián)對(duì)象都會(huì)延遲加載。 特定關(guān)聯(lián)關(guān)系中可通過設(shè)置 fetchType 屬性來覆蓋該項(xiàng)的開關(guān)狀態(tài)。 | true | false | false |
| aggressiveLazyLoading | 開啟時(shí),任一方法的調(diào)用都會(huì)加載該對(duì)象的所有延遲加載屬性。 否則,每個(gè)延遲加載屬性會(huì)按需加載(參考 lazyLoadTriggerMethods)。 | true | false | false (在 3.4.1 及之前的版本中默認(rèn)為 true) |
| multipleResultSetsEnabled | 是否允許單個(gè)語句返回多結(jié)果集(需要數(shù)據(jù)庫驅(qū)動(dòng)支持)。 | true | false | true |
| useColumnLabel | 使用列標(biāo)簽代替列名。實(shí)際表現(xiàn)依賴于數(shù)據(jù)庫驅(qū)動(dòng),具體可參考數(shù)據(jù)庫驅(qū)動(dòng)的相關(guān)文檔,或通過對(duì)比測試來觀察。 | true | false | true |
| useGeneratedKeys | 允許 JDBC 支持自動(dòng)生成主鍵,需要數(shù)據(jù)庫驅(qū)動(dòng)支持。如果設(shè)置為 true,將強(qiáng)制使用自動(dòng)生成主鍵。盡管一些數(shù)據(jù)庫驅(qū)動(dòng)不支持此特性,但仍可正常工作(如 Derby)。 | true | false | False |
| autoMappingBehavior | 指定 MyBatis 應(yīng)如何自動(dòng)映射列到字段或?qū)傩浴?NONE 表示關(guān)閉自動(dòng)映射;PARTIAL 只會(huì)自動(dòng)映射沒有定義嵌套結(jié)果映射的字段。 FULL 會(huì)自動(dòng)映射任何復(fù)雜的結(jié)果集(無論是否嵌套)。 | NONE, PARTIAL, FULL | PARTIAL |
| autoMappingUnknownColumnBehavior | 指定發(fā)現(xiàn)自動(dòng)映射目標(biāo)未知列(或未知屬性類型)的行為。NONE: 不做任何反應(yīng)WARNING: 輸出警告日志('org.apache.ibatis.session.AutoMappingUnknownColumnBehavior' 的日志等級(jí)必須設(shè)置為 WARN)FAILING: 映射失敗 (拋出 SqlSessionException) | NONE, WARNING, FAILING | NONE |
| defaultExecutorType | 配置默認(rèn)的執(zhí)行器。SIMPLE 就是普通的執(zhí)行器;REUSE 執(zhí)行器會(huì)重用預(yù)處理語句(PreparedStatement); BATCH 執(zhí)行器不僅重用語句還會(huì)執(zhí)行批量更新。 | SIMPLE REUSE BATCH | SIMPLE |
| defaultStatementTimeout | 設(shè)置超時(shí)時(shí)間,它決定數(shù)據(jù)庫驅(qū)動(dòng)等待數(shù)據(jù)庫響應(yīng)的秒數(shù)。 | 任意正整數(shù) | 未設(shè)置 (null) |
| defaultFetchSize | 為驅(qū)動(dòng)的結(jié)果集獲取數(shù)量(fetchSize)設(shè)置一個(gè)建議值。此參數(shù)只可以在查詢?cè)O(shè)置中被覆蓋。 | 任意正整數(shù) | 未設(shè)置 (null) |
| defaultResultSetType | 指定語句默認(rèn)的滾動(dòng)策略。(新增于 3.5.2) | FORWARD_ONLY | SCROLL_SENSITIVE | SCROLL_INSENSITIVE | DEFAULT(等同于未設(shè)置) | 未設(shè)置 (null) |
| safeRowBoundsEnabled | 是否允許在嵌套語句中使用分頁(RowBounds)。如果允許使用則設(shè)置為 false。 | true | false | False |
| safeResultHandlerEnabled | 是否允許在嵌套語句中使用結(jié)果處理器(ResultHandler)。如果允許使用則設(shè)置為 false。 | true | false | True |
| mapUnderscoreToCamelCase | 是否開啟駝峰命名自動(dòng)映射,即從經(jīng)典數(shù)據(jù)庫列名 A_COLUMN 映射到經(jīng)典 Java 屬性名 aColumn。 | true | false | False |
| localCacheScope | MyBatis 利用本地緩存機(jī)制(Local Cache)防止循環(huán)引用和加速重復(fù)的嵌套查詢。 默認(rèn)值為 SESSION,會(huì)緩存一個(gè)會(huì)話中執(zhí)行的所有查詢。 若設(shè)置值為 STATEMENT,本地緩存將僅用于執(zhí)行語句,對(duì)相同 SqlSession 的不同查詢將不會(huì)進(jìn)行緩存。 | SESSION | STATEMENT | SESSION |
| jdbcTypeForNull | 當(dāng)沒有為參數(shù)指定特定的 JDBC 類型時(shí),空值的默認(rèn) JDBC 類型。 某些數(shù)據(jù)庫驅(qū)動(dòng)需要指定列的 JDBC 類型,多數(shù)情況直接用一般類型即可,比如 NULL、VARCHAR 或 OTHER。 | JdbcType 常量,常用值:NULL、VARCHAR 或 OTHER。 | OTHER |
| lazyLoadTriggerMethods | 指定對(duì)象的哪些方法觸發(fā)一次延遲加載。 | 用逗號(hào)分隔的方法列表。 | equals,clone,hashCode,toString |
| defaultScriptingLanguage | 指定動(dòng)態(tài) SQL 生成使用的默認(rèn)腳本語言。 | 一個(gè)類型別名或全限定類名。 | org.apache.ibatis.scripting.xmltags.XMLLanguageDriver |
| defaultEnumTypeHandler | 指定 Enum 使用的默認(rèn) TypeHandler 。(新增于 3.4.5) | 一個(gè)類型別名或全限定類名。 | org.apache.ibatis.type.EnumTypeHandler |
| callSettersOnNulls | 指定當(dāng)結(jié)果集中值為 null 的時(shí)候是否調(diào)用映射對(duì)象的 setter(map 對(duì)象時(shí)為 put)方法,這在依賴于 Map.keySet() 或 null 值進(jìn)行初始化時(shí)比較有用。注意基本類型(int、boolean 等)是不能設(shè)置成 null 的。 | true | false | false |
| returnInstanceForEmptyRow | 當(dāng)返回行的所有列都是空時(shí),MyBatis默認(rèn)返回 null。 當(dāng)開啟這個(gè)設(shè)置時(shí),MyBatis會(huì)返回一個(gè)空實(shí)例。 請(qǐng)注意,它也適用于嵌套的結(jié)果集(如集合或關(guān)聯(lián))。(新增于 3.4.2) | true | false | false |
| logPrefix | 指定 MyBatis 增加到日志名稱的前綴。 | 任何字符串 | 未設(shè)置 |
| logImpl | 指定 MyBatis 所用日志的具體實(shí)現(xiàn),未指定時(shí)將自動(dòng)查找。 | SLF4J | LOG4J | LOG4J2 | JDK_LOGGING | COMMONS_LOGGING | STDOUT_LOGGING | NO_LOGGING | 未設(shè)置 |
| proxyFactory | 指定 Mybatis 創(chuàng)建可延遲加載對(duì)象所用到的代理工具。 | CGLIB | JAVASSIST | JAVASSIST (MyBatis 3.3 以上) |
| vfsImpl | 指定 VFS 的實(shí)現(xiàn) | 自定義 VFS 的實(shí)現(xiàn)的類全限定名,以逗號(hào)分隔。 | 未設(shè)置 |
| useActualParamName | 允許使用方法簽名中的名稱作為語句參數(shù)名稱。 為了使用該特性,你的項(xiàng)目必須采用 Java 8 編譯,并且加上 -parameters 選項(xiàng)。(新增于 3.4.1) | true | false | true |
| configurationFactory | 指定一個(gè)提供 Configuration 實(shí)例的類。 這個(gè)被返回的 Configuration 實(shí)例用來加載被反序列化對(duì)象的延遲加載屬性值。 這個(gè)類必須包含一個(gè)簽名為static Configuration getConfiguration() 的方法。(新增于 3.2.3) | 一個(gè)類型別名或完全限定類名。 | 未設(shè)置 |
| shrinkWhitespacesInSql | 從SQL中刪除多余的空格字符。請(qǐng)注意,這也會(huì)影響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:注冊(cè)綁定我們的Mapper文件
映射方式
相對(duì)于類路徑的資源引用
mybatis-config.xml
<mappers><mapper resource="config/dao/UserMapper.xml"></mapper> </mappers>完全限定資源定位符(URL)——不使用
使用映射器接口實(shí)現(xiàn)類的完全限定類名
使用class文件方式綁定
<mappers><mapper class="config.dao.UserMapper"></mapper> </mappers>- 接口和Mapper配置文件必須同名
- 接口和Mapper配置文件必須在同一個(gè)包下(可在生成后的代碼文件中查看,如idea的target)
講包內(nèi)的映射器接口實(shí)現(xiàn)全部注冊(cè)為映射器
8-生命周期和作用域
生命周期,作用域,是至關(guān)重要的,使用錯(cuò)誤會(huì)導(dǎo)致非常嚴(yán)重的并發(fā)問題
8.1-SqlSessionFactoryBuilder
- 一旦創(chuàng)建了SqlSessionFactory,就不需要它了
- 局部變量
8.2-SqlSessionFactory
- 可以想象成,數(shù)據(jù)庫連接池
- SqlSessionFactory一旦被創(chuàng)建就應(yīng)該在應(yīng)用的運(yùn)行期間一直存在,沒有任何理由丟棄它或重新創(chuàng)建另一個(gè)實(shí)例
- 多次重建SqlSessionFactory被視為一種代碼“壞習(xí)慣”
- 因此SqlSessionFactory的最佳作用域是應(yīng)用作用域——一個(gè)Application
- 最簡單的就是使用單例模式或者靜態(tài)單例模式
8.3-SqlSession
- 連接到連接池的一個(gè)請(qǐng)求
- SqlSession的實(shí)例不是線程安全的,因此不能被共享,所以它的最佳的作用域是請(qǐng)求或方法作用域
- 用完之后需要趕緊關(guān)閉,否則資源被占用
- 不能講SqlSession實(shí)例的引用放在任何類型的托管作用域中,比如Servlet框架中的HttpSession
每一個(gè)Mapper,就對(duì)應(yīng)一張表,代表一個(gè)具體的業(yè)務(wù)
9-最終代碼
代碼結(jié)構(gòu)
代碼內(nèi)容
-
UserMapper.java
package config.dao;import config.pojo.User;import java.util.List;public interface UserMapper {//查詢?nèi)坑脩?/span>List<User> getUserList();//根據(jù)Id查詢用戶User getUserById(int id);//insert 一個(gè)用戶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>
數(shù)據(jù)庫結(jié)構(gòu)
數(shù)據(jù)庫名:mybatis
表名:user
字段及內(nèi)容
總結(jié)
以上是生活随笔為你收集整理的4-Mybatis配置详解的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: mac搭建php审计环境,[docker
- 下一篇: BUU刷题记3