Spring Boot

Spring + MyBatisで楽観ロックを実装する

2022年7月20日

はじめに

MyBatisを利用した楽観ロックの方法を紹介します。

MyBatisはSpring Data JPAのようにライブラリとして楽観ロックを行う仕組みは提供していないため、独自で実装する必要があります。

本記事で使用するテーブル定義は次の通りです。

物理名 論理名 データ型 NOT NULL 説明
id ID BIGINT 〇 主キー（AUTO_INCREMENT）
name 名前 VARCHAR(100) 〇 ユーザーの名前
update_date 更新日時 TIMESTAMP 〇 楽観ロック用カラム

■CREATE文

CREATE TABLE `sampledb`.`lock_sample` (
  `id` BIGINT NOT NULL AUTO_INCREMENT,
  `name` VARCHAR(100) NOT NULL,
  `update_date` timestamp NOT NULL,
  PRIMARY KEY (`id`));

Springの設定ファイル

Spring Bootの設定ファイルは次のとおり。

「mybatis.configuration.map-underscore-to-camel-case」（自動的にスネーク→キャメルに変換してくれる設定）を「true」、「mybatis.mapper-locations」でXMLファイル（SQL文）の格納位置を指定しています。

[application.properties]

mybatis.configuration.map-underscore-to-camel-case=true
mybatis.mapper-locations=classpath*:sample/*.xml

MyBatisで楽観ロックを実装する方法

エンティティに楽観ロック用のカラムを用意する

楽観ロックを行うには、数値型かTimestamp型でバージョンを管理する必要があります。

今回の例では、Timestamp型の更新日時を楽観ロック用のカラムとしています。

今回の例ではTimestamp型を使用していますが、Timestamp型の場合は同時に処理が発生（Timestampがまったく同じ）した時、一意性が保証されないため、数値型で管理した方がより確実な方法です。

[テーブルのエンティティ]

package com.example.demo.entity;

import java.io.Serializable;
import java.sql.Timestamp;

import lombok.Data;

@Data
public class LockSample implements Serializable {

    /**
     * ID
     */
    private Long id;

    /**
     * 名前
     */
    private String name;

    /**
     * 更新日時
     */
    private Timestamp updateDate;
}

スポンサーリンク

UPDATE文の条件に更新日時を加える

