mybatis（从0-1）你以为？

mybatis

Mybatis系列第1篇：mybatis未出世之前我们那些痛苦的经历

本篇内容

\1. java操作数据库相关的各种技术介绍

\2. 这么多技术，如何选择？

\3. 这么多技术，为什么我们选择的是mybatis

不知道大家是否还记得使用jdbc如何操作数据库？加载驱动、获取连接、拼接sql、执行sql、获取结果、解析结果、关闭数据库，这些操作是纯jdbc的方式必经的一些过程，每次操作数据库都需要写这些，但是真正和开发相关有：拼接sql、执行sql、解析结果，这几个可能不同，而其他的几个步骤是所有db操作共用的一些步骤，所以纯jdbc的方式重复性的代码太多了，如果每个操作都使用这种方式会耗费大量的时间。纯jdbc的方式，sql多数都是写在java代码中，我还记得刚开始工作的时候接触的第一个项目就是jdbc写的，当时jdbc是写在jsp中，调试和维护起来是相当麻烦的。还有就是动态sql方面：面对于各种复杂的条件查询，需要在代码中写很多判断，拼接sql，这种情况估计大家都有经历过，应该是有同感的，各种判断各种拼接没有统一的规范，各种写法也是千奇百怪，最终导致系统难以维护。上面这些问题使系统开发缓慢、难以维护，后面就出现了各种优秀的框架来解决这些问题，下面我们就来看一下常见的db框架及他们的优缺点，以及我们应该如何选择？

Hibernate

这个框架学过，但是实际工作中所有接触的项目都未曾使用过hibernate。

介绍hibernate之前，我们先了解一下什么是ORM？

ORM（Object Relational Mapping）：对象关系映射，简单点说就是将数据库中的表和java中的对象建立映射关系，可以让我们操作对象来间接的操作数据库。

ORM最好的框架就是hibernate，hibernate可以让你通过java对象来间接的操作数据库，java对象就相当于数据库中表的代理一样，当你想删除表的数据的时候，不需要自己写delete语句发给数据库，只需要对hibernate说我需要删除哪个java对象就行了，hibernate自动根据你的操作去生成db需要的sql然后发给db去执行，对于开发者来说隐藏了底层jdbc和db的交互过程，可能开发者不需要掌握数据库技术，就可以通过这个框架直接操作数据库，比如对数据库进行增、删、改、查可能需要开发者会写各种sql脚本，还有每种数据库的sql脚本语法也不一样，刚开始项目使用的是mysql，你按照mysql的语法写的，后面可能要切换到oracle，语法上面需要变动，但是如果你使用hibernate，这些都不是问题，你不会sql也没关系，而你只需要像操作对象一样去操作数据库，hibernate会根据你的操作和db的类型自动生成操作所需要的sql，一种写法能够跨多种数据库运行。

优点

\1. 简化了整个jdbc操作过程

\2. 对于开发者来说不需要关心sql了，只需要去操作对象就可以了，hibernate可以帮我们自动生成所需要的sql

\3. 代码移植性比较好，通过hibernate操作db都是通过操作对象来进行的，而hibernate会根据我们的操作和db的类型生成符合各种db要求的sql，如果我们需要切换db的类型，hibernate会自动适应，对于开发者业务代码来说不需要做任何业务代码上的调整

\4. 开发效率比较高

缺点

\1. sql优化比较艰难，各种操作最终发给db的sql是由hibernate自动生成的，对于开发者来说如果想干预最终需要执行的sql，相对来说比较困难

\2. hibernate入门比较容易，但是想成为高手学习成本比较高

\3. 对于复杂的动态sql，代码中也需要写很多判断进行组装，动态sql这块的支持比较欠缺

如果做一些简单的系统，开发周期也比较紧急，对sql的优化要求也不是很高，可以使用hibernate。

JdbcTemplate

jdbctemplate是在spring框架的基础上开发的一个jdbc框架，所以对spring是有依赖的，它对jdbc做了封装，隐藏了各种重复的操作，使用时只需传入：需要执行的sql、参数以及对于结果如何解析的程序就可以了，使用起来还是很方便的，但是面对与动态sql，它也是无能为力了。整体上来说，jdbctemplate相对于纯jdbc隐藏了很多重复性的操作，对于sql的写法和结果的组装上完全交给了开发者自己去控制，在系统中使用也可以帮助我们节约很多时间，而且学习相当简单，花2个小时就学会了，也是很优秀的一个框架。

Mybatis

mybatis相对于纯jdbc来说，也隐藏了重复性的工作，mybatis是一个半自动化的orm框架，为什么说是半自动化的呢，因为他需要我们自己去写sql，而他做的更好的地方就是动态sql的支持上面，而上面说的各种技术，面对与动态sql只能自己写很多判断去组装sql，而这些判断和组装在mybatis中实现起来就非常简单了，完全由mybatis去帮我们实现了。mybatis将sql交由开发者去控制，所以在sql的优化方面，开发者可以随心所欲，也就是说mybatis将重复性的工作优化到了极致：操作db的过程、动态sql的拼装、结果和对象的映射，这些mybatis都帮我们实现的很好，而让我们将更多的经历花在sql的写法和优化上面，所以毫无疑问mybatis使用人数和公司也是最多的，大部分互联网公司基本上都会使用mybatis，其他2种可以不会，但是mybatis你必须要会。

几种技术的对比

	纯JDBC	Hibernate	JdbcTemplate	Mybatis
代码重复度	高	低	低	低
动态sql支持度	低	低	低	高
sql控制度	高	低	低	高
学习成本	低	高	低	低
开发速度	慢	高	高	高
使用的公司	少	比较多	比较多	最多

后面的文章我们将正式详解mybatis所有知识点，理论**+实战的方式，带领大家成为mybatis****高手，请大家关注！**

Mybatis系列第2篇：mybatis入门，你确定mybatis你玩的很溜？

本篇技术栈

\1. mysql5.7.25

\2. maven3.6.1

\3. jdk1.8

\4. idea

本篇主要内容

\1. 通过一个案例感受一下mybatis的强大之处

\2. mybatis开发项目的具体步骤

\3. 介绍mybatis中主要的几个对象

我们先来一个案例，让大家感受一下mybatis是多么的牛逼，我相信大家看了案例之后，会强烈的激发大家学习mybatis的兴趣。

案例：原来ibatis是这么强大

下面的案例，大家先不用关系代码为什么这么写，先感受一下效果，后面我们再来细说代码，案例代码文章尾部有获取方式。

准备数据库

mysql中运行下面脚本：

*/**创建数据库javacode2018*/
DROP DATABASE IF EXISTS javacode2018;
CREATE DATABASE javacode2018;
USE javacode2018;

*/**创建表结构*/
DROP TABLE IF EXISTS t_user;
CREATE TABLE t_user (
id BIGINT AUTO_INCREMENT PRIMARY KEY COMMENT ‘主键，用户id，自动增长’,
name VARCHAR(32) NOT NULL DEFAULT ‘’ COMMENT ‘姓名’,
age SMALLINT NOT NULL DEFAULT 1 COMMENT ‘年龄’,
salary DECIMAL(12,2) NOT NULL DEFAULT 0 COMMENT ‘薪水’
) COMMENT ‘用户表’;

SELECT * FROM t_user;

上面脚本中，创建了一个javacode2018数据库，然后创建了一个用户表，里面有4个字段，id为主键自动增长。

我们的需求

对t_user表，我们有以下这些需求：

\1. 实现一个通用的插入操作：支持动态插入，可以根据传入的字段的值，动态生成所需要的各种insert语句

\2. 批量插入功能

\3. 实现一个通用的更新操作：支持动态更新操作，可以根据传入的字段，动态生成所需要的各种update语句

\4. 实现一个通用的查询操作：支持各种组合条件查询、支撑排序、分页、支持返回列的控制等各种复杂的查询需求

下面我们就来一个案例，将上面这些需求通过mybatis实现，先见证一下mybatis的强大之处。

创建maven项目

idea中创建maven项目，这个操作在maven系列中已经说过很多次了，以后大部分项目都是通过maven来玩的，maven这方面玩的不是太溜的，可以跳到文章尾部去看一下maven系列的文章。

项目采用maven中聚合及继承的方式来管理。

创建父项目

先创建父项目mybatis-series，父项目的坐标信息：

com.javacode2018
mybatis-series
1.0-SNAPSHOT

创建子项目

创建一个子模块chat01，子模块的坐标信息：

com.javacode2018
chat01
1.0-SNAPSHOT

项目结构

如下图：

引入mybatis依赖

mybatis-series/pom.xml内容如下：

4.0.0 com.javacode2018 mybatis-series 1.0-SNAPSHOT pom chat01 UTF-8 1.8 1.8 1.8 3.5.3 5.1.47 1.18.10 org.mybatis mybatis ${mybatis.version} mysql mysql-connector-java ${mysql.version} org.projectlombok lombok ${lombok.version} provided junit junit 4.12 test ch.qos.logback logback-classic 1.2.3 test

chat01/pom.xml内容如下：

mybatis-series com.javacode2018 1.0-SNAPSHOT 4.0.0 chat01 org.mybatis mybatis mysql mysql-connector-java org.projectlombok lombok junit junit ch.qos.logback logback-classic

上面我们引入了mybatis需要的包、mysql jdbc驱动、lombok、单元测试需要的junit包、日志输出需要的logback包。

这里lombok可能大家没有用过，这个东西可以自动帮我们生成javabean的一些代码，比如get、set方法，可以节省开发编写代码的量，这个以后有空了写一篇文章来介绍。

配置logback

mybatis在运行过程中会输出一些日志，比如sql信息、sql的参数信息、执行的结果等信息，mybatis中会通过logback输出出来。

在chat01/src/main/resources目录中新建文件logback.xml，内容如下：

