mybatis使用注解替代xml配置，動態生成Sql

mybatis使用注解替代xml配置時，遇到判斷條件是否為null或者為空時，@Select很難搞定，不知道怎么辦？

mybatis3中增加了使用注解來配置Mapper的新特性，使用 SelectProvider來動態生成sql。

典型的使用場景

1. 無參數@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     }

 

2.單個參數使用@SelectProvider

2.1.沒有@Param注解的單個參數使用@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。

 

@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 }

2.2.帶有@Param注解一個參數的@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     }

3.多參數的@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     }

4.一些限制
在Mapper接口和@SelectProvide方法類中，不要使用重載，也就是說，不要使用方法名相同參數不同的方法，以避免發生詭異問題。

 

參考文獻：

【1】http://www.blogjava.net/dbstar/archive/2011/08/08/355825.html