本文转载自CSDN博主「象在舞」的博文BeetlSql中的Mapper
BeetlSql中的Mapper
本文参考BeetlSql官方网站，官网网站请点击这里~
一、使用Mapper
BeetlSql支持Mapper，它可以将sql文件映射到一个interface接口。接口的方法名与sql文件的sqlid一一对应。接口必须实现BaseMapper接口（后面可以自定义一个Base接口），它提供内置的CRUD方法，如insert，unique，template，templateOne，updateById等。BaseMapper 具备数据库常见的操作，接口只需要定义额外的方法与sqlid同名即可。例如：
1public interface UserDao extends BaseMapper<User> { 2 3 4 5 List<User> select(String name); 6}
上例中的select方法将会对应下面的md文件：
1select 2=== 3select * from user where name = #name#
如果使用的是JDK8，不必为参数提供名称，自动对应。但必须保证java编译的时候开启-parameters选项。如果使用JDK8以下的版本，则可以使用@Param注解()：
List<User> select(@Param("name") String name);
BeetlSql的mapper方法总会根据调用方法名字，返回值，以及参数映射到SQLManager相应的查询接口，比如返回类型是List，意味着发起SQLManager.select 查询，如果返回是一个Map或者Pojo，则发起一次selectSingle查询，如果返回定义为List，则表示查询实体，如果定义为List ，则对应的查询结果映射为Long。定义好接口后，可以通过SQLManager.getMapper来获取一个Dao的真正实现。
UserDao dao = sqlManager.getMapper(UserDao.class);
Mapper 对应的sql文件默认根据实体来确定，如实体是UserInfo对象，则对应的sql文件是userInfo.md(sql),可以通过@SqlResource 注解来指定Mapper对应的sql文件。例如：
1@SqlResource("core.user") 2public interface UserCoreDao extends BaseMapper<User> { 3 4 5 6 List<User> select(String name); 7} 8@SqlResource("console.user") 9public interface UserConsoleDao extends BaseMapper<User> { 10 11 12 13 List<User> select(String name); 14}
这样，这俩个mapper分别访问sql/core/user.md 和 sql/console/user.md
二、内置的CRUD
BaseMapper包含了内置的常用查询，如下：
1public interface BaseMapper<T> { 2 3 4 5/** 6 * 通用插入，插入一个实体对象到数据库，所有字段将参与操作，除非使用ColumnIgnore注解 7 * @param entity 8 */ 9void insert(T entity); 10/** 11 * （数据库表有自增主键调用此方法）如果实体对应的有自增主键，插入一个实体到数据库，设置assignKey为true的时候，将会获取此主键 12 * @param entity 13 * @param autDbAssignKey 是否获取自增主键 14 */ 15void insert(T entity, boolean autDbAssignKey); 16/** 17 * 插入实体到数据库，对于null值不做处理 18 * @param entity 19 */ 20void insertTemplate(T entity); 21/** 22 * 如果实体对应的有自增主键，插入实体到数据库，对于null值不做处理,设置assignKey为true的时候，将会获取此主键 23 * @param entity 24 * @param autDbAssignKey 25 */ 26void insertTemplate(T entity,boolean autDbAssignKey); 27/** 28 * 批量插入实体。此方法不会获取自增主键的值，如果需要，建议不适用批量插入，适用 29 * <pre> 30 * insert(T entity,true); 31 * </pre> 32 * @param list 33 */ 34void insertBatch(List<T> list); 35/** 36 * （数据库表有自增主键调用此方法）如果实体对应的有自增主键，插入实体到数据库，自增主键值放到keyHolder里处理 37 * @param entity 38 * @return 39 */ 40KeyHolder insertReturnKey(T entity); 41 42/** 43 * 根据主键更新对象，所以属性都参与更新。也可以使用主键ColumnIgnore来控制更新的时候忽略此字段 44 * @param entity 45 * @return 46 */ 47int updateById(T entity); 48/** 49 * 根据主键更新对象，只有不为null的属性参与更新 50 * @param entity 51 * @return 52 */ 53int updateTemplateById(T entity); 54 55/** 56 * 根据主键删除对象，如果对象是复合主键，传入对象本生即可 57 * @param key 58 * @return 59 */ 60int deleteById(Object key); 61 62/** 63 * 根据主键获取对象，如果对象不存在，则会抛出一个Runtime异常 64 * @param key 65 * @return 66 */ 67T unique(Object key); 68/** 69 * 根据主键获取对象，如果对象不存在，返回null 70 * @param key 71 * @return 72 */ 73T single(Object key); 74 /** 75 * 根据主键获取对象，如果在事物中执行会添加数据库行级锁(select * from table where id = ? for update)，如果对象不存在，返回null 76 * @param key 77 * @return 78 */ 79T lock(Object key); 80 81/** 82 * 返回实体对应的所有数据库记录 83 * @return 84 */ 85List<T> all(); 86/** 87 * 返回实体对应的一个范围的记录 88 * @param start 89 * @param size 90 * @return 91 */ 92List<T> all(int start,int size); 93/** 94 * 返回实体在数据库里的总数 95 * @return 96 */ 97long allCount(); 98 99/** 100 * 模板查询，返回符合模板得所有结果。beetlsql将取出非null值（日期类型排除在外），从数据库找出完全匹配的结果集 101 * @param entity 102 * @return 103 */ 104List<T> template(T entity); 105 /** 106 * 模板查询，返回一条结果,如果没有，返回null 107 * @param entity 108 * @return 109 */ 110<T> T templateOne(T entity); 111 112List<T> template(T entity,int start,int size); 113/** 114 * 符合模板得个数 115 * @param entity 116 * @return 117 */ 118long templateCount(T entity); 119 120/** 121 * 单表的基于模板查询的翻页 122 * @param query 123 * @return 124 */ 125void templatePage(PageQuery<T> query); 126 127/** 128 * 执行一个jdbc sql模板查询 129 * @param sql 130 * @param args 131 * @return 132 */ 133List<T> execute(String sql,Object... args); 134/** 135 * 执行一个更新的jdbc sql 136 * @param sql 137 * @param args 138 * @return 139 */ 140int executeUpdate(String sql,Object... args ); 141SQLManager getSQLManager(); 142/** 143 * 返回一个Query对象 144 * @return 145 */ 146Query<T> createQuery(); 147 148 /** 149 * 返回一个LambdaQuery对象 150 * @return 151 */ 152LambdaQuery<T> createLambdaQuery();
}
三、sqlid查询
对于sqlId 是查询语句，返回值可以是任何类型，Mapper将视图将查询结果映射到定义的类型上，如下是一些常见例子：
1public interface UserDao extends BaseMapper<User> { 2 3 4 5 // 使用"user.getCount"语句,无参数 6 public int getCount(); 7 //使用"user.findById"语句，参数是id，返回User对象 8 public User findById(@Param("id") Integer id); 9 //使用"user.findById"语句，参数是id，返回User对象 10 public List<User> findByName(@Param("name") String name); 11 //使用user.findTop10OfIds语句, 查询结果映射为Long，比如“select id from user limit 10 12 public List<Long> findTop10OfIds(); 13 //返回一个Map，不建议这么做，最好返回一个实体，或者实体+Map的混合模型(参考BeetlSql模型) 14 public List<Map<String,Object> findUsers(@Param("name") String name,@Param("departmentId") departmentId) 15}
Mapper 查询有一个例外，如果第一个参数是一个JavaBean(即非java内置对象)，则默认为是_root对象，因此如下俩个接口定义是等价的：
1public List query(User template); 2public List query2(@Param("_root") User template)
如果需要查询指定范围内的结果集，可以使用@RowStart，@RowSize，将指示Mapper发起一次范围查询：
pulic List<User> selectRange(User data,Date maxTime,@RowStart int start,@RowSize int size)
如上查询语句，类似这样调用了SQLManager：
1Map paras = new HashMap(); 2paras.put("_root",data); 3paras.put("maxTime",maxTime); 4List<User> list = sqlManager.select("user.selectRanage",User.class,paras,start,size);
四、PageQuery查询
PageQuery查询需要提供PageQuery参数以让Mapper理解为PageQuery查询，如下俩个是等价的：
1public void queryByCondtion(PageQuery query); 2public PageQuery queryByCondtion(PageQuery query)
;
可以添加额外参数，但PageQuery 必须是第一个参数，如：
public void queryByCondtion(PageQuery query,Date maxTime);
这类似如下SQLManager调用：
1query.setPara("maxTime",maxTime); 2sqlManager.pageQuery("user.queryByCondtion",User.class,query)
也可以在方法中提供翻页参数来实现翻页查询，这时候返回值必须是PageQuery，如下：
public PageQuery queryByCondtion(int pageNumber,int pageSize,String name);
五、更新语句
更新语句返回的结果可以是void，或者int，如果是批量更新，则可以返回int[]：
1public int updaetUser(int id,String name); 2public int updateUser(User user); 3public int[] updateAll(List<User> list);
BeetlSql通常根据返回值是int或者int[] 来判断是否是更新还是批量更新，如果没有返回值，会进一步判断第一个参数是否是集合或者数组，比如：
1public void updateAllByUser(List<User> list); 2public void updateAllByIds(List<Integer> list);
六、插入语句
插入语句同更新语句，唯一不同的是插入语句有时候需要获取自增序列值，这时候使用KeyHolder作为返回参数：
public KeyHolder insertSql(User user);
使用JDBC SQL 可以通过@Sql注解直接在java中使用较为简单的sql语句，如下：
1@Sql(value=" update user set age = ? where id = ? ") 2public void updateAge(int age,int id); 3@Sql(value="select id from user where create_time<?") 4public List<Long> selectIds(Date date)
此时方法参数与"?" 一一对应 也可以使用@Sql翻页，这要求方法参数前俩个必须是int或者long,返回结果使用PageQuery定义：
1@Sql(value="select * from user where create_time<?") 2public PageQuery selectUser(int pageNumber,int pageSize,Date date)
七、Mapper中的注解
上面已经了解了@Param注解，用于申明参数名字，如果使用jdk8，且打开了编译选项parameters，则可以去掉@Param注解。@RowStart和 @RowSize，用于查询中的范围查询。 @Sql 注解则用于在java中构造一个简短的jdbc sql语句。@SqlStatment注解可以对接口参数进一步说明，他有如下属性：
1、type，用于说明sqlid是何种类型的语句，默认为auto，BeetlSql将会根据sqlId对应的Sql语句判断是否是查询，还是修改语句等，通常是根据sql语句的第一个词来判断，如果是select，表示查询，如果是insert，表示新增，如果update，drop，则是更新。如果Sql模板语句第一个词不包含这些，则需要用type做说明。如下是一个需要用到type的情况：
1selectUsers 2=== 3#use("otherSelect")# and status=1;
因为beetlsql无法根据第一个单词确定操作类型，因此必须使用type=SqlStatementType.SELECT，来说明。
2、params ,可以不用在接口参数上使用@Param，而直接使用params属性，如下是等价的：
1@SqlStatement(params="name,age,_st,_sz") 2public List<User> queryUser( String name, Integer age,int start, int size); 3 4public List<User> queryUser( @Param(name) String name, @Param(age) @RowStart Integer age,int start, @RowSize int size);
_st,_sz 同@RowStart和@RowSize。
八、使用接口默认方法
如果使用JDK8，则可以在mapper中添加默认方法，有利于重用：
1public interface SysResourceDao extends BaseMapper<SysResource> { 2 3 4 5 6 void page(PageQuery<SysResource> query); 7 8 default List<SysResource> listChildren(Integer resourceId) { 9 10 11 12 return createLambdaQuery() 13 .andNotEq(SysResource::getStatus, 1) 14 .andEq(SysResource::getPid, resourceId) 15 .select(); 16 } 17}
参考资料
本文同步分享在 博客“雪域迷影”（CSDN）。
如有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一起分享。