Mybatis的参数及返回值类型详解

一、返回一般数据类型
比如要根据 id 属性获得数据库中的某个字段值。

mapper 接口：

    // 根据 id 获得数据库中的 username 字段的值
    String getEmpNameById(Integer id);

SQL 映射文件：

    <!-- 
        指定 resultType 返回值类型时 String 类型的，
        string 在这里是一个别名，代表的是 java.lang.String 

        对于引用数据类型，都是将大写字母转小写，比如 HashMap 对应的别名是 'hashmap'
        基本数据类型考虑到重复的问题，会在其前面加上 '_'，比如 byte 对应的别名是 '_byte'
    -->
    <select id="getEmpNameById" resultType="string">
        select username from t_employee where id = #{id}
    </select>

二、返回 JavaBean 类型
比如根据某个字段获得数据库中的信息，把查询的结果信息封装成某个 JavaBean 类型的数据。

mapper 接口：

    // 根据 id 查询信息，并把信息封装成 Employee 对象
    Employee getEmpById(Integer id);

SQL 映射文件：

    <!-- 
        通过 resultType 指定查询的结果是 Employee 类型的数据  
        只需要指定 resultType 的类型，MyBatis 会自动将查询的结果映射成 JavaBean 中的属性
    -->
    <select id="getEmpById" resultType="employee">
        select * from t_employee where id = #{id}
    </select>
三、返回List类型
有时候我们要查询的数据不止一条，比如：模糊查询，全表查询等，这时候返回的数据可能不止是一条数据，对于多数据的处理可以存放在List集合中。

mapper 接口：

    // 假如是全表查询数据，将查询的数据封装成 Employee 类型的集合
    List<Employee> getAllEmps();

SQL 映射文件：

    <!--
        注意这里的 resultType 返回值类型是集合内存储数据的类型，不是 'list'
    -->
    <select id="getAllEmps" resultType="employee">
        select * from t_employee
    </select>

四、返回Map类型
MyBatis 还支持将查询的数据封装成Map。

1. 如果查询的结果是一条，我们可以把查询的数据以{表字段名， 对应的值}方式存入到Map中。

mapper 接口：

    //  根据 id 查询信息，并把结果信息封装成 Map 
    Map<String, Object> getEmpAsMapById(Integer id);

SQL 映射文件：

    <!-- 
        注意这里的 resultType 返回值类型是 'map'
     -->
    <select id="getEmpAsMapById" resultType="map">
        select * from t_employee where id = #{id}
    </select>

下面把查询的结果数据贴出来供大家参考： 

2. 如果查询的结果是多条数据，我们也可以把查询的数据以{表中某一字段名, JavaBean}方式来封装成Map。

mapper 接口：

    // 查询所有员工的信息，把数据库中的 'id' 字段作为 key,对应的 value 封装成 Employee 对象
    // @MapKey 中的值表示用数据库中的哪个字段名作 key
    @MapKey("id")
    Map<Integer, Employee> getAllEmpsAsMap();

SQL 映射文件：

    <!--
        注意 resultType 返回值类型，不再是 'map'，而是 Map 的 value 对应的 JavaBean 类型
    -->
    <select id="getAllEmpsAsMap" resultType="employee">
        select * from t_employee
    </select>

下面是查询的结果 (只截取了一部分)： 

MyBatis 允许查询的结果封装成Map，这种机制是极好的。

五、扩展
扩展. 上面返回结果的形式都是基于查询 (select) 的，其实对于增删改的操作也可以返回一定类型的数据，比如Boolean，Integer等。
作者：留兰香丶 
来源：CSDN 
原文：https://blog.csdn.net/codejas/article/details/79520246 
版权声明：本文为博主原创文章，转载请附上博文链接！

 

附加：

返回值只是一个简单的数据类型。

<select id="getUserName" resultType="string">
    select user_name from user where id = 1
</select>

String userName = sqlSession.selectOne("self.eercise.dao.UserDao.getUserName");

如果是多个字段对应的多个返回值，可以返回值类型设为map或类。

返回值为map，字段名会自动映射成key，属性名映射为key值；返回值为类，类中的变量名必须跟数据库中的字段名或者字段别名相同才可以，否则即使数据库中的字段值不为空，在类中对应的变量值也为空。

如果返回值不止一个，而是多个记录的结果集，返回值类型应设为为泛型，得到的结果集会自动封装到List集合中。

<select id="load_map" resultType="map" parameterType="map">
    select * from user where id = #{id} and account = #{account}
</select>

Map<String, Object> map = new HashMap<String, Object>();
map.put("id", 1);
map.put("account", "dva");
List<Map<String, Object>> listMap = sqlSession.selectList("self.exercise.dao.UserDao.load_map", map);

参数

当只有一个参数时，参数类型用parameterType指定类型，可以是简单类型，map或者对象。

如果参数是一个简单的数据类型，那么#{param}中的param可以任意取名。

<select id="getUserName" resultType="string" parameterType="integer">
    select user_name from user where id = #{id}
</select>

String userName = sqlSession.selectOne("self.exercise.dao.UserDao.getUserName"，1);

另外，在参数是一个简单类型的情况下，如果控制台报如下错误：

Caused by: org.apache.ibatis.reflection.ReflectionException: There is no getter for property named 'user_name' in 'class java.lang.String'

那么要将param改名为_parameter,具体原因还不清楚。。。在何种情况下使用也不清楚，目前我只能通过控制台报错来获取线索。如果有知道的dalao还请告知，谢谢。

如果有多个参数，有两种方法可以实现传参。

一　　可以将参数封装到map或者类中

在parameterType中指明容器的类型即可；param取名要与map中的key或者类中的变量名相同，这样获取值时才会正确映射。例如上面load_map的例子。

二　　直接传递参数，这种方式只有接口代理的才能使用。

这种情况下不用在映射文件中指明参数类型，又分三种解决方式。

（一）用0，1，2....来指明第几个参数

//接口中的方法
User getUser(String user_name，String account);

映射文件中的语句应为

<select id="getUser" resultType="sel.exercise.dao.UserDao">
    select user_name from user where user_name = #{0} and account = #{1}
</select>

（二）用param1,param2...来代替参数

//接口中的方法
User getUser(String user_name，String account);

映射文件中的语句应为

<select id="getUser" resultType="sel.exercise.dao.UserDao" >
    select user_name from user where user_name = #{param1} and account = #{param2}
</select>

前两种方式，where语句中字段名的顺序必须严格遵循接口中方法参数的顺序。

（三）@Param方法进行映射

//接口中的方法
User getUser(@Param("userName") String user_name，@Param("account") String account);

映射文件中的语句应为

<select id="getUser" resultType="sel.exercise.dao.UserDao" >
    select user_name from user where user_name = #{userName} and account = #{account}
</select>

注意，#{param}中的param名为@Param方法映射出的新的参数名