[SQL文]

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="sample">

    <!-- 主キー検索 -->
    <select id="findById" parameterType="java.lang.Long" resultType="com.example.demo.entity.LockSample">
        SELECT * FROM lock_sample WHERE id = #{id} ・・・①
    </select>

    <!-- 更新 -->
    <update id="update" parameterType="com.example.demo.entity.LockSample">
        UPDATE lock_sample SET
            name = #{name}
            ,update_date = CURRENT_TIMESTAMP ・・・②
        WHERE
            id = #{id}
            AND update_date = #{updateDate} ・・・③
    </update>

    <!-- 登録 -->
    <insert id="insert" parameterType="com.example.demo.entity.LockSample">
        INSERT INTO lock_sample (name, update_date) VALUES (#{name}, CURRENT_TIMESTAMP)
    </insert>

</mapper>

楽観ロックを実装する際の流れは次のとおりです。

  1. 更新対象のデータを取得するSQLにて更新日時を取得する。（上記SQL①）
  2. 更新する際は、更新日時をシステム日時で更新する。（上記SQL②）
  3. 更新条件に更新日時が一致することを加える。（上記SQL③）

注意ポイント

③のWHERE句にid（主キー）と更新日時以外の条件は加えないようにしましょう。

別の条件を加えると、更新できなかった場合に、更新日時が一致しないことが理由なのか、別の条件に一致しないのが理由なのか、判断できなくなります。

更新結果が0件の場合、楽観ロックエラーにする

今回の例では、LockSampleDaoクラスを作成し、saveメソッド内で更新結果が0件の場合は、他のトランザクションによって更新されたことになるので、楽観ロックエラーにしています。

[Daoクラス]

package com.example.demo.dao;

import org.apache.ibatis.session.SqlSession;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.dao.OptimisticLockingFailureException;
import org.springframework.stereotype.Repository;

import com.example.demo.entity.LockSample;

@Repository
public class LockSampleDao {

    @Autowired
    private SqlSession sqlSession;

    /**
     * 主キー検索
     * @param id ID
     * @return エンティティ
     */
    public LockSample findById(Long id) {
        return sqlSession.selectOne("sample.findById", id);
    }

    /**
     * 保存処理
     * @param entity エンティティ
     */
    public void save(LockSample entity) {

        if (entity.getId() != null) {
            // 更新処理
            int updateCount = sqlSession.update("sample.update", entity);

            if (updateCount == 0) {
                throw new OptimisticLockingFailureException("楽観ロックエラー");
            }

        } else {
            // 登録処理
            sqlSession.insert("sample.insert", entity);
        }
    }
}

スポンサーリンク

楽観ロックの動作確認

それでは、次のサンプルクラスを使って楽観ロックの動作確認を行います。

  1. sampleUpdateメソッドを実行
  2. 別のスレッドでsampleUpdate2メソッドを実行
package com.example.demo.service;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import com.example.demo.dao.LockSampleDao;
import com.example.demo.entity.LockSample;

@Service
public class LockSampleService {

    @Autowired
    private LockSampleDao lockSampleDao;

    /**
    * 更新処理 (スリープあり）
    * @param id 更新対象のID
    * @throws InterruptedException 例外
    */
    @Transactional
    public void sampleUpdate(Long id) throws InterruptedException {

        LockSample lockSample = lockSampleDao.findById(id);

        if (lockSample != null) {

            // 10秒間待機
            Thread.sleep(10000);

            lockSample.setName("変更" + lockSample.getUpdateDate().getTime());
            lockSampleDao.save(lockSample);
        }
    }

    /**
     * 更新処理
     * @param id 更新対象のID
     */
    @Transactional
    public void sampleUpdate2(Long id) {

        LockSample lockSample = lockSampleDao.findById(id);

        if (lockSample != null) {

            lockSample.setName("変更2" + lockSample.getUpdateDate().getTime());
            lockSampleDao.save(lockSample);
        }
    }
}

 

上記の処理を順番に実行した結果、楽観ロックが発生しました。

org.springframework.dao.OptimisticLockingFailureException: 楽観ロックエラー
at com.example.demo.dao.LockSampleDao.save(LockSampleDao.java:38) ~[classes/:na]
at com.example.demo.dao.LockSampleDao$$FastClassBySpringCGLIB$$478416e7.invoke(<generated>) ~[classes/:na]
at org.springframework.cglib.proxy.MethodProxy.invoke(MethodProxy.java:218) ~[spring-core-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.CglibAopProxy$CglibMethodInvocation.invokeJoinpoint(CglibAopProxy.java:793) ~[spring-aop-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:163) ~[spring-aop-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.CglibAopProxy$CglibMethodInvocation.proceed(CglibAopProxy.java:763) ~[spring-aop-5.3.21.jar:5.3.21]
at org.springframework.dao.support.PersistenceExceptionTranslationInterceptor.invoke(PersistenceExceptionTranslationInterceptor.java:137) ~[spring-tx-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:186) ~[spring-aop-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.CglibAopProxy$CglibMethodInvocation.proceed(CglibAopProxy.java:763) ~[spring-aop-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.CglibAopProxy$DynamicAdvisedInterceptor.intercept(CglibAopProxy.java:708) ~[spring-aop-5.3.21.jar:5.3.21]
at com.example.demo.dao.LockSampleDao$$EnhancerBySpringCGLIB$$54aefbb2.save(<generated>) ~[classes/:na]
at com.example.demo.service.LockSampleService.sampleUpdate(LockSampleService.java:32) ~[classes/:na]
at com.example.demo.service.LockSampleService$$FastClassBySpringCGLIB$$f579b4ed.invoke(<generated>) ~[classes/:na]
at org.springframework.cglib.proxy.MethodProxy.invoke(MethodProxy.java:218) ~[spring-core-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.CglibAopProxy$CglibMethodInvocation.invokeJoinpoint(CglibAopProxy.java:793) ~[spring-aop-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:163) ~[spring-aop-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.CglibAopProxy$CglibMethodInvocation.proceed(CglibAopProxy.java:763) ~[spring-aop-5.3.21.jar:5.3.21]
at org.springframework.transaction.interceptor.TransactionInterceptor$1.proceedWithInvocation(TransactionInterceptor.java:123) ~[spring-tx-5.3.21.jar:5.3.21]
at org.springframework.transaction.interceptor.TransactionAspectSupport.invokeWithinTransaction(TransactionAspectSupport.java:388) ~[spring-tx-5.3.21.jar:5.3.21]
at org.springframework.transaction.interceptor.TransactionInterceptor.invoke(TransactionInterceptor.java:119) ~[spring-tx-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:186) ~[spring-aop-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.CglibAopProxy$CglibMethodInvocation.proceed(CglibAopProxy.java:763) ~[spring-aop-5.3.21.jar:5.3.21]
at org.springframework.aop.framework.CglibAopProxy$DynamicAdvisedInterceptor.intercept(CglibAopProxy.java:708) ~[spring-aop-5.3.21.jar:5.3.21]
at com.example.demo.service.LockSampleService$$EnhancerBySpringCGLIB$$46695740.sampleUpdate(<generated>) ~[classes/:na]
at com.example.demo.controller.LockSampleControl.display(LockSampleControl.java:20) ~[classes/:na]
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:na]
at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[na:na]
at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[na:na]
at java.base/java.lang.reflect.Method.invoke(Method.java:566) ~[na:na]
at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:205) ~[spring-web-5.3.21.jar:5.3.21]
at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:150) ~[spring-web-5.3.21.jar:5.3.21]
at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:117) ~[spring-webmvc-5.3.21.jar:5.3.21]
at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:895) ~[spring-webmvc-5.3.21.jar:5.3.21]
at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:808) ~[spring-webmvc-5.3.21.jar:5.3.21]
at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87) ~[spring-webmvc-5.3.21.jar:5.3.21]
at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1067) ~[spring-webmvc-5.3.21.jar:5.3.21]
at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:963) ~[spring-webmvc-5.3.21.jar:5.3.21]
at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006) ~[spring-webmvc-5.3.21.jar:5.3.21]
at org.springframework.web.servlet.FrameworkServlet.doGet(FrameworkServlet.java:898) ~[spring-webmvc-5.3.21.jar:5.3.21]
at javax.servlet.http.HttpServlet.service(HttpServlet.java:655) ~[tomcat-embed-core-9.0.64.jar:4.0.FR]
at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883) ~[spring-webmvc-5.3.21.jar:5.3.21]
at javax.servlet.http.HttpServlet.service(HttpServlet.java:764) ~[tomcat-embed-core-9.0.64.jar:4.0.FR]
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:227) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53) ~[tomcat-embed-websocket-9.0.64.jar:9.0.64]
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100) ~[spring-web-5.3.21.jar:5.3.21]
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) ~[spring-web-5.3.21.jar:5.3.21]
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93) ~[spring-web-5.3.21.jar:5.3.21]
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) ~[spring-web-5.3.21.jar:5.3.21]
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201) ~[spring-web-5.3.21.jar:5.3.21]
at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117) ~[spring-web-5.3.21.jar:5.3.21]
at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:197) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:97) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:541) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:135) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:78) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:360) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:399) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:890) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1787) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61) ~[tomcat-embed-core-9.0.64.jar:9.0.64]
at java.base/java.lang.Thread.run(Thread.java:834) ~[na:na]

helpful