mybatis传递多个参数的 4 种方法

Mybatis在使用Mapper接口进行编程时,其实底层是采用了动态代理机制,表面上是调用的Mapper接口,而实际上是通过动态代理调用的SqlSession的对应方法,其最终会获得一个代理了Mapper接口的MapperProxy对象。MapperProxy对象在调用Mapper接口方法时会把传递的参数做一个转换,然后把转换后的参数作为入参调用SqlSession对应的操作方法(如:selectOneinsert等)。

使用myBatis注解形式的SQL,则首先需要在启动类上使用@MapperScan注解扫描到SQL所在的DAO接口或者mapper接口。

传递多个参数的 4 种方法

1.Java Bean 传参法

参数以Bean形式传入,这种方法很直观,但需要建一个实体类(请求体),扩展时需要向类中添加属性

1.1 指定变量名

Controller.java

@GetMapping("/api/user/page/bean")
public R pageWithBean(UserPageRequest request) {
    log.debug("分页『Bean传参法』......");
    UserPageRequestParams params = new UserPageRequestParams();
    BeanUtils.copyProperties(request, params);
    Page<User> page = userMapper.pageWithBean(new Page(request.getCurrent(), request.getSize()), params);
    return R.ok(page);
}

UserMapper.java

/**
  * 指定变量名“params”
  *
  * @param page
  * @param params
  * @return
  */
 Page<User> pageWithBean(Page page, @Param("params") UserPageRequestParams params);

UserMapper.xml

