在Mybatis中会我们可能遇到数据库字段名与实体类属性名称不一致的情况,例如在数据库表中有如下3个字段:
而在实体类中我们的属性定义可能是这样的:
我们不对其进行修改,查询全部字段信息后出来的结果会是这样的:
由于mybatis在没有设置结果映射集的情况下会自动生成Map与之对应,而当执行查询语句时由于没有找到pwd所对应的字段,因此map中的password得到的返回值为NULL
为解决此问题,mabatis中可以自定义ResultMap,例如:
<resultMap id="UserMap" type="myuser">
<!--结果集映射,解决数据库字段和实体类属性不一致问题:只需要定义属性名和字段名不同的对象-->
<result column="pwd" property="password"/>
</resultMap>
<select id="getUserById" resultMap="UserMap">
select * from mybatis.user where id = #{id};
</select>
column表示数据库中的字段名,property表示实体类中的属性名,修改完成后我们再次运行查看结果:
结果正常输出。
“然而,世界总是这么简单就好了。” ——Mybatis官方
在实际开发中,我们不仅仅会遇到上述问题,往往会遇到尤为复杂的CRUD操作,我们可能需要进行一对多,多对一,多对多的CRUD操作…
当遇到上述情况时,我们上述的简单ResultMap仍然无法解决。来看看下面这个例子:
数据库中有两张表:
table student
table teacher
需求:查询教师信息以及其下所有学生信息。
这是一个一对多的查询,无法通过简单的一对一映射来输出结果,我们需要使用ResultMap的更复杂的写法来解决它。
首先我们先做好准备工作,建好Mybatis环境,先建好db.properties,放在resource下:
driver=com.mysql.cj.jdbc.Driver
url=jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
user=root
password=******
再来写好mybatis-config.xml核心配置文件,该文件放置在resource目录下:
<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<!--引入外部配置文件-->
<properties resource="db.properties"></properties>
<!--类别名-->
<typeAliases>
<typeAlias type="com.ndkj.pojo.Student" alias="Student"/>
<typeAlias type="com.ndkj.pojo.Teacher" alias="Teacher"/>
</typeAliases>
<environments default="test">
<environment id="test">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${user}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
<!--mappers标签十分重要,指向了我们的具体功能实现的配置文件-->
<mappers>
<mapper class="com.ndkj.dao.TeacherMapper"/>
<mapper class="com.ndkj.dao.StudentMapper"/>
</mappers>
</configuration>
再来将连接数据库的代码封装成utils工具类,便于我们下次重用:
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;
import java.io.InputStream;
/**
* @program: Java-Mybatis
* @description: Mybatis连接数据库并返回操作对象的工具类
* @author: liuy
* @create: 2021-04-25 12:35
**/
public class MybatisUtils {
public static SqlSessionFactory sqlSessionFactory;
static {
try {
String resource = "mybatis-config.xml";
InputStream stream = Resources.getResourceAsStream(resource);
sqlSessionFactory = new SqlSessionFactoryBuilder().build(stream);
} catch (IOException e) {
e.printStackTrace();
}
}
public static SqlSession getSqlSession(){
//openSession(boolen) true为开启自动提交。无参默认false
return sqlSessionFactory.openSession(true);
}
}
接下来写好接口:
public interface TeacherMapper {
//获取指定老师下的所有学生及老师的信息
Teacher getTeacher(@Param("id") int id);
}
我们再来定义好需要返回的Teacher和Student实体类:
/**
* @program: mybatis-04
* @description: 一对多测试:教师实体类
* @author: liuy
* @create: 2021-04-28 14:43
**/
@Data
@ToString
public class Teacher {
private int id;
private String name;
//一个老师拥有多个学生,将其放入list中
private List<Student> students;
}
/**
* @program: mybatis-04
* @description:一对多测试:学生实体类
* @author: liuy
* @create: 2021-04-28 14:41
**/
@Data
@ToString
public class Student {
private int id;
private String name;
private int tid;
}
做完这五步,基础工作已经准备的差不多了,接下来需要解决难点:怎样编写具体实现的映射文件?这也是本例要解决的主要问题。
我们可以这样写teacherMapper.xml:
<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ndkj.dao.TeacherMapper">
<select id="getTeacher" resultMap="TeacherAndStudent">
select t.name as tname,s.id as sid,s.name as sname
from mybatis.student s,mybatis.teacher t
where s.tid = t.id and t.id = #{id};
</select>
<!--复杂的属性,我们需要单独处理 对象:association 集合:collection集合中的泛型信息,我们使用ofType获取-->
<resultMap id="TeacherAndStudent" type="Teacher">
<result property="id" column="id"/>
<result property="name" column="tname"/>
<collection property="students" ofType="Student">
<result property="id" column="sid"/>
<result property="name" column="sname"/>
<result property="tid" column="tid"/>
</collection>
</resultMap>
</mapper>
看上去似乎比之前复杂了不少,我们试着解读一下:
首先我们定义了一个select标签,id为我们的接口目标方法名,SQL语句的返回值我们定义了一个名为TeacherAndStudent的resultMap,SQL语句使用了简单的联表查询,并对查询结果字段进行了重命名,#{id}取值为接口中目标方法中传入的(int id)参数。
在下面我们定义了名称为TeacherAndStudent的resultMap与之对应,由于是查询教师下的学生信息,resultMap的类型我们定义为Teacher。
resultMap第一、二行result与Teacher实体类中的id、name相对应。由于这两个实体类属性和数据库字段的名称一致,我们甚至可以省去不写。
第三行由于接口中我们定义的返回值为一个Student类型的数组,简单的result已经无法满足需求,因此我们定义了collection标签用于返回一个学生类型的数组。由于SQ语句中为查询出的字段更改了别名:
t.name as tname,s.id as sid,s.name as sname
因此在resultMap中property实体类属性id、name对应的数据库字段column也要更改为:tname、sname。至此映射文件解读完毕。
其实这个步骤并不复杂,通过仔细的观察我们会发现mapper映射文件和我们的需求:一对多查询教师和其对应的学生信息结构高度吻合,resultMap中使用了两个result和一个collection结构完美符合了一对多的形式。
编写测试类:
/**
* @program: mybatis-04
* @description: 测试类
* @author: liuy
* @create: 2021-04-29 10:57
**/
public class StudentAndTeacherTest {
@Test
public void getTeacher(){
SqlSession sqlSession = MybatisUtils.getSqlSession();
TeacherMapper mapper = sqlSession.getMapper(TeacherMapper.class);
//查询id为1的教师以及其下所有的学生信息
Teacher teacher = mapper.getTeacher(1);
System.out.println(teacher);
sqlSession.close();
}
}
开始我们最激动人心的start:
完成需求。
补充另一种解决思路,mapper中使用子查询:
<?xml version="1.0" encoding="UTF8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.ndkj.dao.TeacherMapper">
<!--使用子查询-->
<select id="getTeacher2" resultMap="TeacherStudents2">
select * from mybatis.teacher where id = #{id}
</select>
<resultMap id="TeacherStudents2" type="Teacher">
<collection property="students" javaType="ArrayList" ofType="Student" select="getStudentByTeacherId" column="id"/>
</resultMap>
<select id="getStudentByTeacherId" resultType="Student">
select * from mybatis.student where tid = #{id}
</select>
</mapper>