Mybatis中@Param註解的作用說明

2022-03-10 13:01:28

@Param註解的作用說明

1.關於@Param

@Param是MyBatis所提供的(org.apache.ibatis.annotations.Param)，作為Dao層的註解，作用是用於傳遞引數，從而可以與SQL中的的欄位名相對應，一般在2=<引數數<=5時使用最佳。

2.原始的方法

當只有一個引數時，沒什麼好說的，傳進去一個值也只有一個引數可以匹配。當存在多個引數時，傳進去的值就區分不開了，這時可以考慮用Map，例如介面

public List<Role> findRoleByMap(Map<String, Object> parameter);

<select id="findRoleByMap" parameterType="map" resultType="role">
    SELECT id,name FROM t_role
    WHERE roleName=#{roleName}
    AND note=#{note}
<select>

測試程式碼：

RoleMapper roleMapper = sqlSession.getMapper(RoleMapper.class);
Map<String, Object> parameter = new HashMap<>();
parameter.put("roleName", "劍士");
parameter.put("note", "決戰紫禁之巔");
List<Role> roles = roleMapper.findRolesByMap(parameter);

3.使用@Param

很明顯上面的缺點就在於可讀性差，每次必須閱讀他的鍵，才能明白其中的作用，並且不能限定其傳遞的資料型別，下面是使用@Param的情況，需要將介面改為

public List<Role> findRoleByAnnotation(@Param("roleName") String roleName, @Param("note") String note);

這樣我們就可以直接傳入對應的值了。

當然也可以使用Java Bean來傳遞多個引數，定義一個POJO

public class RoleParam {
    private String roleName;
    private String note;
    /*getter和setter*/
}

此時介面就變為

public List<Role> findRoleByBean(RoleParam role);

這樣對應的xml檔案與1處的區別就在於id和parameterType發生了變化，id對應的方法和parameterType對應該類的許可權定名。

而使用更多的場景可能是這樣的，對應多個POJO

public List<Role> findRoleByMix(@Param("roleP") RoleParam role, @Param("permissionP") PermissionParam permission);

這樣就可以進行如下對映：

<select id="findRoleByMix" resultType="role">
    SELECT id,name FROM t_role
    WHERE roleName=#{roleP.roleName}
    AND note=#{rolep.note}
    AND level=#{permissionP.level}
<select>

注意此時並不需要寫出parameterType屬性，Mybatis會進行自動搜尋。

小結一下：最後也許會有小火辦會問，那@Param和@RequestParam是什麼關係呢？其實它們沒有關係，就跟Java和JavaScript，雷鋒和雷鋒塔一樣，擁有相似的外表，其實作用是不一樣的，@Param是地處Dao層，是為了傳遞多個引數，解決的是可讀性和直觀性；而@RequestParam是位列Controller層，作用是為獲取前端引數，解決的是前後端引數不一致的問題。所以它們沒有關係！

@Param註解和引數使用

1.使用@Param註解

當以下面的方式進行寫SQL語句時：

@Select("select column from table where userid = #{userid} ")
public int selectColumn(int userid);

當你使用了使用@Param註解來宣告引數時，如果使用 #{} 或 ${} 的方式都可以。

@Select("select column from table where userid = ${userid} ")
public int selectColumn(@Param("userid") int userid);

當你不使用@Param註解來宣告引數時，必須使用使用 #{}方式。如果使用 ${} 的方式，會報錯。

@Select("select column from table where userid = ${userid} ")
public int selectColumn(@Param("userid") int userid);

2.不使用@Param註解

不使用@Param註解時，引數只能有一個，並且是Javabean。在SQL語句裡可以參照JavaBean的屬性，而且只能參照JavaBean的屬性。

// 這裡id是user的屬性
@Select("SELECT * from Table where id = ${id}")
Enchashment selectUserById(User user);

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。