<select id="pageWithBean" resultType="michael.spica.entity.mybatisplus.User">
    SELECT * FROM tb_user u
    <where>
        <if test="null != params.name">
            AND u.name LIKE CONCAT('%',#{params.name},'%')
        </if>
        <if test="null != params.email">
            AND u.email LIKE CONCAT('%',#{params.email},'%')
        </if>
        <if test="null != params.phoneType">
            AND u.phone_type = #{params.phoneType}
        </if>
        <if test="null != params.gender">
            AND u.gender = #{params.gender}
        </if>
    </where>
</select>

#{}里面的名称对应的是User类里面的成员属性

1.2 默认变量名

Controller.java

@GetMapping("/api/user/page/bean/default")
public R pageWithBean(UserPageRequest request) {
    log.debug("分页『Bean传参法』......");
    UserPageRequestParams params = new UserPageRequestParams();
    BeanUtils.copyProperties(request, params);
    Page<User> page = userMapper.pageWithBeanDefault(new Page(request.getCurrent(), request.getSize()), params);
    return R.ok(page);
}

UserMapper.java

/**
  * 默认变量“params” --> “param2”
  *
  * @param page
  * @param params
  * @return
  */
 Page<User> pageWithBeanDefault(Page page, UserPageRequestParams params);

UserMapper.xml

<select id="pageWithBeanDefault" resultType="michael.spica.entity.mybatisplus.User">
    SELECT * FROM tb_user u
    <where>
        <if test="null != param2.name">
            AND u.name LIKE CONCAT('%',#{param2.name},'%')
        </if>
        <if test="null != param2.email">
            AND u.email LIKE CONCAT('%',#{param2.email},'%')
        </if>
        <if test="null != param2.phoneType">
            AND u.phone_type = #{param2.phoneType}
        </if>
        <if test="null != param2.gender">
            AND u.gender = #{param2.gender}
        </if>
    </where>
</select>

#{}里面的名称对应的是User类里面的成员属性
#{param2.xxx}param2为默认变量名

2.Map 传参法

参数以Map形式传入,这种方法对后台来说是一劳永逸(以后如果需要添加参数,Controller可以不用修改,只需要修改SQL文件),但是不直观,对于Map中解析了什么是不清楚的

Controller.java

@GetMapping("/api/user/page/map")
public R pageWithMap(Map<String, Object> paramsMap) {
    log.debug("分页『Map传参法』......");
    Page<User> page = userMapper.pageWithMap(new Page(request.getCurrent(), request.getSize()), paramsMap);
    Page<User> page = userMapper.pageWithMapDefault(new Page(request.getCurrent(), request.getSize()), paramsMap);
    return R.ok(page);
}

@GetMapping("/api/user/page/map/default")
public R pageWithMap(Map<String, Object> paramsMap) {
    log.debug("分页『Map传参法』......");
    Page<User> page = userMapper.pageWithMapDefault(new Page(request.getCurrent(), request.getSize()), paramsMap);
    return R.ok(page);
}

UserMapper.java

/**
  * 指定变量名“paramsMap”
  *
  * @param page
  * @param paramsMap
  * @return
  */
Page<User> pageWithMap(Page page, @Param("paramsMap") Map<String, Object> paramsMap);

/**
  * 默认变量“paramsMap” --> “param2”
  *
  * @param page
  * @param paramsMap
  * @return
  */
Page<User> pageWithMapDefault(Page page, Map<String, Object> paramsMap);

UserMapper.xml

<select id="pageWithMap" resultType="michael.spica.entity.mybatisplus.User">
   SELECT * FROM tb_user u
    <where>
        <if test="null != paramsMap.name">
            AND u.name LIKE CONCAT('%',#{paramsMap.name},'%')
        </if>
        <if test="null != paramsMap.email">
            AND u.email LIKE CONCAT('%',#{paramsMap.email},'%')
        </if>
        <if test="null != paramsMap.phoneType">
            AND u.phone_type = #{paramsMap.phoneType}
        </if>
        <if test="null != paramsMap.gender">
            AND u.gender = #{paramsMap.gender}
        </if>
    </where>
</select>

<select id="pageWithMapDefault" resultType="michael.spica.entity.mybatisplus.User">
    SELECT * FROM tb_user u
    <where>
        <if test="null != param2.name">
            AND u.name LIKE CONCAT('%',#{param2.name},'%')
        </if>
        <if test="null != param2.email">
            AND u.email LIKE CONCAT('%',#{param2.email},'%')
        </if>
        <if test="null != param2.phoneType">
            AND u.phone_type = #{param2.phoneType}
        </if>
        <if test="null != param2.gender">
            AND u.gender = #{param2.gender}
        </if>
    </where>
</select>

3.@Param注解传参法

这种方法在参数不多的情况还是比较直观的,若参数多的情况下推荐使用** Java Bean 传参法**

Controller.java

@GetMapping("/api/user/page/param")
public R pageWithParam(UserPageRequest request) {
    log.debug("分页『@Param注解传参法』......");
    Page<User> page = userMapper.pageWithParam(new Page(request.getCurrent(), request.getSize()),
            request.getName(),
            request.getEmail(),
            request.getPhoneType(),
            request.getGender()
    );
    return R.ok(page);
}

UserMapper.java

Page<User> pageWithParam(Page page,
                         @Param("name") String name,
                         @Param("email") String email,
                         @Param("phoneType") String phoneType,
                         @Param("gender") String gender);

UserMapper.xml

<select id="pageWithParam" resultType="michael.spica.entity.mybatisplus.User">
    SELECT * FROM tb_user u
    <where>
        <if test="null != name">
            AND u.name LIKE CONCAT('%',#{name},'%')
        </if>
        <if test="null != email">
            AND u.email LIKE CONCAT('%',#{email},'%')
        </if>
        <if test="null != phoneType">
            AND u.phone_type = #{phoneType}
        </if>
        <if test="null != gender">
            AND u.gender = #{gender}
        </if>
    </where>
</select>

#{}里面的名称对应的是注解@Param括号里面修饰的名称

4. 索引传参法(也叫顺序传参法)

#{}里面的参数如果使用arg,则从0开始。如果使用param,则从1开始,如:param1,因SQL层表达不直观,且一旦顺序调整容易出错,所以这种方法不建议使用

Controller.java

@GetMapping("/api/user/page/index")
public R pageWithIndex(UserPageRequest request) {
    log.debug("分页『Index传参法』......");
    Page<User> page = userMapper.pageWithIndex(new Page(request.getCurrent(), request.getSize()),
            request.getName(),
            request.getEmail(),
            request.getPhoneType(),
            request.getGender()
    );
    return R.ok(page);
}

UserMapper.java

Page<User> pageWithIndex(Page page,
                         String name,
                         String email,
                         String phoneType,
                         String gender);

UserMapper.xml

<select id="pageWithIndex" resultType="michael.spica.entity.mybatisplus.User">
    SELECT * FROM tb_user u
    <where>
        <if test="null != param2">
            AND u.name LIKE CONCAT('%',#{param2},'%')
        </if>
        <if test="null != param3">
            AND u.email LIKE CONCAT('%',#{param3},'%')
        </if>
        <if test="null != param4">
            AND u.phone_type = #{param4}
        </if>
        <if test="null != param5">
            AND u.gender = #{param5}
        </if>
    </where>
</select>

传入混合参数的获取方式

1. 既有注解参数,又有普通参数

有注解的可以使用注解中使用的名字,没有注解的只能使用该参数对应的 Key(param1或者其它位置)

@Select("SELECT * FROM tb_user WHERE id = #{id} AND `name` = #{param2}")
User getUser(@Param("id") Integer id, String name);

取值:
id → #{id} 或 #{param1}
name → #{param2}

2. 既有普通参数,又有一个参数是一个对象

没有注解的只能使用该参数对应的 Key(param1或者其它位置),另一个对象使用对应位置的 key 获得该对象之后,再获得其相应的属性

@Select("SELECT * FROM tb_user WHERE id = #{param1} AND `name` = #{param2.name}")
User getUser(Integer id, User user);

取值:
id → #{param1}
name → #{param2.name}

3. 既有普通参数,又有一个参数是一个对象,且该对象使用了注解

没有注解的只能使用该参数对应的 Key(param1或者其它位置),另一个对象使用对应位置的 key 获得该对象之后,再获得其相应的属性(又因为该对象又有注解,所以可以使用注解时的名字获得对象后,再获得其属性值)

@Select("SELECT * FROM tb_user WHERE id = #{param1} AND `name` = #{param2.name}")
User getUser(Integer id, @Param("user") User user);

@Select("SELECT * FROM tb_user WHERE id = #{param1} AND `name` = #{user.name}")
User getUser(Integer id, @Param("user") User user);

取值:
id → #{param1}
name → #{param2.name} 或 #{user.name}

4. 参数是 Collection(List、Set)类型或者是数组

mybatis会特殊处理,把传入的Collection或者数组封装在map中(其中的keymybatis封装好了,国定的,不会改变的)

参数类型 KEY
Collection collection
List list
Array array

Collection取出第一个 id 的值

User getUserById(Collection<Integer> ids);

取值:#{collection[0]}

List取出第一个 id 的值

User getUserById(List<Integer> ids);

取值:#{collection[0]}

Set取出第一个 id 的值

User getUserById(Set<Integer> ids);

取值:#{collection[0]}

Array取出第一个 id 的值

User getUserById(Array<Integer> ids);

取值:#{array[0]}

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容