关于mybatis3中@SelectProvider的使用问题

mybatis3中增加了使用注解来配置Mapper的新特性，本篇文章主要介绍其中几个@Provider的使用方式，他们是：@SelectProvider、@UpdateProvider、@InsertProvider和@DeleteProvider。

1.使用@SelectProvider

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

 public interface UserMapper {
    @SelectProvider(type = SqlProvider.class, method = "selectUser")
    @ResultMap("userMap")
    public User getUser(long 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<User> getAllUser();

SqlProvider.java：

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

4.一个参数的@SelectProvide方法

对于只有一个参数的情况，可以直接使用，参见前面的getUser和selectUser。
但是，如果在getUser方法中，对userId方法使用了@Param注解的话，那么相应selectUser方法必须接受Map<String, Object>做为参数：

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.更多参数的@SelectProvide方法

在超过一个参数的情况下，@SelectProvide方法必须接受Map<String, Object>做为参数，
如果参数使用了@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<String, Object> para) {
    return "select * from user where userId=" + para.get("userId") + " and password='" + para.get("1") + "'";
  }

6.一些限制

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

实例

@Repository
public interface FqzRlMapInfoMapper {

    @SelectProvider(type = FqzRlMapInfoProvider.class, method = "findRelationInfos")
    List<RelationInfo> findRelationInfos(Collection<String> flags);

    class FqzRlMapInfoProvider {
        public String findRelationInfos(Collection<String> flags) {
            String inStr = String.join("','", flags);
            StringBuilder sb = new StringBuilder();
            sb.append("select * from dm_screen_fqz_mapdata_2_b where 1=1 ");
            if (null == flags || flags.size() == 0) {
                sb.append(" and 1<>1 ");
            } else {
                sb.append(" and relate_flag in ('").append(inStr).append("')");
            }
            return sb.toString();
        }
    }
}

到此这篇关于mybatis3中@SelectProvider的使用技巧的文章就介绍到这了,更多相关mybatis3中@SelectProvider使用内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！