浅谈Mybatis乐观锁插件
背景:对于数据库的同一条记录,假如有两个人同时对数据进行了修改,然后最终同步到数据库的时候,因为存在着并发,产生的结果是不可预料的。最简单的解决方式就是通过给表的记录加一个version字段,记录在修改的时候需要比较一下version是否匹配,如果匹配就更新,不匹配就直接失败。更新成功则把version+1,也就是所谓的乐观锁。当然这样的逻辑最好能做到对开发人员透明,本插件就是来做这件事情的。
1. 使用方式:在mybatis配置文件中加入如下配置,就完成了。
<plugins> <plugin interceptor="com.chrhc.mybatis.locker.interceptor.OptimisticLocker"/> </plugins>
2. 对插件配置的说明:
上面对插件的配置默认数据库的乐观锁列对应的Java属性为version。这里可以自定义属性命,例如:
<plugins> <plugin interceptor="com.chrhc.mybatis.locker.interceptor.OptimisticLocker"> <property name="versionColumn" value="xxx"/><!--数据库的列名--> <property name="versionField" value="xxx"/> <!--java字段名--> </plugin> </plugins>
3. 效果:
之前:update user set name = ?, password = ? where id = ?
之后:update user set name = ?, password = ?, version = version+1 where id = ? and version = ?
4. 对version的值的说明:
1、当PreparedStatement获取到version值之后,插件内部会自动自增1。
2、乐观锁的整个控制过程对用户而言是透明的,这和Hibernate的乐观锁很相似,用户不需要关心乐观锁的值。
5.插件原理描述:
插件通过拦截mybatis执行的update语句,在原有sql语句基础之上增加乐观锁标记,比如,原始sql为:
update user set name = ?, password = ? where id = ?,
那么用户不需要修改sql语句,在插件的帮助之下,会自动将上面的sql语句改写成为:
update user set name = ?, password = ?, version = version + 1 where id = ? and version = ?,
形式,用户也不用关心version前后值的问题,所有的动作对用户来说是透明的,由插件自己完成这些功能。
6.默认约定:
1、本插件拦截的update语句的Statement都是PreparedStatement,仅针对这种方式的sql有效;
2、mapper.xml的<update>标签必须要与接口Mapper的方法对应上,也就是使用mybatis推荐的方式,但是多个接口可以对应一个mapper.xml的<update>标签;
3、本插件不会对sql的结果做任何操作,sql本身应该返回什么就是什么;
4、插件默认拦截所有update语句,如果用户对某个update不希望有乐观锁控制,那么在对应的mapper接口方法上面增加@VersionLocker(false)或者@VersionLocker(value = false),这样插件就不会对这个update做任何操作,等同于没有本插件;
5、本插件目前暂时不支持批量更新的乐观锁,原因是由于批量更新在实际开发中应用场景不多,另外批量更新乐观锁开发难度比较大;
6、Mapper接口的参数类型必须和传入的实际类型保持一致,这是由于在JDK版本在JDK8以下没有任何方法能获取接口的参数列表名称,因此,插件内部是使用参数类型和参数作为映射来匹配方法签名的;
github地址:https://github.com/xjs1919/locker
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。