%d{mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n

创建mybatis相关文件

user.xml

chat01/src/main/resources目录中新建user.xml，内容如下：

(#{item.id}, #{item.name}, #{item.age}, #{item.salary})

mybatis-config.xml

chat01/src/main/resources目录中新建mybatis-config.xml，内容如下：

UserMapper接口

package com.javacode2018.mybatis.chat01;

import java.util.List;
import java.util.Map;

/**

*/
public interface UserMapper {

/**
*** 插入用户信息

*** @param userModel
*** *@*return
*/
void insert(UserModel userModel);

/**
*** 批量插入用户信息

*** @param userModelList
*/
void insertBatch(List userModelList);

/**
*** 更新用户信息

*** @param userModel
*** *@*return
*/
int update(UserModel userModel);

/**
*** 通过map来更新用户记录

*** @param map
*** *@*return
*/
int updateByMap(Map<String, Object> map);

/**
*** 通过map来删除用户记录

*** @param map
*** *@*return
*/
int delete(Map<String, Object> map);

/**
*** 查询用户列表

*** @param map
*** *@*return
*/
List getModelList(Map<String, Object> map);

}

UserModel类

package com.javacode2018.mybatis.chat01;

import lombok.*;

/**

*/
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
@ToString
public class UserModel {
private Long id;
private String name;
private Integer age;
private Double salary;
}

这个类上面的注解都是都是lombok中的，通过这些注解，lombok可以帮助我们自动生成上面4个字段的get方法、set方法、无参构造方法、有参有参构造方法、builder模式构建对象的代码、重写toString方法，这些都在代码编译为字节码之前会写进去，通过lombok代码是不是精简了很多，最后生成的代码大家可以反编译一下UserModel.class去看一下，感受一下，此处我们就不贴出来了。

UserUtil类

package com.javacode2018.mybatis.chat01;

import lombok.extern.slf4j.Slf4j;
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;

/**

*/
@Slf4j
public class UserUtil {
private static SqlSessionFactory sqlSessionFactory = build();

public static SqlSessionFactory build() {
try {
return new SqlSessionFactoryBuilder().build(Resources.getResourceAsStream(“mybatis-config.xml”));
} catch (IOException e) {
log.error(e.getMessage(), e);
throw new RuntimeException(e);
}
}

@FunctionalInterface
public interface SessionCall {
O call(SqlSession session) throws Exception;
}

@FunctionalInterface
public interface MapperCall<T, O> {
O call(T mapper) throws Exception;
}

public static <T, O> O callMapper(Class tClass, MapperCall<T, O> mapper) throws Exception {
return call(session -> mapper.call(session.getMapper(tClass)));
}

public static O call(SessionCall sessionCall) throws Exception {
try (SqlSession session = sqlSessionFactory.openSession(true)😉 {
return sessionCall.call(session);
}
}
}

创建单元测试类UserMapperTest

chat01\src\test\java\com\javacode2018\mybatis\chat01中创建UserMapperTest，代码如下：

package com.javacode2018.mybatis.chat01;

import lombok.extern.slf4j.Slf4j;
import org.junit.Test;

import java.util.*;
import java.util.stream.Collectors;

/**
/*
@Slf4j
public class UserMapperTest {

*//*动态插入
@Test
public void insert() throws Exception {
UserModel userModel1 = UserModel.builder().name(“路人甲Java”).build();
UserUtil.callMapper(UserMapper.class, mapper -> {
mapper.insert(userModel1);
return null;
});
log.info(“插入结果：{}”, this.getModelById(userModel1.getId()));
log.info(“---------------------”);
UserModel userModel2 = UserModel.builder().name(“路人”).age(30).salary(50000.00).build();
UserUtil.callMapper(UserMapper.class, mapper -> {
mapper.insert(userModel2);
return null;
});
log.info(“插入结果：{}”, this.getModelById(userModel2.getId()));
}

*//*批量插入
@Test
public void insertBatch() throws Exception {
List userModelList = new ArrayList<>();
for (int i = 1; i <= 5; i++) {
userModelList.add(UserModel.builder().name(“路人甲Java-” + i).age(30 + i).salary(10000.00 * i).build());
userModelList.add(UserModel.builder().name(“javacode2018-” + i).age(30 + i).salary(10000.00 * i).build());
}
UserUtil.callMapper(UserMapper.class, mapper -> {
mapper.insertBatch(userModelList);
return null;
});

List userModelList1 = UserUtil.callMapper(UserMapper.class, mapper -> mapper.getModelList(null));
log.info(“结果:{}”, userModelList1);
}

//根据用户id删除数据
@Test
public void delete() throws Exception {
Map<String, Object> map = new HashMap<>();
*//*需要删除的用户id
map.put(“id”, 1);
Integer count = UserUtil.callMapper(UserMapper.class, mapper -> mapper.delete(map));
log.info(“删除行数：{}”, count);
}

//动态更新
@Test
public void update() throws Exception {
*//将userId=2的name*修改为：路人
Long userId1 = 2L;
Integer count = UserUtil.callMapper(UserMapper.class, mapper -> mapper.update(UserModel.builder().id(userId1).name(“ready”).build()));
log.info(“更新行数：{}”, count);

log.info(“---------------------”);
*//将userId=3的name**修改为：路人,*薪水为：1000.88
Long userId2 = 3L;
count = UserUtil.callMapper(UserMapper.class, mapper -> mapper.update(UserModel.builder().id(userId2).name(“ready”).salary(1000.88D).build()));
log.info(“更新行数：{}”, count);
}

//按用户id查询
public UserModel getModelById(Long userId) throws Exception {
//查询指定id的数据
Map<String, Object> map = new HashMap<>();
map.put(“id”, userId);
return UserUtil.callMapper(UserMapper.class, mapper -> {
List userModelList = mapper.getModelList(map);
if (userModelList.size() == 1) {
return userModelList.get(0);
}
return null;
});
}

*//*查询所有数据
@Test
public void getModelList1() throws Exception {
List userModelList = UserUtil.callMapper(UserMapper.class, mapper -> mapper.getModelList(null));
log.info(“结果:{}”, userModelList);
}

//查询多个用户id对应的数据
@Test
public void getModelListByIds() throws Exception {
List idList = Arrays.asList(2, 3, 4).stream().collect(Collectors.toList());
Map<String, Object> map = new HashMap<>();
map.put(“idList”, idList);

List userModelList = UserUtil.callMapper(UserMapper.class, mapper -> mapper.getModelList(map));
log.info(“结果:{}”, userModelList);
}

//多条件 & 指定返回的列
@Test
public void getModelList2() throws Exception {
*//查询姓名中包含路人甲java以及薪资大于3万的用户id、姓名*
Map<String, Object> map = new HashMap<>();
map.put(“nameLike”, “路人甲java”);
map.put(“salaryGte”, 30000.00D);
*//*需要返回的列
List tableColumnList = new ArrayList<>();
tableColumnList.add(“id”);
tableColumnList.add(“name”);
map.put(“tableColumnList”, tableColumnList);

List userModelList = UserUtil.callMapper(UserMapper.class, mapper -> mapper.getModelList(map));
log.info(“结果:{}”, userModelList);
}

//条件过滤 & 排序 & 分页查询数据 & 只返回用户id、salary
@Test
public void getPage() throws Exception {
//查询姓名中包含路人甲java以及薪资大于3万的用户id，按照薪资倒叙，每页5条取第1页
Map<String, Object> map = new HashMap<>();
map.put(“nameLike”, “路人甲java”);
map.put(“salaryGte”, 30000.00D);

*//*加入排序参数
map.put(“sort”, “salary desc”);

*//*加入分页参数
int page = 1;
int pageSize = 5;
map.put(“skip”, (page - 1) * pageSize);
map.put(“pageSize”, pageSize);

*//*加入需要返回的列
List tableColumnList = new ArrayList<>();
tableColumnList.add(“id”);
tableColumnList.add(“salary”);
map.put(“tableColumnList”, tableColumnList);

List userModelList = UserUtil.callMapper(UserMapper.class, mapper -> mapper.getModelList(map));
log.info(“结果:{}”, userModelList);
}
}

项目最终结构如下

用例：动态插入

运行UserMapperTest#insert，输出如下：

37:58.556 [main] DEBUG c.j.mybatis.chat01.UserMapper.insert - ==> Preparing: INSERT INTO t_user ( name ) VALUES ( ? )
37:58.605 [main] DEBUG c.j.mybatis.chat01.UserMapper.insert - > Parameters: 路人甲Java(String)
37:58.613 [main] DEBUG c.j.mybatis.chat01.UserMapper.insert - < Updates: 1
37:58.641 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - ==> Preparing: SELECT id, name, age, salary FROM t_user a WHERE a.id = ?
37:58.641 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - > Parameters: 1(Long)
37:58.663 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - < Total: 1
37:58.664 [main] INFO c.j.mybatis.chat01.UserMapperTest - 插入结果：UserModel(id=1, name=路人甲Java, age=1, salary=0.0)
37:58.667 [main] INFO c.j.mybatis.chat01.UserMapperTest - ---------------------
37:58.668 [main] DEBUG c.j.mybatis.chat01.UserMapper.insert - ==> Preparing: INSERT INTO t_user ( name, age, salary ) VALUES ( ?, ?, ? )
37:58.675 [main] DEBUG c.j.mybatis.chat01.UserMapper.insert - > Parameters: 路人(String), 30(Integer), 50000.0(Double)
37:58.679 [main] DEBUG c.j.mybatis.chat01.UserMapper.insert - < Updates: 1
37:58.681 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - ==> Preparing: SELECT id, name, age, salary FROM t_user a WHERE a.id = ?
37:58.681 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - > Parameters: 2(Long)
37:58.683 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - < Total: 1
37:58.683 [main] INFO c.j.mybatis.chat01.UserMapperTest - 插入结果：UserModel(id=2, name=路人, age=30, salary=50000.0)

UserMapperTest#insert这个方法主要有4步操作：

步骤1：插入一条用户记录，用户记录只有name字段有值

步骤2：去db中查询步骤1中插入的记录

步骤3：插入一条用户记录，这次插入的记录所有字段都指定了值

步骤4：去db中查询步骤3中插入的记录

**重点来了：**大家认真看一下UserMapperTest#insert方法的代码，两个插入调用都是mapper.insert方法，传入的都是UserModel对象，唯一不同的是这个对象构建的时候字段的值不一样，最后再认真看一下上面输出的sql，产生的2个insert也是不一样的，这个mapper.insert方法可以根据UserModel对象字段是否有值来组装我们需要的sql，是不是很牛逼，这就是动态插入。

用例：批量插入

运行UserMapperTest#insertBatch，输出如下：

38:12.425 [main] DEBUG c.j.m.chat01.UserMapper.insertBatch - ==> Preparing: INSERT INTO t_user (id, name, age, salary) VALUES (?, ?, ?, ?) , (?, ?, ?, ?) , (?, ?, ?, ?) , (?, ?, ?, ?) , (?, ?, ?, ?) , (?, ?, ?, ?) , (?, ?, ?, ?) , (?, ?, ?, ?) , (?, ?, ?, ?) , (?, ?, ?, ?)
38:12.476 [main] DEBUG c.j.m.chat01.UserMapper.insertBatch - > Parameters: null, 路人甲Java-1(String), 31(Integer), 10000.0(Double), null, javacode2018-1(String), 31(Integer), 10000.0(Double), null, 路人甲Java-2(String), 32(Integer), 20000.0(Double), null, javacode2018-2(String), 32(Integer), 20000.0(Double), null, 路人甲Java-3(String), 33(Integer), 30000.0(Double), null, javacode2018-3(String), 33(Integer), 30000.0(Double), null, 路人甲Java-4(String), 34(Integer), 40000.0(Double), null, javacode2018-4(String), 34(Integer), 40000.0(Double), null, 路人甲Java-5(String), 35(Integer), 50000.0(Double), null, javacode2018-5(String), 35(Integer), 50000.0(Double)
38:12.484 [main] DEBUG c.j.m.chat01.UserMapper.insertBatch - < Updates: 10
38:12.502 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - ==> Preparing: SELECT id, name, age, salary FROM t_user a
38:12.502 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - > Parameters:
38:12.521 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - < Total: 12
38:12.521 [main] INFO c.j.mybatis.chat01.UserMapperTest - 结果:[UserModel(id=1, name=路人甲Java, age=1, salary=0.0), UserModel(id=2, name=路人, age=30, salary=50000.0), UserModel(id=3, name=路人甲Java-1, age=31, salary=10000.0), UserModel(id=4, name=javacode2018-1, age=31, salary=10000.0), UserModel(id=5, name=路人甲Java-2, age=32, salary=20000.0), UserModel(id=6, name=javacode2018-2, age=32, salary=20000.0), UserModel(id=7, name=路人甲Java-3, age=33, salary=30000.0), UserModel(id=8, name=javacode2018-3, age=33, salary=30000.0), UserModel(id=9, name=路人甲Java-4, age=34, salary=40000.0), UserModel(id=10, name=javacode2018-4, age=34, salary=40000.0), UserModel(id=11, name=路人甲Java-5, age=35, salary=50000.0), UserModel(id=12, name=javacode2018-5, age=35, salary=50000.0)]

这次批量插入了10条用户记录，可以看到有这样的输出：

40:40.727 [main] DEBUG c.j.m.chat01.UserMapper.insertBatch - <== Updates: 10

上面这个表示插入影响的行数，10表示插入了10行。

批量插入之后，又执行了全表查询，这次插入了10条，加上前面的2个单条插入，表中总计12条记录。

用例：根据用户id删除数据

运行UserMapperTest#delete，输出如下：

38:36.498 [main] DEBUG c.j.mybatis.chat01.UserMapper.delete - ==> Preparing: DELETE FROM t_user WHERE id = ?
38:36.551 [main] DEBUG c.j.mybatis.chat01.UserMapper.delete - > Parameters: 1(Integer)
38:36.560 [main] DEBUG c.j.mybatis.chat01.UserMapper.delete - < Updates: 1
38:36.561 [main] INFO c.j.mybatis.chat01.UserMapperTest - 删除行数：1

用例：动态更新

运行UserMapperTest#update，输出如下：

38:51.289 [main] DEBUG c.j.mybatis.chat01.UserMapper.update - ==> Preparing: UPDATE t_user SET name = ? WHERE id = ?
38:51.347 [main] DEBUG c.j.mybatis.chat01.UserMapper.update - > Parameters: ready(String), 2(Long)
38:51.355 [main] DEBUG c.j.mybatis.chat01.UserMapper.update - < Updates: 1
38:51.356 [main] INFO c.j.mybatis.chat01.UserMapperTest - 更新行数：1
38:51.358 [main] INFO c.j.mybatis.chat01.UserMapperTest - ---------------------
38:51.359 [main] DEBUG c.j.mybatis.chat01.UserMapper.update - ==> Preparing: UPDATE t_user SET name = ?, salary = ? WHERE id = ?
38:51.360 [main] DEBUG c.j.mybatis.chat01.UserMapper.update - > Parameters: ready(String), 1000.88(Double), 3(Long)
38:51.363 [main] DEBUG c.j.mybatis.chat01.UserMapper.update - < Updates: 1
38:51.364 [main] INFO c.j.mybatis.chat01.UserMapperTest - 更新行数：1

UserMapperTest#update方法，大家也认真看一下，2个更新，调用都是mapper.update方法，传入的都是UserModel类型的参数，只是2个UserModel对象的字段值不一样，最后产生的2个update语句也是不一样的，这个update语句是mybatis动态组装的，mybatis可以根据UserModel中字段是否为NULL，来拼装sql，这个更新是不是很强大。

用例：动态查询

查询所有数据

运行UserMapperTest#getModelList1，输出如下：

39:10.552 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - ==> Preparing: SELECT id, name, age, salary FROM t_user a
39:10.611 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - > Parameters:
39:10.639 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - < Total: 11
39:10.639 [main] INFO c.j.mybatis.chat01.UserMapperTest - 结果:[UserModel(id=2, name=ready, age=30, salary=50000.0), UserModel(id=3, name=ready, age=31, salary=1000.88), UserModel(id=4, name=javacode2018-1, age=31, salary=10000.0), UserModel(id=5, name=路人甲Java-2, age=32, salary=20000.0), UserModel(id=6, name=javacode2018-2, age=32, salary=20000.0), UserModel(id=7, name=路人甲Java-3, age=33, salary=30000.0), UserModel(id=8, name=javacode2018-3, age=33, salary=30000.0), UserModel(id=9, name=路人甲Java-4, age=34, salary=40000.0), UserModel(id=10, name=javacode2018-4, age=34, salary=40000.0), UserModel(id=11, name=路人甲Java-5, age=35, salary=50000.0), UserModel(id=12, name=javacode2018-5, age=35, salary=50000.0)]

可以看到sql是没有查询条件的。

查询多个用户id对应的数据

运行UserMapperTest#getModelListByIds，输出如下：

39:38.000 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - ==> Preparing: SELECT id, name, age, salary FROM t_user a WHERE a.id IN ( ? , ? , ? )
39:38.064 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - > Parameters: 2(Integer), 3(Integer), 4(Integer)
39:38.096 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - < Total: 3
39:38.097 [main] INFO c.j.mybatis.chat01.UserMapperTest - 结果:[UserModel(id=2, name=ready, age=30, salary=50000.0), UserModel(id=3, name=ready, age=31, salary=1000.88), UserModel(id=4, name=javacode2018-1, age=31, salary=10000.0)]

上面这个按照id列表查询也是比较常用的，比如我们在电商中查询订单列表，还需要查询每个订单对应的商品，此时可以先查询订单列表，然后在通过订单列表拿到所有的商品id集合，然后通过商品id集合去通过上面的方式检索商品信息，只需要2次查询就可以查询出订单及商品的信息了。

多条件 & 指定返回的列

运行UserMapperTest#getModelList2，查询姓名中包含路人甲java以及薪资大于3万的用户id、姓名，输出如下：

41:12.185 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - ==> Preparing: SELECT id , name FROM t_user a WHERE a.name like ‘%路人甲java%’ AND a.salary >= ?
41:12.275 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - > Parameters: 30000.0(Double)
41:12.311 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - < Total: 3
41:12.312 [main] INFO c.j.mybatis.chat01.UserMapperTest - 结果:[UserModel(id=7, name=路人甲Java-3, age=null, salary=null), UserModel(id=9, name=路人甲Java-4, age=null, salary=null), UserModel(id=11, name=路人甲Java-5, age=null, salary=null)]

看一下上面select语句，select后面只有id,name2个字段，where后面有多个条件，这种查询也是比较常用的，有些表可能有几十个字段，可能我们只需要几个字段，就可以使用上面这种查询。

条件过滤 & 排序 & 分页查询数据 & 只返回用户id、salary

运行UserMapperTest#getModelList3，查询姓名中包含路人甲java以及薪资大于3万的用户id，按照薪资倒叙，每页5条取第1页，输出如下：

44:00.719 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - ==> Preparing: SELECT id , salary FROM t_user a WHERE a.name like ‘%路人甲java%’ AND a.salary >= ? order by salary desc LIMIT ?,?
44:00.775 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - > Parameters: 30000.0(Double), 0(Integer), 5(Integer)
44:00.805 [main] DEBUG c.j.m.chat01.UserMapper.getModelList - < Total: 3
44:00.806 [main] INFO c.j.mybatis.chat01.UserMapperTest - 结果:[UserModel(id=11, name=null, age=null, salary=50000.0), UserModel(id=9, name=null, age=null, salary=40000.0), UserModel(id=7, name=null, age=null, salary=30000.0)]

大家主要看一下输出的sql，如下：

SELECT id , salary FROM t_user a WHERE a.name like ‘%路人甲java%’ AND a.salary >= ? order by salary desc LIMIT ?,?

这个sql会根据查询条件，自动构建出我们需要的sql，这点上面是最厉害的。

案例总结

上面列举的一些用例基本上包含了我们对db所需的大部分操作，动态sql处理方面体现的最为强劲，如果让我们自己写，我们需要写很多判断，而用mybatis这么简单就实现了，我们在java代码中没有看到一个判断拼接语句，而这些sql的判断拼接都在一个文件中：user.xml中，这个就是mybatis中核心的文件，我们需要写的sql及判断逻辑基本上都在这个xml中，大家可以认真去看一下这个xml文件。

mybatis开发项目的具体步骤

项目中引入mybatis maven配置

org.mybatis mybatis ${mybatis.version}

上面的mybatis.version版本，大家可以在maven社区中央仓库中去查找最新的，目前最新的是3.5.3

创建mybatis配置文件

mybatis配置文件为xml格式，可以放在resource目录下面，如上面案例中的mybatis-config.xml，内容如下：

这个文件主要是对mybatis进行全局配置，比如数据源、事务的配置，如上面的datasource元素用来配置数据源，数据源中就需要指定数据库的一些配置信息；还有其他更多的配置，此处先不做具体说明，后面我们慢慢来，整个系列完成之后，这些配置大家都会懂的。

创建mapper xml文件

如上面案例中的user.xml，大家在打开看看，我们需要对t_user表所有操作sql就写在这个文件中，下一篇文章我们会详细介绍mapper xml文件的各种写法，user.xml文件是对t_user表的所有操作一般都会放在这个里面，mybatis如何使用到这个文件呢，我们需要在上面的mybatis配置文件中引入这个mapper文件，如案例中在mybatis-config.xml有下面这样的内容：

mappers元素中可以有多个mapper文件，我们开发的项目中可能有很多表需要操作，那么对应会有很多mapper xml文件，我们都需要在mappers元素中进行引入，然后mybatis才会使用到。

创建Mapper接口

开发者如何去调用user.xml中的各种操作去执行sql呢，这时我们就需要一个Mapper接口了，Mapper接口会和mapper xml建立映射关系，当我们调用Mapper接口中的方法的时候，会间接的调用到mapper xml中的各种数据的sql操作，Mapper接口如何和Mapper xml文件关联的呢？

大家去看一下user.xml文件中有个这样的一个配置：

注意上面的namespace的值，对应的是UserMapper这个接口完整的引用，通过这个namespace，UserMapper接口就可以user.xml建立了映射关系。

user.xml中又有很多db操作，这些操作会和UserMapper接口中的方法建立映射关系，当调用UserMapper中的方法的时候，间接的会调用到user.xml中对应的操作。

如user.xml中有下面一段配置：

(#{item.id}, #{item.name}, #{item.age}, #{item.salary})

而UserMapper中有个insertBatch方法和上面这个insert批量插入对应，如下：

/**
*** 批量插入用户信息

*** @param userModelList
*/
void insertBatch(List userModelList);

所以当我们调用UserMapper中的insertBatch方法的时候，会间接调用到user.xml中的 id="insertBatch"这个操作。

提示一下：接口和mapper xml映射起来间接调用，是通过java动态代理实现的，后面我们会详解如何实现的。

下面我们就可以使用mybatis来操作db了。

通过mybatis获取Mapper接口执行对db的操作

上面我们说了，我们可以通过mapper接口来执行对db的操作，获取Mapper的主要代码如下：

SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(Resources.getResourceAsStream(“mybatis-config.xml”));
SqlSession sqlSession = sqlSessionFactory.openSession(true);
UserMapper mapper = sqlSession.getMapper(UserMapper.class);

上面代码中使用到了mybatis中的核心组件，我们具体来看一下。

Mybatis核心对象介绍

SqlSessionFactoryBuilder

这个是一个构建器，通过名字大家也可以感觉到SqlSessionFactoryBuilder构建器，是用来构建SqlSessionFactory对象的，SqlSessionFactoryBuilder可以通过读取mybatis的配置文件，然后构建一个SqlSessionFactory对象，一个项目中有很多mapper xml文件，如果每次操作都去重新解析是非常慢的，那么怎么办？

能不能第一次解析好然后放在内存中，以后直接使用，SqlSessionFactoryBuilder就是搞这个事情的，将mybatis配置文件、mapper xml文件、mapper xml文件和Mapper 接口的映射关系，这些都先给解析好，然后放在java对象中，java对象存在于内存中，内存中访问会非常快的，那么我们每次去用的时候就不需要重新去解析xml了，SqlSessionFactoryBuilder解析配置之后，生成的对象就是SqlSessionFactory，这个是一个重量级的对象，创建他是比较耗时的，所以一般一个db我们会创建一个SqlSessionFactory对象，然后在系统运行过程中会一直存在，而SqlSessionFactoryBuilder用完了就可以释放了。

SqlSessionFactory

通过名字可以知道，这个是一个工厂，是用来创建SqlSession的工厂，SqlSessionFactory是一个重量级的对象，一般一个db对应一个SqlSessionFactory对象，系统运行过程中会一直存在。

SqlSessionFactory是一个接口，这个接口有2个实现DefaultSqlSessionFactory和SqlSessionManager，一般都是通过SqlSessionFactoryBuilder来创建SqlSessionFactory对象。

通过SqlSessionFactoryBuilder来创建SqlSessionFactory对象主要有2种方式，一种通过读取mybatis配置文件的方式，另外一种是硬编码的方式，这个后面会专门抽一篇文件介绍这块，springboot中会使用到硬编码的方式，所以这块会详细介绍。

SqlSession

我们通过jdbc操作数据库需要先获取一个Connection连接，然后拿着这个连接去对db进行操作，在mybatis中SqlSession就类似于jdbc中Connection连接对象，在mybatis中叫做Sql会话对象，一般我们一个db操作使用一个SqlSession对象，所以这个对象一般是方法级别的，方法结束之后，这个对象就销毁了，这个对象可以调用sqlSessionFactory.openSession的方法来进行获取。

我们可以直接通过SqlSession对象来调用mapper xml中各种db操作，需要指定具体的操作的id，id的格式为namespace.操作的id。

Mapper接口

我们可以通过SqlSession直接调用mapper xml中的db操作，不过更简单的以及推荐的方式是使用Mapper接口，Mapper接口中的方法和mapper xml文件中的各种db操作建立了映射关系，是通过Mapper接口完整名称+方法名称和mapper xml中的namespace+具体操作的id来进行关联的，然后我们直接调用Mapper接口中的方法就可以间接的操作db了，使用想当方便，Mapper接口需要通过SqlSession获取，传入Mapper接口对应的Class对象，然后会返回这个接口的实例，如：

UserMapper mapper = sqlSession.getMapper(UserMapper.class);

总结

本篇文章主要通过一个案例来感受一下mybatis可以干什么，以及他的强大之处，还需要大家掌握mybatis开发项目的具体步骤，后面的文章将对mybatis中具体的知识点做详细介绍，让大家成为mybatis高手。

MyBatis系列

\1. MyBatis系列第1篇：MyBatis未出世之前我们那些痛苦的经历

Mybatis系列第3篇：Mybatis使用详解(-)

主要内容

\1. 快速入门

– 准备数据库

– 我们的需求

– 使用idea****创建项目

– pom.xml中引入mybatis依赖

– 配置mybatis****全局配置文件

– 创建Mapper xml****文件

– mybatis全局配置文件中引入Mapper xml文件

– 构建SqlSessionFactory****对象

– 构建SqlSession****对象

– 引入lombok**（非必须）**

– 引入logback****支持（非必须）

– 写一个测试用例

\2. 使用SqlSesion执行sql操作

– SqlSession****常见的用法

– 新增操作

– 执行删除

– 执行修改

– 执行查询

\3. Mapper****接口的使用

– 为什么需要Mapper****接口

– Mapper****接口的用法

– 案例：使用Mapper接口来实现增删改查

– Mapper****接口使用时注意的几点

– Mapper****接口的原理

快速入门

准备数据库

mysql中执行下面sql：

*/**创建数据库javacode2018*/
DROP DATABASE IF EXISTS javacode2018;
CREATE DATABASE javacode2018;
USE javacode2018;

SELECT * FROM t_user;

上面我们创建了一个数据库：javacode2018，一个用户表t_user。

我们的需求

使用mybatis来实现对t_user表增删改查。

使用idea创建项目

我们在上一篇文章mybatis-series项目中创建另外一个模块chat02，过程如下：

选中mybatis-series，如下图：

点击右键->New->Module，如下图：

选中上图中的Maven，点击Next，如下图：

出现下面窗口：

上图中输入ArtifactId为chat02，点击Next，如下图：

![img](file:///C:/Users/24340/AppData/Local/Temp/msohtmlclip1/01/clip_image015.png)

点击上图中的Finish完成chat02模块的创建，项目结构如下图：

pom.xml中引入mybatis依赖

org.mybatis mybatis mysql mysql-connector-java org.projectlombok lombok junit junit ch.qos.logback logback-classic

上面我们引入了依赖mybatis、mysql驱动、lombok支持、junit、logback支持，其实运行mybatis只需要引入下面这一个构件就行了：

org.mybatis mybatis

注意：上面pom引入的构建中没有写版本号，是因为构件的版本号在父pom.xml中已经声明了，所以chat03/pom.xml中就不需要再去写了。

配置mybatis全局配置文件

使用mybatis操作数据库，那么当然需要配置数据库相关信息，这个需要在mybatis全局配置文件中进行配置。

mybatis需提供一个全局配置的xml文件，可以在这个配置文件中对mybatis进行配置，如事务的支持，数据源的配置等等，这个属于配置文件，我们一般放在main/resource中。

在chat03/src/main/resource中创建mybatis-config.xml文件，内容如下：

我们做一下解释。

configuration元素

这个是mybatis全局配置文件的根元素，每个配置文件只有一个

environments元素

用来配置mybatis的环境信息，什么是环境？比如开发环境、测试环境、线上环境，这3个环境中的数据库可能是不一样的，可能还有更多的环境。

environments元素中用来配置多个环境的，具体的一个环境使用environment元素进行配置，environment元素有个id用来标识某个具体的环境。

配置了这么多环境，那么mybatis具体会使用哪个呢？

environments元素有个default属性，用来指定默认使用哪个环境，如上面默认使用的是chat03。

environment元素

用来配置具体的环境信息，这个元素下面有两个子元素：transactionManager****和dataSource

• transactionManager元素

用来配置事务工厂的，有个type属性，type的值必须是org.apache.ibatis.transaction.TransactionFactory接口的实现类，TransactionFactory看名字就知道是一个工厂，用来创建事务管理器org.apache.ibatis.transaction.Transaction对象的，TransactionFactory接口默认有2个实现：

org.apache.ibatis.transaction.managed.ManagedTransactionFactory
org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory

一般情况下我们使用org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory这个，mybatis和其他框架集成，比如和spring集成，事务交由spring去控制，spring中有TransactionFactory接口的一个实现org.mybatis.spring.transaction.SpringManagedTransactionFactory，有兴趣的朋友可以去研究一下，这个到时候讲到spring的使用会详细说。

• dataSource元素

这个用来配置数据源的，type属性的值必须为接口org.apache.ibatis.datasource.DataSourceFactory的实现类，DataSourceFactory也是一个工厂，用来创建数据源javax.sql.DataSource对象的，mybatis中这个接口默认有3个实现类：

org.apache.ibatis.datasource.jndi.JndiDataSourceFactory
org.apache.ibatis.datasource.pooled.PooledDataSourceFactory
org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory

我们使用第2个org.apache.ibatis.datasource.pooled.PooledDataSourceFactory，这个用来创建一个数据库连接池类型的数据源，可以实现数据库连接共用，减少连接重复创建销毁的时间。

配置数据源需要指定数据库连接的属性信息，比如：驱动、连接db的url、用户名、密码，这个在dataSource元素下面的property中配置，property元素的格式：

创建Mapper xml文件

我们需要对t_user表进行操作，需要写sql，sql写在什么地方呢？

在mybatis中一般我们将一个表的所有sql操作写在一个mapper xml中，一般命名为XXXMapper.xml格式。

创建文件chat02/src/main/resource/mapper/UserMapper.xml，内容如下：

mapper xml根元素为mapper，这个元素有个namespace属性，系统中会有很多表，每个表对应一个Mapper xml，为了防止mapper文件重复，我们需要给每个mapper xml文件需要指定一个namespace，通过这个可以区分每个mapper xml文件，上面我们指定为com.javacode2018.chat02.UserMapper。

一会对t_user表的所有操作相关的sql，我们都会写在上面这个xml中。

mybatis全局配置文件中引入Mapper xml文件

UserMapper.xml我们写好了，如何让mybatis知道这个文件呢，此时我们需要在mybatis-config.xml全局配置文件中引入UserMapper.xml，在mybatis-config.xml加入下面配置：

mappers元素下面有多个mapper元素，通过mapper元素的resource属性可以引入Mapper xml文件，resource是相对于classes的路径。

上面说的都是一些配置文件，配置文件都ok了，下面我们就需要将mybatis跑起来了，此时需要使用到mybatis中的一些java对象了。

构建SqlSessionFactory对象

//指定mybatis全局配置文件
String resource = “mybatis-config.xml”;
*//*读取全局配置文件
InputStream inputStream = Resources.getResourceAsStream(resource);
//构建SqlSessionFactory对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

SqlSessionFactory是一个接口，是一个重量级的对象，SqlSessionFactoryBuilder通过读取全局配置文件来创建一个SqlSessionFactory，创建这个对象是比较耗时的，主要耗时在对mybatis全局配置文件的解析上面，全局配置文件中包含很多内容，SqlSessionFactoryBuilder通过解析这些内容，创建了一个复杂的SqlSessionFactory对象，这个对象的生命周期一般和应用的生命周期是一样的，随着应用的启动而创建，随着应用的停止而结束，所以一般是一个全局对象，一般情况下一个db对应一个SqlSessionFactory对象。

构建SqlSession对象

SqlSession相当于jdbc中的Connection对象，相当于数据库的一个连接，可以用SqlSession来对db进行操作：如执行sql、提交事务、关闭连接等等，需要通过SqlSessionFactory来创建SqlSession对象，SqlSessionFactory中常用的有2个方法来创建SqlSession对象，如下：

//创建一个SqlSession，默认不会自动提交事务
SqlSession openSession();
//创建一个SqlSession,autoCommit：指定是否自动提交事务
SqlSession openSession(boolean autoCommit);

SqlSession接口中很多方法，直接用来操作db，方法清单如下，大家眼熟一下：

T selectOne(String statement);
T selectOne(String statement, Object parameter);
List selectList(String statement);
List selectList(String statement, Object parameter);
List selectList(String statement, Object parameter, RowBounds rowBounds);
<K, V> Map<K, V> selectMap(String statement, String mapKey);
<K, V> Map<K, V> selectMap(String statement, Object parameter, String mapKey);
<K, V> Map<K, V> selectMap(String statement, Object parameter, String mapKey, RowBounds rowBounds);
Cursor selectCursor(String statement);
Cursor selectCursor(String statement, Object parameter);
Cursor selectCursor(String statement, Object parameter, RowBounds rowBounds);
void select(String statement, Object parameter, ResultHandler handler);
void select(String statement, ResultHandler handler);
void select(String statement, Object parameter, RowBounds rowBounds, ResultHandler handler);
int insert(String statement);
int insert(String statement, Object parameter);
int update(String statement);
int update(String statement, Object parameter);
int delete(String statement);
int delete(String statement, Object parameter);
void commit();
void commit(boolean force);
void rollback();
void rollback(boolean force);
List flushStatements();
void close();
void clearCache();
Configuration getConfiguration();
T getMapper(Class type);
Connection getConnection();

上面以select开头的可以对db进行查询操作，insert相关的可以对db进行插入操作，update相关的可以对db进行更新操作。

引入lombok支持（非必须）

声明一下：lombok不是mybatis必须的，为了简化代码而使用的，以后我们会经常使用。

Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。例如开发中经常需要写的javabean，都需要花时间去添加相应的getter/setter，也许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法，这些显得很冗长也没有太多技术含量，一旦修改属性，就容易出现忘记修改对应方法的失误。

Lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。出现的神奇就是在源码中没有getter和setter方法，但是在编译生成的字节码文件中有getter和setter方法。这样就省去了手动重建这些代码的麻烦，使代码看起来更简洁些。

lombok的使用步骤

\1. 先在idea中安装lombok插件

打开idea，点击File->Settings->plugins，然后搜索Lombok Plugin，点击安装就可以了。

\2. maven中引入lombok支持

org.projectlombok lombok 1.18.10 provided

\3. 代码中使用lombok相关功能

引入logback（非必须）

声明一下：日志框架mybatis中也不是必须的，不用配置也可以正常运行。

为了方便查看mybatis运行过程中产生的日志，比如：执行的sql、sql的参数、sql的执行结果等等调试信息，我们需要引入日志框架的支持，logback是一个很好的日志框架，此处我们就使用这个

mybatis中集成logback步骤

\1. maven中引入logback支持

ch.qos.logback logback-classic 1.2.3

\2. src/main/resources中创建logback.xml文件：

%d{mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n

logback.xml具体的写法不是本文讨论的范围，有兴趣的朋友可以去研究一下logback具体的用法。

上面xml中配置了com.javacode2018包中所有的类，使用logback输出日志的时候，debug级别及以上级别的日志会输出到控制台，方便我们查看。

写一个测试用例

在chat02/src/test下创建一个类:

com.javacode2018.chat02.UserTest

内容如下：

package com.javacode2018.chat02;

import java.io.IOException;
import java.io.InputStream;

@Slf4j
public class UserTest {

private SqlSessionFactory sqlSessionFactory;

@Before
public void before() throws IOException {
//指定mybatis全局配置文件
String resource = “mybatis-config.xml”;
*//*读取全局配置文件
InputStream inputStream = Resources.getResourceAsStream(resource);
//构建SqlSessionFactory对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
this.sqlSessionFactory = sqlSessionFactory;
}

@Test
public void sqlSession() {
SqlSession sqlSession = this.sqlSessionFactory.openSession();
log.info(“{}”, sqlSession);
}

}

上面代码中有个@Slf4j注解，这个是lombok提供的，可以在这个类中生成下面代码：

private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(UserTest.class);

运行一下上面的用例：sqlSession方法，输出如下：

45:51.289 [main] INFO com.javacode2018.chat02.UserTest - org.apache.ibatis.session.defaults.DefaultSqlSession@1f021e6c

使用SqlSesion执行sql操作

SqlSession常见的用法

SqlSession相当于一个连接，可以使用这个对象对db执行增删改查操作，操作完毕之后需要关闭，使用步骤：

1.获取SqlSession对象：通过该sqlSessionFactory.openSession方法获取SqlSession对象
2.对db进行操作：使用SqlSession对象进行db操作
3.关闭SqlSession对象：sqlSession.close();

常见的使用方式如下：

*//*获取SqlSession
SqlSession sqlSession = this.sqlSessionFactory.openSession();
try {
*//*执行业务操作，如：增删改查
} finally {
*//*关闭SqlSession
sqlSession.close();
}

上面我们将SqlSession的关闭放在finally块中，确保close()一定会执行。更简单的方式是使用java中的try()的方式，如下：

try (SqlSession sqlSession = this.sqlSessionFactory.openSession()😉 {
*//*执行业务操作，如：增删改查
}

新增操作

需求：传入UserModel对象，然后将这个对象的数据插入到t_user表中。

创建一个UserModel

新建一个com.javacode2018.chat02.UserModel类，代码如下：

package com.javacode2018.chat02;

import lombok.*;

/**

*/
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
@ToString
public class UserModel {
private Long id;
private String name;
private Integer age;
private Double salary;
private Integer sex;
}

这个类的字段和t_user表对应。

UserMapper.xml中定义插入操作

我们说过了，对t_user表的所有sql操作，我们都放在UserMapper.xml中，我们在UserMapper.xml中加入下面配置，使用insert元素定义插入操作：

insert元素用来定义了一个对db的insert操作

id：是这个操作的一个标识，一会通过mybatis执行操作的时候会通过这个namespace和id引用到这个insert操作，

parameterType：用来指定这个insert操作接受的参数的类型，可以是：各种javabean、map**、list****、collection类型的java对象**，我们这个插入接受的是UserModel对象。

insert元素内部定义了具体的sql，可以看到是一个insert的sql，向t_user表插入数据。

需要插入的值从UserModel对象中获取，取UserModel对象的的字段，使用**#{****字段}**这种格式可以获取到UserModel中字段的值。

调用SqlSession.insert方法执行插入操作

t_user插入的sql我们已经在UserMapper中写好，此时我们怎么调用呢？

需要调用SqlSession.insert方法：

int insert(String statement, Object parameter)

这个方法有2个参数:

statement：表示那个操作，值为Mapper xml的namespace.具体操作的id，如需要调用UserMapper.xml中的insertUser操作，这个值就是：

com.javacode2018.chat02.UserMapper.insertUser

parameter：insert操作的参数，和Mapper xml中的insert中的parameterType指定的类型一致。

返回值为插入的行数。

UserTest类中新增一个测试用例：

@Test
public void insertUser() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(false)😉 {
//创建UserModel对象
UserModel userModel = UserModel.builder().id(2L).name(“javacode2018”).age(30).salary(50000D).sex(1).build();
*//*执行插入操作
int result = sqlSession.insert(“com.javacode2018.chat02.UserMapper.insertUser”, userModel);
log.info(“插入影响行数：{}”, result);
*//*提交事务
sqlSession.commit();
}
}

运行输出如下：

01:46.683 [main] DEBUG c.j.chat02.UserMapper.insertUser - ==> Preparing: INSERT INTO t_user (id,name,age,salary,sex) VALUES (?,?,?,?,?)
01:46.745 [main] DEBUG c.j.chat02.UserMapper.insertUser - > Parameters: 2(Long), javacode2018(String), 30(Integer), 50000.0(Double), 1(Integer)
01:46.751 [main] DEBUG c.j.chat02.UserMapper.insertUser - < Updates: 1
01:46.751 [main] INFO com.javacode2018.chat02.UserTest - 影响行数：1

输出中打印了详细的sql语句，以及sql的参数信息，可以看到Mapper xml中的#{}被替换为了?，这个使用到了jdbc中的PreparedStatement来对参数设置值。

输出中的第二行详细列出了参数的值以及每个值的类型。

第三行输出了insert的结果为1，表示插入成功了1行记录。

去db中看一下，如下，插入成功：

mysql> SELECT * FROM t_user;
±—±--------------±----±---------±----+
| id | name | age | salary | sex |
±—±--------------±----±---------±----+
| 1 | 路人甲Java | 30 | 50000.00 | 1 |
±—±--------------±----±---------±----+
1 row in set (0.00 sec)

上面代码中创建SqlSession，我们使用的是sqlSessionFactory.openSession()创建的，这个方法创建的SqlSession，内部事务是非自动提交的方式，所以需要我们手动提交：

sqlSession.commit();

如果想自动提交事务，可以将上面的测试用例改成下面这样：

@Test
public void insertUser() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
//创建UserModel对象
UserModel userModel = UserModel.builder().id(1L).name(“路人甲Java”).age(30).salary(50000D).sex(1).build();
*//*执行插入操作
int result = sqlSession.insert(“com.javacode2018.chat02.UserMapper.insertUser”, userModel);
log.info(“影响行数：{}”, result);
}
}

上面在创建SqlSession的时候调用了sqlSessionFactory.openSession(true)，指定事务为自动提交模式，所以最后我们不需要手动提交事务了。

更新操作

需求：传入UserModel对象，然后通过id更新数据。

UserMapper.xml中定义Update操作

使用update定义更新操作：

写法和insert操作的写法类似，指定id标识、parameterType指定操作的参数类型，元素体中是具体的sql语句。

调用SqlSession.update方法执行更新操作

需要调用SqlSession.update方法：

int update(String statement, Object parameter)

这个方法有2个参数:

statement：表示哪个操作，值为Mapper xml的namespace.具体操作的id，如需要调用UserMapper.xml中的updateUser操作，这个值就是：

com.javacode2018.chat02.UserMapper.updateUser

parameter：update操作的参数，和Mapper xml中的update中的parameterType指定的类型一致。

返回值为update影响行数。

UserTest类中新增一个测试用例：

@Test
public void updateUser() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
//创建UserModel对象
UserModel userModel = UserModel.builder().id(1L).name(“路人甲Java，你好”).age(18).salary(5000D).sex(0).build();
*//*执行更新操作
int result = sqlSession.update(“com.javacode2018.chat02.UserMapper.updateUser”, userModel);
log.info(“影响行数：{}”, result);
}
}

