mybatis学习笔记
1. HelloWorld
导入mybatis
<dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.3.2</version> </dependency>
1.1 配置文件法
从XML中构建SqlSessionFactory
<?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> <environments default="development"> <environment id="development"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="com.mysql.jdbc.Driver"/> <property name="url" value="jdbc:mysql://"/> <property name="username" value="root"/> <property name="password" value="123456"/> </dataSource> </environment> </environments> <mappers> <mapper resource="mapper/employee-mapper.xml"/> </mappers> </configuration>
mapper
<?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: 唯一标识 returnType: 返回值类型 #{id} 从传递过来的参数中取出id值 --> <mapper namespace="com.meituan.mybatis.bean.EmployeeMapper"> <select id="selectEmp" resultType="com.meituan.mybatis.bean.Employee"> select * from employee where id = #{id} </select> </mapper>
JavaBean
public class Employee { private Integer id; private String lastName; private String email; private String gender; public Integer getId() { return id; } public void setId(Integer id) { this.id = id; } public String getLastName() { return lastName; } public void setLastName(String lastName) { this.lastName = lastName; } public String getEmail() { return email; } public void setEmail(String email) { this.email = email; } public String getGender() { return gender; } public void setGender(String gender) { this.gender = gender; } @Override public String toString() { return "Employee{" + "id=" + id + ", lastName='" + lastName + '\'' + ", email='" + email + '\'' + ", gender='" + gender + '\'' + '}'; } }
单元测试
/** * 1. 根据xml配置文件(全局配置文件)创建一个SqlSessionFactory对象 * 有数据源一些运行环境信息 * 2. sql映射文件,配置了每一个sql,以及sql的封装规则等 * 3. 将sql映射文件注册在全局配置文件中 * 4. 写代码 * 1) 根据全局配置文件得到SqlSessionFactory * 2) 通过SqlSession工厂获取到SqlSession,使用SqlSession执行增删改查,一个SqlSession就是代表和数据库的一次会话,用完关闭 * 3) 使用sql的唯一标识(id)来告诉mybatis执行哪个sql,sql全部保存在sql映射文件(mapper)中 * @throws Exception */ @Test public void test() throws Exception{ String resource = "mybatis-config.xml"; InputStream inputStream = Resources.getResourceAsStream(resource); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream); //2. 获取SqlSession实例,能直接执行已经映射的sql语句 SqlSession sqlSession = sqlSessionFactory.openSession(); /** * Retrieve a single row mapped from the statement key and parameter. * @param <T> the returned object type * @param statement Unique identifier matching the statement to use. 传入唯一标识 * @param parameter A parameter object to pass to the statement. 传入参数 * @return Mapped object */ Employee employee = sqlSession.selectOne("com.meituan.mybatis.bean.EmployeeMapper.selectEmp", 1); System.out.println(employee); }
驼峰命名法问题:
mybatis-config.xml配置文件配置时,要注意节点顺序
<properties>...</properties> <settings>...</settings> <typeAliases>...</typeAliases> <typeHandlers>...</typeHandlers> <objectFactory>...</objectFactory> <objectWrapperFactory>...</objectWrapperFactory> <plugins>...</plugins> <environments>...</environments> <databaseIdProvider>...</databaseIdProvider> <mappers>...</mappers>
增加设置
支持驼峰命名法 <setting name="mapUnderscoreToCamelCase" value="true"/>
1.2 接口式编程
配置文件
<?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: 唯一标识 returnType: 返回值类型 #{id} 从传递过来的参数中取出id值;接口式编程中,id改为方法名 --> <mapper namespace="com.meituan.mybatis.dao.EmployeeMapper"> <select id="getEmpById" resultType="com.meituan.mybatis.bean.Employee"> select * from employee where id = #{id} </select> </mapper>
mapper接口
@Mapper public interface EmployeeMapper { public Employee getEmpById(Integer id); }
单元测试
@Test public void test01() throws Exception { //1. 获取SqlSessionFactory对象 SqlSessionFactory sqlSessionFactory = getSqlSessionFactory(); //2. 获取SqlSession对象 SqlSession sqlSession = sqlSessionFactory.openSession(); try { //3. 获取接口的实现类对象 // mybatis会为接口自动创建一个代理对象,代理对象去执行增删改查方法 EmployeeMapper mapper = sqlSession.getMapper(EmployeeMapper.class); Employee employee = mapper.getEmpById(1); System.out.println(employee); } finally { sqlSession.close(); } } private SqlSessionFactory getSqlSessionFactory() throws Exception{ String resources = "mybatis-config.xml"; InputStream is = Resources.getResourceAsStream(resources); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); return sqlSessionFactory; }
1.3 总结
- 接口式编程
原生: Dao ====> DaoImpl
mybatis: Mapper ==== > xxMapper.xml
- SqlSession代表和数据库的一次,用完必须关闭
- SqlSession和connection一样,都是非线程安全的,每次使用都应该去获取新的对象,不能写为成员变量。
- mapper接口没有实现类,但是mybatis会为这个接口生成一个代理对象
- 两个重要的配置文件
全局配置文件:mybatis-config.xml 包含数据库连接池信息,事务管理器信息等系统运行环境
sql映射文件:保存了每一个sql语句的映射信息
2. Mybatis全局配置文件
<?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> <!-- 1. mybatis可以使用properties来引入外部properties配置文件的内容 属性:resource:引入类路径下的资源 url:引入网络路径或者磁盘路径下的资源 --> <properties resource="dbconfig.properties"> </properties> <!-- 2. 这是 MyBatis 中极为重要的调整设置,它们会改变 MyBatis 的运行时行为。 setting:用来设置每一个设置项 name:设置项名 value:设置项取值 --> <settings> <setting name="mapUnderscoreToCamelCase" value="true"/> </settings> <!-- 3. typeAliases 类型别名是为 Java 类型设置一个短的名字。它只和 XML 配置有关,存在的意义仅在于用来减少类完全限定名的冗余。 别名不区分大小写 typeAlias:为某个java类型起别名 type:指定要起别名的类型全类名;默认别名就是类名小写:employee alias:指定新的别名 <package> :为某个包下的所有类批量起别名 每一个在包 domain.blog 中的 Java Bean,在没有注解的情况下,会使用 Bean 的首字母小写的非限定类名来作为它的别名。 比如 domain.blog.Author 的别名为 author;若有注解,则别名为其注解值。 name:指定包名(为当前包以及下面所有的后代包的每一类都起一个包名) 如果子包下有相同的类名,mybatis会起相同的包名从而报错。可以使用@Alias给特定类指定别名 --> <typeAliases> <!--<typeAlias type="com.meituan.mybatis.config.bean.Employee" alias="emp"></typeAlias>--> <package name="com.meituan.mybatis.config"/> </typeAliases> <!-- 4. typeHandler 无论是 MyBatis 在预处理语句(PreparedStatement)中设置一个参数时,还是从结果集中取出一个值时, 都会用类型处理器将获取的值以合适的方式转换成 Java 类型。 --> <!-- 5. plugins 插件 --> <!-- 6. environment MyBatis 可以配置成适应多种环境,这种机制有助于将 SQL 映射应用于多种数据库之中, 现实情况下有多种理由需要这么做。 default指定使用某种环境来切换环境,可以达到快速切换环境。 environment配置一个具体的环境信息,id代表当前环境的唯一标识,必须有两个标签: transactionManager:事务管理器, type指定事务管理器的类型 在 MyBatis 中有两种类型的事务管理器(也就是 type=”[JDBC|MANAGED]”): JDBC:typeAliasRegistry.registerAlias("JDBC", JdbcTransactionFactory.class); MANAGED:typeAliasRegistry.registerAlias("MANAGED", ManagedTransactionFactory.class); 支持自定义事务管理器,实现TransactionFactory接口即可 dataSource:数据源 type:数据源类型,有三种内建的数据源类型(也就是 type=”[UNPOOLED|POOLED|JNDI]”): 支持自定义数据源,实现DataSourceFactory接口,type为自定义数据源的全类名 --> <environments default="development"> <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> <!-- 7. databaseIdProvider: 支持多数据库厂商 --> <!-- 8. mappers映射器 mapper注册一个sql映射 resource:引用类路径下的sql映射文件 url:引用网络路径下或者磁盘路径下的映射文件 class:使用映射器接口实现类的完全限定类名 1. 有sql映射文件,映射文件名必须和接口同名,并且放在与接口同一目录下 2. 没有sql映射文件,所有的sql都是利用注解写在接口上 package:将包内的映射器接口实现全部注册为映射器 --> <mappers> <mapper resource="mapper/employee-mapper.xml"/> </mappers> <!-- 标签的编写是有顺序的 --> </configuration>
3. Mybatis映射文件
MyBatis 的真正强大在于它的映射语句,也是它的魔力所在。由于它的异常强大,映射器的 XML 文件就显得相对简单。如果拿它跟具有相同功能的 JDBC 代码进行对比,你会立即发现省掉了将近 95% 的代码。MyBatis 就是针对 SQL 构建的,并且比普通的方法做的更好。
3.1 获取自增主键
<?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: 唯一标识 returnType: 返回值类型 #{id} 从传递过来的参数中取出id值 --> <mapper namespace="com.meituan.mybatis.mapper.dao.EmployeeMapper"> <select id="getEmpById" resultType="com.meituan.mybatis.mapper.bean.Employee"> SELECT * FROM employee WHERE id = #{id} </select> <!--parameterType:可以省略 mysql支持自增主键,自增主键的获取,mybatis也是利用statement.getGeneratedKeys(), useGeneratedKeys="true":使用自增主键获取主键值策略 keyProperty:指定对应的主键属性,也就是mybatis获取到主键值以后,将这个值封装给JavaBean的哪个属性 --> <insert id="addEmp" parameterType="com.meituan.mybatis.mapper.bean.Employee" useGeneratedKeys="true" keyProperty="id" > INSERT INTO employee (last_name, email, gender) VALUES (#{lastName}, #{email}, #{gender}) </insert> <update id="updateEmp"> UPDATE employee SET last_name = #{lastName}, email = #{email}, gender = #{gender} WHERE id = #{id} </update> <delete id="deleteEmpById"> DELETE FROM employee WHERE id=#{id} </delete> </mapper>
单元测试
/** * 1. mybatis允许增删改直接定义以下类型返回值 * Integer Long Boolean * 2. 手动提交数据 * @throws Exception */ @Test public void test02() throws Exception { SqlSessionFactory sqlSessionFactory = getSqlSessionFactory(); //1. 获取到的SqlSession不会自动提交 SqlSession sqlSession = sqlSessionFactory.openSession(); try { EmployeeMapper mapper = sqlSession.getMapper(EmployeeMapper.class); Employee employee = new Employee(null, "jerry", "[email protected]", "2"); System.out.println(employee); System.out.println("============"); mapper.addEmp(employee); System.out.println(employee); // employee.setLastName("jason"); // employee.setId(3); // mapper.updateEmp(employee); // mapper.deleteEmpById(3); sqlSession.commit(); } finally { sqlSession.close(); } } private SqlSessionFactory getSqlSessionFactory() throws Exception{ String resources = "mybatis-config.xml"; InputStream is = Resources.getResourceAsStream(resources); SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); return sqlSessionFactory; }
3.2 参数处理
1)单个参数:mybatis不会做特殊处理
2)多个参数
异常:
org.apache.ibatis.exceptions.PersistenceException: ### Error querying database. Cause: org.apache.ibatis.binding.BindingException: Parameter 'id' not found. Available parameters are [arg1, arg0, param1, param2] ### Cause: org.apache.ibatis.binding.BindingException: Parameter 'id' not found. Available parameters are [arg1, arg0, param1, param2]
操作:
方法:public Employee getEmpByIdAndLastName(Integer id ,String lastName);
取值:#{id},#{lastName}
mybatis会特殊处理,多个参数会被封装成一个map
key:param1....paramN
value:传入的参数值
#{}就是从map中获取指定的key值,或者参数的索引也可以
命名参数:
明确指定封装参数值map的key: @Param("id")
POJO:
如果多个参数正好是业务逻辑的数据模型,可以直接传入POJO:
#{属性名}:取出传入的pojo的属性值
Map:
如果多个参数不是业务模型中的数据,没有对应的pojo,不经常使用,为了方便,也可以传入map
如果多个参数不是业务模型中的数据,但是经常使用,推荐写一个TO(Transfer Object) 数据传输对象
3)参数封装扩展思考:
- 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还可以使用(list)
数组(array)
public Employee getEmpById(List<Integer> ids);
取值:取出第一个id的值:#{list[0]}
3.3 结合源码,mybatis如何处理参数
ParamNameResolver解析参数封装map
(1) names:(0=id, 1=lastName)
1) 获取每个标注Param注解的参数param值:id,lastName,赋值给name
2)每次解析一个参数给map中保存信息:key是索引值, value是name的值
name的值:
标注了param注解,注解的值
没有标注:
1、全局配置:useActualParamName,name=参数名(要求JDK1.8)
2、name=map.size() 相当于当前元素的索引
names:{0=id, 1=lastName}
public Object getNamedParams(Object[] args) { final int paramCount = names.size(); //1. 参数为null直接返回 if (args == null || paramCount == 0) { return null; //2. 如果只有一个元素并且没有param注解:args[0],单个参数直接返回 } else if (!hasParamAnnotation && paramCount == 1) { return args[names.firstKey()]; //3. 多个元素或者有Param标注 } else { final Map<String, Object> param = new ParamMap<Object>(); int i = 0; // 4. 遍历names,构造器的时候就已经确定 for (Map.Entry<Integer, String> entry : names.entrySet()) { //names的value作为新map的key,nameskey作为取值的参考 //eg:{id=args[0], lastName=args[1]},因此可以在映射文件中取到相应的值 param.put(entry.getValue(), args[entry.getKey()]); // add generic param names (param1, param2, ...) final String genericParamName = GENERIC_NAME_PREFIX + String.valueOf(i + 1); // ensure not to overwrite parameter named with @Param if (!names.containsValue(genericParamName)) { param.put(genericParamName, args[entry.getKey()]); } i++; } return param; } }
3.4 参数值的获取
#{}:可以获取map中的值或者pojo对象属性的值
${}:可以获取map中的值或者pojo对象属性的值
区别:#{}是以预编译的形式,将参数设置到sql语句中,PreparedStatement
${}:取出的值直接拼装在sql语句中,会有安全问题
大多情况下,取参数的值都应该使用#{},在某些情况下,原生jdbc不支持占位符的地方可以使用${}进行取值,
比如分表;按年份分表拆分 select from 2017_salary可以写为 select from ${year}_salary
3.5 #{}取值规则
更丰富的用法
规定参数的一些规则:
javaType、jdbcType、mode(存储过程)、numericScale、resultMap、typeHandler、jdbcTypeName、expression
jdbcType参演需要在某种特定的条件下被设置
在数据为null的时候,有些数据库可能无法识别mybatis对null的默认处理,如oracle,mybatis对所有的null都映射为原生Jdbc的OTHER类型, oracle无法处理,mysql可以处理
1、#{email, jdbcType=OTHER}
2、全局配置文件mybatis-config.xml中:<setting name="jdbcTypeForNull" value="NULL" />
3.6 Select返回List、Map
- 返回List
<!--resultType:如果返回的是一个集合,要写集合中元素的类型--> <select id="getEmpsByLastNameLike" resultType="com.meituan.mybatis.mapper.bean.Employee"> SELECT * FROM employee WHERE last_name LIKE #{lastName} </select>
- 返回Map,key就是列名,值是对应的值
<!--map是mybatis自定义的别名--> <select id="getEmpByIdReturnMap" resultType="map"> SELECT * FROM employee WHERE id=#{id} </select>
- 多条纪录封装成一个map,Map<Integer, Employee> 键是这条纪录的主键,值是记录封装的JavaBean
<select id="getEmpByLastNameLikeReturnMap" resultType="com.meituan.mybatis.mapper.bean.Employee"> SELECT * FROM employee WHERE last_name LIKE #{lastName} </select>
@MapKey("id") public Map<Integer, Employee> getEmpByLastNameLikeReturnMap(String lastName);
3.7 自定义结果映射封装规则
resultMap
元素是 MyBatis 中最重要最强大的元素。它可以让你从 90% 的 JDBC ResultSets
数据提取代码中解放出来, 并在一些情形下允许你做一些 JDBC 不支持的事情。 实际上,在对复杂语句进行联合映射的时候,它很可能可以代替数千行的同等功能的代码。 ResultMap 的设计思想是,简单的语句不需要明确的结果映射,而复杂一点的语句只需要描述它们的关系就行了。
<resultMap id="myEmp" type="com.meituan.mybatis.mapper.bean.Employee"> <!--column指定哪一列, property指定对应JavaBean属性 id:指定主键列的封装规则,会在底层优化规则 --> <id column="id" property="id"/> <!--定义普通列的封装规则--> <result column="last_name" property="lastName"/> <!--其他不指定的列会自动封装,推荐只要写resultMap,就将全列的映射规则都写上--> <result column="email" property="email"/> <result column="gender" property="gender"/> </resultMap> <select id="getEmpById" resultMap="myEmp"> SELECT * FROM employee WHERE id = #{id} </select>
3.8 关联查询
- 第一种resultMap的写法:
<!-- 场景一: 查询Employee的同时查询员工所在的部门 --> <resultMap id="myDifEmp" type="com.meituan.mybatis.mapper.bean.Employee"> <id column="id" property="id" /> <result column="last_name" property="lastName"/> <result column="email" property="email"/> <result column="gender" property="gender"/> <result column="did" property="dept.id"/> <result column="dept_name" property="dept.departmentName"/> </resultMap> <select id="getEmpAndDept" resultMap="myDifEmp"> SELECT e.id id, e.last_name lastName, e.email email, e.gender gender, e.d_id d_id, d.id did , d.dept_name dept_name from employee e, department d WHERE e.d_id = d.id AND e.id=#{id} </select>
- 第二种resultMap的写法
<resultMap id="myDifEmp2" type="com.meituan.mybatis.mapper.bean.Employee"> <id column="id" property="id" /> <result column="last_name" property="lastName"/> <result column="email" property="email"/> <result column="gender" property="gender"/> <!-- association可以指定联合的JavaBean对象 property ="dept" 指定哪个属性是联合的对象 javaType:指定这个属性对象的类型 --> <association property="dept" javaType="com.meituan.mybatis.mapper.bean.Department"> <id column="did" property="id"/> <result column="dept_name" property="departmentName"/> </association> </resultMap>
- 使用association进行分步查询
<resultMap id="myEmpByStep" type="com.meituan.mybatis.mapper.bean.Employee"> <id column="id" property="id" /> <result column="last_name" property="lastName"/> <result column="email" property="email"/> <result column="gender" property="gender"/> <!--association定义关联对象的封装规则 select:表明当前属性是调用select指定的方法查出的结果 column:指定将哪一列的值传给这个方法 --> <association property="dept" select="com.meituan.mybatis.mapper.dao.DepartmentMapper.getDeptById" column="d_id" ></association> </resultMap> <select id="getEmpByIdStep" resultMap="myEmpByStep"> SELECT * FROM employee WHERE id=#{id} </select>
其中association中select的部分为
<mapper namespace="com.meituan.mybatis.mapper.dao.DepartmentMapper"> <select id="getDeptById" resultType="com.meituan.mybatis.mapper.bean.Department"> SELECT* FROM department WHERE id=#{id} </select> </mapper>
3.9 延迟加载
<!--可以使用延迟加载 Employee===》Dept 每次查询Employee对象的时候,都将部门信息一起查询出来,而需要是: 部门信息在使用的时候再去查询 分步查询的基础之上,加上两个配置,即可实现延迟加载 -->
mybatis-config.xml
<!--显示指定每个需要更改的配置的值,即使是默认的,以防版本更替带来的问题--> <setting name="lazyLoadingEnabled" value="true"/> <setting name="aggressiveLazyLoading" value="false"/>
测试
@Test public void test07() throws Exception { SqlSessionFactory sqlSessionFactory = getSqlSessionFactory(); SqlSession sqlSession = sqlSessionFactory.openSession(); try { Employee employee = sqlSession.selectOne("com.meituan.mybatis.mapper.dao.EmployeeMapperPlus.getEmpByIdStep", 1); System.out.println(employee.getLastName()); System.out.println(employee.getDept().getDeptName()); } finally { sqlSession.close(); } }
输出:
在两次输出中出现一段sql查询
14:23:18.093 [main] DEBUG com.meituan.mybatis.mapper.dao.EmployeeMapperPlus.getEmpByIdStep - ==> Preparing: SELECT * FROM employee WHERE id=? 14:23:18.133 [main] DEBUG com.meituan.mybatis.mapper.dao.EmployeeMapperPlus.getEmpByIdStep - ==> Parameters: 1(Integer) 14:23:18.227 [main] DEBUG com.meituan.mybatis.mapper.dao.EmployeeMapperPlus.getEmpByIdStep - <== Total: 1 tom 14:23:18.228 [main] DEBUG com.meituan.mybatis.mapper.dao.DepartmentMapper.getDeptById - ==> Preparing: SELECT* FROM department WHERE id=? 14:23:18.228 [main] DEBUG com.meituan.mybatis.mapper.dao.DepartmentMapper.getDeptById - ==> Parameters: 2(Integer) 14:23:18.269 [main] DEBUG com.meituan.mybatis.mapper.dao.DepartmentMapper.getDeptById - <== Total: 1 销售部
3.10 collection定义关联集合封装规则
- 嵌套结果集的方式
<!--场景二 查询部门的时候将部门对应的所有员工信息也查询出来 --> <resultMap id="MyDept" type="com.meituan.mybatis.mapper.bean.Department"> <id column="did" property="id" /> <result column="dept_name" property="deptName"/> <!--collection定义关联集合类型的属性的封装规则--> <collection property="emps" ofType="com.meituan.mybatis.mapper.bean.Employee"> <!--定义这个今本中元素的封装规则--> <id column="eid" property="id"/> <result column="last_name" property="lastName"/> <result column="email" property="email"/> <result column="gender" property="gender"/> </collection> </resultMap> <select id="getDeptByIdPlus" resultMap="MyDept"> SELECT d.id did, d.dept_name dept_name, e.id eid, e.last_name last_name, e.email email, e.gender gender FROM department d LEFT JOIN employee e ON d.id=e.d_id WHERE d.id=#{id} </select>
- 分步方式
<resultMap id="MyDeptStep" type="com.meituan.mybatis.mapper.bean.Department"> <id column="id" property="id"/> <result column="departmentName" property="deptName"/> <collection property="emps" select="com.meituan.mybatis.mapper.dao.EmployeeMapper.getEmpByDeptId" column="id" ></collection> </resultMap> <select id="getDeptByIdStep" resultMap="MyDeptStep"> SELECT id,dept_name departmentName FROM department WHERE id=#{id} </select>
扩展:
多列传值
封装成map传递
column="{key1=val1, key2=val2}"
fetchType="lazy",表示使用延迟加载
- lazy:延迟加载
- eager:立即加载
3.11 descriminator 鉴别器
<discriminator javaType="int" column="draft"> <case value="1" resultType="DraftPost"/> </discriminator>
有时一个单独的数据库查询也许返回很多不同 (但是希望有些关联) 数据类型的结果集。 鉴别器元素就是被设计来处理这个情况的, 还有包括类的继承层次结构。 鉴别器非常容易理 解,因为它的表现很像 Java 语言中的 switch 语句。
定义鉴别器指定了 column 和 javaType 属性。 列是 MyBatis 查找比较值的地方。 JavaType 是需要被用来保证等价测试的合适类型(尽管字符串在很多情形下都会有用)。比如:
<resultMap id="vehicleResult" type="Vehicle"> <id property="id" column="id" /> <result property="vin" column="vin"/> <result property="year" column="year"/> <result property="make" column="make"/> <result property="model" column="model"/> <result property="color" column="color"/> <discriminator javaType="int" column="vehicle_type"> <case value="1" resultMap="carResult"/> <case value="2" resultMap="truckResult"/> <case value="3" resultMap="vanResult"/> <case value="4" resultMap="suvResult"/> </discriminator> </resultMap>
4. 动态sql
MyBatis 的强大特性之一便是它的动态 SQL。 mybatis支持OGNL表达式。
4.1 if where trim
<!-- 查询员工,需求:携带了哪个字段查询条件就整个这个字段的值 --> <select id="getEmpsByConditionIf" resultType="com.meituan.mybatis.dynamic.bean.Employee"> SELECT * FROM employee WHERE <!-- test:判断表达式(OGNL) c: if test 从参数中取值进行判断 遇见特殊符号应该去写转义字符 &&需要写为& "需要写为" --> <if test="id != null"> id=#{id} </if> <if test="lastName != null and lastName!=''"> AND last_name LIKE #{lastName} </if> <if test="email!=null and email.trim()!="""> AND email=#{email} </if> <if test="gender==0 or gender == 1"> AND gender=#{gender} </if> </select>
查询时,某些条件缺失(如id),则可能导致sql拼装出现问题
解决方案:
1、WHERE 1=1
WHERE 1=1 <if test = ""> AND *** </if>
2、mybatis推荐的的方案:采用<where>
标签,将所有的查询条件包括在内,mybatis就会将where标签中拼装的sql,多出来的and或者or去掉;where
只会去掉前面多出来的and或者or
<where> <!-- test:判断表达式(OGNL) c: if test 从参数中取值进行判断 遇见特殊符号应该去写转义字符 &&需要写为& "需要写为" --> <if test="id != null"> id=#{id} </if> <if test="lastName != null and lastName!=''"> AND last_name LIKE #{lastName} </if> <if test="email!=null and email.trim()!="""> AND email=#{email} </if> <if test="gender==0 or gender == 1"> AND gender=#{gender} </if> </where>
3、trim标签的使用
<select id="getEmpsByConditionTrim" resultType="com.meituan.mybatis.dynamic.bean.Employee"> SELECT * FROM employee <!--- prefix="" 前缀:trim标签体中是整个字符串拼串后的结果,prefix会给拼串后的整个字符串加一个前缀 prefixOverrides="" 前缀覆盖:去掉整个字符串前面多余的字符 suffix="" 后缀:整个串加后缀 suffixOverrides="" 去掉整个串后面的字符 --> <trim prefix="where" suffixOverrides="and"> <if test="id != null"> id=#{id} AND </if> <if test="lastName != null and lastName!=''"> last_name LIKE #{lastName} AND </if> <if test="email!=null and email.trim()!="""> email=#{email} AND </if> <if test="gender==0 or gender == 1"> gender=#{gender} </if> </trim> </select>
4.2 choose set标签
choose 分支选择,相当于带了break的switch-case
<!-- 如果带了id就用id查,如果带了lastName就用lastName查 --> <select id="getEmpsByConditionChoose" resultType="com.meituan.mybatis.dynamic.bean.Employee"> SELECT * FROM employee <where> <!-- 如果带了id就用id查,如果带了lastName就用lastName查--> <choose> <when test="id!=null"> id=#{id} </when> <when test="lastName!=null"> last_name LIKE #{lastName} </when> <when test="email!=null"> email=#{email} </when> <otherwise> 1=1 </otherwise> </choose> </where> </select>
set标签用于update,可以去掉多掉多余的“,”
4.3 foreach
<select id="getEmpsByConditionForeach" resultType="com.meituan.mybatis.dynamic.bean.Employee"> SELECT * FROM employee WHERE id IN <!-- collection:指定要遍历的集合 list类型的参数会特殊处理封装在map中,map的key就叫list item:将遍历出的元素赋值给指定的变量 #{变量名}就能取出变量的值也就是当前遍历出的元素 separator:每个元素之间的分隔符 open:遍历出的所有结果拼接一个开始的字符 close:遍历出的所有结果拼接一个结束的字符 index:索引。遍历list的时候是索引 遍历map的时候index表示的就是map的key,item就是map的值 --> <foreach collection="ids" item="item_id" separator="," open="(" close=")"> #{item_id} </foreach> </select>
批量插入:
<insert id="addEmpsByConditionForeach"> INSERT INTO employee (last_name, email, gender, d_id) VALUES <foreach collection="list" item="emp" separator=","> (#{emp.lastName}, #{emp.email}, #{emp.gender}, #{emp.dept.id}) </foreach> </insert>
注意:list类型的参数会特殊处理封装在map中,map的key就叫list。如果期望此时传入的参数名由自己定制,可以
1、@Param("*")
2、将list传入自己的map中
4.4 mybatis内置参数
mybatis默认有两个内因参数
1、 _parameter:代表整个参数
单个参数:_parameter就是这个参数
多个参数:参数会被封装为一个map;_parameter就是代表这个map
2、 _databaseId: 如果配置了databaseIdProvider标签,
_databaseId就是代表当前数据库的别名
4.5 bind
bind可以将OGNL表达式的值绑定到一个变量中,方便后来引用,例如:
<bind name="_lastName" value="'%'+lastName+'%'">
4.6 sql 抽取可重用的片段
使用sql标签定义可重用片段
<sql id="insertColumn"> employee_id, last_name, email </sql>
使用include标签引用可重用片段
<include refid"insertColumn"></include>
5. 缓存机制
缓存可以极大的提升查询效率。mybatis默认定义了两级缓存:
- 默认情况下,只有一级缓存(SqlSession级别缓存,也称为本地缓存)开启。
- 二级缓存需要手动开启和配置,是基于namespace级别的缓存,也称全局缓存。
- 为了提高扩展性,mybatis定义了缓存接口Cache。可以通过实现cache接口来自定义二级缓存
5.1 一级缓存
与数据库同一次会话期间查询到的数据会放在本地缓存中,以后如果需要获取相同的数据,直接从缓存中拿,没必要再去查询数据库。mybatis默认开启一级缓存。
一级缓存失效情况
- sqlSession不同
- sqlSession相同,查询条件不同(当前一级缓存中还没有这个数据)
- sqlSession相同,两次查询期间执行了增删改(可能会导致当前数据失效)
- 手动清空了缓存
sqlSession.clearCache();
5.2 二级缓存
基于namespace级别的缓存,一个namespace对应一个二级缓存
工作机制:
1、一个会话(session),查询一条ovry,这个数据就会被放在当前会话的一级缓存中
2、 如果当前会话关闭,一级缓存中的数据会被保存到二级缓存中;新的会话查询信息,可以参照二级缓存
3、 不同namespace查出的数据会放在自己对应的缓存中(map)
4、 查出的数据会默认先放在一级缓存中,只有会话提交或者关闭以后,一级缓存中的数据才会转移到二级缓存中
使用:
1、开启全局二级缓存配置,<setting name="cacheEnabled" value="true"/>
2、在某个namespace中进行配置
<cache eviction="FIFO" flushInterval="60000" size="512" readOnly="true"/>
- eviction
1、LRU – 最近最少使用的:移除最长时间不被使用的对象。
2、FIFO – 先进先出:按对象进入缓存的顺序来移除它们。
3、SOFT – 软引用:移除基于垃圾回收器状态和软引用规则的对象。
4、WEAK – 弱引用:更积极地移除基于垃圾收集器状态和弱引用规则的对象。
默认LRU
- flushInterval:缓存刷新间隔
缓存多久清空一次,默认不清空,单位毫秒
- readOnly:是否只读
true:只读,mybatis认为所有从缓存中获取数据的操作都是只读操作,不会修改数据。mybatis为了加快获取速度,直接会将数据在缓存中的引用交给用户。特点:不安全,速度快
false:不只读。mybatis认为获取的数据可能会被修改,mybatis会利用序列化&反序列的技术克隆一份新的数据给用户。特点:安全,速度慢
- size:缓存多少个元素
- type:指定自定义缓存的全类名,实现Cache接口即可
3、 pojo需要实现序列化接口
5.3 和缓存有关的设置和属性
1、<setting name="cacheEnabled" value="true"/>
开启或关闭缓存
2、 每个select标签都有useCache属性,true为使用,false为不使用(一级缓存依然使用,二级缓存不使用)
3、每个增删改标签的flushCache属性值为true,即增删改执行完成后应付清除缓存,包括一级、二级缓存。查询标签默认flushCache="false",当设置为true时,每次查询之前都会清空缓存,缓存没有被使用
4、sqlSession.clearCache();
只是清除一级缓存
5、localCacheScope:本地缓存作用域(一级缓存),可选择SESSION、STATEMENT。STATEMENT可以禁用缓存
5.4 缓存原理