【mybatis深度历险系列】mybatis中的输入映射和输出映射

时间：2023-03-08 16:22:02

在前面的博文中，小编介绍了mybatis的框架原理以及入门程序，还有mybatis中开发到的两种方法，原始开发dao的方法和mapper代理方法，今天博文，我们来继续学习mybatis中的相关知识，随着小编的脚步，今天小编要向小伙伴们介绍的是mybatis中的输入映射和输出映射。

一、输入映射

通过parameterType指定输入参数的类型，类型可以是简单类型、hashmap、pojo的包装类型。

a、传递pojo的包装对象

1）需求描述

完成用户信息的综合查询，需要传入的查询条件可能很复杂(可能包括用户信息，其它信息，比如，商品，订单等等)。

2）定义包装类型的pojo

针对上边的需求，建议使用自定义的包装类型pojo，在包装类型的pojo中将复杂的查询条件包装进去。

第一步、包装条件查询pojo类的UserQueryVo类的代码，如下所示：

package cn.itcast.mybatis.po;

import java.util.List;

/**
 *
 * <p>Title: UserQueryVo</p>
 * <p>Description:包装类型 </p>
 * <p>Company: www.itcast.com</p>
 * @author	丁国华
 * @date	2016年8月7日 10:20:38
 * @version 1.0
 */
public class UserQueryVo {

	//在这里包装所需要的查询条件

	//用户查询条件
	private UserCustom userCustom;

	public UserCustom getUserCustom() {
		return userCustom;
	}

	public void setUserCustom(UserCustom userCustom) {
		this.userCustom = userCustom;
	}

	//可以包装其它的查询条件，订单、商品
	//....

}

第二步、编写UserCustom类的代码，如下所示：

package cn.itcast.mybatis.po;
/**
  *
 * @ClassName: UserCustom
 * @Description: 用户的扩展类
 * @author 丁国华
 * @date 2016年8月7日 11:47:20
 *
  */

public class UserCustom extends User {
	//可以扩展用户的信息

}

第三步、编写UserMapper.xml的代码，在UserMapper.xml中定义用户信息综合查询，假设查询条件很复杂，通过高级查询复杂关联查询，如下所示： 

	<!-- 用户信息综合查询
	#{userCustom.sex}:取出pojo包装对象中性别值
	${userCustom.username}：取出pojo包装对象中用户名称
	 -->
	 <select id="findUserList" parameterType="cn.itcast.mybatis.po.UserQueryVo"
	 	resultType="cn.itcast.mybatis.po.UserCustom">
	 	SELECT * FROM USER WHERE user.sex=#{userCustom.sex} ADN user.username LIKE '%${userCustom.username}%'
	 </select>

第四步、编写UserMapper.java类中的代码如下所示：

  /**
   *
   * @ClassName: UserMapper
  * @Description: 用户管理mapper接口
  * @author 丁国华
   * @date2016年8月7日 11:51:06
  *
  */
 public interface UserMapper {
     // 用户信息综合查询
     public List<UserCustom> findUserList(UserQueryVo userQueryVo);

 }

第五步、编写junit单元测试代码

ackage com.mybatis.dao.test;

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

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 com.mybatis.entity.User;
import com.mybatis.entity.UserCustom;
import com.mybatis.entity.UserQueryVo;
import com.mybatis.mapper.UserMapper;

public class UserMapperTest {

    private SqlSessionFactory sqlSessionFactory;

    // 此方法是在执行findUserByIdTest之前执行
    @Before
    public void setUp() throws Exception {
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        // 创建SqlSessionFcatory
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }

    @Test
    public void testFindUserList() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //创造查询条件
        UserQueryVo userQueryVo = new UserQueryVo();
        UserCustom userCustom = new UserCustom();
        userCustom.setSex("女");
        userCustom.setUsername("丁国华");
        userQueryVo.setUserCustom(userCustom);
        // 创建Usermapper对象，mybatis自动生成mapper代理对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        List<UserCustom>list=mapper.findUserList(userQueryVo);
        System.out.println(list);
        sqlSession.commit();
        sqlSession.close();
    }
}

接着，我们来学习输出映射，学习之前小编先来简单的介绍一下resultType以及需求。

a.resultType

使用resultType进行输出映射，只有查询出来的列名和pojo中的属性名一致，该列才可以映射成功。

如果查询出来的列名和pojo中的属性名全部不一致，没有创建pojo对象。

只要查询出来的列名和pojo中的属性有一个一致，就会创建pojo对象。

1）输出简单类型

需求：用户信息的综合查询列表，通过查询总数才能实现分页功能。接着我们来编写代码的部分。

第一步、编写UserMapper.xml的代码部分，如下所示：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!-- namespace命名空间,作用就是对sql进行分类化的管理,理解为sql隔离
    注意:使用mapper代理开发时，namespace有特殊作用,namespace等于mapper接口地址
 -->
<!-- 用户信息综合查询总数
     parameterType:指定输入类型，和findUserList一致。
     resultType:输出结果类型.
  -->
<mapper namespace="com.mybatis.mapper.UserMapper">
    <select id="findUserCount" parameterType="com.mybatis.entity.UserQueryVo" resultType="int">
        select count(*) from t_user where  sex=#{userCustom.sex} and username like '%${userCustom.username}%'
    </select>
</mapper>

第二步、编写UserMapper的代码部分，如下所示：

 public interface UserMapper {
    //用户信息综合查询总数
    public int findUserCount(UserQueryVo userQueryVo);
}

第三步、编写Junit单元测试代码，如下所示：