运行输出：

14:09.051 [main] DEBUG c.j.chat02.UserMapper.updateUser - ==> Preparing: UPDATE t_user SET name = ?,age = ?,salary = ?,sex = ? WHERE id = ?
14:09.095 [main] DEBUG c.j.chat02.UserMapper.updateUser - > Parameters: 路人甲Java，你好(String), 18(Integer), 5000.0(Double), 0(Integer), 1(Long)
14:09.100 [main] DEBUG c.j.chat02.UserMapper.updateUser - < Updates: 1
14:09.101 [main] INFO com.javacode2018.chat02.UserTest - 影响行数：1

db中去看一下：

mysql> SELECT * FROM t_user;
±—±-----------------------±----±---------±----+
| id | name | age | salary | sex |
±—±-----------------------±----±---------±----+
| 1 | 路人甲Java，你好 | 18 | 5000.00 | 0 |
| 2 | javacode2018 | 30 | 50000.00 | 1 |
±—±-----------------------±----±---------±----+
2 rows in set (0.00 sec)

删除操作

需求：根据用户的id删除对应的用户记录

UserMapper.xml中定义Delete操作

使用update元素定义删除操作：

写法和update操作的写法类似，指定id标识、parameterType指定操作的参数类型，用户id为Long类型的，元素体中是具体的delete语句。

