mybatis3中@SelectProvider的使用技巧
mybatis3中增加了使用註解來配置Mapper的新特性,本篇文章主要介紹其中幾個@Provider的使用方式,他們是:@SelectProvider、@UpdateProvider、@InsertProvider和@DeleteProvider。
1.使用@SelectProvider
@SelectProvider是宣告在方法基本上的,這個方法定義在Mapper對應的的interface上。
public interface UserMapper {
@SelectProvider(type = SqlProvider.class, method = "selectUser")
@ResultMap("userMap")
public User getUser(long userId);
}
上例中是個很簡單的Mapper介面,其中定義了一個方法:getUser,這個方法根據提供的使用者id來查詢使用者資訊,並返回一個User實體bean。
這是一個很簡單很常用的查詢場景:根據key來查詢記錄並將結果封裝成實體bean。其中:
@SelectProvider註解用於生成查詢用的sql語句,有別於@Select註解,@SelectProvide指定一個Class及其方法,並且通過呼叫Class上的這個方法來獲得sql語句。在我們這個例子中,獲取查詢sql的方法是SqlProvider.selectUser。
@ResultMap註解用於從查詢結果集RecordSet中取資料然後拼裝實體bean。
2.定義拼裝sql的類
@SelectProvide中type引數指定的Class類,必須要能夠通過無參的建構函式來初始化。
@SelectProvide中method引數指定的方法,必須是public的,返回值必須為String,可以為static。
public class SqlProvider {
public String selectUser(long userId) {
return "select * from user where userId=" + userId;
}
}
3.無引數@SelectProvide方法##
在Mapper介面方法上和@SelectProvide指定類方法上,均無引數:
UserMapper.java:
@SelectProvider(type = SqlProvider.class, method = "selectAllUser")
@ResultMap("userMap")
public List<User> getAllUser();
SqlProvider.java:
public String selectAllUser() {
return "select * from user";
}
4.一個引數的@SelectProvide方法
對於只有一個引數的情況,可以直接使用,參見前面的getUser和selectUser。
但是,如果在getUser方法中,對userId方法使用了@Param註解的話,那麼相應selectUser方法必須接受Map<String, Object>做為引數:
UserMapper.java:
@SelectProvider(type = SqlProvider.class, method = "selectUser2")
@ResultMap("userMap")
public User getUser2(@Param("userId") long userId);
SqlProvider.java:
public String selectUser2(Map<String, Object> para) {
return "select * from user where userId=" + para.get("userId");
}
5.更多引數的@SelectProvide方法
在超過一個引數的情況下,@SelectProvide方法必須接受Map<String, Object>做為引數,
如果引數使用了@Param註解,那麼引數在Map中以@Param的值為key,如下例中的userId;
如果引數沒有使用@Param註解,那麼引數在Map中以引數的順序為key,如下例中的password:
UserMapper.java:
@SelectProvider(type = SqlProvider.class, method = "selectUserCheck")
@ResultMap("userMap")
public User getUserCheck(@Param("userId") long userId, String password);
SqlProvider.java:
public String selectUserCheck(Map<String, Object> para) {
return "select * from user where userId=" + para.get("userId") + " and password='" + para.get("1") + "'";
}
6.一些限制
在Mapper介面和@SelectProvide方法類中,不要使用過載,也就是說,不要使用方法名相同引數不同的方法,以避免發生詭異問題。
作者:crMiao
連結:https://www.jianshu.com/p/a0da82865edf
來源:簡書
著作權歸作者所有。商業轉載請聯絡作者獲得授權,非商業轉載請註明出處。
例項
@Repository public interface FqzRlMapInfoMapper { @SelectProvider(type = FqzRlMapInfoProvider.class, method = "findRelationInfos") List<RelationInfo> findRelationInfos(Collection<String> flags); class FqzRlMapInfoProvider { public String findRelationInfos(Collection<String> flags) { String inStr = String.join("','", flags); StringBuilder sb = new StringBuilder(); sb.append("select * from dm_screen_fqz_mapdata_2_b where 1=1 "); if (null == flags || flags.size() == 0) { sb.append(" and 1<>1 "); } else { sb.append(" and relate_flag in ('").append(inStr).append("')"); } return sb.toString(); } } }