mybatis3中SQLProvider的使用技巧

1.使用@SelectProvider

@SelectProvider是声明在方法基本上的，这个方法定义在Mapper对应的的interface上。

 public interface UserMapper {

    @SelectProvider(type = SqlProvider.class, method = "selectUser")

     @ResultMap("userMap")

     public User getUser(String 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 getAllUser();

SqlProvider.java：

     public String selectAllUser() {

        return "select * from user";

    }

4.一个参数的@SelectProvide方法

对于只有一个参数的情况，可以直接使用，参见前面的getUser和selectUser。

但是，如果在getUser方法中，对userId方法使用了@Param注解的话，那么相应selectUser方法必须接受Map做为参数：

UserMapper.java：

     @SelectProvider(type = SqlProvider.class, method = "selectUser2")

     @ResultMap("userMap")

     public User getUser2(@Param("userId") String userId);

SqlProvider.java：

     public String selectUser2(Map para) {

         return "select * from user where userId=" + para.get("userId");

     }

5.更多参数的@SelectProvide方法

在超过一个参数的情况下，@SelectProvide方法必须接受Map做为参数，

如果参数使用了@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 para) {

         return "select * from user where userId=" + para.get("userId") + " and password='" + para.get("1") + "'";

     }

6.一些限制

在Mapper接口和@SelectProvide方法类中，不要使用重载，也就是说，不要使用方法名相同参数不同的方法，以避免发生诡异问题。

7.@InsertProvider批量插入

@InsertProvider(type = NoticeProvider.class, method = "insert")

int insert(List notices);

public String insert(List notices){

             StringBuffer sb = new StringBuffer();

              sb.append("insert into notice( operator, optionContent, receiverId, optionDate, status, type) ");

              sb.append("VALUES ");

              MessageFormat mf = new MessageFormat(

                      " ( '{'list[{0}].operator}, '{'list[{0}].operator}， '{'list[{0}].optionContent}，'{'list[{0}].receiverId}, now(),“

                                  +”'{'list[{0}].status}， '{'list[{0}].type}) ");

               for(int i = 0; i < notices.size(); i++){

                         sb.append(

                                   mf.format(new Object[]{i})

                         );

                          if(i < notices.size()-1){

                                 sb.append(",");

                          }

               }

         return sb.toString();

}

SQLProvider传递的参数只能有一个

@InsertProvider(method = "insertlist",type=SqlProvider.class)

 public int insertInnerTable(List list,String dbTable);        

思，跟到mybatis了报错的方法中，发现了如下的代码

try {     

          this.sqlSourceParser = new SqlSourceBuilder(config);  

          this.providerType = (Class) provider.getClass().getMethod("type").invoke(provider); 

           providerMethodName = (String) provider.getClass().getMethod("method").invoke(provider);

           for (Method m : this.providerType.getMethods()) {

                   if (providerMethodName.equals(m.getName())) {

                              //限定参数个数的地方

                              if (m.getParameterTypes().length < 2  && m.getReturnType() == String.class) {  

                                      this.providerMethod = m; 

                                     this.providerTakesParameterObject = m.getParameterTypes().length == 1;         

                               }

                        }

             }

    } catch (Exception e) {

           throw new BuilderException("Error creating SqlSource for SqlProvider.  Cause: " + e, e);   

  }        

注意加粗的位置，终于发现导致错误的罪魁祸首了，原来是这里限制了参数的个数，不能操作两个参数的啊。

于是将方法以及注解改为如下形式

@InsertProvider(method = "insert",type=SqlProvider.class)

public int insert(Map map);

在SqlProvider中对应的方法为

public String insert(Map map){       ........ }

还有一点请注意当以List/Collection为参数时会有这样的原因错误

Parameter ‘XXX’ not found.，Available parameters are [collection, list]

原因是：传递一个 List 实例或者数组作为参数对象传给 MyBatis,MyBatis 会自动将它包装在一个 Map 中,用名称在作为键。

List 实例将会以“list” 作为键,而数组实例将会以“array”作为键