【Mybatis】返回值类型和参数传递-补充

已于 2024-07-27 14:30:28 修改
阅读量1.9k 收藏 24
点赞数 8
分类专栏： java 文章标签： mybatis spring java 数据库 sql 后端
于 2024-07-27 14:26:22 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/u013675821/article/details/140735003
版权

在 MyBatis 中，返回值类型和参数传递是 Mapper 接口中至关重要的两个方面。正确理解和使用它们可以帮助我们高效、准确地进行数据库操作。下面将详细讲解 MyBatis 中的返回值类型和参数传递。

返回值类型

MyBatis 支持多种返回值类型，帮助开发者根据需求灵活选择合适的类型进行处理。主要包括以下几种：

1. 单一对象返回

当 SQL 查询结果为一行数据时，可以使用单一对象作为返回值类型。

示例

假设我们有一个 User 表：

CREATE TABLE User (
    id INT PRIMARY KEY,
    username VARCHAR(255),
    email VARCHAR(255),
    age INT
);

对应的 User 实体类：

package com.example.entity;

public class User {
    private Integer id;
    private String username;
    private String email;
    private Integer age;

    // getters and setters
}

Mapper 接口方法及 XML 配置：

package com.example.mapper;

import com.example.entity.User;
import org.apache.ibatis.annotations.Select;

public interface UserMapper {
    @Select("SELECT * FROM User WHERE id = #{id}")
    User selectUserById(int id);
}

XML 配置：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUserById" resultType="com.example.entity.User">
        SELECT * FROM User WHERE id = #{id}
    </select>
</mapper>

在以上代码中，selectUserById 方法返回 User 对象，因为该 SQL 语句预期返回单条记录。

2. 集合返回

当 SQL 查询结果为多行数据时，可以使用集合类型（如 List、Set）作为返回值类型。

示例

假设我们需要查询所有用户：

Mapper 接口方法及 XML 配置：

package com.example.mapper;

import com.example.entity.User;
import java.util.List;

public interface UserMapper {
    List<User> selectAllUsers();
}

XML 配置：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectAllUsers" resultType="com.example.entity.User">
        SELECT * FROM User
    </select>
</mapper>

在以上代码中，selectAllUsers 方法返回 List<User>，因为该 SQL 语句预期返回多条记录。

3. 原始数据类型返回

当 SQL 查询结果为单行单列数据时，可以使用原始数据类型或其包装类作为返回值类型。

示例

假设我们需要获取用户总数：

Mapper 接口方法及 XML 配置：

package com.example.mapper;

public interface UserMapper {
    int getUserCount();
}

XML 配置：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="getUserCount" resultType="int">
        SELECT COUNT(*) FROM User
    </select>
</mapper>

在以上代码中，getUserCount 方法返回 int，因为该 SQL 语句预期返回单行单列数据。

4. Map 返回

MyBatis 允许返回 Map 类型的数据，特别适用于动态查询和多表联查。

示例

假设我们有一个需要获取用户名和邮箱的场景：

Mapper 接口方法及 XML 配置：

package com.example.mapper;

import java.util.Map;

public interface UserMapper {
    Map<String, Object> getUserMapById(int id);
}

XML 配置：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="getUserMapById" resultType="map">
        SELECT username, email FROM User WHERE id = #{id}
    </select>
</mapper>

在以上代码中，getUserMapById 方法返回 Map<String, Object>，因为该 SQL 语句返回的字段是多个，MyBatis 会将列名作为键，列值作为值存入 Map 中。

5. 自定义结果映射

除了自动映射结果，MyBatis 还支持自定义结果映射，通过 resultMap 进行复杂的映射操作。

示例

假设我们有一个更复杂的用户表结构，涉及多个实体类之间的映射：

CREATE TABLE Address (
    id INT PRIMARY KEY,
    user_id INT,
    street VARCHAR(255),
    city VARCHAR(255),
    country VARCHAR(255)
);

Address 实体类：

package com.example.entity;

public class Address {
    private Integer id;
    private String street;
    private String city;
    private String country;

    // getters and setters
}

我们需要将 User 和 Address 进行关联映射：

package com.example.entity;

import java.util.List;

