Mybatis的全局配置文件SqlMapConfig.xml,配置内容如下:
properties(属性)
settings(全局配置参数)
typeAliases(类型别名)
typeHandlers(类型处理器)
objectFactory(对象工厂)
plugins(插件)
environments(环境集合属性对象)
environment(环境子属性对象)
transactionManager(事务管理)
dataSource(数据源)
mappers(映射器)
一、properties的配置
需求:
将数据库连接参数单独配置在db.properties中,只需要在SqlMapConfig.xml中加载db.properties的属性值。在SqlMapConfig.xml中就不需要对数据库连接参数硬编码。
将数据库连接参数只配置在db.properties中,原因:方便对参数进行统一管理,其他xml可以引用该db.properties。
在类路径下定义db.properties文件:
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf-8
jdbc.username=root
jdbc.password=root
修改SqlMapConfig.xml中的代码,应用上面定义的db.properties文件:
<?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>
<!-- 加载属性文件 -->
<properties resource="db.properties">
<!-- properties中还可以配置一些属性名和属性值 -->
<!-- <property name="" value=""/> -->
</properties>
<!-- 和spring整合后 environments配置将废除-->
<environments default="development">
<environment id="development">
<!-- 使用JDBC事务管理,由mybatis控制 -->
<transactionManager type="JDBC" />
<!-- 数据库连接池,由mybatis管理 -->
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
</dataSource>
</environment>
</environments>
<!-- 加载映射文件,只能写类路径名,不能带上应用名,否则会报错 -->
<mappers>
<mapper resource="sqlmap/User.xml" />
<mapper resource="mapper/UserMapper.xml" />
</mappers>
</configuration>
注意:Mybatis将按照下面的顺序来加载属性。 在properties元素体内定义的属性首先被读取;
然后会读取properties元素中resource或url(绝对路径:用于引用硬盘上的文件)加载的属性,它会覆盖已读取的同名属性。
最后读取parameterType传递的属性,它会覆盖已读取的同名属性。
因此,通过parameterType传递的属性具有最高优先级,resource或url加载的属性次之,最低优先级的是properties元素体内定义的属性。
建议:
不要在properties元素体内添加任何属性值,只将属性值定义在properties文件中。
在properties文件中定义属性名要有一定的特殊性,如:XXX.XXX.XXX。
二、settings全局参数配置
Mybatis框架在运行时可以调整一些运行参数。
比如:开启二级缓存、开启延迟加载
参考自Ibatis官方文档:
<settings>
<setting name="cacheEnabled" value="true"/>
<setting name="lazyLoadingEnabled" value="true"/>
<setting name="multipleResultSetsEnabled" value="true"/>
<setting name="useColumnLabel" value="true"/>
<setting name="useGeneratedKeys" value="false"/>
<setting name="autoMappingBehavior" value="PARTIAL"/>
<setting name="defaultExecutorType" value="SIMPLE"/>
<setting name="defaultStatementTimeout" value="25"/>
<setting name="safeRowBoundsEnabled" value="false"/>
<setting name="mapUnderscoreToCamelCase" value="false"/>
<setting name="localCacheScope" value="SESSION"/>
<setting name="jdbcTypeForNull" value="OTHER"/>
<setting name="lazyLoadTriggerMethods" value="equals,clone,hashCode,toString"/>
</settings>
三、typeAliases(别名)重点
在parameterType和resultType设置时,为了方便编码,定义别名代替POJO的全路径名(包名+类名)。别名定义时,需要定义在<environments>标签之前。
3.1、需求
在mapper.xml中,定义很多的statement.xml,statement需要parameterType指定输入参数的类型,需要resultType指定输出结果的映射类型。
如果在指定类型时输入类型全路径,不方便进行开发。通过定义别名,方便开发。
3.2、框架默认支持的别名
别名 | 映射的类型 |
_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 |
3.3、自定义别名
3.3.1、单个别名定义
注意是定义在SqlMapConfig.xml中的,不是定义在mapper.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>
<!-- 加载属性文件 -->
<properties resource="db.properties">
<!-- properties中还可以配置一些属性名和属性值 -->
<!-- <property name="" value=""/> -->
</properties>
<!-- 全局属性配置 -->
<!-- <settings>
</settings> -->
<!-- 别名定义 -->
<typeAliases>
<!-- 针对单个别名定义 -->
<typeAlias type="cn.sunft.mybatis.po.User" alias="user"/>
</typeAliases>
<!-- 和spring整合后 environments配置将废除-->
<environments default="development">
<environment id="development">
<!-- 使用JDBC事务管理,由mybatis控制 -->
<transactionManager type="JDBC" />
<!-- 数据库连接池,由mybatis管理 -->
<dataSource type="POOLED">
<property name="driver" value="${jdbc.driver}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
</dataSource>
</environment>
</environments>
<!-- 加载映射文件,只能写类路径名,不能带上应用名,否则会报错 -->
<mappers>
<mapper resource="sqlmap/User.xml" />
<mapper resource="mapper/UserMapper.xml" />
</mappers>
</configuration>
在UserMapper.xml中引用别名:
<?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">
<!-- namwspace命名空间:作用就是对SQL进行分类管理,进行SQL隔离 -->
<!-- namespace命名空间特殊作用:
如果使用mapper动态代理方法,这里就需要配置mapper接口地址-->
<mapper namespace="cn.sunft.mybatis.mapper.UserMapper">
<!-- 在映射文件中配置很多sql语句 -->
<!-- 需求:通过id查询用户表的记录 -->
<!-- 通过select执行数据库查询
id:标识映射文件中的sql
将sql语句封装到mappedStatement对象中,所以将id成为statement的id
parameterType:指定输入参数的类型,这里指定int型
#{}表示一个占位符
#{id}:其中的id表示接收输入的参数,参数名称就是id,如果输入参数是简单类型,
#{}中的参数名可以任意,可以是value或其他名称,例如#{aaa}
resultType:指定SQL输出结果所映射的java对象类型,select指定resultType表示
将单条记录映射成的java对象
-->
<select id="findUserById" parameterType="int"
resultType="user">
select * from user where id=#{id}
</select>
<!-- 根据用户名称模糊查询用户信息,可能返回多条
resultType:指定的就是单条记录所映射的java对象类型
${}:表示拼接SQL串,将接收到参数的内容不加任何修饰拼接在SQL中。
使用${}拼接SQL,引起SQL注入。
${value}:接收输入参数的内容,如果传入类型是简单类型,${}中只能使用value
-->
<select id="findUserByName" parameterType="java.lang.String"
resultType="cn.sunft.mybatis.po.User">
select * from user where username like '%${value}%'
</select>
<!-- 添加用户
parameterType:指定输入参数类型是pojo(包括用户信息)
#{}中指定pojo的属性名,接收到pojo对象的属性值,
mybatis也是通过OGNL获取对象的属性值
-->
<insert id="insertUser" parameterType="cn.sunft.mybatis.po.User">
<!-- 将刚刚插入的主键返回,返回到user对象中
SELECT LAST_INSERT_ID():得到insert进去记录的主键值,只适用于自增主键
keyProperty:将查询到主键值设置到parameterType指定的对象的那个属性
order:SELECT LAST_INSERT_ID()执行顺序,相对于insert语句来说它的执行顺序
resultType:指定结果的类型
-->
<selectKey keyProperty="id" order="AFTER" resultType="java.lang.Integer">
SELECT LAST_INSERT_ID()
</selectKey>
insert into user(username, birthday, sex, address)
value(#{username}, #{birthday}, #{sex}, #{address})
</insert>
<insert id="insertStudent" parameterType="cn.sunft.mybatis.po.Student">
<!--
使用MySQL的uuid()生成主键
执行过程:
首先通过uuid()得到主键,将主键设置到student对象的id字段中
其次在insert执行时,从user对象中取出id属性插入数据库
-->
<selectKey keyProperty="id" order="BEFORE" resultType="java.lang.String">
SELECT uuid()
</selectKey>
insert into student(id, name) value(#{id}, #{name})
</insert>
<!-- 删除用户
根据id删除用户,需要输入id值
-->
<delete id="deleteUser" parameterType="java.lang.Integer">
delete from user where id=#{id}
</delete>
<!-- 根据id更新用户
分析:
需要传入用户的id
需要传入用户的更新信息
parameterType:指定user对象,包括id和更新信息,注意:id必须存在
#{id}:从输入user对象中获取id
-->
<update id="updateUser" parameterType="cn.sunft.mybatis.po.User">
update user set
username=#{username},
birthday=#{birthday},
sex=#{sex},
address=#{address}
where id=#{id}
</update>
</mapper>
3.3.2、批量定义别名(常用)
<!-- 别名定义 -->
<typeAliases>
<!-- 批量别名定义
指定包名:mybatis自动扫描包中的po类,
自动定义别名,别名就是类名(首字母大写或者小写都可以)
可以在下面定义多个package标签,扫描多个包
-->
<package name="cn.sunft.mybatis.po"/>
</typeAliases>
3.3.3、typeHandlers(类型处理器)
1、类型处理器用于Java类型和JDBC类型映射,一般不需要程序员自己定义,MyBatis提供的类型处理器满足日常需要。
具体参见Mybatis官方文档或参考书籍《深入浅出MyBatis技术原理与实战》。
3.4、mappers映射器(重点掌握)
3.4.1、<mapper resource = “” />
使用相对于类路径的资源,如:
<mapper resource=”sqlmap/user.xml” />
3.4.2、<mapper url=”” />
使用完全限定路径,如:
<mapper url=”file://D:\workspace_springmvc\mabatis_01\config\sqlmap\user.xml” />
3.4.3、<mapper class=”” />
使用mapper接口类路径。使用class方式需要遵循一定的方法:将mapper.xml和mapper.java文件放在一个目录,且文件名相同。
代码如下:
<!-- 加载映射文件,只能写类路径名,不能带上应用名,否则会报错 -->
<mappers>
<!-- 通过resource方法一次性加载一个映射文件 -->
<mapper resource="sqlmap/User.xml" />
<!-- 通过mapper接口加载单个映射文件
遵循一些规范:需要将mapper接口类名和mapper.xml映射文件名称保持一致,且存放在一个目录中
上边规范的前提是:使用的是mapper代理方法
-->
<mapper class="cn.sunft.mybatis.mapper.UserMapper" />
</mappers>
注意:此种方法要求mapper接口名和mapper映射文件名称相同,且放在同一个目录中。3.5、批量mapper加载
使用批量扫面也需要遵守一定的规则:将mapper.xml和mapper.java文件放在一个目录下,且文件名相同。
具体代码如下:
<!-- 加载映射文件,只能写类路径名,不能带上应用名,否则会报错 -->
<mappers>
<!-- 通过resource方法一次性加载一个映射文件 -->
<mapper resource="sqlmap/User.xml" />
<!-- 通过mapper接口加载单个映射文件
遵循一些规范:需要将mapper接口类名和mapper.xml映射文件名称保持一致,且存放在一个目录中
上边规范的前提是:使用的是mapper代理方法
-->
<!-- <mapper class="cn.sunft.mybatis.mapper.UserMapper" /> -->
<!-- 批量加载mapper
指定mapper接口的包名,mybatis自动扫描包包下边所有mapper接口进行加载
-->
<package name="cn.sunft.mybatis.mapper"/>
</mappers>
注意:此种方法要求mapper接口名和mapper映射文件名称相同,且放在同一个目录中。企业常用的是批量扫描的方式。