调用SqlSession.update方法执行更新操作

需要调用SqlSession.delete方法：

int delete(String statement, Object parameter)

这个方法有2个参数:

statement：表示哪个操作，值为Mapper xml的namespace.具体操作的id，如需要调用UserMapper.xml中的deleteUser操作，这个值就是：

com.javacode2018.chat02.UserMapper.

parameter：delete操作的参数，和Mapper xml中的delete中的parameterType指定的类型一致。

返回值为delete影响行数。

UserTest类中新增一个测试用例：

@Test
public void deleteUser() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
*//*定义需要删除的用户id
Long userId = 1L;
*//*执行删除操作
int result = sqlSession.delete(“com.javacode2018.chat02.UserMapper.deleteUser”, userId);
log.info(“影响行数：{}”, result);
}
}

运行输出：

24:45.427 [main] DEBUG c.j.chat02.UserMapper.deleteUser - ==> Preparing: DELETE FROM t_user WHERE id = ?
24:45.476 [main] DEBUG c.j.chat02.UserMapper.deleteUser - > Parameters: 1(Long)
24:45.485 [main] DEBUG c.j.chat02.UserMapper.deleteUser - < Updates: 1
24:45.485 [main] INFO com.javacode2018.chat02.UserTest - 影响行数：1

执行查询

需求：查询所有用户信息

UserMapper.xml中定义Select操作

写法和update操作的写法类似，指定id标识、parameterType指定操作的参数类型，resultType指定查询结果的类型，元素体中是具体的select语句。

调用SqlSession.select方法执行更新操作

UserTest添加一个用例：

@Test
public void getUserList() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
*//*执行查询操作
List userModelList = sqlSession.selectList(“com.javacode2018.chat02.UserMapper.getUserList”);
log.info(“结果：{}”, userModelList);
}
}

多插入几行，然后运行上面的用例，输出如下：

36:39.015 [main] DEBUG c.j.chat02.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
36:39.048 [main] DEBUG c.j.chat02.UserMapper.getUserList - > Parameters:
36:39.066 [main] DEBUG c.j.chat02.UserMapper.getUserList - < Total: 3
36:39.067 [main] INFO com.javacode2018.chat02.UserTest - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
36:39.069 [main] INFO com.javacode2018.chat02.UserTest - UserModel(id=1575621274235, name=路人甲Java, age=30, salary=50000.0, sex=1)
36:39.069 [main] INFO com.javacode2018.chat02.UserTest - UserModel(id=1575621329823, name=路人甲Java, age=30, salary=50000.0, sex=1)

Mapper接口的使用

为什么需要Mapper接口

上面我们讲解了对一个表的增删改查操作，都是通过调用SqlSession中的方法来完成的，大家再来看一下SqlSession接口中刚才用到的几个方法的定义：

int insert(String statement, Object parameter);
int update(String statement, Object parameter);
int delete(String statement, Object parameter);
List selectList(String statement);

这些方法的特点我们来看一下：

\1. 调用这些方法，需要明确知道statement的值，statement的值为namespace.具体操作的id，这些需要打开Mapper xml中去查看了才知道，写起来不方便

\2. parameter参数都是Object类型的，我们根本不知道这个操作具体类型是什么，需要查看Mapper xml才知道，随便传递个值，可能类型不匹配，但是只有在运行的时候才知道有问题

\3. selectList方法返回的是一个泛型类型的，通过这个方法我们根本不知道返回的结果的具体类型，也需要去查看Mapper xml才知道

以上这几点使用都不是太方便，有什么方法能解决上面这些问题么？

有，这就是mybatis中的Mapper接口，我们可以定义一个interface，然后和Mapper xml关联起来，Mapper xml中的操作和Mapper接口中的方法会进行绑定，当我们调用Mapper接口的方法的时候，会间接调用到Mapper xml中的操作，接口的完整类名需要和Mapper xml中的namespace一致。

Mapper接口的用法（三步）

步骤1：定义Mapper接口

去看一下，UserMapper.xml中的namespace，是：

我们创建的接口完整的名称需要和上面的namespace的值一样，下面我们创建一个接口com.javacode2018.chat02.UserMapper，如下：

package com.javacode2018.chat02;

/**

*/
public interface UserMapper {
}

UserMapper.xml中有4个操作，我们需要在UserMapper接口中也定义4个操作，和UserMapper.xml的4个操作对应，如下：

package com.javacode2018.chat02;

import java.util.List;

/**

*/
public interface UserMapper {

int insertUser(UserModel model);

int updateUser(UserModel model);

int deleteUser(Long userId);

List getUserList();
}

UserMapper接口中定义了4个方法，方法的名称需要和UserMapper.xml具体操作的id值一样，这样调用UserMapper接口中的方法的时候，才会对应的找到UserMapper.xml中具体的操作。

比如调用UserMapper接口中的insertUser方法，mybatis查找的规则是：通过接口完整名称.方法名称去Mapper xml中找到对应的操作。

步骤2：通过SqlSession获取Mapper接口对象

SqlSession中有个getMapper方法，可以传入接口的类型，获取具体的Mapper接口对象，如下：

/**
*** Retrieves a mapper*.*
*** @param the mapper type
*** @param type Mapper interface class
*** @return a mapper bound to this SqlSession
*/
T getMapper(Class type);

如获取UserMapper接口对象：

UserMapper mapper = sqlSession.getMapper(UserMapper.class);

步骤3：调用Mapper接口的方法对db进行操作

如调用UserMapper接口的insert操作：

@Test
public void insertUser() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
//创建UserModel对象
UserModel userModel = UserModel.builder().id(System.currentTimeMillis()).name(“路人甲Java”).age(30).salary(50000D).sex(1).build();
*//*执行插入操作
int insert = mapper.insertUser(userModel);
log.info(“影响行数：{}”, insert);
}
}

案例：使用Mapper接口来实现增删改查

chat02/src/test/java中创建一个测试类，代码如下：

package com.javacode2018.chat02;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

/**

*/
@Slf4j
public class UserMapperTest {
private SqlSessionFactory sqlSessionFactory;

@Test
public void updateUser() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
//创建UserModel对象
UserModel userModel = UserModel.builder().id(1L).name(“路人甲Java，你好”).age(18).salary(5000D).sex(0).build();
*//*执行更新操作
int result = mapper.updateUser(userModel);
log.info(“影响行数：{}”, result);
}
}

@Test
public void deleteUser() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
*//*定义需要删除的用户id
Long userId = 1L;
*//*执行删除操作
int result = mapper.deleteUser(userId);
log.info(“影响行数：{}”, result);
}
}

@Test
public void getUserList() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
UserMapper mapper = sqlSession.getMapper(UserMapper.class);
*//*执行查询操作
List userModelList = mapper.getUserList();
userModelList.forEach(item -> {
log.info(“{}”, item);
});
}
}
}

大家认真看一下上面的代码，这次我们使用了UserMapper来间接调用UserMapper.xml中对应的操作，可以去运行一下感受一下效果。

Mapper接口使用时注意的几点

\1. Mapper接口的完整类名必须和对应的Mapper xml中的namespace的值一致

\2. Mapper接口中方法的名称需要和Mapper xml中具体操作的id值一致

\3. Mapper接口中方法的参数、返回值可以不和Mapper xml中的一致

Mapper接口的原理

这个使用java中的动态代理实现的，mybatis启动的时候会加载全局配置文件mybatis-config.xml，然后解析这个文件中的mapper元素指定的UserMapper.xml，会根据UserMapper.xml的namespace的值创建这个接口的一个动态代理，具体可以去看一下mybatis的源码，主要使用java中的Proxy实现的，使用java.lang.reflect.Proxy类中的newProxyInstance方法，我们可以创建任意一个接口的一个代理对象：

public static Object newProxyInstance(ClassLoader loader,
Class<?>[] interfaces,
InvocationHandler h)

我们使用Proxy来模仿Mapper接口的实现：

package com.javacode2018.chat02;

import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.List;

/**

*/
@Slf4j
public class ProxyTest {

public static class UserMapperProxy implements InvocationHandler {
private SqlSession sqlSession;

 private Class<?> mapperClass;

 public UserMapperProxy(SqlSession sqlSession, Class<?> mapperClass) {
   this.sqlSession = sqlSession;
   this.mapperClass = mapperClass;
 }

 @Override
 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
   log.debug("invoke start");
   String statement = mapperClass.getName() + "." + method.getName();
   List<Object> result = sqlSession.selectList(statement);
   log.debug("invoke end");
   return result;
 }

}

private SqlSessionFactory sqlSessionFactory;

@Test
public void test1() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
UserMapper userMapper = (UserMapper) Proxy.newProxyInstance(ProxyTest.class.getClassLoader(), new Class[]{UserMapper.class}, new UserMapperProxy(sqlSession, UserMapper.class));
log.info(“{}”, userMapper.getUserList());
}
}
}

上面代码中：UserMapper是没有实现类的，可以通过Proxy.newProxyInstance给UserMapper接口创建一个代理对象，当调用UserMapper接口的方法的时候，会调用到UserMapperProxy对象的invoke方法。

运行一下test1用例，输出如下：

16:34.288 [main] DEBUG com.javacode2018.chat02.ProxyTest - invoke start
16:34.555 [main] DEBUG c.j.chat02.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
16:34.580 [main] DEBUG c.j.chat02.UserMapper.getUserList - > Parameters:
16:34.597 [main] DEBUG c.j.chat02.UserMapper.getUserList - < Total: 4
16:34.597 [main] DEBUG com.javacode2018.chat02.ProxyTest - invoke end
16:34.597 [main] INFO com.javacode2018.chat02.ProxyTest - [UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1), UserModel(id=1575621274235, name=路人甲Java, age=30, salary=50000.0, sex=1), UserModel(id=1575621329823, name=路人甲Java, age=30, salary=50000.0, sex=1), UserModel(id=1575623283897, name=路人甲Java, age=30, salary=50000.0, sex=1)]

