mybatis的原身是ibatis,现在已经脱离了apache基金会,新官网是http://www.mybatis.org/。
mybatis3中增加了使用注解来配置Mapper的新特性,本篇文章主要介绍其中几个@Provider的使用方式,他们是:@SelectProvider、@UpdateProvider、@InsertProvider和@DeleteProvider。(无参数直接用@Select等注解即可)
这几个注解声明在Mapper对应的interface的方法上的,注解用于生成查询(CRUD)用的sql语句。如果对应的Mapper中已使用@Param来注解参数,则在对应的Prodiver的方法中无需写参数。
注解中的参数:
type参数指定的Class类,必须要能够通过无参的构造函数来初始化;
method参数指定的方法,必须是public的,返回值必须为String,可以为static。
下面依次描述几种典型的使用场景,具体了解一下参数传递的方式:
@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}");
}
}
// 或者
public class SqlProvider {
public String selectUser(long userId) {
return "select * from user where userId=" + userId;
}
}
上例中定义了一个Mapper接口,其中定义了一个getUser方法,这个方法根据用户id来获取用户信息,并返回相应的User。而对应的SQL语句则写在SqlProvider类中。
对于只有一个参数的情况,可以直接使用,参见前面的getUser和selectUser。
但是,如果在getUser方法中,对userId方法使用了@Param注解的话,那么相应selectUser方法必须接受Map
@SelectProvider(type = SqlProvider.class, method = "selectUser2")
@ResultMap("userMap")
public User getUser2(@Param("userId") long userId);
public String selectUser2(Map para) {
return "select * from user where userId=" + para.get("userId");
}
在超过一个参数的情况下,@SelectProvide方法必须接受Map
如果参数使用了@Param注解,那么参数在Map中以@Param的值为key,如下例中的userId;
如果参数没有使用@Param注解,那么参数在Map中以参数的顺序为key,如下例中的password:
@SelectProvider(type = SqlProvider.class, method = "selectUserCheck")
@ResultMap("userMap")
public User getUserCheck(@Param("userId") long userId, String password);
public String selectUserCheck(Map para) {
return "select * from user where userId=" + para.get("userId") + " and password='" + para.get("1") + "'";
}
注意:在Mapper接口和@SelectProvider方法类中,不要使用重载,也就是说,不要使用方法名相同参数不同的方法,以避免发生诡异问题。
其他三种类型用法和注意事项基本相同,唯一不方便的是现在用idea开发,接口层方法没有能够直接跳到SqlProvider对应方法的快捷操作,希望知道的大佬不吝赐教。