public class User {
    private Integer id;
    private String username;
    private String email;
    private Integer age;
    private List<Address> addresses;

    // getters and setters
}

自定义 resultMap 映射：

<mapper namespace="com.example.mapper.UserMapper">
    <resultMap id="userResultMap" type="com.example.entity.User">
        <id property="id" column="id"/>
        <result property="username" column="username"/>
        <result property="email" column="email"/>
        <result property="age" column="age"/>
        <collection property="addresses" ofType="com.example.entity.Address">
            <id property="id" column="address_id"/>
            <result property="street" column="street"/>
            <result property="city" column="city"/>
            <result property="country" column="country"/>
        </collection>
    </resultMap>

    <select id="selectUserWithAddresses" resultMap="userResultMap">
        SELECT u.id, u.username, u.email, u.age, 
               a.id AS address_id, a.street, a.city, a.country
        FROM User u
        LEFT JOIN Address a ON u.id = a.user_id
        WHERE u.id = #{id}
    </select>
</mapper>

在这个示例中，resultMap 用于将查询结果映射到嵌套的 Java 对象中，使用 collection 元素表示一个一对多的关系。

参数传递

MyBatis 提供了多种方式来传递参数到 SQL 语句中。理解参数传递机制可以提高代码的可读性和灵活性。

1. 单个参数

当方法只有一个参数时，可以直接在 SQL 语句中使用 #{paramName} 或 #{param1} 来引用该参数。

示例

假设我们需要根据用户名查询用户信息：

Mapper 接口方法及 XML 配置：

package com.example.mapper;

import com.example.entity.User;

public interface UserMapper {
    User selectUserByUsername(String username);
}

XML 配置：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUserByUsername" resultType="com.example.entity.User">
        SELECT * FROM User WHERE username = #{username}
    </select>
</mapper>

在以上代码中，方法有一个 username 参数，SQL 语句中直接使用 #{username} 进行引用。

2. 多个参数

当方法有多个参数时，MyBatis 会默认将这些参数包装成一个 Map，键名为 param1、param2 等。

示例

假设我们需要根据用户名和年龄查询用户信息：

Mapper 接口方法及 XML 配置：

package com.example.mapper;

import com.example.entity.User;

public interface UserMapper {
    User selectUserByUsernameAndAge(String username, int age);
}

XML 配置：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUserByUsernameAndAge" resultType="com.example.entity.User">
        SELECT * FROM User WHERE username = #{param1} AND age = #{param2}
    </select>
</mapper>

在以上代码中，方法有两个参数，SQL 语句中使用 #{param1} 和 #{param2} 分别引用。

3. 使用 @Param 注解

MyBatis 提供了 @Param 注解用于指定参数名称，以增强代码可读性。

示例

假设我们需要根据用户名和邮箱查询用户信息：

Mapper 接口方法及 XML 配置：

package com.example.mapper;

import com.example.entity.User;
import org.apache.ibatis.annotations.Param;

public interface UserMapper {
    User selectUserByUsernameAndEmail(@Param("username") String username, @Param("email") String email);
}

XML 配置：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUserByUsernameAndEmail" resultType="com.example.entity.User">
        SELECT * FROM User WHERE username = #{username} AND email = #{email}
    </select>
</mapper>

在以上代码中，使用 @Param 注解指定参数名称，SQL 语句中可以直接使用 #{username} 和 #{email} 引用。

4. 使用 Map 参数

可以使用 Map 对象传递多个参数，适合动态参数场景。

示例

假设我们需要根据动态条件查询用户信息：

Mapper 接口方法及 XML 配置：

package com.example.mapper;

import com.example.entity.User;
import java.util.Map;

public interface UserMapper {
    User selectUserByParams(Map<String, Object> params);
}

XML 配置：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUserByParams" resultType="com.example.entity.User">
        SELECT * FROM User
        WHERE username = #{username}
        <if test="email != null">
            AND email = #{email}
        </if>
        <if test="age != null">
            AND age = #{age}
        </if>
    </select>
</mapper>

在以上代码中，selectUserByParams 方法的参数是一个 Map 对象，SQL 语句中可以使用 #{username}、#{email} 和 #{age} 引用。