注意上面输出的invoke start和invoke end，可以看到我们调用userMapper.getUserList时候，被UserMapperProxy#invoke方法处理了。

Mybatis中创建Mapper接口代理对象使用的是下面这个类，大家可以去研究一下：

public class MapperProxyFactory {

private final Class mapperInterface;
private final Map<Method, MapperMethod> methodCache = new ConcurrentHashMap<Method, MapperMethod>();

public MapperProxyFactory(Class mapperInterface) {
this.mapperInterface = mapperInterface;
}

public Class getMapperInterface() {
return mapperInterface;
}

public Map<Method, MapperMethod> getMethodCache() {
return methodCache;
}

@SuppressWarnings(“unchecked”)
protected T newInstance(MapperProxy mapperProxy) {
return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy);
}

public T newInstance(SqlSession sqlSession) {
final MapperProxy mapperProxy = new MapperProxy(sqlSession, mapperInterface, methodCache);
return newInstance(mapperProxy);
}

}

MyBatis系列

\1. MyBatis系列第1篇：MyBatis未出世之前我们那些痛苦的经历

\2. MyBatis系列第2篇：入门篇，带你感受一下mybatis独特的魅力！

Mybatis系列第4篇：Mybatis使用详解(2)

主要内容

\1. idea创建本篇案例

– 建库建表

– 创建项目

\2. 别名使用详解(typeAliases)

– 为什么需要使用别名

– 别名3种用法详解

– 方式1：使用typeAlias元素注册别名

– 方式2：使用package元素批量注册别名

– 方式3：使用package结合@Alias批量注册并指定别名的名称

– 别名不区分大小写

– mybatis内置的别名

– 别名的原理

– 别名使用建议

\3. 属性配置详解(properties)

– 属性配置的3种方式

– 方式1：通过propertie元素配置属性

– 方式2：方式通过resource引用classpath中的属性配置文件

– 方式3：通过url引用外部属性配置文件

– 使用建议

– 相关问题

\4. mybatis中引入mapper的3种方式

– 方式1：通过mapper元素resource属性的方式注册Mapper xml文件和Mapper接口

– 方式2：通过mapper元素class属性的方式注册Mapper接口和Mapper xml文件

– 方式3：通过package元素批量注册Mapper接口和Mapper xml文件

– 源码解释

– 使用注意

idea创建案例

建库建表

*/**创建数据库javacode2018*/
DROP DATABASE IF EXISTS javacode2018;
CREATE DATABASE javacode2018;
USE javacode2018;

DROP TABLE IF EXISTS t_order;
CREATE TABLE t_order (
id BIGINT AUTO_INCREMENT PRIMARY KEY COMMENT ‘主键，订单id，自动增长’,
user_id BIGINT NOT NULL DEFAULT 0 COMMENT ‘用户id’,
price DECIMAL(12,2) NOT NULL DEFAULT 0 COMMENT ‘订单金额’
) COMMENT ‘订单表’;

*/**插入几条测试数据*/
INSERT INTO t_user (name,age,salary,sex)
VALUES
(‘路人甲Java’,30,50000,1),
(‘javacode2018’,30,50000,1),
(‘张学友’,56,500000,1),
(‘林志玲’,45,88888.88,2);

INSERT INTO t_order (user_id,price)
VALUES
(1,88.88),
(2,666.66);

SELECT * FROM t_user;
SELECT * FROM t_order;

创建工程

整个mybatis系列的代码采用maven模块的方式管理的，可以在文章底部获取，本次我们还是在上一篇的mybatis-series中进行开发，在这个项目中新建一个模块chat03，模块坐标如下：

com.javacode2018
chat03
1.0-SNAPSHOT

下面我们通过mybatis快速来实现对t_user表增删改查，这个在上一篇的chat02中已经详细讲解过了。

创建mybatis配置文件

chat03\src\main\resources\demo1目录创建，mybatis-config.xml，如下：

创建UserMapper.xml文件

chat03\src\main\resources\demo1\mapper目录创建，UserMapper.xml，如下：

创建UserModel类

chat03\src\main\java\com\javacode2018\chat03\demo1目录创建UserModel.java，如下：

package com.javacode2018.chat03.demo1;

import lombok.*;

/**

创建UserMapper接口

chat03\src\main\java\com\javacode2018\chat03\demo1目录创建UserMapper.java，如下：

package com.javacode2018.chat03.demo1;

import java.util.List;

/**

*/
public interface UserMapper {

int insertUser(UserModel model);

int updateUser(UserModel model);

int deleteUser(Long userId);

List getUserList();
}

引入logback日志支持

chat03\src\main\resources目录创建logback.xml，如下：

%d{mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n

创建测试用例UserMapperTest

chat03\src\test\java\com\javacode2018\chat03\demo1目录创建UserMapperTest.java，如下：

package com.javacode2018.chat03.demo1;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

/**

*/
@Slf4j
public class UserMapperTest {
private SqlSessionFactory sqlSessionFactory;

@Before
public void before() throws IOException {
//指定mybatis全局配置文件
String resource = “demo1/mybatis-config.xml”;
*//*读取全局配置文件
InputStream inputStream = Resources.getResourceAsStream(resource);
//构建SqlSessionFactory对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
this.sqlSessionFactory = sqlSessionFactory;
}

}

代码解释一下：

上面的before()方法上面有个@Before注解，这个是junit提供的一个注解，通过junit运行每个@Test标注的方法之前，会先运行被@before标注的方法，before()方法中我们创建了SqlSessionFactory对象，所以其他的@Test标注的方法中可以直接使用sqlSessionFactory对象了。

项目结构如下图

注意项目结构如下图，跑起来有问题的可以对照一下。

运行一下测试用例看效果

运行一下UserMapperTest.getUserList()方法，输出如下：

32:21.991 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
32:22.028 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - > Parameters:
32:22.052 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - < Total: 4
32:22.053 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
32:22.056 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
32:22.056 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
32:22.056 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)

上面是mybatis开发项目的一个玩转的步骤，希望大家都能够熟练掌握，下面我们来在这个示例的基础上讲解本章的知识点。

别名

为什么需要使用别名?

大家打开chat03\src\main\resources\demo1\mapper\UserMapper.xml文件看一下，是不是有很多下面这样的代码：

parameterType=“com.javacode2018.chat03.demo1.UserModel”
resultType=“com.javacode2018.chat03.demo1.UserModel”

parameterType是指定参数的类型，resultType是指定查询结果返回值的类型，他们的值都是UserModel类完整的类名，比较长，mybatis支持我们给某个类型起一个别名，然后通过别名可以访问到指定的类型。

别名的用法

使用别名之前需要先在mybatis中注册别名，我们先说通过mybatis全局配置文件中注册别名，通过mybatis配置文件注册别名有3种方式。

方式1

使用typeAlias元素进行注册

如下：

typeAliases元素中可以包含多个typeAlias子元素，每个typeAlias可以给一个类型注册别名，有2个属性需要指定：

type**：完整的类型名称**

alias**：别名**

如上面给UserModel起了一个别名为user。

案例

给UserModel注册一个别名user

chat03\src\main\resources\demo1\mapper\UserMapper.xml中加入下面配置：

UserMapper.xml中使用别名，将chat03\src\main\resources\demo1\mapper\UserMapper.xml中getUserList的resultType的值改为user，如下：

运行com.javacode2018.chat03.demo1.UserMapperTest#getUserList，如下：

07:35.477 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
07:35.505 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - > Parameters:
07:35.527 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - < Total: 4
07:35.527 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
07:35.529 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
07:35.529 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
07:35.529 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)

看到了么，getUserList中我们使用的别名，运行是正常的，说明可以通过别名user直接访问UserModel。

方式2

通过packege元素批量注册

上面我们通过typeAlias元素可以注册一个别名，如果我们有很多类需要注册，需要写很多typeAlias配置。

mybatis为我们提供了批量注册别名的方式，通过package元素，如下：

这个也是在typeAliases元素下面，不过这次使用的是package元素，package有个name属性，可以指定一个包名，mybatis会加载这个包以及子包中所有的类型，给这些类型都注册别名，别名名称默认会采用类名小写的方式，如UserModel的别名为usermodel

案例

下面我们将demo1/mybatis-config.xml中typeAliases元素的值改为下面这样：

mybatis会给com.javacode2018.chat03.demo1包及子包中的所有类型注册别名，UserModel类在这个包中，会被注册，别名为usermodel

UserMapper.xml中使用别名，将chat03\src\main\resources\demo1\mapper\UserMapper.xml中getUserList的resultType的值改为usermodel，如下：

上面我们将返回值的类型resultType的值改为了usermodel

我们来运行com.javacode2018.chat03.demo1.UserMapperTest#getUserList，如下：

26:08.267 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
26:08.296 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - > Parameters:
26:08.318 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - < Total: 4
26:08.319 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
26:08.320 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
26:08.320 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
26:08.320 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)

看到了么，getUserList中我们使用的别名usermodel，运行也是正常的。

方式3

package结合@Alias批量注册并指定别名

方式2中通过package可以批量注册别名，如果指定的包中包含了多个类名相同的类，会怎么样呢？

我们在com.javacode2018.chat03.demo1.model包中创建一个和UserModel同名的类，如下：

package com.javacode2018.chat03.demo1.model;

import lombok.*;

