mybatis3中@SelectProvider的使用技巧

 

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方法類中，不要使用重載，也就是說，不要使用方法名相同參數不同的方法，以避免發生詭異問題。

 

其他：

　　注解中的參數：

　　　　type參數指定的Class類，必須要能夠通過無參的構造函數來初始化；

　　　　method參數指定的方法，必須是public的，返回值必須為String，可以為static。

一、@SelectProvider

　　@ResultMap注解用於從查詢結果集RecordSet中取數據然后拼裝實體bean。

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

public class SqlProvider {

    public String selectUser(long userId){
         SELECT("id, name, email");
          FROM("USER");
          WHERE("ID = #{userId}");

    }
}

上例中定義了一個Mapper接口，其中定義了一個getUser方法，這個方法根據用戶id來獲取用戶信息，並返回相應的User。而對應的SQL語句則寫在SqlProvider類中。

二、@InsertProvider

public interface UserMapper {
    @InsertProvider(type = SqlProvider.class, method = "addUser")
    @Options(useGeneratedKeys = true, keyProperty = "id")
    int addUser(Tutor tutor);
}

public class SqlProvider {
    public String addUser(User user) {
        return new SQL() {
            {
                INSERT_INTO("USER");
                if (user.getName() != null) {
                    VALUES("NAME", "#{name}");
                }
                if (user.getEmail() != null) {
                    VALUES("EMAIL", "#{email}");
                }
            }
        }.toString();
    }
}

三、@UpdateProvider

public interface UserMapper {
    @UpdateProvider(type = SqlProvider.class, method = "updateUser")
    int updateUser(User user);
}

public class SqlProvider {
    public String updateUser(User user) {
        return new SQL() {
            {
                UPDATE("USER");
                if (user.getName() != null) {
                    SET("NAME = #{name}");
                }
                if (user.getEmail() != null) {
                    SET("EMAIL = #{email}");
                }
                WHERE("ID= #{id}");
            }
        }.toString();
    }
}

四、@DeleteProvider

public interface UserMapper {
    @DeleteProvider(type = SqlProvider.class, method = "deleteUser")
    int deleteUser(int id);
}

public class SqlProvider {
    public String deleteUser(int id) {
        return new SQL() {
            {
                DELETE_FROM("USER");
                WHERE("ID= #{id}");
            }
        }.toString();
    }
}

 

注意：在Mapper接口和@SelectProvide方法類中，不要使用重載，也就是說，不要使用方法名相同參數不同的方法。