5. 使用 POJO 作为参数

可以使用 POJO 对象传递参数，将多个字段封装在一个对象中。

示例

假设我们需要根据用户的多个属性查询用户信息：

Mapper 接口方法及 XML 配置：

package com.example.mapper;

import com.example.entity.User;
import com.example.entity.UserSearchCriteria;

public interface UserMapper {
    User selectUserByCriteria(UserSearchCriteria criteria);
}

UserSearchCriteria 类：

package com.example.entity;

public class UserSearchCriteria {
    private String username;
    private String email;
    private Integer age;

    // getters and setters
}

XML 配置：

<mapper namespace="com.example.mapper.UserMapper">
    <select id="selectUserByCriteria" resultType="com.example.entity.User">
        SELECT * FROM User
        WHERE username = #{username}
        <if test="email != null">
            AND email = #{email}
        </if>
        <if test="age != null">
            AND age = #{age}
        </if>
    </select>
</mapper>

在以上代码中，selectUserByCriteria 方法使用 UserSearchCriteria 对象作为参数，SQL 语句中可以使用 #{username}、#{email} 和 #{age} 引用。

以上是 MyBatis 中关于返回值类型和参数传递的详细讲解。理解这些概念可以帮助你更高效地使用 MyBatis 进行数据库操作。

