tk.mybatis通用外掛updateByPrimaryKeySelective無法自動更新ON UPDATE CURRENT_TIMESTAMP列的解決辦法
tk.mybatis是一個很好用的通用外掛，把CRUD這些基本的資料操作全都用動態SQL語句自動生成了，mapper和xml裡十分清爽，但是昨天發現有一個小坑，記錄在此：
有一張表，結構如下（已經簡化了）：
CREATE TABLE `t_sample` ( `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '自增ID', `empcode` varchar(8) NOT NULL DEFAULT '' COMMENT '員工號', `datachange_lasttime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '時間戳', PRIMARY KEY (`id`), UNIQUE KEY `idx_unique_empcode` (`empcode`), KEY `idx_datachange_lasttime` (`datachange_lasttime`) ) ENGINE=InnoDB AUTO_INCREMENT=561 DEFAULT CHARSET=utf8mb4 COMMENT='test'
有一列datachange_lasttime，設定了update時， 讓mysql自動更新成當前時間，這樣只要記錄有變化，通過這一列就能知道什麼時候變化的（這也是很多公司的資料庫開發規範之一）
然後tk.mybatis裡提供了一個很方便的方法：updateByPrimaryKeySelective，用法如下：
@Test
public void testDataChangeLastTime() {
SampleEntity sample = sampleEntityMapper.selectByPrimaryKey(560);
long changeLastTime1 = sample.getDatachangeLasttime().getTime();
sample.setEmpcode("TEST");
int affectedRows = sampleEntityMapper.updateByPrimaryKeySelective(sample);
System.out.println(affectedRows);
long changeLastTime2 = sample.getDatachangeLasttime().getTime();
Assert.assertNotEquals(changeLastTime1, changeLastTime2);
}
程式碼很簡單，先根據主鍵id，取出一條記錄，然後再根據業務要求，修改某一列，然後提交。執行後，發現datachange_lasttime這列並沒按預期那樣，更新成當前時間，仍然是舊的時間戳。（上面的單元測試將會失敗）
把日誌級別調整成DEBUG，觀察了下最終生成的update語句，如下：
22:41:23.933 [main] DEBUG - ==> Preparing: UPDATE t_sample SET id = id,empcode = ?,datachange_lasttime = ? WHERE id = ?
22:41:23.936 [main] DEBUG - ==> Parameters: TEST(String), 2018-09-07 17:01:39.0(Timestamp)
22:41:23.981 [main] DEBUG - <== Updates: 1
可能大家一眼就看出問題了，update語句裡， datachange_lasttime這列，又用舊值重新更新回去了。
updateByPrimaryKeySelective的原理，是根據entity物件的屬性值，是否為null，如果為null，則最終生成的update語句裡，將忽略該列，否則會更新該列。
entity從資料庫裡取出來時，DatachangeLasttime屬性上已經有值了，不為null，所以更新時，又把這個舊值給update回去了！解決辦法：
@Test
public void testDataChangeLastTime() {
SampleEntity sample = sampleEntityMapper.selectByPrimaryKey(560);
long changeLastTime1 = sample.getDatachangeLasttime().getTime();
//注意：就本例而言，如果empCode在資料庫裡的舊值本身是TEST，這一行不會被更新（datachange_lasttime列仍是舊值）
sample.setEmpcode("TEST");
//人為更新成null,以便讓mybatis生成的update的語句忽略
sample.setDatachangeLasttime(null);
int affectedRows = sampleEntityMapper.updateByPrimaryKeySelective(sample);
System.out.println(affectedRows);
long changeLastTime2 = sample.getDatachangeLasttime().getTime();
Assert.assertNotEquals(changeLastTime1, changeLastTime2);
}
手動把DatachangeLasttime屬性設定為null即可，這次生成的udpate語句為：
22:44:06.298 [main] DEBUG - ==> Preparing: UPDATE t_sample SET id = id,empcode = ? WHERE id = ?
22:44:06.300 [main] DEBUG - ==> Parameters: TEST(String), 560(Long)
22:44:06.342 [main] DEBUG - <== Updates: 1
另外還有一個小細節，跟mybatis無關，是mysql自己的機制，如果empcode這列在資料庫裡，這行上的舊值已經是TEST，java程式碼又把更新成TEST，即：這行的資料沒有變化，updateByPrimaryKeySelective在java程式碼裡返回的影響行數，仍然是1 ，但是在mysql裡裸跑sql的話，影響行數是0，即：資料庫層面這行沒有更新，datachange_lasttime列當然仍是舊值（這倒也合理，畢竟資料更新前後的資料一樣，所以mysql不更新也說得過去)
最後，來點優雅的做法，畢竟大家都是有身份~~~~~"證"的人，怎麼可能手動在每個需要更新的地方，手動設定null，這有點low，講出去要被人笑話的^_~
mybatis提供了攔截器機制，搞一個攔截器在更新前攔截一下，用反射大法把這列設定成null，就萬事大吉了。
/**
*
* @author 菩提樹下的楊過(http://yjmyzz.cnblogs.com)
* @date 2018/12/15 5:17 PM
*/
@Intercepts({
@Signature(type = Executor.class, method = DataChangeLastTimeInterceptor.METHOD_UPDATE, args = {
MappedStatement.class, Object.class})})
public class DataChangeLastTimeInterceptor implements Interceptor {
Logger logger = LoggerFactory.getLogger(this.getClass());
public static final String METHOD_UPDATE = "update";
public static final String[] METHOD_SET_DATA_CHANGE_LAST_TIME = new String[]{"setDatachangeLasttime", "setDataChange_LastTime"};
@Override
public Object intercept(Invocation invocation) throws Throwable {
String methodName = invocation.getMethod().getName();
if (methodName.equalsIgnoreCase(DataChangeLastTimeInterceptor.METHOD_UPDATE)) {
Object parameter = invocation.getArgs()[1];
Date empty = null;
try {
for (String s : METHOD_SET_DATA_CHANGE_LAST_TIME) {
ReflectionUtils.callMethod(parameter, s, true, empty);
}
} catch (Exception e) {
logger.warn("setDatachangeLasttime error:" + e.getMessage() + ",class:" + parameter.getClass());
}
}
return invocation.proceed();
}
@Override
public Object plugin(Object o) {
return Plugin.wrap(o, this);
}
@Override
public void setProperties(Properties properties) {
}
}
這裡面有一個自己寫的反射工具類，程式碼如下：
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Member;
import java.lang.reflect.Method;
import org.apache.commons.lang3.ArrayUtils;
public class ReflectionUtils {
static Boolean checkName(Member member, String targetName, Boolean ignoreCase) {
if (ignoreCase) {
if (member.getName().equalsIgnoreCase(targetName)) {
return true;
}
} else if (member.getName().equals(targetName)) {
return true;
}
return false;
}
public static Method getMethod(Object target, String methodName, Boolean ignoreCase) {
if (target == null) {
return null;
} else {
Method[] methods = target.getClass().getDeclaredMethods();
if (ArrayUtils.isEmpty(methods)) {
return null;
} else {
Method[] arr$ = methods;
int len$ = methods.length;
for(int i$ = 0; i$ < len$; ++i$) {
Method method = arr$[i$];
if (checkName(method, methodName, ignoreCase)) {
return method;
}
}
return null;
}
}
}
public static Method getMethod(Object target, String methodName) {
return getMethod(target, methodName, false);
}
public static Field getField(Object target, String propertyName, Boolean ignoreCase) {
if (target == null) {
return null;
} else {
Field[] fields = target.getClass().getDeclaredFields();
if (ArrayUtils.isEmpty(fields)) {
return null;
} else {
Field[] arr$ = fields;
int len$ = fields.length;
for(int i$ = 0; i$ < len$; ++i$) {
Field f = arr$[i$];
if (checkName(f, propertyName, ignoreCase)) {
return f;
}
}
return null;
}
}
}
public static Field getField(Object target, String propertyName) {
return getField(target, propertyName, false);
}
public static void setField(Object target, String propertyName, Boolean ignoreCase, Object propertyValue) throws IllegalAccessException {
Field field = getField(target, propertyName, ignoreCase);
if (field != null) {
field.set(target, propertyValue);
}
}
public static void setField(Object target, String propertyName, Object propertyValue) throws IllegalAccessException {
setField(target, propertyName, false, propertyValue);
}
public static void callMethod(Object target, String methodName, Object... args) throws InvocationTargetException, IllegalAccessException {
callMethod(target, methodName, false, args);
}
public static void callMethod(Object target, String methodName, Boolean ignoreCase, Object... args) throws InvocationTargetException, IllegalAccessException {
Method method = getMethod(target, methodName, ignoreCase);
if (method != null) {
method.invoke(target, args);
}
}
}
最後在mybatis-config.xml裡啟用該外掛：
<plugins>
...
<plugin interceptor="com.xxx.DataChangeLastTimeInterceptor">
</plugin>
</plugins>