乐观锁插件测试用例：支持自定义nextVersion

src/test/java/com/itfsw/mybatis/generator/plugins/OptimisticLockerPluginTest.java

@@ -154,6 +154,7 @@ public class OptimisticLockerPluginTest {
      */
     @Test
     public void testUpdateWithVersionByExampleSelective() throws Exception {
+        // 测试默认自增版本号
         MyBatisGeneratorTool tool = MyBatisGeneratorTool.create("scripts/OptimisticLockerPlugin/mybatis-generator.xml");
         tool.generate(() -> DBHelper.createDB("scripts/OptimisticLockerPlugin/init.sql"), new AbstractShellCallback() {
             @Override
@@ -188,6 +189,42 @@ public class OptimisticLockerPluginTest {
                 Assert.assertEquals(rs.getInt("inc_f1"), 1);
             }
         });
+
+        // 测试自定义版本号
+        tool = MyBatisGeneratorTool.create("scripts/OptimisticLockerPlugin/mybatis-generator-customizedNextVersion.xml");
+        tool.generate(() -> DBHelper.createDB("scripts/OptimisticLockerPlugin/init.sql"), new AbstractShellCallback() {
+            @Override
+            public void reloadProject(SqlSession sqlSession, ClassLoader loader, String packagz) throws Exception {
+                ObjectUtil tbMapper = new ObjectUtil(sqlSession.getMapper(loader.loadClass(packagz + ".TbMapper")));
+
+                ObjectUtil tbExample = new ObjectUtil(loader, packagz + ".TbExample");
+                ObjectUtil criteria = new ObjectUtil(tbExample.invoke("createCriteria"));
+                criteria.invoke("andIdEqualTo", 1l);
+
+                ObjectUtil tb = new ObjectUtil(loader, packagz + ".Tb");
+                tb.set("id", 1L);
+                tb.invoke("setIncF1", 152L);  // 没有借用nextVersion方法
+                tb.set("incF2", 10L);
+                tb.set("incF3", 5L);
+
+                // sql
+                String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "updateWithVersionByExampleSelective", 100L, tb.getObject(), tbExample.getObject());
+                Assert.assertEquals(sql, "update tb SET inc_f1 = 152, id = 1, inc_f2 = 10, inc_f3 = 5 WHERE inc_f1 = 100 and ( ( id = '1' ) )");
+
+                // 执行一次，因为版本号100不存在所以应该返回0
+                Object result = tbMapper.invoke("updateWithVersionByExampleSelective", 100L, tb.getObject(), tbExample.getObject());
+                Assert.assertEquals(result, 0);
+
+                // id = 1 的版本号应该是0
+                result = tbMapper.invoke("updateWithVersionByExampleSelective", 0L, tb.getObject(), tbExample.getObject());
+                Assert.assertEquals(result, 1);
+
+                // 执行完成后版本号应该加1
+                ResultSet rs = DBHelper.execute(sqlSession.getConnection(), "select * from tb where id = 1");
+                rs.first();
+                Assert.assertEquals(rs.getInt("inc_f1"), 152);
+            }
+        });
     }
 
     /**
@@ -259,6 +296,42 @@ public class OptimisticLockerPluginTest {
                 Assert.assertEquals(result, 0);
             }
         });
+
+        // 测试自定义版本号
+        tool = MyBatisGeneratorTool.create("scripts/OptimisticLockerPlugin/mybatis-generator-customizedNextVersion.xml");
+        tool.generate(() -> DBHelper.createDB("scripts/OptimisticLockerPlugin/init.sql"), new AbstractShellCallback() {
+            @Override
+            public void reloadProject(SqlSession sqlSession, ClassLoader loader, String packagz) throws Exception {
+                ObjectUtil tbMapper = new ObjectUtil(sqlSession.getMapper(loader.loadClass(packagz + ".TbMapper")));
+
+                ObjectUtil tbExample = new ObjectUtil(loader, packagz + ".TbExample");
+                ObjectUtil criteria = new ObjectUtil(tbExample.invoke("createCriteria"));
+                criteria.invoke("andIdEqualTo", 1l);
+
+                ObjectUtil tb = new ObjectUtil(loader, packagz + ".Tb");
+                tb.set("id", 1L);
+                tb.invoke("nextVersion", 152L);  // nextVersion方法
+                tb.set("incF2", 10L);
+                tb.set("incF3", 5L);
+
+                // sql
+                String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "updateWithVersionByExample", 100L, tb.getObject(), tbExample.getObject());
+                Assert.assertEquals(sql, "update tb set inc_f1 = 152, id = 1, field1 = 'null', inc_f2 = 10, inc_f3 = 5 WHERE inc_f1 = 100 and ( ( id = '1' ) )");
+
+                // 执行一次，因为版本号100不存在所以应该返回0
+                Object result = tbMapper.invoke("updateWithVersionByExample", 100L, tb.getObject(), tbExample.getObject());
+                Assert.assertEquals(result, 0);
+
+                // id = 1 的版本号应该是0
+                result = tbMapper.invoke("updateWithVersionByExample", 0L, tb.getObject(), tbExample.getObject());
+                Assert.assertEquals(result, 1);
+
+                // 执行完成后版本号应该加1
+                ResultSet rs = DBHelper.execute(sqlSession.getConnection(), "select * from tb where id = 1");
+                rs.first();
+                Assert.assertEquals(rs.getInt("inc_f1"), 152);
+            }
+        });
     }
 
     /**
@@ -339,6 +412,80 @@ public class OptimisticLockerPluginTest {
                 Assert.assertEquals(rs.getString("field1"), "ts1");
             }
         });
+
+        // ================================================ 测试自定义版本号 =======================================================
+        tool = MyBatisGeneratorTool.create("scripts/OptimisticLockerPlugin/mybatis-generator-customizedNextVersion.xml");
+        // 测试执行withoutBLOBs
+        tool.generate(() -> DBHelper.createDB("scripts/OptimisticLockerPlugin/init.sql"), new AbstractShellCallback() {
+            @Override
+            public void reloadProject(SqlSession sqlSession, ClassLoader loader, String packagz) throws Exception {
+                ObjectUtil tbBlobsMapper = new ObjectUtil(sqlSession.getMapper(loader.loadClass(packagz + ".TbBlobsMapper")));
+
+                ObjectUtil tbBlobsExample = new ObjectUtil(loader, packagz + ".TbBlobsExample");
+                ObjectUtil criteria = new ObjectUtil(tbBlobsExample.invoke("createCriteria"));
+                criteria.invoke("andIdEqualTo", 1l);
+
+                ObjectUtil tbBlobsBuilder = new ObjectUtil(loader, packagz + ".TbBlobs$Builder");
+                tbBlobsBuilder.invoke("id", 1L);
+                tbBlobsBuilder.invoke("incF1", 152L);   // 普通set
+                tbBlobsBuilder.invoke("incF2", 10L);
+                tbBlobsBuilder.invoke("incF3", 5L);
+
+                // sql
+                String sql = SqlHelper.getFormatMapperSql(tbBlobsMapper.getObject(), "updateWithVersionByExample", 100L, tbBlobsBuilder.invoke("build"), tbBlobsExample.getObject());
+                Assert.assertEquals(sql, "update tb_blobs set inc_f1 = 152, id = 1, field1 = 'null', inc_f2 = 10, inc_f3 = 5 WHERE inc_f1 = 100 and ( ( id = '1' ) )");
+
+                // 执行一次，因为版本号100不存在所以应该返回0
+                Object result = tbBlobsMapper.invoke("updateWithVersionByExample", 100L, tbBlobsBuilder.invoke("build"), tbBlobsExample.getObject());
+                Assert.assertEquals(result, 0);
+
+                // id = 1 的版本号应该是1
+                result = tbBlobsMapper.invoke("updateWithVersionByExample", 1L, tbBlobsBuilder.invoke("build"), tbBlobsExample.getObject());
+                Assert.assertEquals(result, 1);
+
+                // 执行完成后版本号应该加1
+                ResultSet rs = DBHelper.execute(sqlSession.getConnection(), "select * from tb_blobs where id = 1");
+                rs.first();
+                Assert.assertEquals(rs.getInt("inc_f1"), 152);
+            }
+        });
+
+        // 测试执行withBLOBs
+        tool.generate(() -> DBHelper.createDB("scripts/OptimisticLockerPlugin/init.sql"), new AbstractShellCallback() {
+            @Override
+            public void reloadProject(SqlSession sqlSession, ClassLoader loader, String packagz) throws Exception {
+                ObjectUtil tbBlobsMapper = new ObjectUtil(sqlSession.getMapper(loader.loadClass(packagz + ".TbBlobsMapper")));
+
+                ObjectUtil tbBlobsExample = new ObjectUtil(loader, packagz + ".TbBlobsExample");
+                ObjectUtil criteria = new ObjectUtil(tbBlobsExample.invoke("createCriteria"));
+                criteria.invoke("andIdEqualTo", 1l);
+
+                ObjectUtil tbBlobsBuilder = new ObjectUtil(loader, packagz + ".TbBlobsWithBLOBs$Builder");
+                tbBlobsBuilder.invoke("id", 1L);
+                tbBlobsBuilder.invoke("nextVersion", 152L);   // nextVersion 方法
+                tbBlobsBuilder.invoke("incF2", 10L);
+                tbBlobsBuilder.invoke("incF3", 5L);
+                tbBlobsBuilder.invoke("field1", "ts1");
+
+                // sql
+                String sql = SqlHelper.getFormatMapperSql(tbBlobsMapper.getObject(), "updateWithVersionByExampleWithBLOBs", 100L, tbBlobsBuilder.invoke("build"), tbBlobsExample.getObject());
+                Assert.assertEquals(sql, "update tb_blobs set inc_f1 = 152, id = 1, field1 = 'ts1', inc_f2 = 10, inc_f3 = 5, field2 = 'null', field3 = 'null' WHERE inc_f1 = 100 and ( ( id = '1' ) )");
+
+                // 执行一次，因为版本号100不存在所以应该返回0
+                Object result = tbBlobsMapper.invoke("updateWithVersionByExampleWithBLOBs", 100L, tbBlobsBuilder.invoke("build"), tbBlobsExample.getObject());
+                Assert.assertEquals(result, 0);
+
+                // id = 1 的版本号应该是1
+                result = tbBlobsMapper.invoke("updateWithVersionByExampleWithBLOBs", 1L, tbBlobsBuilder.invoke("build"), tbBlobsExample.getObject());
+                Assert.assertEquals(result, 1);
+
+                // 执行完成后版本号应该加1
+                ResultSet rs = DBHelper.execute(sqlSession.getConnection(), "select * from tb_blobs where id = 1");
+                rs.first();
+                Assert.assertEquals(rs.getInt("inc_f1"), 152);
+                Assert.assertEquals(rs.getString("field1"), "ts1");
+            }
+        });
     }
 
     /**
@@ -376,6 +523,38 @@ public class OptimisticLockerPluginTest {
                 Assert.assertEquals(rs.getInt("inc_f1"), 1);
             }
         });
+
+        // 测试自定义版本号
+        tool = MyBatisGeneratorTool.create("scripts/OptimisticLockerPlugin/mybatis-generator-customizedNextVersion.xml");
+        tool.generate(() -> DBHelper.createDB("scripts/OptimisticLockerPlugin/init.sql"), new AbstractShellCallback() {
+            @Override
+            public void reloadProject(SqlSession sqlSession, ClassLoader loader, String packagz) throws Exception {
+                ObjectUtil tbMapper = new ObjectUtil(sqlSession.getMapper(loader.loadClass(packagz + ".TbMapper")));
+
+                ObjectUtil tb = new ObjectUtil(loader, packagz + ".Tb");
+                tb.set("id", 1L);
+                tb.invoke("nextVersion", 152L);
+                tb.set("incF2", 10L);
+                tb.set("incF3", 5L);
+
+                // sql
+                String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "updateWithVersionByPrimaryKeySelective", 100L, tb.getObject());
+                Assert.assertEquals(sql, "update tb SET inc_f1 = 152, inc_f2 = 10, inc_f3 = 5 where inc_f1 = 100 and id = 1");
+
+                // 执行一次，因为版本号100不存在所以应该返回0
+                Object result = tbMapper.invoke("updateWithVersionByPrimaryKeySelective", 100L, tb.getObject());
+                Assert.assertEquals(result, 0);
+
+                // id = 1 的版本号应该是0
+                result = tbMapper.invoke("updateWithVersionByPrimaryKeySelective", 0L, tb.getObject());
+                Assert.assertEquals(result, 1);
+
+                // 执行完成后版本号应该加1
+                ResultSet rs = DBHelper.execute(sqlSession.getConnection(), "select * from tb where id = 1");
+                rs.first();
+                Assert.assertEquals(rs.getInt("inc_f1"), 152);
+            }
+        });
     }
 
     /**
@@ -413,6 +592,38 @@ public class OptimisticLockerPluginTest {
                 Assert.assertEquals(rs.getInt("inc_f1"), 1);
             }
         });
+
+        // 测试自定义版本号
+        tool = MyBatisGeneratorTool.create("scripts/OptimisticLockerPlugin/mybatis-generator-customizedNextVersion.xml");
+        tool.generate(() -> DBHelper.createDB("scripts/OptimisticLockerPlugin/init.sql"), new AbstractShellCallback() {
+            @Override
+            public void reloadProject(SqlSession sqlSession, ClassLoader loader, String packagz) throws Exception {
+                ObjectUtil tbMapper = new ObjectUtil(sqlSession.getMapper(loader.loadClass(packagz + ".TbMapper")));
+
+                ObjectUtil tb = new ObjectUtil(loader, packagz + ".Tb");
+                tb.set("id", 1L);
+                tb.invoke("nextVersion", 152L);
+                tb.set("incF2", 10L);
+                tb.set("incF3", 5L);
+
+                // sql
+                String sql = SqlHelper.getFormatMapperSql(tbMapper.getObject(), "updateWithVersionByPrimaryKey", 100L, tb.getObject());
+                Assert.assertEquals(sql, "update tb set inc_f1 = 152, field1 = 'null', inc_f2 = 10, inc_f3 = 5 where inc_f1 = 100 and id = 1");
+
+                // 执行一次，因为版本号100不存在所以应该返回0
+                Object result = tbMapper.invoke("updateWithVersionByPrimaryKey", 100L, tb.getObject());
+                Assert.assertEquals(result, 0);
+
+                // id = 1 的版本号应该是0
+                result = tbMapper.invoke("updateWithVersionByPrimaryKey", 0L, tb.getObject());
+                Assert.assertEquals(result, 1);
+
+                // 执行完成后版本号应该加1
+                ResultSet rs = DBHelper.execute(sqlSession.getConnection(), "select * from tb where id = 1");
+                rs.first();
+                Assert.assertEquals(rs.getInt("inc_f1"), 152);
+            }
+        });
     }
 
     /**
@@ -485,6 +696,72 @@ public class OptimisticLockerPluginTest {
                 Assert.assertEquals(rs.getString("field1"), "ts1");
             }
         });
+
+        // ====================================== 测试自定义版本号 ==========================================
+        tool = MyBatisGeneratorTool.create("scripts/OptimisticLockerPlugin/mybatis-generator-customizedNextVersion.xml");
+        // 测试执行withoutBLOBs
+        tool.generate(() -> DBHelper.createDB("scripts/OptimisticLockerPlugin/init.sql"), new AbstractShellCallback() {
+            @Override
+            public void reloadProject(SqlSession sqlSession, ClassLoader loader, String packagz) throws Exception {
+                ObjectUtil tbBlobsMapper = new ObjectUtil(sqlSession.getMapper(loader.loadClass(packagz + ".TbBlobsMapper")));
+
+                ObjectUtil tbBlobs = new ObjectUtil(loader, packagz + ".TbBlobs");
+                tbBlobs.set("id", 1L);
+                tbBlobs.invoke("nextVersion", 152L);
+                tbBlobs.set("incF2", 10L);
+                tbBlobs.set("incF3", 5L);
+
+                // sql
+                String sql = SqlHelper.getFormatMapperSql(tbBlobsMapper.getObject(), "updateWithVersionByPrimaryKey", 100L, tbBlobs.getObject());
+                Assert.assertEquals(sql, "update tb_blobs set inc_f1 = 152, field1 = 'null', inc_f2 = 10, inc_f3 = 5 where inc_f1 = 100 and id = 1");
+
+                // 执行一次，因为版本号100不存在所以应该返回0
+                Object result = tbBlobsMapper.invoke("updateWithVersionByPrimaryKey", 100L, tbBlobs.getObject());
+                Assert.assertEquals(result, 0);
+
+                // id = 1 的版本号应该是1
+                result = tbBlobsMapper.invoke("updateWithVersionByPrimaryKey", 1L, tbBlobs.getObject());
+                Assert.assertEquals(result, 1);
+
+                // 执行完成后版本号应该加1
+                ResultSet rs = DBHelper.execute(sqlSession.getConnection(), "select * from tb_blobs where id = 1");
+                rs.first();
+                Assert.assertEquals(rs.getInt("inc_f1"), 152);
+            }
+        });
+
+        // 测试执行withBLOBs
+        tool.generate(() -> DBHelper.createDB("scripts/OptimisticLockerPlugin/init.sql"), new AbstractShellCallback() {
+            @Override
+            public void reloadProject(SqlSession sqlSession, ClassLoader loader, String packagz) throws Exception {
+                ObjectUtil tbBlobsMapper = new ObjectUtil(sqlSession.getMapper(loader.loadClass(packagz + ".TbBlobsMapper")));
+
+                ObjectUtil tbBlobsWithBLOBs = new ObjectUtil(loader, packagz + ".TbBlobsWithBLOBs");
+                tbBlobsWithBLOBs.set("id", 1L);
+                tbBlobsWithBLOBs.invoke("nextVersion", 152L);
+                tbBlobsWithBLOBs.set("incF2", 10L);
+                tbBlobsWithBLOBs.set("incF3", 5L);
+                tbBlobsWithBLOBs.set("field1", "ts1");
+
+                // sql
+                String sql = SqlHelper.getFormatMapperSql(tbBlobsMapper.getObject(), "updateWithVersionByPrimaryKeyWithBLOBs", 100L, tbBlobsWithBLOBs.getObject());
+                Assert.assertEquals(sql, "update tb_blobs set inc_f1 = 152, field1 = 'ts1', inc_f2 = 10, inc_f3 = 5, field2 = 'null', field3 = 'null' where inc_f1 = 100 and id = 1");
+
+                // 执行一次，因为版本号100不存在所以应该返回0
+                Object result = tbBlobsMapper.invoke("updateWithVersionByPrimaryKeyWithBLOBs", 100L, tbBlobsWithBLOBs.getObject());
+                Assert.assertEquals(result, 0);
+
+                // id = 1 的版本号应该是1
+                result = tbBlobsMapper.invoke("updateWithVersionByPrimaryKeyWithBLOBs", 1L, tbBlobsWithBLOBs.getObject());
+                Assert.assertEquals(result, 1);
+
+                // 执行完成后版本号应该加1
+                ResultSet rs = DBHelper.execute(sqlSession.getConnection(), "select * from tb_blobs where id = 1");
+                rs.first();
+                Assert.assertEquals(rs.getInt("inc_f1"), 152);
+                Assert.assertEquals(rs.getString("field1"), "ts1");
+            }
+        });
     }
 
     /**

src/test/resources/scripts/OptimisticLockerPlugin/mybatis-generator-customizedNextVersion.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  ~ Copyright (c) 2018.
+  ~
+  ~ Licensed under the Apache License, Version 2.0 (the "License");
+  ~ you may not use this file except in compliance with the License.
+  ~ You may obtain a copy of the License at
+  ~
+  ~     http://www.apache.org/licenses/LICENSE-2.0
+  ~
+  ~ Unless required by applicable law or agreed to in writing, software
+  ~ distributed under the License is distributed on an "AS IS" BASIS,
+  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  ~ See the License for the specific language governing permissions and
+  ~ limitations under the License.
+  -->
+
+<!DOCTYPE generatorConfiguration
+        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
+        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
+<generatorConfiguration>
+    <properties resource="db.properties"/>
+
+    <!--导入属性配置 -->
+    <context id="default" targetRuntime="MyBatis3">
+        <!-- 插件 -->
+        <plugin type="com.itfsw.mybatis.generator.plugins.OptimisticLockerPlugin">
+            <property name="customizedNextVersion" value="true"/>
+        </plugin>
+
+        <plugin type="com.itfsw.mybatis.generator.plugins.ModelBuilderPlugin" />
+
+        <!--jdbc的数据库连接 -->
+        <jdbcConnection driverClass="${driver}" connectionURL="${url}" userId="${username}" password="${password}" />
+        <!-- Model模型生成器,用来生成含有主键key的类，记录类 以及查询Example类
+            targetPackage     指定生成的model生成所在的包名
+            targetProject     指定在该项目下所在的路径  -->
+        <javaModelGenerator targetPackage="" targetProject="">
+            <!-- 是否对model添加 构造函数 -->
+            <property name="constructorBased" value="true"/>
+            <!-- 给Model添加一个父类 -->
+            <!--<property name="rootClass" value="com.itfsw.base"/>-->
+        </javaModelGenerator>
+        <!--Mapper映射文件生成所在的目录 为每一个数据库的表生成对应的SqlMap文件 -->
+        <sqlMapGenerator targetPackage="" targetProject="" />
+        <!-- 客户端代码，生成易于使用的针对Model对象和XML配置文件 的代码
+            type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象
+            type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象
+            type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口 -->
+        <javaClientGenerator targetPackage="" targetProject="" type="XMLMAPPER"/>
+
+        <!-- +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 要自动生成的表 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
+        <table tableName="tb">
+            <property name="versionColumn" value="inc_f1"/>
+
+            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
+        </table>
+        <table tableName="tb_keys">
+            <property name="versionColumn" value="inc_f1"/>
+        </table>
+        <table tableName="tb_blobs">
+            <property name="versionColumn" value="inc_f1"/>
+
+            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
+        </table>
+        <table tableName="tb_single_blob">
+            <property name="versionColumn" value="inc_f1"/>
+            <property name="customizedNextVersion" value="false"/>
+
+            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
+        </table>
+    </context>
+</generatorConfiguration>
\ No newline at end of file