/**

现在com.javacode2018.demo1包中有2个UserModel类了

运行com.javacode2018.chat03.demo1.UserMapperTest#getUserList，如下：

org.apache.ibatis.exceptions.PersistenceException:
### Error building SqlSession.
### The error may exist in SQL Mapper Configuration
### Cause: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: org.apache.ibatis.type.TypeException: The alias ‘UserModel’ is already mapped to the value ‘com.javacode2018.chat03.demo1.model.UserModel’.

at org.apache.ibatis.exceptions.ExceptionFactory.wrapException(ExceptionFactory.java:30)
at org.apache.ibatis.session.SqlSessionFactoryBuilder.build(SqlSessionFactoryBuilder.java:80)
at org.apache.ibatis.session.SqlSessionFactoryBuilder.build(SqlSessionFactoryBuilder.java:64)
at com.javacode2018.chat03.demo1.UserMapperTest.before(UserMapperTest.java:29)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:498)
at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)
at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
at org.junit.internal.runners.statements.RunBefores.evaluate(RunBefores.java:24)
at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325)
at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)
at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)
at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
at org.junit.runners.ParentRunner $2.evaluate(ParentRunner.java:268) at org.junit.runners.ParentRunner.run(ParentRunner.java:363) at org.junit.runner.JUnitCore.run(JUnitCore.java:137) at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:68) at com.intellij.rt.execution.junit.IdeaTestRunner$ Repeater.startRunnerWithArgs(IdeaTestRunner.java:51)
at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242)
at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70)
Caused by: org.apache.ibatis.builder.BuilderException: Error parsing SQL Mapper Configuration. Cause: org.apache.ibatis.type.TypeException: The alias ‘UserModel’ is already mapped to the value ‘com.javacode2018.chat03.demo1.model.UserModel’.
at org.apache.ibatis.builder.xml.XMLConfigBuilder.parseConfiguration(XMLConfigBuilder.java:121)
at org.apache.ibatis.builder.xml.XMLConfigBuilder.parse(XMLConfigBuilder.java:98)
at org.apache.ibatis.session.SqlSessionFactoryBuilder.build(SqlSessionFactoryBuilder.java:78)
… 24 more
Caused by: org.apache.ibatis.type.TypeException: The alias ‘UserModel’ is already mapped to the value ‘com.javacode2018.chat03.demo1.model.UserModel’.
at org.apache.ibatis.type.TypeAliasRegistry.registerAlias(TypeAliasRegistry.java:157)
at org.apache.ibatis.type.TypeAliasRegistry.registerAlias(TypeAliasRegistry.java:147)
at org.apache.ibatis.type.TypeAliasRegistry.registerAliases(TypeAliasRegistry.java:136)
at org.apache.ibatis.type.TypeAliasRegistry.registerAliases(TypeAliasRegistry.java:125)
at org.apache.ibatis.builder.xml.XMLConfigBuilder.typeAliasesElement(XMLConfigBuilder.java:164)
at org.apache.ibatis.builder.xml.XMLConfigBuilder.parseConfiguration(XMLConfigBuilder.java:109)
… 26 more

报错了，2个类的类名一样了，默认都会使用usermodel作为别名，别名重复了mybatis会报错，那么此时我们怎么办呢？

package方式批量注册别名的时候，我们可以给类中添加一个@Alias注解来给这个类指定别名：

@Alias(“user”)
public class UserModel {
}

当mybatis扫描类的时候，发现类上有Alias注解，会取这个注解的value作为别名，如果没有这个注解，会将类名小写作为别名，如同方式2。

案例

我们在com.javacode2018.chat03.demo1.UserModel类上加上下面注解：

@Alias(“use”)
public class UserModel {
}

修改demo1/mapper/UserMapper.xml，将resultType的值设置为user：

再来运行com.javacode2018.chat03.demo1.UserMapperTest#getUserList，如下：

18:51.219 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
18:51.250 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - > Parameters:
18:51.271 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - < Total: 4
18:51.272 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
18:51.274 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
18:51.274 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
18:51.274 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)

输出正常。

别名不区分大小写

我们可以将上面UserMapper.xml中的use别名改成大写的：USER，如下：

然后再运行一下com.javacode2018.chat03.demo1.UserMapperTest#getUserList，如下：

42:49.474 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
42:49.509 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - > Parameters:
42:49.527 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - < Total: 4
42:49.528 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
42:49.530 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
42:49.530 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
42:49.531 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)

也是正常的，说明别名使用时是不区分大小写的。

mybatis内置的别名

mybatis默认为很多类型提供了别名，如下：

别名	对应的实际类型
_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

上面这些默认都是在org.apache.ibatis.type.TypeAliasRegistry类中进行注册的，这个类就是mybatis注册别名使用的，别名和具体的类型关联是放在这个类的一个map属性（typeAliases）中，贴一部分代码大家感受一下：

public class TypeAliasRegistry {

private final Map<String, Class<?>> typeAliases = new HashMap<>();

public TypeAliasRegistry() {
registerAlias(“string”, String.class);

registerAlias(“byte”, Byte.class);
registerAlias(“long”, Long.class);
registerAlias(“short”, Short.class);
registerAlias(“int”, Integer.class);
registerAlias(“integer”, Integer.class);
registerAlias(“double”, Double.class);
registerAlias(“float”, Float.class);
registerAlias(“boolean”, Boolean.class);

registerAlias(“byte[]”, Byte[].class);
registerAlias(“long[]”, Long[].class);
registerAlias(“short[]”, Short[].class);
registerAlias(“int[]”, Integer[].class);
registerAlias(“integer[]”, Integer[].class);
registerAlias(“double[]”, Double[].class);
registerAlias(“float[]”, Float[].class);
registerAlias(“boolean[]”, Boolean[].class);

registerAlias(“_byte”, byte.class);
registerAlias(“_long”, long.class);
registerAlias(“_short”, short.class);
registerAlias(“_int”, int.class);
registerAlias(“_integer”, int.class);
registerAlias(“_double”, double.class);
registerAlias(“_float”, float.class);
registerAlias(“_boolean”, boolean.class);

registerAlias(“_byte[]”, byte[].class);
registerAlias(“_long[]”, long[].class);
registerAlias(“_short[]”, short[].class);
registerAlias(“_int[]”, int[].class);
registerAlias(“_integer[]”, int[].class);
registerAlias(“_double[]”, double[].class);
registerAlias(“_float[]”, float[].class);
registerAlias(“_boolean[]”, boolean[].class);

registerAlias(“date”, Date.class);
registerAlias(“decimal”, BigDecimal.class);
registerAlias(“bigdecimal”, BigDecimal.class);
registerAlias(“biginteger”, BigInteger.class);
registerAlias(“object”, Object.class);

registerAlias(“date[]”, Date[].class);
registerAlias(“decimal[]”, BigDecimal[].class);
registerAlias(“bigdecimal[]”, BigDecimal[].class);
registerAlias(“biginteger[]”, BigInteger[].class);
registerAlias(“object[]”, Object[].class);

registerAlias(“map”, Map.class);
registerAlias(“hashmap”, HashMap.class);
registerAlias(“list”, List.class);
registerAlias(“arraylist”, ArrayList.class);
registerAlias(“collection”, Collection.class);
registerAlias(“iterator”, Iterator.class);

registerAlias(“ResultSet”, ResultSet.class);
}
}

mybatis启动的时候会加载全局配置文件，会将其转换为一个org.apache.ibatis.session.Configuration对象，存储在内存中，Configuration类中也注册了一些别名，代码如下：

typeAliasRegistry.registerAlias(“JDBC”, JdbcTransactionFactory.class);
typeAliasRegistry.registerAlias(“MANAGED”, ManagedTransactionFactory.class);

typeAliasRegistry.registerAlias(“JNDI”, JndiDataSourceFactory.class);
typeAliasRegistry.registerAlias(“POOLED”, PooledDataSourceFactory.class);
typeAliasRegistry.registerAlias(“UNPOOLED”, UnpooledDataSourceFactory.class);

typeAliasRegistry.registerAlias(“PERPETUAL”, PerpetualCache.class);
typeAliasRegistry.registerAlias(“FIFO”, FifoCache.class);
typeAliasRegistry.registerAlias(“LRU”, LruCache.class);
typeAliasRegistry.registerAlias(“SOFT”, SoftCache.class);
typeAliasRegistry.registerAlias(“WEAK”, WeakCache.class);

typeAliasRegistry.registerAlias(“DB_VENDOR”, VendorDatabaseIdProvider.class);

typeAliasRegistry.registerAlias(“XML”, XMLLanguageDriver.class);
typeAliasRegistry.registerAlias(“RAW”, RawLanguageDriver.class);

typeAliasRegistry.registerAlias(“SLF4J”, Slf4jImpl.class);
typeAliasRegistry.registerAlias(“COMMONS_LOGGING”, JakartaCommonsLoggingImpl.class);
typeAliasRegistry.registerAlias(“LOG4J”, Log4jImpl.class);
typeAliasRegistry.registerAlias(“LOG4J2”, Log4j2Impl.class);
typeAliasRegistry.registerAlias(“JDK_LOGGING”, Jdk14LoggingImpl.class);
typeAliasRegistry.registerAlias(“STDOUT_LOGGING”, StdOutImpl.class);
typeAliasRegistry.registerAlias(“NO_LOGGING”, NoLoggingImpl.class);

typeAliasRegistry.registerAlias(“CGLIB”, CglibProxyFactory.class);
typeAliasRegistry.registerAlias(“JAVASSIST”, JavassistProxyFactory.class);

上面有2行如下：

typeAliasRegistry.registerAlias(“JDBC”, JdbcTransactionFactory.class);
typeAliasRegistry.registerAlias(“POOLED”, PooledDataSourceFactory.class);

上面这2行，注册了2个别名，别名和类型映射关系如下：

JDBC -> JdbcTransactionFactory
POOLED -> PooledDataSourceFactory

上面这2个对象，大家应该比较熟悉吧，mybatis全局配置文件（chat03\src\main\resources\demo1\mybatis-config.xml）中我们用到过，我们再去看一下，如下：

上面2个红框的是不是就是上面注册的2个类型，上面xml中我们写的是完整类型名称，我们可以将其改为别名的方式也是可以的，如下：

我们来运行com.javacode2018.chat03.demo1.UserMapperTest#getUserList，看一下能否正常运行，输出如下：

44:10.886 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
44:10.929 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - > Parameters:
44:10.947 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - < Total: 4
44:10.948 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
44:10.950 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
44:10.950 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
44:10.950 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)

很好，一切正常的。

别名的原理

mybatis允许我们给某种类型注册一个别名，别名和类型之间会建立映射关系，这个映射关系存储在一个map对象中，key为别名的名称，value为具体的类型，当我们通过一个名称访问某种类型的时候，mybatis根据类型的名称，先在别名和类型映射的map中按照key进行查找，如果找到了直接返回对应的类型，如果没找到，会将这个名称当做完整的类名去解析成Class对象，如果这2步解析都无法识别这种类型，就会报错。

mybatis和别名相关的操作都位于org.apache.ibatis.type.TypeAliasRegistry****类中，包含别名的注册、解析等各种操作。

我们来看一下别名解析的方法，如下：

public Class resolveAlias(String string) {
try {
if (string == null) {
return null;
}
// issue #748
String key = string.toLowerCase(Locale.ENGLISH);
Class value;
if (typeAliases.containsKey(key)) {
value = (Class) typeAliases.get(key);
} else {
value = (Class) Resources.classForName(string);
}
return value;
} catch (ClassNotFoundException e) {
throw new TypeException(“Could not resolve type alias '” + string + "'. Cause: " + e, e);
}
}

有一个typeAliases对象，我们看一下其定义：

private final Map<String, Class<?>> typeAliases = new HashMap<>();

这个对象就是存放别名和具体类型映射关系的，从上面代码中可以看出，通过传入的参数解析对应的类型的时候，会先从typeAliases中查找，如果找不到会调用下面代码：

value = (Class) Resources.classForName(string);

上面这个方法里面具体是使用下面代码去通过名称解析成类型的：

Class.forName(类名完整名称)

Class.forName大家应该是很熟悉的，可以获取一个字符串对应的Class对象，如果找不到这个对象，会报错。

别名使用建议

别名的方式可以简化类型的写法，原本很长一串的UserModel对象，现在只用写个user就行了，用起来是不是挺爽的？

从写法上面来说，确实少帮我们省了一些代码，但是从维护上面来讲，不是很方便。

如Mapper xml直接写别名，看代码的时候，很难知道这个别名对应的具体类型，还需要我们去注册的地方找一下，不是太方便，如果我们在idea中写完整的类名，还可以按住Ctrl健，然后用鼠标左键点击类型直接可以跳到对应的类定义中去，如果使用别名是无法导航过去的。

整体上来说开发和看代码都不是太方便，只是写法上比价简单。

所以建议自定义的类尽量别使用别名，而对mybatis中内置的一些别名我们需要知道。

属性配置文件详解

大家看一下chat03\src\main\resources\demo1\mybatis-config.xml中下面这一部分的配置：

这个连接数据库的配置，我们是直接写在mybatis全局配置文件中的，上面这是我们本地测试库的db信息，上线之后，需要修改为线上的db配置信息，db配置信息一般由运维去修改，让运维去修改这个xml配置文件？

这样不是太好，我们通常将一些需要运维修改的配置信息（如：db配置、邮件配置、redis配置等等各种配置）放在一个properties配文件中，然后上线时，只需要运维去修改这个配置文件就可以了，根本不用他们去修改和代码相关的文件。

mybatis也支持我们通过外部properties文件来配置一些属性信息。

mybatis配置属性信息有3种方式。

方式1：property元素中定义属性

属性定义

mybatis全局配置文件中通过properties元素来定义属性信息，如下：

上面通过property元素的方式进行配置属性信息：

name：属性的名称

value：属性的值。

如：

使用${属性名称}引用属性的值

属性已经定义好了，我们可以通过${属性名称}引用定义好的属性的值，如：

案例

我们在demo1/mapper/mybatis-config.xml的configuration元素中加入下面配置：

修改datasource的配置：

运行com.javacode2018.chat03.demo1.UserMapperTest#getUserList，如下：

40:22.274 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
40:22.307 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - > Parameters:
40:22.330 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - < Total: 4
40:22.331 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
40:22.332 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
40:22.332 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
40:22.332 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)

运行正常。

方式2：resource引入配置文件

方式1中，我们的配置文件还是写在全局配置文件中，mybatis支持从外部引入配置文件，可以把配置文件写在其他外部文件中，然后进行引入。

引入classes路径中的配置文件

properties元素有个resource属性，值为配置文件相对于classes的路径，配置文件我们一般放在src/main/resource目录，这个目录的文件编译之后会放在classes路径中。

案例

下面我们将上面db的配置放在外部的config.properties文件中。

在chat03\src\main\resources\demo1目录新建一个配置文件config.properties，内容如下：

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/javacode2018?characterEncoding=UTF-8
jdbc.username=root
jdbc.password=root123

demo1/mapper/mybatis-config.xml中引入上面配置文件：

目前demo1/mapper/mybatis-config.xml文件内容如下：

运行com.javacode2018.chat03.demo1.UserMapperTest#getUserList，如下：

57:40.405 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
57:40.436 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - > Parameters:
57:40.454 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - < Total: 4
57:40.455 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
57:40.457 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
57:40.457 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
57:40.457 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)

运行正常。

方式3：url的方式引入远程配置文件

mybatis还提供了引入远程配置文件的方式，如下：

这次还是使用properties元素，不过使用的是url属性，如：

这种方式的案例就不提供了，有兴趣的可以自己去玩玩。

属性配置文件使用建议

上面我们说了3中方式，第2中方式是比较常见的做法，建议大家可以使用第二种方式来引入外部资源配置文件。

问题

如果3种方式如果我们都写了，mybatis会怎么走？

下面我们修改一下resources/demo1/mybatis-config.xml，使用第一种方式定义属性，如下：

将password的值改为了root，正确的是root123，运行测试用例，报错如下：

org.apache.ibatis.exceptions.PersistenceException:
### Error querying database. Cause: java.sql.SQLException: Access denied for user ‘root’@‘localhost’ (using password: YES)
### The error may exist in demo1/mapper/UserMapper.xml
### The error may involve com.javacode2018.chat03.demo1.UserMapper.getUserList
### The error occurred while executing a query
### Cause: java.sql.SQLException: Access denied for user ‘root’@‘localhost’ (using password: YES)

at org.apache.ibatis.exceptions.ExceptionFactory.wrapException(ExceptionFactory.java:30)
at org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:149)
at org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:140)
at org.apache.ibatis.binding.MapperMethod.executeForMany(MapperMethod.java:147)
at org.apache.ibatis.binding.MapperMethod.execute(MapperMethod.java:80)
at org.apache.ibatis.binding.MapperProxy.invoke(MapperProxy.java:93)
at com.sun.proxy.$Proxy6.getUserList(Unknown Source)
at com.javacode2018.chat03.demo1.UserMapperTest.getUserList(UserMapperTest.java:38)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:498)
at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)
at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
at org.junit.internal.runners.statements.RunBefores.evaluate(RunBefores.java:26)
at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325)
at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)
at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)
at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
at org.junit.runners.ParentRunner $2.evaluate(ParentRunner.java:268) at org.junit.runners.ParentRunner.run(ParentRunner.java:363) at org.junit.runner.JUnitCore.run(JUnitCore.java:137) at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:68) at com.intellij.rt.execution.junit.IdeaTestRunner$ Repeater.startRunnerWithArgs(IdeaTestRunner.java:51)
at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242)
at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70)
Caused by: java.sql.SQLException: Access denied for user ‘root’@‘localhost’ (using password: YES)

提示密码错误。

下面我们将第2种方式也加入，修改配置：

再运行一下测试用例，如下：

18:59.436 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
18:59.462 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - > Parameters:
18:59.481 [main] DEBUG c.j.c.demo1.UserMapper.getUserList - < Total: 4
18:59.482 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
18:59.485 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
18:59.485 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
18:59.485 [main] INFO c.j.chat03.demo1.UserMapperTest - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)

这次正常了。

可以看出方式1和方式2都存在的时候，方式2的配置会覆盖方式1的配置。

mybatis这块的源码在org.apache.ibatis.builder.xml.XMLConfigBuilder#propertiesElement方法中，如下：

private void propertiesElement(XNode context) throws Exception {
if (context != null) {
Properties defaults = context.getChildrenAsProperties();
String resource = context.getStringAttribute(“resource”);
String url = context.getStringAttribute(“url”);
if (resource != null && url != null) {
throw new BuilderException(“The properties element cannot specify both a URL and a resource based property file reference. Please specify one or the other.”);
}
if (resource != null) {
defaults.putAll(Resources.getResourceAsProperties(resource));
} else if (url != null) {
defaults.putAll(Resources.getUrlAsProperties(url));
}
Properties vars = configuration.getVariables();
if (vars != null) {
defaults.putAll(vars);
}
parser.setVariables(defaults);
configuration.setVariables(defaults);
}
}

从上面代码中也可以看出，如果方式2和方式3都存在的时候，方式3会失效，mybatis会先读取方式1的配置，然后读取方式2或者方式3的配置，会将1中相同的配置给覆盖。

mybatis中引入mapper的3种方式

mapper xml文件是非常重要的，我们写的sql基本上都在里面，使用mybatis开发项目的时候，和mybatis相关的大部分代码就是写sql，基本上都是和mapper xml打交道。

编写好的mapper xml需要让mybatis知道，我们怎么让mybatis知道呢？

可以通过mybatis全局配置文件进行引入，主要有3种方式。

方式1：使用mapper resouce属性注册mapper xml文件

目前我们所涉及到的各种例子都是采用的这种方式，使用下面的方法进行引入：

再来说一下这种方式的一些注意点：

\1. 一般情况下面我，我们会创建一个和Mapper xml中namespace同名的Mapper接口，Mapper接口会和Mapper xml文件进行绑定

\2. mybatis加载mapper xml的时候，会去查找namespace对应的Mapper接口，然后进行注册，我们可以通过Mapper接口的方式去访问Mapper xml中的具体操作

\3. Mapper xml和Mapper 接口配合的方式是比较常见的做法，也是强烈建议大家使用的

方式2：使用mapper class属性注册Mapper接口

引入Mapper接口

mybatis全局配置文件中引入mapper接口，如下：

这种情况下，mybais会去加载class对应的接口，然后还会去加载和这个接口同一个目录的同名的xml文件。

如：

上面这种写法，mybatis会自动去注册UserMapper接口，还会去查找下面的文件：

com/javacode2018/chat03/demo1/UserMapper.xml

大家以后开发项目的时候估计也会看到这种写法，Mapper接口和Mapper xml文件放在同一个包中。

案例

下面我们重新创建一个案例，都放在demo2包中。

新建com.javacode2018.chat03.demo2.UserModel，如下：

package com.javacode2018.chat03.demo2;

import lombok.*;
import org.apache.ibatis.type.Alias;

/**

新建com.javacode2018.chat03.demo2.UserMapper，如下：

package com.javacode2018.chat03.demo2;

import java.util.List;

/**

*/
public interface UserMapper {

List getUserList();
}

chat03\src\main\java\com\javacode2018\chat03\demo2中创建UserMapper.xml，如下：

下面重点来了。

创建mybatis全局配置文件，在chat03\src\main\resources\demo2目录中创建mybatis-config.xml，如下：

chat03\src\test\java目录创建测试用例com.javacode2018.chat03.demo2.UserMapperTest，如下：

package com.javacode2018.chat03.demo2;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

/**

*/
@Slf4j
public class UserMapperTest {
private SqlSessionFactory sqlSessionFactory;

@Before
public void before() throws IOException {
//指定mybatis全局配置文件
String resource = “demo2/mybatis-config.xml”;
*//*读取全局配置文件
InputStream inputStream = Resources.getResourceAsStream(resource);
//构建SqlSessionFactory对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
this.sqlSessionFactory = sqlSessionFactory;
}

}

注意这次上面使用的是demo2/mybatis-config.xml配置文件。

我们先来看一下项目结构，4个文件：

注意一下UserMapper接口所在的包中有个同名的UserMapper.xml文件，这个如果按照方式2中所说的，会自动加载。

下面我们来运行一下com.javacode2018.chat03.demo2.UserMapperTest#getUserList，输出：

org.apache.ibatis.binding.BindingException: Type interface com.javacode2018.chat03.demo2.UserMapper is not known to the MapperRegistry.

at org.apache.ibatis.binding.MapperRegistry.getMapper(MapperRegistry.java:47)
at org.apache.ibatis.session.Configuration.getMapper(Configuration.java:779)
at org.apache.ibatis.session.defaults.DefaultSqlSession.getMapper(DefaultSqlSession.java:291)
at com.javacode2018.chat03.demo2.UserMapperTest.getUserList(UserMapperTest.java:36)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:498)
at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)
at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
at org.junit.internal.runners.statements.RunBefores.evaluate(RunBefores.java:26)
at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325)
at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)
at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)
at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
at org.junit.runners.ParentRunner $2.evaluate(ParentRunner.java:268) at org.junit.runners.ParentRunner.run(ParentRunner.java:363) at org.junit.runner.JUnitCore.run(JUnitCore.java:137) at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:68) at com.intellij.rt.execution.junit.IdeaTestRunner$ Repeater.startRunnerWithArgs(IdeaTestRunner.java:51)
at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:242)
at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:70)

