轉(zhuǎn)載自?mybatis3中@SelectProvider的使用技巧

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

MyBatis 3 User Guide中的最后一章描述了注解的簡(jiǎn)單用法，但是對(duì)于這幾個(gè)Provider的具體使用方式并沒有說的很清楚，特別是參數(shù)傳遞的方式，完全沒有提及，對(duì)于初次使用的同學(xué)來說，會(huì)造成不小的困擾。

經(jīng)過一些嘗試后，我總結(jié)了一些Provider的使用經(jīng)驗(yàn)，下面以@SelectProvider為例，依次描述幾種典型的使用場(chǎng)景。

1.使用@SelectProvider
@SelectProvider是聲明在方法基本上的，這個(gè)方法定義在Mapper對(duì)應(yīng)的的interface上。

public?interface?UserMapper?{@SelectProvider(type?=?SqlProvider.class,?method?=?"selectUser")@ResultMap("userMap")public?User?getUser(long?userId); }

上例中是個(gè)很簡(jiǎn)單的Mapper接口，其中定義了一個(gè)方法：getUser，這個(gè)方法根據(jù)提供的用戶id來查詢用戶信息，并返回一個(gè)User實(shí)體bean。
這是一個(gè)很簡(jiǎn)單很常用的查詢場(chǎng)景：根據(jù)key來查詢記錄并將結(jié)果封裝成實(shí)體bean。其中：
@SelectProvider注解用于生成查詢用的sql語句，有別于@Select注解，@SelectProvide指定一個(gè)Class及其方法，并且通過調(diào)用Class上的這個(gè)方法來獲得sql語句。在我們這個(gè)例子中，獲取查詢sql的方法是SqlProvider.selectUser。
@ResultMap注解用于從查詢結(jié)果集RecordSet中取數(shù)據(jù)然后拼裝實(shí)體bean。

2.定義拼裝sql的類

@SelectProvide中type參數(shù)指定的Class類，必須要能夠通過無參的構(gòu)造函數(shù)來初始化。

@SelectProvide中method參數(shù)指定的方法，必須是public的，返回值必須為String，可以為static。

public?class?SqlProvider?{public?String?selectUser(long?userId)?{return?"select?*?from?user?where?userId="?+?userId;} }

3.無參數(shù)@SelectProvide方法
在Mapper接口方法上和@SelectProvide指定類方法上，均無參數(shù)：
UserMapper.java：

@SelectProvider(type?=?SqlProvider.class,?method?=?"selectAllUser") @ResultMap("userMap") public?List<User> getAllUser();

SqlProvider.java：

public?String?selectAllUser()?{return?"select?*?from?user"; }

4.一個(gè)參數(shù)的@SelectProvide方法
對(duì)于只有一個(gè)參數(shù)的情況，可以直接使用，參見前面的getUser和selectUser。
但是，如果在getUser方法中，對(duì)userId方法使用了@Param注解的話，那么相應(yīng)selectUser方法必須接受Map<String, Object>做為參數(shù)：
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.更多參數(shù)的@SelectProvide方法
在超過一個(gè)參數(shù)的情況下，@SelectProvide方法必須接受Map<String, Object>做為參數(shù)，
如果參數(shù)使用了@Param注解，那么參數(shù)在Map中以@Param的值為key，如下例中的userId；
如果參數(shù)沒有使用@Param注解，那么參數(shù)在Map中以參數(shù)的順序?yàn)閗ey，如下例中的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方法類中，不要使用重載，也就是說，不要使用方法名相同參數(shù)不同的方法，以避免發(fā)生詭異問題。

總結(jié)

以上是生活随笔為你收集整理的mybatis3中@SelectProvider的使用技巧的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。