2022.5.13 Mybatis 配置解析
4、配置解析
1、核心配置文件
mybatis-config.xml,MyBatis的配置文件包含了会深深影响MyBatis行为的设置和属性信息。
2、环境配置(environments)
MyBatis 可以配置成适应多种环境 , 不过要记住:尽管可以配置多个环境,但每个 SqlSessionFactory 实例只能选择一种环境。
学会使用配置多套运行环境!
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE configuration 3 PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-config.dtd"> 5 6 <configuration> 7 8 <environments default="development"> 9 <environment id="development"> 10 <transactionManager type="JDBC"/> 11 <dataSource type="POOLED"> 12 <property name="driver" value="com.mysql.jdbc.Driver"/> 13 <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8"/> 14 <property name="username" value="root"/> 15 <property name="password" value="123456"/> 16 </dataSource> 17 </environment> 18 19 <environment id="test"> 20 <transactionManager type="JDBC"/> 21 <dataSource type="POOLED"> 22 <property name="driver" value="com.mysql.jdbc.Driver"/> 23 <property name="url" value="jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8"/> 24 <property name="username" value="root"/> 25 <property name="password" value="123456"/> 26 </dataSource> 27 </environment> 28 29 </environments> 30 31 <mappers> 32 <mapper resource="com/xing/dao/UserMapper.xml"/> 33 </mappers> 34 </configuration>
Mybatis默认的事务管理器transactionManager就是JDBC ,连接池dataSource:POOLED
3、属性(properties)
我们可以通过properties属性来实现引用配置文件
这些属性都是可外部配置且可动态替换的,既可以在典型的Java属性文件中配置,亦可通过properties元素的子元素来传递。【db.properties】
编写配置文件
法一:
db.properties
1 driver=com.mysql.jdbc.Driver 2 url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8 3 username=root 4 password=123456
mybatis-config.xml
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE configuration 3 PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-config.dtd"> 5 6 <configuration> 7 8 <!--引入外部配置文件--> 9 <properties resource="db.properties"/> 10 11 <environments default="development"> 12 <environment id="development"> 13 <transactionManager type="JDBC"/> 14 <dataSource type="POOLED"> 15 <property name="driver" value="${driver}"/> 16 <property name="url" value="${url}"/> 17 <property name="username" value="${username}"/> 18 <property name="password" value="${password}"/> 19 </dataSource> 20 </environment> 21 22 </environments> 23 24 <mappers> 25 <mapper resource="com/xing/dao/UserMapper.xml"/> 26 </mappers> 27 </configuration>
法二
db.properties
1 driver=com.mysql.jdbc.Driver 2 url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8
mybatis-config.xml
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE configuration 3 PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-config.dtd"> 5 6 <configuration> 7 8 <!--引入外部配置文件--> 9 <properties resource="db.properties"> 10 <property name="username" value="root"/> 11 <property name="pwd" value="123456"/> 12 </properties> 13 14 15 <environments default="development"> 16 <environment id="development"> 17 <transactionManager type="JDBC"/> 18 <dataSource type="POOLED"> 19 <property name="driver" value="${driver}"/> 20 <property name="url" value="${url}"/> 21 <property name="username" value="${username}"/> 22 <property name="password" value="${pwd}"/> 23 </dataSource> 24 </environment> 25 26 </environments> 27 28 <mappers> 29 <mapper resource="com/xing/dao/UserMapper.xml"/> 30 </mappers> 31 </configuration>
两种方法一起,优先级:优先使用外部配置文件
4、类型别名(typeAliases)
类型别名可为 Java 类型设置一个缩写名字。 它仅用于 XML 配置,意在降低冗余的全限定类名书写。
法一:
mybatis-config.xml
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE configuration 3 PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-config.dtd"> 5 6 <configuration> 7 8 <!--引入外部配置文件--> 9 <properties resource="db.properties"> 10 <property name="username" value="root"/> 11 <property name="pwd" value="123456"/> 12 </properties> 13 <!-- 可以给实体类起别名 还需带类名--> 14 <typeAliases> 15 <typeAlias type="com.xing.pojo.User" alias="User"/> 16 </typeAliases> 17 18 19 <environments default="development"> 20 <environment id="development"> 21 <transactionManager type="JDBC"/> 22 <dataSource type="POOLED"> 23 <property name="driver" value="${driver}"/> 24 <property name="url" value="${url}"/> 25 <property name="username" value="${username}"/> 26 <property name="password" value="${pwd}"/> 27 </dataSource> 28 </environment> 29 30 </environments> 31 32 <mappers> 33 <mapper resource="com/xing/dao/UserMapper.xml"/> 34 </mappers> 35 </configuration>
UserMapper.xml
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE mapper 3 PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> 5 6 <mapper namespace="com.xing.dao.UserMapper"> 7 别名 8 <select id="getUserList" resultType="User"> 9 select * from mybatis.user; 10 </select> 11 </mapper>
法二:
也可以指定一个包名,MyBatis 会在包名下面搜索需要的Java Bean,比如:
扫描实体类的包,它的默认别名就为这个类的类名,首字母小写!
mybatis-config.xml
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE configuration 3 PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-config.dtd"> 5 6 <configuration> 7 8 <!--引入外部配置文件--> 9 <properties resource="db.properties"> 10 <property name="username" value="root"/> 11 <property name="pwd" value="123456"/> 12 </properties> 13 <!-- 可以给实体类起别名 只写包名,不带类名--> 14 <typeAliases> 15 <package name="com.xing.pojo"/> 16 </typeAliases> 17 18 <environments default="development"> 19 <environment id="development"> 20 <transactionManager type="JDBC"/> 21 <dataSource type="POOLED"> 22 <property name="driver" value="${driver}"/> 23 <property name="url" value="${url}"/> 24 <property name="username" value="${username}"/> 25 <property name="password" value="${pwd}"/> 26 </dataSource> 27 </environment> 28 29 </environments> 30 31 <mappers> 32 <mapper resource="com/xing/dao/UserMapper.xml"/> 33 </mappers> 34 </configuration>
UserMapper.xml
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE mapper 3 PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> 5 6 <mapper namespace="com.xing.dao.UserMapper"> 7 写User也行,这种方式建议小写 8 <select id="getUserList" resultType="user"> 9 select * from mybatis.user; 10 </select> 11 12 </mapper>
第二种方式实体类若有注解,则别名为其注解值
1 package com.xing.pojo; 2 3 import org.apache.ibatis.type.Alias; 4 5 //实体类 注解值为hello 6 @Alias("hello") 7 public class User { 8 private int id; 9 private String name; 10 private String pwd; 11 12 public User() { 13 } 14 15 public User(int id, String name, String pwd) { 16 this.id = id; 17 this.name = name; 18 this.pwd = pwd; 19 } 20 21 public int getId() { 22 return id; 23 } 24 25 public void setId(int id) { 26 this.id = id; 27 } 28 29 public String getName() { 30 return name; 31 } 32 33 public void setName(String name) { 34 this.name = name; 35 } 36 37 public String getPwd() { 38 return pwd; 39 } 40 41 public void setPwd(String pwd) { 42 this.pwd = pwd; 43 } 44 45 @Override 46 public String toString() { 47 return "User{" + 48 "id=" + id + 49 ", name='" + name + '\'' + 50 ", pwd='" + pwd + '\'' + 51 '}'; 52 } 53 } 54
UserMapper.xml
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE mapper 3 PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> 5 6 <mapper namespace="com.xing.dao.UserMapper"> 7 别名为注解值 8 <select id="getUserList" resultType="hello"> 9 select * from mybatis.user; 10 </select> 11 12 </mapper>
在实体类比较少的时候,使用第一种方式。
如果实体类十分多,建议使用第二种。
第一种可以DIY(自定义)别名,第二种则不行,如果非要改,需要在实体上增加注解
下面是一些为常见的 Java 类型内建的类型别名。它们都是不区分大小写的,注意,为了应对原始类型的命名重复,采取了特殊的命名风格。
别名 (resultType参数写的) | 映射的类型(方法返回的类型) |
---|---|
_byte | byte |
_long | long |
_short | short |
_int | int |
_integer | int |
_double | double |
_float | float |
_boolean | boolean |
string | String |
byte | Byte |
long | Long |
short | Short |
int | Integer |
integer | Integer |
double | Double |
float | Float |
boolean | Boolean |
date | Date |
decimal | BigDecimal |
bigdecimal | BigDecimal |
object | Object |
map | Map |
hashmap | HashMap |
list | List |
arraylist | ArrayList |
collection | Collection |
iterator | Iterator |
5、设置(settings)
这是 MyBatis 中极为重要的调整设置,它们会改变 MyBatis 的运行时行为。 下表描述了设置中各项设置的含义、默认值等
6、其他配置
-
-
mybatis-generator-core
-
mybatis-plus
-
通用mapper
-
7、映射器(mappers)
MapperRegistry:注册绑定我们的Mapper文件;
方式一:推荐使用
mybatis-config.xml
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE configuration 3 PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-config.dtd"> 5 6 <configuration> 7 8 <!--引入外部配置文件--> 9 <properties resource="db.properties"> 10 <property name="username" value="root"/> 11 <property name="pwd" value="123456"/> 12 </properties> 13 <!-- 可以给实体类起别名--> 14 <typeAliases> 15 <package name="com.xing.pojo"/> 16 </typeAliases> 17 18 19 <environments default="development"> 20 <environment id="development"> 21 <transactionManager type="JDBC"/> 22 <dataSource type="POOLED"> 23 <property name="driver" value="${driver}"/> 24 <property name="url" value="${url}"/> 25 <property name="username" value="${username}"/> 26 <property name="password" value="${pwd}"/> 27 </dataSource> 28 </environment> 29 <!-- 使用相对于类路径的资源引用 --> 30 <mappers> 31 <mapper resource="com/xing/dao/UserMapper.xml"/> 32 </mappers> 33 </configuration>
方式二:
1 <!-- 使用接口实现类的完全限定类名 --> 2 <mappers> 3 <mapper class="com.xing.dao.UserMapper"/> 4 </mappers>
注意点:
-
接口和他的Mapper配置文件必须同名!
-
接口和他的Mapper配置文件必须在同一个包下!
方式三:
1 <!-- 将包内的映射器接口实现全部注册为映射器 --> 2 <mappers> 3 <package name="com.xing.dao"/> 4 </mappers>
注意点:
-
接口和他的Mapper配置文件必须同名!
-
接口和他的Mapper配置文件必须在同一个包下!
8、生命周期
生命周期和作用域,是至关重要的,因为错误的使用会导致非常严重的并发问题。
sqlSessionFactoryBuilder:
-
一旦创建了SqlSessionFactory,就不再需要它了
-
局部变量
sqlSessionFactory:
-
说白了就是可以想象为︰数据库连接池
-
SqlSessionFactory 一旦被创建就应该在应用的运行期间一直存在,没有任何理由丢弃它或重新创建另一个实例。
-
因此 SqlSessionFactory 的最佳作用域是应用作用域。
-
最简单的就是使用单例模式或者静态单例模式。
sqlSession
-
连接到连接池的一个请求!
-
SqlSession的实例不是线程安全的,因此是不能被共享的,所以它的最佳的作用域是请求或方法作用域。
-
用完之后需要赶紧关闭,否则资源被占用!
这里面的每一个Mapper,就代表一个具体的业务!
· 阿里巴巴 QwQ-32B真的超越了 DeepSeek R-1吗?
· 10年+ .NET Coder 心语 ── 封装的思维:从隐藏、稳定开始理解其本质意义
· 【设计模式】告别冗长if-else语句:使用策略模式优化代码结构
· 字符编码:从基础到乱码解决
· 提示词工程——AI应用必不可少的技术