Mybatis
MyBatis 是一款优秀的持久层框架,它支持定制化 SQL、存储过程以及高级映射。MyBatis避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以使用简单的 XML 或注解来配置和映射原生类型、接口和 Java 的POJO(Plain Old Java Objects,普通老式Java 对象)为数据库中的记录。
Mybatis基本配置
- 配置jar包
- 配置log4j的相应配置(用来观察日志信息)
- 根据官方文档配置mybatis文件
mybatis基本流程
- 编写数据库对应的JavaBean
- mybatis_config.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>
<properties resource="dbconf.properties"></properties>
<!-- environments标签:配置多种环境 必须包含 transactionManager(事务管理器)、dataSource(数据库)-->
<environments default="development">
<!-- id为当前环境的唯一标识,可以与databaseIdProvider标签配合实现不同数据库的切换 -->
<environment id="development">
<transactionManager type="JDBC"/>
<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>
<!--
将我们写好的sql映射文件(HeroMapper.xml)一定要注册到全局配置文件(mybatis-config.xml)中
conf和src源码文件下的com.ys.mybatis.dao,实际是同一个包,只是在视觉上存在不同
-->
<mappers>
<!-- xxxMapper接口和xxxMapper映射文件在同一目录下,是package标签使用的前提 -->
<package name="com.ys.mybatis.dao"/>
</mappers>
</configuration>
- dbconf.properties
jdbc.driver = com.mysql.jdbc.Driver
jdbc.url = jdbc:mysql://localhost:3306/how2java
jdbc.username = root
jdbc.password = admin
- HeroMapper.java接口
package com.ys.mybatis.dao;
import com.ys.mybatis.bean.Hero;
public interface HeroMapper {
Hero getHeroById(int id);
}
- HeroMapper.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">
<!--
namespace:名称空间:指定为接口的全类名
id:唯一标识
resultType:返回类型,一般使用类型的全类名;也可以通过在全局配置文件中设置别名、和注解别名的这两个方法。
#{id}:从传递过来的参数值中取出id的值
-->
<mapper namespace="com.ys.mybatis.dao.HeroMapper">
<!-- Hero getHeroById(int id); -->
<select id="getHeroById" resultType="com.ys.mybatis.bean.Hero">
select * from hero where id = #{id}
</select>
</mapper>
- MybatisTest.java
package com.ys.mybatis.test;
import java.io.IOException;
import java.io.InputStream;
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 org.junit.jupiter.api.Test;
import com.ys.mybatis.bean.Hero;
import com.ys.mybatis.dao.HeroMapper;
class MybatisTest {
private SqlSessionFactory getSqlSessionFactory() throws IOException {
String resource = "mabatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory =
new SqlSessionFactoryBuilder().build(inputStream);
return sqlSessionFactory;
}
@Test
void test() throws IOException {
//1、获取sqlSessionFactory
SqlSessionFactory sqlSessionFactory = getSqlSessionFactory();
//2、获取SqlSession
SqlSession sqlSession = sqlSessionFactory.openSession();
try {
//3、获得接口的实现类对象
//mybatis会自动创建一个代理对象,代理对象执行增删改查
HeroMapper mapper = sqlSession.getMapper(HeroMapper.class);
Hero hero = mapper.getHeroById(3);
System.out.println(hero);
}finally {
sqlSession.close();
}
}
}
Mybatis参数设置
单个参数:mybatis不会做特殊处理,
#{参数名/任意名}:取出参数值。
多个参数:mybatis会做特殊处理。
多个参数会被封装成 一个map,
key:param1.param2..paramN,或者参数的索引也可以
value:传入的参数值
#{}就是从map中获取指定的key的值;
异常:
org.apache.ibatis.binding.BindingException:
Parameter 'id' not found.
Available parameters are [1, 0, param1, param2]
操作:
方法:public Employee getEmpByIdAndLastName(Integer id,String lastName);
取值:#{id},#{lastName}
【命名参数】:明确指定封装参数时map的key;@Param("id")
多个参数会被封装成 一个map,
key:使用@Param注解指定的值
value:参数值
#{指定的key(即id)}取出对应的参数值
POJO:
如果多个参数正好是我们业务逻辑的数据模型,我们就可以直接传入pojo;
#{属性名}:取出传入的pojo的属性值
Map:
如果多个参数不是业务模型中的数据,没有对应的pojo,不经常使用,为了方便,我们也可以传入map
#{key}:取出map中对应的值
TO:
如果多个参数不是业务模型中的数据,但是经常要使用,推荐来编写一个TO(Transfer Object)数据传输对象
Page{
int index;
int size;
}
================================思考================================
public Employee getEmp(@Param("id")Integer id,String lastName);
取值:id==>#{id/param1} lastName==>#{param2}
public Employee getEmp(Integer id,@Param("e")Employee emp);
取值:id==>#{param1} lastName===>#{param2.lastName/e.lastName}
##特别注意:如果是Collection(List、Set)类型或者是数组,
也会特殊处理。也是把传入的list或者数组封装在map中。
key:Collection(collection),如果是List还可以使用这个key(list)数组(array)
public Employee getEmpById(List<Integer> ids);
取值:取出第一个id的值:#{list[0]}
============================参数值的获取============================
#{}:可以获取map中的值或者pojo对象属性的值;
${}:可以获取map中的值或者pojo对象属性的值;
select * from tbl_employee where id=${id} and last_name=#{lastName}
Preparing: select * from tbl_employee where id=2 and last_name=?
区别:
#{}:是以预编译的形式,将参数设置到sql语句中;PreparedStatement;防止sql注入
${}:取出的值直接拼装在sql语句中;会有安全问题;
大多情况下,我们去参数的值都应该去使用#{};
原生jdbc不支持占位符的地方我们就可以使用${}进行取值
比如分表、排序。。。;按照年份分表拆分
select * from ${year}_salary where xxx;
select * from tbl_employee order by ${f_name} ${order}
xxxMapper映射文件
<select id="getHeroById" resultType="com.ys.mybatis.bean.Hero">
<!-- 查询的时候,给名称不对应的可以取别名 -->
select id,name,hp_ hp,damage from hero where id = #{id}
</select>
<!--
parameterType 可以省略
useGeneratedKeys:使用自增主键获取主键值策略
keyProperty:指定对应的属性,也就是mybatis获取到主键值后,将这个值封装到javabean的哪一个属性。
-->
<insert id="addHero" useGeneratedKeys="true" keyProperty="id">
insert into hero(name, hp_, damage) values(#{name}, #{hp}, #{damage})
</insert>
<!-- 如果接口的返回类型是一个Map,且只有一条数据,则resultType="map" -->
<!-- 如果接口的返回类型是一个Map,且有多数据
如:返回Map<Integer, Hero>,key是这条记录的主键,value是JavaBean
则:resultType返回集合中的元素类型
至于返回类型的key如何找到数据库中的主键,则需要对接口中相应函数进行注解@MapKay("id")
-->
<!--
对于表中名称和JavaBean名称不对应的情况,可以有一下三种解决办法:
1、在查询的过程中取别名。
2、如果相对应的名称满足驼峰命名法,则可以在全局配置文件中通过
<setting name="mapUnderscoreToCamelCase" value="true"/>
*3、通过resultMap自定义映射结果规则, 实现高级结果映射。
-->
返回类型resultMap的理解
<?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">
<!-- 对象中引用另外一个对象(查询Hero的时候同时显示Hero的Atribute)的查询-->
<!-- 联合查询一:通过级联属性查询 -->
<!-- 联合查询二:通过association关联的单个对象的封装规则 -->
<!-- 联合查询三:通过association分布查询 -->
<!--
resultMap标签:自定义某个放回类型的规则
type: 自定义规则的Java类型 id:与select中的resultMap值对应
-->
<resultMap type="com.ys.mybatis.bean.Hero" id="myHeroByStep">
<!-- 指定主键的封装规则
column:指定表格中的某一列
property:指定JavaBean中的某一属性
-->
<id column="id" property="id"/>
<!-- 指定其他属性的封装规则 -->
<result column="name" property="name"/>
<result column="hp" property="hp_"/>
<result column="damage" property="damage"/>
<!-- association可以指定联合的javaBean对象
property="attr":指定哪个属性是联合的对象
javaType:指定这个属性对象的类型[不能省略]
selsct:表示当前的属性是由这个方法查出
column:指定将那一列的值传给方法
使用select方法通过column方法查出property的值
返回的类型如果是集合的,则利用collection标签
-->
<association property="attr"
select="com.ys.mybatis.dao.AttributeMapper.getAttrById"
column="c_id">
</association>
</resultMap>
<!-- Hero getHeroByIdStep(int id); -->
<select id="getHeroByIdStep" resultMap="myHeroByStep">
select * from hero where id = #{id}
</select>
<!--
分步查询可以使用懒加载
在全局配置文件中配置
<setting name="lazyLoadingEnabled" value="true"/>
<setting name="aggressiveLazyLoading" value="false"/> defaul=false (true in ≤3.4.1)
-->
</mapper>
MBG
- 根据官方文档
缓存cache
/**
* 两级缓存:
* 一级缓存:(本地缓存) :sqlSession级别的缓存。一级缓存是一直开启的;SqlSession级别的一个Map
* 与数据库同一次会话期间查询到的数据会放在本地缓存中。
* 以后如果需要获取相同的数据,直接从缓存中拿,没必要再去查询数据库;
*
* 一级缓存失效情况(没有使用到当前一级缓存的情况,效果就是,还需要再向数据库发出查询):
* 1、sqlSession不同。
* 2、sqlSession相同,查询条件不同.(当前一级缓存中还没有这个数据)
* 3、sqlSession相同,两次查询之间执行了增删改操作(这次增删改可能对当前数据有影响)
* 4、sqlSession相同,手动清除了一级缓存(缓存清空)
*
* 二级缓存:(全局缓存):基于namespace级别的缓存:一个namespace对应一个二级缓存:
* 工作机制:
* 1、一个会话,查询一条数据,这个数据就会被放在当前会话的一级缓存中;
* 2、如果会话关闭;一级缓存中的数据会被保存到二级缓存中;新的会话查询信息,就可以参照二级缓存中的内容;
* 3、sqlSession===EmployeeMapper==>Employee
* DepartmentMapper===>Department
* 不同namespace查出的数据会放在自己对应的缓存中(map)
* 效果:数据会从二级缓存中获取
* ##查出的数据都会被默认先放在一级缓存中。
* ##只有会话提交或者关闭以后,一级缓存中的数据才会转移到二级缓存中
* 使用:
* 1)、开启全局二级缓存配置:<setting name="cacheEnabled" value="true"/>
* 2)、去mapper.xml中配置使用二级缓存:
* <cache></cache>
* 3)、我们的POJO需要实现序列化接口
*
* ##新会话进入时,首先进入二级缓存,而后再是一级缓存。如果都没有则进入数据库
*
* 和缓存有关的设置/属性:
* 1)、cacheEnabled=true:false:关闭缓存(二级缓存关闭)(一级缓存一直可用的)
* 2)、每个select标签都有useCache="true":
* false:不使用缓存(一级缓存依然使用,二级缓存不使用)
* 3)、【每个增删改标签的:flushCache="true":(一级二级都会清除)】
* 增删改执行完成后就会清楚缓存;
* 测试:flushCache="true":一级缓存就清空了;二级也会被清除;
* 查询标签:flushCache="false":
* 如果flushCache=true;每次查询之后都会清空缓存;缓存是没有被使用的;
* 4)、sqlSession.clearCache();只是清楚当前session的一级缓存;
* 5)、localCacheScope:本地缓存作用域:(一级缓存SESSION);当前会话的所有数据保存在会话缓存中;
* STATEMENT:可以禁用一级缓存;
*
* 第三方缓存整合:
* 1)、导入第三方缓存包即可;
* 2)、导入与第三方缓存整合的适配包;官方有;
* 3)、mapper.xml中使用自定义缓存
* <cache type="org.mybatis.caches.ehcache.EhcacheCache"></cache>
*
*/