从输出中可以看到，UserMapper找不到。

我们去看一下demo2/mybatis-config.xml这个配置文件，这个文件中需要使用方式2引入UserMapper接口，在demo2/mybatis-config.xml中加入下面配置：

再运行一下，还是报错，如下，还是找不到对应的UserMapper：

org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): com.javacode2018.chat03.demo2.UserMapper.getUserList

at org.apache.ibatis.binding.MapperMethod$SqlCommand.(MapperMethod.java:235)
at org.apache.ibatis.binding.MapperMethod.(MapperMethod.java:53)

还是有问题，我们看一下target/classes中demo2包的内容，如下图：

编译之后的文件中少了UserMapper.xml，这个和maven有关，maven编译src/java代码的时候，默认只会对java文件进行编译然后放在target/classes目录，需要在chat03/pom.xml中加入下面配置：

${project.basedir}/src/main/java</directory> <includes> <include>**/*.xml</include> </includes> </resource> <resource> <directory>$ {project.basedir}/src/main/resources **/*

最终chat03/pom.xml内容如下：

mybatis-series com.javacode2018 1.0-SNAPSHOT 4.0.0 chat03 org.mybatis mybatis mysql mysql-connector-java org.projectlombok lombok junit junit ch.qos.logback logback-classic ${project.basedir}/src/main/java **/*.xml ${project.basedir}/src/main/resources **/*

加了这个之后UserMapper.xml就会被放到target的classes中去了，如下图：

我们再次运行一下测试用例com.javacode2018.chat03.demo2.UserMapperTest#getUserList，效果如下：

24:37.814 [main] DEBUG c.j.c.demo2.UserMapper.getUserList - ==> Preparing: SELECT * FROM t_user
24:37.852 [main] DEBUG c.j.c.demo2.UserMapper.getUserList - > Parameters:
24:37.875 [main] DEBUG c.j.c.demo2.UserMapper.getUserList - < Total: 4
24:37.876 [main] INFO c.j.chat03.demo2.UserMapperTest - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
24:37.879 [main] INFO c.j.chat03.demo2.UserMapperTest - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
24:37.879 [main] INFO c.j.chat03.demo2.UserMapperTest - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
24:37.879 [main] INFO c.j.chat03.demo2.UserMapperTest - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)

这次正常了。

源码

方式2对应的源码大家可以去看下面这个方法：

org.apache.ibatis.builder.xml.XMLConfigBuilder#mapperElement

方法中会去加载mapper元素中class属性指定的Mapper接口，然后进行注册，随后会在接口同目录中查找同名的mapper xml文件，将解析这个xml文件，如果mapper xml文件不存在，也不会报错，源码还是比较简单的，大家可以去看一下，加深理解。

方式3：使用package元素批量注册Mapper接口

批量注册Mapper接口

上面说2种方式都是一个个注册mapper的，如果我们写了很多mapper，是否能够批量注册呢？

mybatis提供了扫描包批量注册的方式，需要在mybatis全局配置文件中加入下面配置：

mybatis会扫描package元素中name属性指定的包及子包中的所有接口，将其当做Mapper 接口进行注册，所以一般我们会创建一个mapper包，里面放Mapper接口和同名的Mapper xml文件。

大家来看一个案例，理解一下。

案例

这个案例中将对t_user、t_order两个表进行查询操作，采用方式3中的package批量引入mapper 接口和xml文件。

所有代码放在demo3包中，大家先看下文件所在的目录：

创建UserModel类，如下：

package com.javacode2018.chat03.demo3.model;

import lombok.*;

/**

创建OrderModel类，如下：

package com.javacode2018.chat03.demo3.model;

import lombok.*;

/**

*/
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
@ToString
public class OrderModel {
private Long id;
private Long user_id;
private Double price;
}

创建UserMapper接口，如下：

package com.javacode2018.chat03.demo3.mapper;

import com.javacode2018.chat03.demo3.model.UserModel;

import java.util.List;

/**

*/
public interface UserMapper {

List getList();
}

创建OrderMapper接口，如下：

package com.javacode2018.chat03.demo3.mapper;

import com.javacode2018.chat03.demo3.model.OrderModel;
import com.javacode2018.chat03.demo3.model.UserModel;

import java.util.List;

/**

*/
public interface OrderMapper {

List getList();
}

创建UserMapper.xml，如下：

上面我们写了一个查询t_user数据的sql

创建OrderMapper.xml，如下：

上面我们写了一个查询t_order数据的sql

创建resources/demo3/mybatis-config.xml配置文件，如下：

注意这次我们使用package来让mybatis加载com.javacode2018.chat03.demo3.mapper包下面所有的Mapper接口和Mapper xml文件。

创建测试用例Demo3Test，如下：

package com.javacode2018.chat03.demo3;

import com.javacode2018.chat03.demo3.mapper.OrderMapper;
import com.javacode2018.chat03.demo3.mapper.UserMapper;
import com.javacode2018.chat03.demo3.model.OrderModel;
import com.javacode2018.chat03.demo3.model.UserModel;
import lombok.extern.slf4j.Slf4j;
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.Before;
import org.junit.Test;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

/**

*/
@Slf4j
public class Demo3Test {
private SqlSessionFactory sqlSessionFactory;

@Before
public void before() throws IOException {
//指定mybatis全局配置文件
String resource = “demo3/mybatis-config.xml”;
*//*读取全局配置文件
InputStream inputStream = Resources.getResourceAsStream(resource);
//构建SqlSessionFactory对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
this.sqlSessionFactory = sqlSessionFactory;
}

@Test
public void test() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
*//*执行查询操作
List userModelList = userMapper.getList();
userModelList.forEach(item -> {
log.info(“{}”, item);
});

   log.info("----------------------------------");
   OrderMapper orderMapper = sqlSession.getMapper(OrderMapper.class);
   *//**执行查询操作*
   List<OrderModel> orderModelList = orderMapper.getList();
   orderModelList.forEach(item -> {
     log.info("{}", item);
   });
 }

}

运行com.javacode2018.chat03.demo3.Demo3Test#test，输出如下：

48:39.280 [main] DEBUG c.j.c.d.mapper.UserMapper.getList - ==> Preparing: SELECT * FROM t_user
48:39.315 [main] DEBUG c.j.c.d.mapper.UserMapper.getList - > Parameters:
48:39.339 [main] DEBUG c.j.c.d.mapper.UserMapper.getList - < Total: 4
48:39.340 [main] INFO c.j.chat03.demo3.Demo3Test - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
48:39.343 [main] INFO c.j.chat03.demo3.Demo3Test - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
48:39.343 [main] INFO c.j.chat03.demo3.Demo3Test - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
48:39.343 [main] INFO c.j.chat03.demo3.Demo3Test - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)
48:39.343 [main] INFO c.j.chat03.demo3.Demo3Test - ----------------------------------
48:39.344 [main] DEBUG c.j.c.d.mapper.OrderMapper.getList - ==> Preparing: SELECT * FROM t_order
48:39.345 [main] DEBUG c.j.c.d.mapper.OrderMapper.getList - > Parameters:
48:39.351 [main] DEBUG c.j.c.d.mapper.OrderMapper.getList - < Total: 2
48:39.351 [main] INFO c.j.chat03.demo3.Demo3Test - OrderModel(id=1, user_id=1, price=88.88)
48:39.351 [main] INFO c.j.chat03.demo3.Demo3Test - OrderModel(id=2, user_id=2, price=666.66)

这种批量的方式是不是用着挺爽的，不过有点不是太好，mapper xml和mapper接口放在了一个目录中，目录中既有java代码又有xml文件，看起来也挺别扭的，其实你们可以这样：

一般我们将配置文件放在resource目录，我们可以在resource目录中创建下面子目录：

com/javacode2018/chat03/demo3/mapper

然后将com.javacode2018.chat03.demo3.mapper中的2个xml文件移到上面新创建的目录中去，如下图：

在去运行一下com.javacode2018.chat03.demo3.Demo3Test#test，输出如下：

56:22.669 [main] DEBUG c.j.c.d.mapper.UserMapper.getList - ==> Preparing: SELECT * FROM t_user
56:22.700 [main] DEBUG c.j.c.d.mapper.UserMapper.getList - > Parameters:
56:22.721 [main] DEBUG c.j.c.d.mapper.UserMapper.getList - < Total: 4
56:22.722 [main] INFO c.j.chat03.demo3.Demo3Test - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
56:22.725 [main] INFO c.j.chat03.demo3.Demo3Test - UserModel(id=2, name=javacode2018, age=30, salary=50000.0, sex=1)
56:22.725 [main] INFO c.j.chat03.demo3.Demo3Test - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)
56:22.725 [main] INFO c.j.chat03.demo3.Demo3Test - UserModel(id=4, name=林志玲, age=45, salary=88888.88, sex=2)
56:22.725 [main] INFO c.j.chat03.demo3.Demo3Test - ----------------------------------
56:22.727 [main] DEBUG c.j.c.d.mapper.OrderMapper.getList - ==> Preparing: SELECT * FROM t_order
56:22.727 [main] DEBUG c.j.c.d.mapper.OrderMapper.getList - > Parameters:
56:22.732 [main] DEBUG c.j.c.d.mapper.OrderMapper.getList - < Total: 2
56:22.732 [main] INFO c.j.chat03.demo3.Demo3Test - OrderModel(id=1, user_id=1, price=88.88)
56:22.732 [main] INFO c.j.chat03.demo3.Demo3Test - OrderModel(id=2, user_id=2, price=666.66)

也是可以的。

源码

方式3的源码和方式2的源码在一个地方：

org.apache.ibatis.builder.xml.XMLConfigBuilder#mapperElement

方法中会去扫描指定的包中所有的接口，会将接口作为Mapper接口进行注册，然后还会找这些接口同名的Xml文件，将其注册为Mapper xml文件，相对于对方式2循环的方式。

使用注意

方式3会扫描指定包中所有的接口，把这些接口作为Mapper接口进行注册，扫描到的类型只要是接口就会被注册，所以指定的包中通常我们只放Mapper接口，避免存放一些不相干的类或者接口。

关于配置和源码

本次讲解到的一些配置都是在mybatis全局配置文件中进行配置的，这些元素配置是有先后顺序的，具体元素是在下面的dtd文件中定义的：

http://mybatis.org/dtd/mybatis-3-config.dtd

建议大家去看一下这个dtd配置文件。

Mybatis解析这个配置文件的入口是在下面的方法中：

org.apache.ibatis.builder.xml.XMLConfigBuilder#parseConfiguration

代码的部分实现如下：

private void parseConfiguration(XNode root) {
try {
//issue #117 read properties first
propertiesElement(root.evalNode(“properties”));
Properties settings = settingsAsProperties(root.evalNode(“settings”));
loadCustomVfs(settings);
loadCustomLogImpl(settings);
typeAliasesElement(root.evalNode(“typeAliases”));
pluginElement(root.evalNode(“plugins”));
objectFactoryElement(root.evalNode(“objectFactory”));
objectWrapperFactoryElement(root.evalNode(“objectWrapperFactory”));
reflectorFactoryElement(root.evalNode(“reflectorFactory”));
settingsElement(settings);
// read it after objectFactory and objectWrapperFactory issue #631
environmentsElement(root.evalNode(“environments”));
databaseIdProviderElement(root.evalNode(“databaseIdProvider”));
typeHandlerElement(root.evalNode(“typeHandlers”));
mapperElement(root.evalNode(“mappers”));
} catch (Exception e) {
throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
}
}

可以看到mybatis启动的时候会按顺序加载上面的标签，大家可以去看一下源码，研究一下，下篇继续深入mybatis其他知识点。

总结

\1. 掌握别名注册的3种方式，建议大家尽量少使用自定义别名

\2. 掌握属性配置3种方式

\3. 掌握mapper注册的3种方式及需要注意的地方

案例代码获取方式

扫码添加微信备注：mybatis****案例，即可获取

MyBatis系列

\1. MyBatis系列第1篇：MyBatis未出世之前我们那些痛苦的经历

\2. MyBatis系列第2篇：入门篇，带你感受一下mybatis独特的魅力！

\3. MyBatis系列第3篇：Mybatis使用详解（1）

Mybatis系列第5篇：详解传参的几种方式、原理、源码解析

主要内容

本篇详解mapper接口传参的各种方式。

• 传递一个参数

• 传递一个Map参数

• 传递一个javabean参数

• 多参数中用@param指定参数名称

• java编译中参数名称的处理

• mapper接口传参源码分析

• 传递1个Collection参数

• 传递1个List参数

• 传递1个数组参数

• mybatis对于集合处理源码分析

• ResultHandler作为参数的用法

本篇文章的案例在上一篇chat03模块上进行开发，大家可以到文章的尾部获取整个mybatis****系列的案例源码。

mybatis****系列的文章前后都是有依赖的，请大家按顺序去看，尽量不要跳着去看，这样不会出现看不懂的情况，建议大家系统化的学习知识，基础打牢，慢慢才能成为高手。

使用mybatis开发项目的中，基本上都是使用mapper接口的方式来执行db操作，下面我们来看一下mapper接口传递参数的几种方式及需要注意的地方。

传递一个参数

用法

Mapper接口方法中只有一个参数，如：

UserModel getByName(String name);

Mapper xml引用这个name参数：

如：#{name}、#{val}、${x}等等写法都可以引用上面name参数的值。

案例

创建UserModel类，如下：

package com.javacode2018.chat03.demo4.model;

import lombok.*;

/**

创建Mapper接口UserMapper，如下：

package com.javacode2018.chat03.demo4.mapper;

import com.javacode2018.chat03.demo4.model.UserModel;

import java.util.List;
import java.util.Map;

/**

/
public interface UserMapper {
/*
*** 通过name查询

*** @param name
*** *@*return
*/
UserModel getByName(String name);
}

注意上面有个getByName方法，这个方法传递一个参数。

创建Mapper xml文件UserMapper.xml,mybatis-series\chat03\src\main\resources\com\javacode2018\chat03\demo4\mapper目录创建UserMapper.xml，如下：

上面有个getByName通过用户名查询，通过#{value}引用传递进来的name参数，当一个参数的时候#{变量名称}中变量名称可以随意写，都可以取到传入的参数。

创建属性配置文件，mybatis-series\chat03\src\main\resources目录创建jdbc.properties，如下：

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/javacode2018?characterEncoding=UTF-8
jdbc.username=root
jdbc.password=root123

上面是我本地db配置，大家可以根据自己db信息做对应修改。

创建mybatis全局配置文件，mybatis-series\chat03\src\main\resources\demo4目录创建mybatis-config.xml，如下：

上面通过properties的resource属性引入了jdbc配置文件。

package属性的name指定了mapper接口和mapper xml文件所在的包，mybatis会扫描这个包，自动注册mapper接口和mapper xml文件。

创建测试用例Demo4Test，如下：

package com.javacode2018.chat03.demo4;

import com.javacode2018.chat03.demo4.mapper.UserMapper;
import com.javacode2018.chat03.demo4.model.UserModel;
import lombok.extern.slf4j.Slf4j;
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.Before;
import org.junit.Test;

import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**

*/
@Slf4j
public class Demo4Test {
private SqlSessionFactory sqlSessionFactory;

@Before
public void before() throws IOException {
//指定mybatis全局配置文件
String resource = “demo4/mybatis-config.xml”;
*//*读取全局配置文件
InputStream inputStream = Resources.getResourceAsStream(resource);
//构建SqlSessionFactory对象
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
this.sqlSessionFactory = sqlSessionFactory;
}

/**
*** 通过map给Mapper接口的方法传递参数
*/
@Test
public void getByName() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
UserModel userModel = userMapper.getByName(“路人甲Java”);
log.info(“{}”, userModel);
}
}

}

注意上面的getByName方法，会调用UserMapper接口的getByName方法通过用户名查询用户信息，我们运行一下这个方法，输出如下：

44:55.747 [main] DEBUG c.j.c.d.mapper.UserMapper.getByName - ==> Preparing: SELECT * FROM t_user WHERE name = ? LIMIT 1
44:55.779 [main] DEBUG c.j.c.d.mapper.UserMapper.getByName - > Parameters: 路人甲Java(String)
44:55.797 [main] DEBUG c.j.c.d.mapper.UserMapper.getByName - < Total: 1
44:55.798 [main] INFO c.j.chat03.demo4.Demo4Test - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)