package com.mybatis.dao.test;

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

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 com.mybatis.entity.User;
import com.mybatis.entity.UserCustom;
import com.mybatis.entity.UserQueryVo;
import com.mybatis.mapper.UserMapper;

public class UserMapperTest {

    private SqlSessionFactory sqlSessionFactory;

    // 此方法是在执行findUserByIdTest之前执行
    @Before
    public void setUp() throws Exception {
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        // 创建SqlSessionFcatory
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }

    @Test
    public void findUserCountTest() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //创造查询条件
        UserQueryVo userQueryVo = new UserQueryVo();
        UserCustom userCustom = new UserCustom();
        userCustom.setSex("女");
        userCustom.setUsername("丁丁");
        userQueryVo.setUserCustom(userCustom);
        // 创建Usermapper对象，mybatis自动生成mapper代理对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        int count=mapper.findUserCount(userQueryVo);
        System.out.println(count);
        sqlSession.commit();
        sqlSession.close();
    }
}

小结：查询出来的结果集只有一行一列，可以使用简单类型进行输出映射。

2）输出pojo对象和pojo列表　　

不管是输出的pojo单个对象还是一个列表（list中包括pojo），在mapper.xml中resultType指定的类型是一样的。在mapper.java指定的方法返回值类型不一样。

3）输出单个pojo对象，方法返回值是单个对象类型

 public interface UserMapper {
     /** 根据ID查询用户信息 */
     public User findUserById(int id);
 }

输出pojo对象list，方法返回值是List<pojo>

 public interface UserMapper {
     /** 根据用户名称模糊查询用户信息 */
     public List<User> findUserByName(String username);
 }

小结：生成的动态代理对象中是根据mapper.java方法的返回值类型确定是调用selectOne(返回单个对象调用)还是selectList(返回集合对象调用)

输出类型resultMap

mybatis中使用resultMap完成高级输出结果映射。

resultMap使用方法

(1).定义resultMap

(2).使用resultMap作为statement的输出映射类型

demo

(1).需求：将下面的sql使用User完成映射

select id id_,usernameusername_ from t_user where id=?

User类中属性名和上边的列名不一致。

(2).定义resultMap　　　

例子

(1).需求：将下面的sql使用User完成映射

select id id_,usernameusername_ from t_user where id=?

User类中属性名和上边的列名不一致。

(2).定义resultMap　　　

<?xml version="1.0" encoding="UTF-8" ?>
 <!DOCTYPE mapper
 PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  <!-- namespace命名空间,作用就是对sql进行分类化的管理,理解为sql隔离
    注意:使用mapper代理开发时，namespace有特殊作用,namespace等于mapper接口地址
  -->
   <!-- 用户信息综合查询总数
     parameterType:指定输入类型，和findUserList一致。
      resultType:输出结果类型.
   -->
 <mapper namespace="com.mybatis.mapper.UserMapper">
 <!-- 定义resultMap
     select id id_,username username_ from t_user和User类中的属性作为一个映射关系
    type:resultMap最终映射的java对象类型，可以使用别名；
     id:对resultMap的唯一标识
 -->
 <resultMap type="user" id="userResultMap">
     <!--id表示查询结果中的唯一标识，
         column：查询出来的列名
         property：type指定的pojo类型中的属性名
        最终resultMap对column和property作一个映射关系（对应关系）
      -->
     <id column="id_" property="id"/>
     <!--result:表示对普通列名的映射，
        column：查询出来的列名
       property：type指定的pojo类型中的属性名
         最终resultMap对column和property作一个映射关系（对应关系）
       -->
     <result column="username_" property="username"/>
 </resultMap>
 </mapper>

(3).使用resultMap作为statement的输出类型映射

<!-- 使用resultMap作为输出映射
     resultMap:指定定义的resultMap的id，如果这个resultMap在其它的mapper.xml文件中，前边需要添加namespace命名空间
  -->
 <select id="findUserByIdResultMap" parameterType="int" resultMap="userResultMap" >
     select id id_,username username_ from t_user where id=#{id}
 </select>
UserMapper.java代码
public interface UserMapper {
    /** 根据ID查询用户信息,使用resultMap进行输出 */
    public User findUserByIdResultMap(int id);
}

Junit测试代码:

package com.mybatis.dao.test;

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

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 com.mybatis.entity.User;
import com.mybatis.entity.UserCustom;
import com.mybatis.entity.UserQueryVo;
import com.mybatis.mapper.UserMapper;

public class UserMapperTest {

    private SqlSessionFactory sqlSessionFactory;

    // 此方法是在执行findUserByIdTest之前执行
    @Before
    public void setUp() throws Exception {
        String resource = "SqlMapConfig.xml";
        InputStream inputStream = Resources.getResourceAsStream(resource);
        // 创建SqlSessionFcatory
        sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
    }

    @Test
    public void testFindUserByIdResultMap() {
        SqlSession sqlSession = sqlSessionFactory.openSession();
        // 创建Usermapper对象，mybatis自动生成mapper代理对象
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        User user = mapper.findUserByIdResultMap(1);
        System.out.println(user);
        sqlSession.close();
    }
}

小编寄语：用resultType进行输出映射，只有查询出来的列名和pojo中的属性名一致，该列才可以映射成功。如果查询出来的列名和pojo的属性名不一致，通过定义一个resultMap对列名和pojo属性名之间作一个映射关系。该博文，小编主要简单介绍了mybatis中的输出映射和输入映射，通过demo简单的介绍了输入映射和输出映射，希望对有需要的小伙伴有帮助，不足之处，还请小伙伴多多指教，下篇博文中，小编将介绍mybatis中的动态sql，敬请关注。

相关文章