MyBatis返回类型
小小渔夫
06-10 9661
分类及返回值类型 对应的分类为 resultMap resultType 对应返回值类型 resultMap:结果集 resultType:int,string ,long ,class 要点 在MyBatis进行查询映射时，其实查询出来的每一个属性都是放在一个对应的Map里面的，其中键是属性名，值则是其对应的值。1、当提供的返回类型属性是resultType时，MyBatis会将Ma...
Mybatis---从入门到深化
11-16 597
框架即一个半成品软件。开发者从头开发一个软件需要花费大量精力，于是有一些项目组开发出半成品软件，开发者在这些软件的基础上进行开发，这样的软件就称之为框架。如果将开发完成的软件比作是一套已经装修完毕的新房，框架就好比是一套已经修建好的毛坯房。用户直接购买毛坯房，保证建筑质量和户型合理的同时可以进行风格的自由装修。省去大量的代码编写、减少开发时间、降低开发难度。限制程序员必须使用框架规范开发，增强代码的规范性，降低程序员之间沟通及日后维护的成本。将程序员的注意力从技术中抽离出来，更集中在业务层面。
Mybatis的返回参数类型
hyj
07-15 3361
MyBatis的返回参数类型分两种 1.对应的分类为： 1.1. resultMap : 1.2. resultType : 2 . 对应返回值类型： 2.1. resultMap : 结果集[对象等] 2.2. resultType : Integer,String ,Long ,class 3. 注意点： 在MyBatis进行查询映射时，其实查询出来的每一个属性都是放在一个...
MyBatis基于XML的详细使用-参数、返回结果处理
最新发布
逍遥人世欢
03-28 386
-1.声明resultMap自定义结果集 resultType 和 resultMap 只能使用一个。id 唯一标识， 需要和<select 上的resultMap 进行对应type 需要映射的pojo对象， 可以设置别名autoMapping 自动映射，（默认=true） 只要字段名和属性名遵循映射规则就可以自动映射，但是不建议，哪怕属性名和字段名一一对应上了也要显示的配置映射。
mybatis返回类型
06-14 323
mybatis中resultType可选类型: 1，java的基础类型及其包装类int,double和java.lang.Integer,java.lang.Double等 2，实体类，自己定义的实体类 3，map类型，如果使用resultMap这里可以使用自定义map，本文只介绍res...
MyBatis中查询结果resultType返回值类型
Damon_zqt的博客
05-02 3402
常见的MyBatis中查询结果resultType返回值类型 1、基本类型 ： resultType=基本类型 2、List类型： resultType=List中元素的类型即泛型类型 多条记录，需要返回List<Map<String,Object>>，可以自定义一个<resultMap> 3、Map类型 单条记录，{表字段名， 对应的值}方式存入到Map：r...
MyBatis的返回参数类型
我只是一个简单的Coder，为了兴趣和理想奋斗在生活的道路上
08-16 1072
MyBatis的返回参数类型分两种 1. 对应的分类为： 1.1.resultMap: 1.2.resultType: 2 .对应返回值类型： 2.1.resultMap:结果集 2.2.resultType:int,string ,long ,class 3. 注意点： 在MyBatis进行查询映射时，其实查询出来的每一个属性都是放在一
从Mybatis-Plus开始认识SerializedLambda
Poker_Facex的博客
05-26 1227
Mybatis-Plus Lambda查询、SerializedLambda、方法引用、Lambda表达式、writeReplace方法
tk-mybatis使用
热门推荐
西西
09-30 1万+
一、序言 二、组件介绍 1、前置条件 2、独立性和兼容性 3、环境的搭建 ⑴、独立环境的使用 ①自定义mybatis-config.xml配置文件 ②创建测试表以及数据 ③构建SqlSessionFactory ④创建PO对象以及Mapper接口 ⑤配置和测试Mapper对象 ⑥小结 ⑵、基于Spring环境（不依赖于与m...
刚学习Mybatis-Plus自身遇到的问题
Keep_CSDN的博客
08-10 546
刚学习Mybatis-Plus自身遇到的问题说明1.mybatis-plus传递类型有Map型2.关于mybatis-plus的and 和 or方法3.关于分页4.关于自定义mapper5.根据多个列排序 说明 因为有很多文章都写了关于mybatis-plus的使用方法，但是有些小问题可能因为太简单了没有提，在这里结合自己用的情况做一个记录，有别的新问题再做补充。 1.mybatis-plus传递类型有Map型 mybatis可以将wrapper对象传递为map类型，返回值也可以是map类而不一定要是实体类
深入了解mybatis参数
weixin_43242688的博客
10-31 398
深入了解MyBatis参数 相信很多人可能都遇到过下面这些异常： &quot;Parameter 'xxx' not found. Available parameters are [...]&quot; &quot;Could not get property 'xxx' from xxxClass. Cause: &quot;The expression 'xxx' evaluated to a null value.&quot; &am
Mybatis 返回值类型
持之以恒
11-17 1万+
MyBatis的返回参数类型分两种 1. 对应的分类为： resultMap: resultType: 2 .对应返回值类型： resultMap:结果集 resultType:int,string ,long ,class 3. 注意点： 在MyBatis进行查询映射时，其实查询出来的每一个属性都是放在一个对应的Map里面的，其中键是属
Mybatis查询返回结果类型专题
qq_42338744的博客
10-31 3156
list map pojo类 list list Map
mybatis返回值
yuange
11-07 1030
mybatis的返回值resultmap和resulttype 1 resulttype 使用的是“automapper”自动映射。意思就是，不需要配置属性和列的对应关系，在属性和列同名的情况下，查询的结果会自动匹配。   2 resultmap 1）单表查询 在属性和列名不一样的时候你可以你可以自己指定哪一个属性对应着哪一个列 用&lt;result&gt;和&lt;id&gt;标签...
mybatis返回值为int_MyBatis查询结果resultType返回值类型详细介绍
weixin_28888459的博客
12-29 6911
一、返回一般数据类型比如要根据 id 属性获得数据库中的某个字段值。mapper 接口：// 根据 id 获得数据库中的 username 字段的值String getEmpNameById(Integer id);SQL 映射文件：select username from t_employee where id = #{id}二、返回 JavaBean 类型比如根据某个字段获得数据库中的信息，把...
mybatis之返回值总结
s_156的博客
08-05 5566
mybatis之返回值总结
【MyBatis】学习笔记06：各种查询所返回数据的数据类型
萌狼蓝天の技术栈
03-27 2899
【Mybatis】学习笔记01：连接数据库，实现增删改 【Mybatis】学习笔记02：实现简单的查 【MyBatis】学习笔记03：配置文件进一步解读(非常重要) 【MyBatis】学习笔记04：配置文件模板 【MyBatis】学习笔记05：获取参数值的两种方式 目录准备(1)创建接口(2)创建对应的映射文件查询一个实体类对象查询返回一个List集合Eg1：查询出的数据只有一条Eg2：查询出的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值