这个案例中我们新增的几个文件结构如下：

传递一个Map参数

用法

如果我们需要传递的参数比较多，参数个数是动态的，那么我们可以将这些参数放在一个map中，key为参数名称，value为参数的值。

Mapper接口中可以这么定义，如：

List getByMap(Map<String,Object> map);

如我们传递：

Map<String, Object> map = new HashMap<>();
map.put(“id”, 1L);
map.put(“name”, “张学友”);

对应的mapper xml中可以通过#{map中的key}可以获取key在map中对应的value的值作为参数，如：

SELECT * FROM t_user WHERE id=#{id} OR name = #

案例

下面我们通过map传递多个参数来按照id或者用户名进行查询。

com.javacode2018.chat03.demo4.mapper.UserMapper中新增一个方法，和上面UserMapper.xml中的对应，如下：

/**
*** 通过map查询
*** @param map
*** *@*return
*/
List getByMap(Map<String,Object> map);

注意上面的方法由2个参数，参数名称分别为id、name，下面我们在对应的mapper xml中写对应的操作

chat03\src\main\resources\com\javacode2018\chat03\demo4\mapper\UserMapper.xml中新增下面代码：

大家注意一下上面的取值我们是使用#{id}取id参数的值，#{name}取name参数的值，下面我们创建测试用例，看看是否可以正常运行？

Demo4Test中新增下面方法：

运行一下上面的这个测试用例，输出：

01:28.242 [main] DEBUG c.j.c.d.mapper.UserMapper.getByMap - ==> Preparing: SELECT * FROM t_user WHERE id=? OR name = ?
01:28.277 [main] DEBUG c.j.c.d.mapper.UserMapper.getByMap - > Parameters: 1(Long), 张学友(String)
01:28.296 [main] DEBUG c.j.c.d.mapper.UserMapper.getByMap - < Total: 2
01:28.297 [main] INFO c.j.chat03.demo4.Demo4Test - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
01:28.298 [main] INFO c.j.chat03.demo4.Demo4Test - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)

传递一个java对象参数

当参数比较多，但是具体有多少个参数我们是确定的时候，我们可以将这些参数放在一个javabean对象中。

如我们想通过userId和userName查询，可以定义一个dto对象，属性添加对应的get、set方法，如：

@Getter
@Setter
@ToString
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class UserFindDto {
private Long userId;
private String userName;
}

注意上面的get、set方法我们通过lombok自动生成的。

UserMapper中新增一个方法，将UserFindDto作为参数：

/**
*** 通过UserFindDto进行查询
*** @param userFindDto
*** *@*return
*/
List getListByUserFindDto(UserFindDto userFindDto);

对应的UserMapper.xml中这么写，如下：

Demo4Test中创建一个测试用例来调用一下新增的这个mapper接口中的方法，如下：

@Test
public void getListByUserFindDto() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
UserFindDto userFindDto = UserFindDto.builder().userId(1L).userName(“张学友”).build();
List userModelList = userMapper.getListByUserFindDto(userFindDto);
userModelList.forEach(item -> {
log.info(“{}”, item);
});
}
}

上面我们通过传递一个userFindDto对象进行查询，运行输出：

20:59.454 [main] DEBUG c.j.c.d.m.U.getListByUserFindDto - ==> Preparing: SELECT * FROM t_user WHERE id=? OR name = ?
20:59.487 [main] DEBUG c.j.c.d.m.U.getListByUserFindDto - > Parameters: 1(Long), 张学友(String)
20:59.508 [main] DEBUG c.j.c.d.m.U.getListByUserFindDto - < Total: 2
20:59.509 [main] INFO c.j.chat03.demo4.Demo4Test - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
20:59.511 [main] INFO c.j.chat03.demo4.Demo4Test - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)

传递java对象的方式相对于map的方式更清晰一些，可以明确知道具体有哪些参数，而传递map，我们是不知道这个map中具体需要哪些参数的，map对参数也没有约束，参数可以随意传，建议多个参数的情况下选择通过java对象进行传参。

传递多个参数

上面我们介绍的都是传递一个参数，那么是否可以传递多个参数呢？我们来试试吧。

案例

我们来新增一个通过用户id或用户名查询的操作。

com.javacode2018.chat03.demo4.mapper.UserMapper中新增一个方法，和上面UserMapper.xml中的对应，如下：

/**
*** 通过id或者name查询

*** @param id
*** @param name
*** *@*return
*/
UserModel getByIdOrName(Long id, String name);

注意上面的方法由2个参数，参数名称分别为id、name，下面我们在对应的mapper xml中写对应的操作

chat03\src\main\resources\com\javacode2018\chat03\demo4\mapper\UserMapper.xml中新增下面代码：

大家注意一下上面的取值我们是使用**#{id}取id参数的值，#{name}取name****参数的值，下面我们创建测试用例，看看是否可以正常运行？**

Demo4Test中新增下面方法：

/**
*** 通过map给Mapper接口的方法传递参数
*/
@Test
public void getByIdOrName() {
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
UserModel userModel = userMapper.getByIdOrName(1L, “路人甲Java”);
log.info(“{}”, userModel);
}
}

运行一下上面的这个测试用例，报错了，我们截取部分主要的错误信息，如下：

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]

上面报错，给大家解释一下，sql中我们通过#{id}去获取id参数的值，但是mybatis无法通过#{id}获取到id的值，所以报错了，从上错误中我们看到有这样的一段：

Available parameters are [arg1, arg0, param1, param2]

上面表示可用的参数名称列表，我们可以在sql中通过#{参数名称}来引参数列表中的参数，先不说这4个参数具体怎么来的，那么我们将sql改成下面这样试试：

SELECT * FROM t_user WHERE id=#{arg0} OR name = #{arg1} LIMIT 1

再运行一下测试用例，看看效果：

46:07.533 [main] DEBUG c.j.c.d.m.UserMapper.getByIdOrName - ==> Preparing: SELECT * FROM t_user WHERE id=? OR name = ? LIMIT 1
46:07.566 [main] DEBUG c.j.c.d.m.UserMapper.getByIdOrName - > Parameters: 1(Long), 路人甲Java(String)
46:07.585 [main] DEBUG c.j.c.d.m.UserMapper.getByIdOrName - < Total: 1
46:07.586 [main] INFO c.j.chat03.demo4.Demo4Test - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)

这下正常了。

我们将sql再修改一下，修改成下面这样：

SELECT * FROM t_user WHERE id=#{param1} OR name = #{param2} LIMIT 1

运行一下测试用例，输出：

47:19.935 [main] DEBUG c.j.c.d.m.UserMapper.getByIdOrName - ==> Preparing: SELECT * FROM t_user WHERE id=? OR name = ? LIMIT 1
47:19.966 [main] DEBUG c.j.c.d.m.UserMapper.getByIdOrName - > Parameters: 1(Long), 路人甲Java(String)
47:19.984 [main] DEBUG c.j.c.d.m.UserMapper.getByIdOrName - < Total: 1
47:19.985 [main] INFO c.j.chat03.demo4.Demo4Test - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)

也是正常的。

我们来分析一下mybatis对于这种多个参数是如何处理的？

多参数mybatis的处理

mybatis处理多个参数的时候，会将多个参数封装到一个map中，map的key为参数的名称，java可以通过反射获取方法参数的名称，下面这个方法：

UserModel getByIdOrName(Long id, String name);

编译之后，方法参数的名称通过反射获取的并不是id、name，而是arg0、arg1，也就是说编译之后，方法真实的参数名称会丢失，会变成arg+参数下标的格式。

所以上面传递的参数相当于传递了下面这样的一个map：

Map<String,Object> map = new HashMap<>();
map.put(“arg0”,id);
map.put(“arg1”,name);

那么参数中的param1、param2又是什么呢？

上面的map中会放入按照参数名称->参数的值的方式将其放入map中，通过反射的方式获取的参数名称是可能会发生变化的，我们编译java代码使用javac命令，javac命令有个-parameters参数，当编译代码的时候加上这个参数，方法的实际名称会被编译到class字节码文件中，当通过反射获取方法名称的时候就不是arg0、arg1这种格式了，而是真实的参数名称：id、name了，我们来修改一下maven的配置让maven编译代码的时候加上这个参数，修改chat03/pom.xml中的build元素，这个元素中加入下面代码：

org.apache.maven.plugins maven-compiler-plugin 3.3 -parameters

idea中编译代码也加一下这个参数，操作如下：

点击File->Settings->Build,Execution,Deployment->Java Compiler，如下图：

下面我们将demo4/UserMapper.xml中的getByIdOrName对应的sql修改成下面这样：

SELECT * FROM t_user WHERE id=#{arg0} OR name = #{arg1} LIMIT 1

使用maven命令重新编译一下chat03的代码，cmd命令中mybatis-series/pom.xml所在目录执行下面命令，如下：

D:\code\IdeaProjects\mybatis-series>mvn clean compile -pl :chat03
[INFO] Scanning for projects…
[INFO]
[INFO] ----------------------< com.javacode2018:chat03 >-----------------------
[INFO] Building chat03 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] — maven-clean-plugin:2.5:clean (default-clean) @ chat03 —
[INFO] Deleting D:\code\IdeaProjects\mybatis-series\chat03\target
[INFO]
[INFO] — maven-resources-plugin:2.6:resources (default-resources) @ chat03 —
[INFO] Using ‘UTF-8’ encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO] Copying 11 resources
[INFO]
[INFO] — maven-compiler-plugin:3.3:compile (default-compile) @ chat03 —
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 13 source files to D:\code\IdeaProjects\mybatis-series\chat03\target\classes
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 3.532 s
[INFO] Finished at: 2019-12-10T13:41:05+08:00
[INFO] ------------------------------------------------------------------------

再运行一下com.javacode2018.chat03.demo4.Demo4Test#getByIdOrName，输出如下：

org.apache.ibatis.exceptions.PersistenceException:
### Error querying database. Cause: org.apache.ibatis.binding.BindingException: Parameter ‘arg0’ not found. Available parameters are [name, id, param1, param2]
### Cause: org.apache.ibatis.binding.BindingException: Parameter ‘arg0’ not found. Available parameters are [name, id, param1, param2]

又报错了，这次错误信息变了，注意有这么一行：

Parameter ‘arg0’ not found. Available parameters are [name, id, param1, param2]

参数名称变成了真实的名称了，但是还是有param1、param2，方法参数名称不管怎么变，编译方式如何变化，param1, param2始终在这里，这个param1, param2就是为了应对不同的编译方式导致参数名称而发生变化的，mybatis内部除了将参数按照名称->值的方式放入map外，还会按照参数的顺序放入一些值，这些值的key就是param+参数位置，这个位置从1开始的，所以id是第一个参数，对应的key是param1，name对应的key是param2，value对应的还是参数的值，所以mybatis对于参数的处理相当于下面过程：

Map<String,Object> map = new HashMap<>();
map.put(“反射获取的参数id的名称”,id);
map.put(“反射获取的参数name的名称”,name);
map.put(“param1”,id);
map.put(“param2”,name);

我们将demo4/UserMaper.xml中的getByIdOrName对应的sql改成param的方式，如下：

SELECT * FROM t_user WHERE id=#{param1} OR name = #{param2} LIMIT 1

再运行一下com.javacode2018.chat03.demo4.Demo4Test#getByIdOrName，输出如下，正常了：

51:12.588 [main] DEBUG c.j.c.d.m.UserMapper.getByIdOrName - ==> Preparing: SELECT * FROM t_user WHERE id=? OR name = ? LIMIT 1
51:12.619 [main] DEBUG c.j.c.d.m.UserMapper.getByIdOrName - > Parameters: 1(Long), 路人甲Java(String)
51:12.634 [main] DEBUG c.j.c.d.m.UserMapper.getByIdOrName - < Total: 1
51:12.635 [main] INFO c.j.chat03.demo4.Demo4Test - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)

使用注意

\1. 使用参数名称的方式对编译环境有很强的依赖性，如果编译中加上了**-parameters参数，参数实际名称可以直接使用，如果没有加，参数名称就变成arg下标的格式了，这种很容易出错**

\2. sql中使用param1**、param2、paramN这种方式来引用多参数，对参数的顺序依赖性特别强，如果有人把参数的顺序调整了或者调整了参数的个数，后果就是灾难性的，所以这种方式不建议大家使用。**

多参数中用@param指定参数名称

刚才上面讲了多参数传递的使用上面，对参数名称和顺序有很强的依赖性，容易导致一些严重的错误。

mybatis也为我们考虑到了这种情况，可以让我们自己去指定参数的名称，通过@param(“参数名称”)来给参数指定名称。

com.javacode2018.chat03.demo4.mapper.UserMapper#getByIdOrName做一下修改：

/**
*** 通过id或者name查询

*** @param id
*** @param name
*** *@*return
*/
UserModel getByIdOrName(@Param(“userId”) Long id, @Param(“userName”) String name);

上面我们通过@Param注解给两个参数明确指定了名称，分别是userId、userName，对应的UserMapper.xml中也做一下调整，如下：

运行com.javacode2018.chat03.demo4.Demo4Test#getByMap，输出：

13:25.431 [main] DEBUG c.j.c.d.mapper.UserMapper.getByMap - ==> Preparing: SELECT * FROM t_user WHERE id=? OR name = ?
13:25.460 [main] DEBUG c.j.c.d.mapper.UserMapper.getByMap - > Parameters: null, 张学友(String)
13:25.477 [main] DEBUG c.j.c.d.mapper.UserMapper.getByMap - < Total: 1
13:25.478 [main] INFO c.j.chat03.demo4.Demo4Test - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)

mybatis参数处理相关源码

上面参数的解析过程代码在org.apache.ibatis.reflection.ParamNameResolver类中，主要看下面的2个方法：

public ParamNameResolver(Configuration config, Method method)
public Object getNamedParams(Object[] args)

这2个方法建议大家都设置一下断点细看一下整个过程，方法的实现不复杂，大家花半个小时去看一下加深一下理解。

下面我们继续说其他方式的传参。

传递1个Collection参数

当传递的参数类型是java.util.Collection的时候，会被放在map中，key为collection，value为参数的值，如下面的查询方法：

/**
*** 查询用户id列表

*** @param idCollection
*** *@*return
*/
List getListByIdCollection(Collection idCollection);

上面的查询方法，mybatis内部会将idList做一下处理：

Map<String,Object> map = new HashMap<>();
map.put(“collection”,idCollection)

所以我们在mapper xml中使用的使用，需要通过collection名称来引用idCollection参数，如下：

com.javacode2018.chat03.demo4.Demo4Test中写个测试用例getListByIdList，查询2个用户信息，如下：

@Test
public void getListByIdCollection() {
log.info(“----------”);
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true)😉 {
UserMapper userMapper = sqlSession.getMapper(UserMapper.class);
List userIdList = Arrays.asList(1L, 3L);
List userModelList = userMapper.getListByIdCollection(userIdList);
userModelList.forEach(item -> {
log.info(“{}”, item);
});
}
}

运行输出：

26:15.774 [main] INFO c.j.chat03.demo4.Demo4Test - ----------
26:16.055 [main] DEBUG c.j.c.d.m.U.getListByIdCollection - ==> Preparing: SELECT * FROM t_user WHERE id IN (?,?)
26:16.083 [main] DEBUG c.j.c.d.m.U.getListByIdCollection - > Parameters: 1(Long), 3(Long)
26:16.102 [main] DEBUG c.j.c.d.m.U.getListByIdCollection - < Total: 2
26:16.103 [main] INFO c.j.chat03.demo4.Demo4Test - UserModel(id=1, name=路人甲Java, age=30, salary=50000.0, sex=1)
26:16.105 [main] INFO c.j.chat03.demo4.Demo4Test - UserModel(id=3, name=张学友, age=56, salary=500000.0, sex=1)

Mybatis中集合参数处理了源码解析

集合参数，mybatis会进行一些特殊处理，代码在下面的方法中：

org.apache.ibatis.session.defaults.DefaultSqlSession#wrapCollection

这个方法的源码如下：

private Object wrapCollection(final Object object) {
if (object instanceof Collection) {
StrictMap

sql对应的字段	OrderModel中的字段
id	id
user_id	userId
create_time	createTime
up_time	upTime