MyBatis中傳遞多個參數的方法以及傳入混合參數的獲取方式

概述

Mybatis在使用Mapper接口進行編程時，其實底層是採用了動態代理機制，表面上是調用的Mapper接口，而實際上是通過動態代理調用的SqlSession的對應方法，其最終會獲得一個代理了Mapper接口的MapperProxy對象。MapperProxy對象在調用Mapper接口方法時會把傳遞的參數做一個轉換，然後把轉換後的參數作爲入參調用SqlSession對應的操作方法（如：selectOne、insert等）。

使用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中（其中的key是mybatis封裝好了，國定的，不會改變的）

參數類型	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]}