更新日志
<!-- 2016-11-13更新 start -->1 新增批量操作数据方法:批量插入,根据条件删除,根据条件更新指定的列名-字段值。
2 新增高级查询方法:可设置查询列,查询条件,排序,分页。
3 根据1、2更新接口。
4 更改dao接口方法实现方式,统一采用GeneralMapper.xml编写sql,弃用GeneralDaoProvider。
<!-- 2016-11-13更新 end -->一 关于Mybatis
1.1 mybatis 的优点
1 轻量级ORM 。
2 提供了完善的缓存机制。
3 mapper.xml 原声SQL更清晰灵活,且sql便于SQL调优。
4 resultType resultMap 处理返回结果集,与pojo解耦。
1.2 mybatis的使用体验
这里只将Mybatis不便于使用之处做以说明。
1 需要为每张表写一个dao接口和mapper.xml,这对于开发者来讲就不是很友好了,假设系统有30张业务表,呵呵。
2 虽然有generator 工具,可以自动生成dao 接口和mapper.xml,是可以不用自己去写这些代码了,但是还是有2个缺点:
(1) generator只是提供了基础的增删改查功能,复杂的sql还是要自己去添加。
(2) 还是上面的问题,每张表都要有dao接口和mapper.xml。
1.3 关于物理分页
对于分页的功能,仁者见仁,智者见智吧,就我个人的观点来讲,我觉得没必要。
上面也描述了mybatis的优点之一就是mapper.xml中的原声SQL,特别是对于复杂的SQL语句,原声SQL很有魅力。
如果你分页的sql封装成如下的格式,
1<!-- mysql page封装 --> 2select count(1) as 'totalNum',t.* from (select user_id , user_name from user ) t limit startRowNo,rowNum 3 4<!-- mysql 原生分页 --> 5select count(1) as 'totalNum', user_id , user_name from user limit startRowNo,rowNum
我觉得,还是算了吧,不如原声SQL来的实在。select * 我就不讲了,select * from (sql) 根本就没必要嘛。
如果说你希望实现一个灵活的查询方法,有分页参数就按分页查询,没有分页参数就查询全部。那么我的观点是,mybatis 提供了<if></if>标签,代码如下:
1 <!-- mapper.xml --> 2 <select id="selectByPage" parameterType="map" resultType="hashmap"> 3 4 select count(1) as 'totalNum',user_id,user_name 5 from user 6 7 <if test="pageParam != null" > 8 limit #{pageParam.startRowNo},#{pageParam.pageSize} 9 </if> 10 11 </select>
如果说你希望分页方法能够更灵活,希望实现一个方法对任何一张表都可以分页,代码可以这样写
1 <select id="selectByPage" parameterType="map" resultType="hashmap"> 2 3 select ${queryColumn} 4 from ${tableName} 5 6 <if test="page != null" > 7 limit #{page.startRowNo},#{page.pageSize} 8 </if> 9 10 </select>
关于分页,就这么多,仅个人观点,欢迎批评、建议或讨论。
二 Mybatis通用Crud设计
2.1 需求
基于1.2,希望提供类似于hibernate中的load、insert、delete、save方法,对于基础的数据访问层操作,系统只需要存在一处,便于统一的管理,减少不必要的代码。
基于1.1,避免使用java封装字符串sql,mapper.xml,@select,@selectProvider三选一。
2.2 设计
2.2.1 通用crud接口
希望实现的功能方法接口,因篇幅有限,这里就只给出主键查询的接口。
全部接口声明可以查看对应代码,或者,
查看上一篇博文Mybatis 通用Crud-接口预览,https://my.oschina.net/LittleNewbie/blog/785947
1/** 2 * 通用Crud 数据访问层接口 3 * 4 * @author svili 5 * @date 2016年11月11日 6 * 7 */ 8public interface CrudServiceInter { 9 10 /** 11 * 根据主键查询 12 * @param <T> pojo类 13 * @param clazz pojo类-class对象 14 * @param primaryValue 主键值 15 * @return pojo对象 16 */ 17 <T> T selectByPrimaryKey(Class<T> clazz, Object primaryValue) throws Exception; 18}
2.2.2 根据主键查询
1 首先,明确接口
<T> T selectByPrimaryKey(Class<T> clazz, Object primaryValue) throws Exception;
<2017-02-18更新>
主键类型不做限制。
2 分析下mapper.xml中的sql
1<select id="selectByPrimaryKey" parameterType="map" resultType="hashmap"> 2 select 3 <foreach item="columnName" index="index" collection="queryColumn" separator="," > 4 ${columnName} 5 </foreach> 6 from ${tableName} 7 where ${primaryKey} = #{primaryValue} 8</select>
注意:不要使用<![CDATA[ ]]>去尝试对这段sql进行转义,会导致<foreach></foreach>标签不被解析处理。
关于xml中的<![CDATA[ ]]> ,自行百度get噢。
3 明确sql中的参数
sql中需要传递的参数有4个,分别是:tableName(表名),queryColumn(查询字段集),primaryKey(主键列名),primaryValue(主键值)。
4 接口参数与sql参数转化
(1)tableName
从Java类到数据库的表名,我们可以获取两个信息,一个是类名,第二个是JPA的@Table注解。
要注意两点,1.注解优先,2.Java的命名规则为驼峰,数据库的命名规则为下划线。如果你不按套路出牌,还是要好好想想如何去对应转换。
1//获取pojo表名 2public static String getTableName(Class<?> clazz) { 3 // 驼峰转下划线 4 String tableName = StringUtil.camelToUnderline(clazz.getName()); 5 // 判断是否有Table注解 6 if (clazz.isAnnotationPresent(Table.class)) { 7 // 获取注解对象 8 Table table = clazz.getAnnotation(Table.class); 9 // 设置了name属性 10 if (!table.name().trim().equals("")) { 11 return table.name(); 12 } 13 } 14 return tableName; 15}
(2)queryColumn
直接获取字段名就好,注意驼峰转下划线。
1//获取所有字段名 2public static List<String> getAllColumns(Class<?> clazz) { 3 List<String> columns = new ArrayList<String>(); 4 Field[] fields = clazz.getDeclaredFields(); 5 for (Field field : fields) { 6 columns.add(StringUtil.camelToUnderline(field.getName())); 7 } 8 return columns; 9}
(3)primaryKey
这只能靠JPA的@Id了。
当然你可自己定制一套标准,比如每张表都固定一个主键字段名为table_id。但是我觉得完全没必要,既然有JPA的标准,为什么要去自己费脑经呢。如果说你使用oracle的guid,没脾气,呵呵。
1//获取主键字段 2public static Field getPrimaryFieldNotCareNull(Class<?> clazz) { 3 Field field = FieldReflectUtil.findField(clazz, Id.class); 4 if (field != null) { 5 return field; 6 } else { 7 return null; 8 } 9} 10//获取指定注解类型的字段 11public static Field findField(Class<?> clazz, Class<? extends Annotation> annotationType) { 12 Class<?> searchType = clazz; 13 while (!Object.class.equals(searchType) && searchType != null) { 14 Field[] fields = searchType.getDeclaredFields(); 15 for (Field field : fields) { 16 if (field.isAnnotationPresent(annotationType)) { 17 return field; 18 } 19 } 20 searchType = searchType.getSuperclass(); 21 } 22 return null; 23}
2.2.3 其他接口
关于其他接口,其实大同小异,这里就不做说明了,只需要按照2.2.2 中的思路去查看源码就OK了。
三 源码
源码地址:https://github.com/LittleNewbie/portal
如何阅读源码:
主要4个文件 GeneralDao,GeneralMapper.xml,GeneralDaoProvider,CrudServiceImpl
GeneralDao声明了数据访问层接口;
GeneralMapper.xml 和GeneralDaoProvider(已弃用2016-11-13)配合GeneralDao。
GeneralDaoProvider已弃用 from 2016-11-13。
CrudServiceImpl 实现由接口参数转化为GeneralDao参数,并封装返回类型。
GeneralQueryParam 查询参数封装,start from 2016-11-13。