1. 程式人生 > >mybatis中關於使用註解來完成動態SQL拼接的解決辦法

mybatis中關於使用註解來完成動態SQL拼接的解決辦法

mybatis的原身是ibatis,現在已經脫離了apache基金會,新官網是http://www.mybatis.org/。

mybatis3中增加了使用註解來配置Mapper的新特性,本篇文章主要介紹其中幾個@Provider的使用方式,他們是:@SelectProvider、@UpdateProvider、@InsertProvider和@DeleteProvider。

MyBatis 3 User Guide中的最後一章描述了註解的簡單用法,但是對於這幾個Provider的具體使用方式並沒有說的很清楚,特別是引數傳遞的方式,完全沒有提及,對於初次使用的同學來說,會造成不小的困擾。

經過一些嘗試後,我總結了一些Provider的使用經驗,下面以@SelectProvider為例,依次描述幾種典型的使用場景。

1.使用@SelectProvider

@SelectProvider是宣告在方法基本上的,這個方法定義在Mapper對應的的interface上。
1 public interface UserMapper {
2     @SelectProvider(type = SqlProvider.class, method = "selectUser")
3     @ResultMap("userMap")
4     public User getUser(long userId);
5 }
上例中是個很簡單的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。 1 public class SqlProvider {
2     public String selectUser(long userId) {
3         return "select * from user where userId=" + userId;
4     }
5 }

3.無引數@SelectProvide方法
在Mapper介面方法上和@SelectProvide指定類方法上,均無引數:
UserMapper.java:
1
     @SelectProvider(type = SqlProvider.class, method = "selectAllUser")
2     @ResultMap("userMap")
3     public List<User> getAllUser();
SqlProvider.java: 1     public String selectAllUser() {
2         return "select * from user";
3     }

4.一個引數的@SelectProvide方法
對於只有一個引數的情況,可以直接使用,參見前面的getUser和selectUser。
但是,如果在getUser方法中,對userId方法使用了@Param註解的話,那麼相應selectUser方法必須接受Map<String, Object>做為引數:
UserMapper.java:
1     @SelectProvider(type = SqlProvider.class, method = "selectUser2")
2     @ResultMap("userMap")
3     public User getUser2(@Param("userId") long userId); SqlProvider.java:
1     public String selectUser2(Map<String, Object> para) {
2         return "select * from user where userId=" + para.get("userId");
3     }

5.更多引數的@SelectProvide方法
在超過一個引數的情況下,@SelectProvide方法必須接受Map<String, Object>做為引數,
如果引數使用了@Param註解,那麼引數在Map中以@Param的值為key,如下例中的userId;
如果引數沒有使用@Param註解,那麼引數在Map中以引數的順序為key,如下例中的password:
UserMapper.java: 1     @SelectProvider(type = SqlProvider.class, method = "selectUserCheck")
2     @ResultMap("userMap")
3     public User getUserCheck(@Param("userId") long userId, String password); SqlProvider.java:
1     public String selectUserCheck(Map<String, Object> para) {
2         return "select * from user where userId=" + para.get("userId") + " and password='" + para.get("1") + "'";
3     }
6.一些限制
在Mapper介面和@SelectProvide方法類中,不要使用過載,也就是說,不要使用方法名相同引數不同的方法,以避免發生詭異問題。