locker

MyBatis Optimistic Locker Plugin

License

License

GroupId

GroupId

com.github.dreamroute
ArtifactId

ArtifactId

locker
Last Version

Last Version

2.5-RELEASE
Release Date

Release Date

Type

Type

jar
Description

Description

locker
MyBatis Optimistic Locker Plugin
Project URL

Project URL

https://github.com/Dreamroute/locker
Source Code Management

Source Code Management

https://github.com/Dreamroute/locker

Download locker

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.dreamroute/locker/ -->
<dependency>
    <groupId>com.github.dreamroute</groupId>
    <artifactId>locker</artifactId>
    <version>2.5-RELEASE</version>
</dependency>
// https://jarcasting.com/artifacts/com.github.dreamroute/locker/
implementation 'com.github.dreamroute:locker:2.5-RELEASE'
// https://jarcasting.com/artifacts/com.github.dreamroute/locker/
implementation ("com.github.dreamroute:locker:2.5-RELEASE")
'com.github.dreamroute:locker:jar:2.5-RELEASE'
<dependency org="com.github.dreamroute" name="locker" rev="2.5-RELEASE">
  <artifact name="locker" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.github.dreamroute', module='locker', version='2.5-RELEASE')
)
libraryDependencies += "com.github.dreamroute" % "locker" % "2.5-RELEASE"
[com.github.dreamroute/locker "2.5-RELEASE"]

Dependencies

compile (6)

Group / Artifact Type Version
org.mybatis : mybatis jar 3.4.6
junit : junit jar 4.12
ch.qos.logback : logback-classic jar 1.2.3
com.github.dreamroute : common-util jar 1.0
com.alibaba : fastjson jar 1.2.61
com.github.dreamroute : sqlprinter jar 1.5.5-RELEASE

provided (1)

Group / Artifact Type Version
mysql : mysql-connector-java jar 5.1.23

Project Modules

There are no modules declared in this project.

MyBatis乐观锁插件2.0,全面升级,更加简便,更加强大

老版本MyBatis乐观锁插件1.x请移步至wiki文档: 1.x文档

MyBatis Optimistic Locker Plugin

mybatis

Document:

Get Start...

<dependency>
    <groupId>com.github.dreamroute</groupId>
    <artifactId>locker</artifactId>
    <version>2.x-RELEASE</version>
</dependency>

描述:本插件主要是为了解决MyBatis Generator自动生成的update标签不带乐观锁的问题,为开发带来比较简单优雅的实现方式。只要插件检测到你的sql是update类型的,并且sql中存在version = #{version}这样的内容,就会触发乐观锁改写你的sql语句

1. 使用方式:在mybatis配置文件中加入如下配置,就完成了。

1.传统Spring配置文件方式
<plugins>
	<plugin interceptor="com.github.dreamroute.locker.interceptor.OptimisticLocker"/>
</plugins>
2.Spring Boot方式
@Configuration
public class CommonBeans {
    @Bean
    public OptimisticLocker locker() {
        OptimisticLocker locker = new OptimisticLocker();
        // 不设置versionColumn,默认为version
        Properties props = new Properties();
        props.setProperty("versionColumn", "version");
        locker.setProperties(props);
        return locker;
    }
}

2. 对插件配置的说明:

上面对插件的配置默认数据库的乐观锁列对应的Java属性为version。这里可以自定义属性名,例如:

<plugins>
	<plugin interceptor="com.mook.locker.interceptor.OptimisticLocker">
		<property name="versionColumn" value="xxx"/>
	</plugin>
</plugins>

3. 效果:

之前:update user set name = ?, password = ?, version = ? where id = ?

之后:update user set name = ?, password = ?, version = ? where id = ? and version = ?


4. 对version的值的说明:

1、加入数据库的version列的值为0,PreparedStatement将两个'version'字段的值分别设置成这样:update table set version = 1 where id = 1 and version = 0 
2、乐观锁的整个控制过程对用户而言是透明的,这和Hibernate的乐观锁很相似,用户不需要关心乐观锁的值。
3、用户在使用的时候只需要将实体内设置一个Long(long)或者Integer(int)类型的乐观锁字段,并且数据库也设置一个数字类型的字段(需要有初始值或者默认值,不能为空)

5.插件原理描述:

插件通过拦截mybatis执行的update语句,在原有sql语句基础之上增加乐观锁标记,比如,原始sql为:
update user set name = ?, password = ?, version = ? where id = ?,
那么用户不需要修改sql语句,在插件的帮助之下,会自动将上面的sql语句改写成为:
update user set name = ?, password = ?, version = ? where id = ? and version = ?,
形式,用户也不用关心version前后值的问题,插件会将第二个version的值设置成为用户从数据库查询获得的值,
而第二个version会在第一个的基础之上自增1。所有的动作对用户来说是透明的,
用户丝毫不用关心version相关的问题,又插件自己完成这些功能。具体功能可以参考插件的测试类。注意事项:在决定乐观锁字段的时候,尽量选择一个项目里面永远都不会出现重复的第二个字段,如果出现冲突,那么请修改该字段不要与乐观锁字段冲突即可。

6.默认约定:

1、本插件拦截的update语句的Statement都是PreparedStatement,仅针对这种方式的sql有效;
2、mapper.xml的<update>标签必须要与接口Mapper的方法对应上,也就是使用mybatis推荐的方式,
   但是多个接口可以对应一个mapper.xml的<update>标签;
3、本插件不会对sql的结果做任何操作,sql本身应该返回什么就是什么;
4、插件拦截sql的原理(这个1.x有本质的区别,1.x文档请查看wiki):首先是拦截update类型的sql,第二是sql中存在乐观锁字段,
        比如update x set name = #{name}, version = #{version} where id = #{id},
   sql中存在version= #{version},那么插件就会启动乐观锁,改写sql,如果不存在version = #{version}那么就不会,当然version字段名称可以自定义;

7.关于插件:

如果您有什么建议或者意见,欢迎留言,也欢迎pull request,作者会将你优秀的思想加入到插件里面来,为其他人更好的解决问题。

8.Demo

1、在数据库中建立表,表名smart_user(可以按照你自己的);
2、表的字段为id(int),name(varchar),password(varchar),version(bigint);
3、数据库连接信息在mybatis-config.xml文件中修改,改成你自己的数据库信息;
4、直接运行com.mook.locker.misc.test.mapper下面的各个测试方法,观察控制台输出结果;
5、在调用每个test方法之前先将数据库的数据id设置为100,version设置成为100,其他字段随意;

9.强烈推荐:

1.mybatis-spring,和spring整合,利用spring的各种优良机制;
2.通用Mapper和PageHelper物理分页插件,地址为:http://mybatis.tk,利用插件的单表CRUD动态创建能力;
3.集齐这4个mybatis插件,可以达到与Hibernate,JPA媲美的开发效率,但是性能又优于Hibernate;

10.关于作者:

QQ讨论群:170660681
作者QQ:342252328
作者邮箱:[email protected]

Versions

Version
2.5-RELEASE
2.4-RELEASE
2.3-RELEASE
2.2-RELEASE
2.1-RELEASE
2.0-RELEASE
1.3-RELEASE
1.2-RELEASE
1.1-RELEASE
1.0-RELEASE