? ? ? ?Spring Boot提供了一個(gè)叫做Spring Task的任務(wù)調(diào)度工具，支持注解和配置文件形式蟀伸，支持Cron表達(dá)式，使用簡(jiǎn)單且功能強(qiáng)大。正好在項(xiàng)目中使用到了這個(gè)工具主守，并且遇到了問(wèn)題禀倔，現(xiàn)把遇到的問(wèn)題以及解決方案與大家分享，歡迎批評(píng)指正参淫！

一救湖、問(wèn)題背景

? ? ? ?首先介紹一下如何在Spring Boot項(xiàng)目中使用定時(shí)任務(wù)（Spring Task），本文以Maven項(xiàng)目為例涎才，使用dubbo框架鞋既，使用MySQL數(shù)據(jù)庫(kù)和MyBatis ORM，以基于注解（annotation）的方式來(lái)實(shí)現(xiàn)耍铜。
? ? ? ?在Spring Boot項(xiàng)目中邑闺，我們可以很優(yōu)雅的使用注解來(lái)實(shí)現(xiàn)定時(shí)任務(wù)，首先創(chuàng)建項(xiàng)目棕兼，導(dǎo)入依賴(lài)：

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
  </dependency>
  <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
  </dependency>
</dependencies>

? ? ? ?啟動(dòng)類(lèi)中加入@EnableScheduling讓注解@Scheduled生效陡舅。基于注解的@Scheduled默認(rèn)為單線(xiàn)程伴挚，開(kāi)啟多個(gè)定時(shí)任務(wù)時(shí)靶衍，任務(wù)的執(zhí)行和調(diào)度時(shí)機(jī)會(huì)受上一個(gè)任務(wù)執(zhí)行時(shí)間的影響。慶幸地是章鲤，Spring Task支持多線(xiàn)程異步執(zhí)行摊灭，只需簡(jiǎn)單地使用config配置類(lèi)的方式添加相應(yīng)的配置即可。新建一個(gè)AsyncTaskConfig類(lèi)败徊，以便使Spring Task多線(xiàn)程異步執(zhí)行方式生效帚呼，同時(shí)對(duì)其進(jìn)行相應(yīng)的配置。AsyncTaskConfig類(lèi)如下：

@Configuration
@EnableAsync
public class AsyncTaskConfig {
     /*
    此處成員變量應(yīng)該使用@Value從配置中讀取皱蹦，此處僅為演示目的煤杀。
     */
    private int corePoolSize = 5;
    private int maxPoolSize = 10;
    private int queueCapacity = 5;
    
@Bean
    public Executor taskExecutor() {
        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
        executor.setCorePoolSize(corePoolSize);
        executor.setMaxPoolSize(maxPoolSize);
        executor.setQueueCapacity(queueCapacity);
        executor.initialize();
        return executor;
    }
}

注解說(shuō)明如下：
@Configuration：表明該類(lèi)是一個(gè)配置類(lèi)
@EnableAsync：開(kāi)啟異步事件的支持
? ? ? ?然后在定時(shí)任務(wù)的類(lèi)或者方法上添加@Async，之后每一個(gè)定時(shí)任務(wù)都會(huì)跑在不同的線(xiàn)程中沪哺。
? ? ? ?OK沈自！Spring Task就是這么簡(jiǎn)單！到此為止辜妓，定時(shí)任務(wù)在本地執(zhí)行一點(diǎn)問(wèn)題都沒(méi)有枯途！
? ? ? ?本以為大功告成，誰(shuí)知在測(cè)試環(huán)境部署的時(shí)候出了問(wèn)題籍滴！同一個(gè)定時(shí)任務(wù)被執(zhí)行了多次酪夷，造成數(shù)據(jù)庫(kù)中數(shù)據(jù)混亂（由于業(yè)務(wù)保密需要，具體不詳述）孽惰。為什么會(huì)這樣呢晚岭？突然想起原來(lái)測(cè)試環(huán)境部署在多個(gè)節(jié)點(diǎn)之上，每個(gè)節(jié)點(diǎn)都會(huì)在相同的時(shí)間執(zhí)行相同的任務(wù)勋功。因?yàn)閐ubbo服務(wù)部署在不同節(jié)點(diǎn)的JVM里面坦报，而不同節(jié)點(diǎn)的JVM之間并沒(méi)有通信機(jī)制库说，都是各自獨(dú)立的，所以每個(gè)節(jié)點(diǎn)都會(huì)根據(jù)定時(shí)任務(wù)的配置來(lái)執(zhí)行同樣的任務(wù)片择∏钡模考慮問(wèn)題還是不周全啊构回！
? ? ? ?順便多說(shuō)一句夏块，這里強(qiáng)烈建議測(cè)試環(huán)境（test env）要和生產(chǎn)環(huán)境（product env）完全一致，這樣才能盡早發(fā)現(xiàn)問(wèn)題纤掸，以免在生產(chǎn)環(huán)境中造成不必要的損失，那可以真金白銀哦浑塞！

二借跪、解決方案

? ? ? ?前面已經(jīng)找到了問(wèn)題的根源，那接下來(lái)我們就要考慮如何解決這個(gè)問(wèn)題酌壕。Spring Task并不是為分布式環(huán)境設(shè)計(jì)的掏愁，在分布式環(huán)境下，這種定時(shí)任務(wù)是不支持集群配置的卵牍，如果部署到多個(gè)節(jié)點(diǎn)上果港，各個(gè)節(jié)點(diǎn)之間并沒(méi)有任何協(xié)調(diào)通訊機(jī)制，因?yàn)榧旱墓?jié)點(diǎn)之間是不會(huì)共享任務(wù)信息的糊昙，每個(gè)節(jié)點(diǎn)上的任務(wù)都會(huì)按時(shí)執(zhí)行辛掠。
? ? ? ?當(dāng)然可以使用比較重量級(jí)的分布式定時(shí)任務(wù)框架，比如：Elastic Job释牺。還有一種比較直接的方案就是把定時(shí)任務(wù)分離出來(lái)萝衩，成為一個(gè)單獨(dú)的服務(wù)，只在一個(gè)節(jié)點(diǎn)上部署没咙。但是這樣既要修改項(xiàng)目工程又得改變部署方式猩谊，故未采用這種方案。
? ? ? ?另一種想法是在全局緩存中設(shè)置一個(gè)全局鎖祭刚，拿到這個(gè)鎖的節(jié)點(diǎn)執(zhí)行相應(yīng)的任務(wù)牌捷。不過(guò)這樣就得依賴(lài)Redis，我們還是希望項(xiàng)目能夠比較獨(dú)立的運(yùn)行涡驮，減少對(duì)其他服務(wù)的依賴(lài)暗甥。
? ? ? ?最終我們選擇了用數(shù)據(jù)庫(kù)+樂(lè)觀鎖的方式來(lái)解決任務(wù)互斥訪(fǎng)問(wèn)的問(wèn)題。大致的思路是這樣的遮怜，聲明一把全局的“鎖”作為互斥量淋袖，哪個(gè)應(yīng)用服務(wù)器拿到這把“鎖”，就有執(zhí)行任務(wù)的權(quán)利锯梁，未拿到“鎖”的應(yīng)用服務(wù)器不進(jìn)行任何任務(wù)相關(guān)的操作即碗。另外就是這把“鎖”最好還能在下次任務(wù)執(zhí)行時(shí)間點(diǎn)前失效焰情。
? ? ? ?具體實(shí)現(xiàn)中，我們?cè)贛ySQL中新建了一張表job_locks剥懒，其中每一條記錄代表了一個(gè)定時(shí)任務(wù)的全局鎖内舟，同時(shí)這條記錄也存儲(chǔ)了任務(wù)當(dāng)前的狀態(tài)（status字段，運(yùn)行還是空閑）初橘，另外每條記錄還有一個(gè)version字段來(lái)標(biāo)識(shí)版本验游，以便實(shí)現(xiàn)樂(lè)觀鎖機(jī)制。當(dāng)定時(shí)任務(wù)觸發(fā)的時(shí)刻保檐，集群中的節(jié)點(diǎn)同時(shí)讀取該條數(shù)據(jù)耕蝉，將version字段的值一同讀出，然后再更新該條數(shù)據(jù)夜只，將任務(wù)狀態(tài)由空閑更新為運(yùn)行垒在，同時(shí)對(duì)version值加一。提交更新的時(shí)候扔亥，判斷數(shù)據(jù)庫(kù)表對(duì)應(yīng)記錄的當(dāng)前版本信息與取出來(lái)的version值進(jìn)行比對(duì)场躯，如果數(shù)據(jù)庫(kù)表當(dāng)前版本號(hào)與取出來(lái)的version值相等，則予以更新旅挤，否則更新失敗踢关。在這種競(jìng)爭(zhēng)的情況下，只有一個(gè)節(jié)點(diǎn)可以成功更新數(shù)據(jù)庫(kù)記錄粘茄，我們認(rèn)為它獲取了全局鎖签舞，只有它可以執(zhí)行定時(shí)任務(wù)，那些更新數(shù)據(jù)庫(kù)記錄失敗的節(jié)點(diǎn)則認(rèn)為未能獲取全局鎖驹闰，不再執(zhí)行定時(shí)任務(wù)瘪菌。任務(wù)執(zhí)行完畢之后，獲取全局鎖的節(jié)點(diǎn)要釋放全局鎖嘹朗，即將對(duì)應(yīng)數(shù)據(jù)庫(kù)記錄的status字段由運(yùn)行改為空閑师妙，以便下次繼續(xù)競(jìng)爭(zhēng)全局鎖。

三屹培、使用方法

? ? ? ?本小結(jié)來(lái)對(duì)如何使用該方案進(jìn)行詳細(xì)介紹默穴。
? ? ? ?首先在Mysql數(shù)據(jù)庫(kù)中新建job_locks表，對(duì)應(yīng)一個(gè)定時(shí)任務(wù)新增一條記錄褪秀。

SET NAMES utf8mb4;
SET FOREIGN_KEY_CHECKS = 0;

-- ----------------------------
-- Table structure for job_locks
-- ----------------------------
DROP TABLE IF EXISTS `job_locks`;
CREATE TABLE `job_locks` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) COLLATE utf8mb4_unicode_ci NOT NULL COMMENT 'job名稱(chēng)',
  `status` tinyint(4) DEFAULT '0' COMMENT 'job狀態(tài)：0-空閑蓄诽，1-運(yùn)行',
  `description` varchar(255) COLLATE utf8mb4_unicode_ci DEFAULT NULL COMMENT 'job描述',
  `create_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT '創(chuàng)建時(shí)間',
  `update_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP COMMENT '更新時(shí)間',
  `version` bigint(20) NOT NULL DEFAULT '0' COMMENT '版本',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

-- ----------------------------
-- Records of job_locks
-- ----------------------------
BEGIN;
INSERT INTO `job_locks` VALUES (1, 'job-name', 0, 'job描述 ', '2019-05-19 21:22:38', '2019-05-19 21:22:38', 0);
COMMIT;

SET FOREIGN_KEY_CHECKS = 1;

注意事項(xiàng)：id為主鍵且自增。

? ? ? ?在Mybatis的Mapper XML（JobLocksMapper.xml）文件中新增如下兩個(gè)update語(yǔ)句媒吗，我是使用Mybatis Generator（簡(jiǎn)稱(chēng)MBG）來(lái)生成實(shí)體類(lèi)仑氛，Mapper接口類(lèi)，Mapper XML文件的。

 <update id="requireLock" parameterType=" Entity.JobLocks">
    <![CDATA[
        update job_locks
        set status = 1, version=version + 1
        where id = #{id,jdbcType=INTEGER} and version =#{version,jdbcType=BIGINT} and status = 0
]]>
  </update>
  <update id="releaseLock" parameterType=" Entity.JobLocks">
    <![CDATA[
        update job_locks
        set status = 0
        where id = #{id,jdbcType=INTEGER} and status = 1
    ]]>
  </update>

注意事項(xiàng)：更新時(shí)主鍵id作為第一個(gè)查詢(xún)條件锯岖，這樣保證更新時(shí)使用行鎖而不是表鎖介袜。因?yàn)镸ySQL的innoDB引擎是支持行鎖的，但是行鎖建立在索引之上出吹。

? ? ? ?同時(shí)在Mapper接口類(lèi)（JobLocksMapper.java）中增加兩個(gè)接口遇伞，分別對(duì)應(yīng)兩個(gè)update語(yǔ)句，如下所示：

int requireLock(JobLocks record);
int releaseLock(JobLocks record);

? ? ? ?接下來(lái)在Dubbo框架內(nèi)新建JobLocksService.java接口定義以及實(shí)現(xiàn)類(lèi)JobLocksServiceImpl.java捶牢。
JobLocksService.java文件：

package <yourpackage>.;

import com.alibaba.dubbo.rpc.protocol.rest.support.ContentType;
import <yourpackage>.Entity.JobLocks;
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

@Path("jobLocksService")
@Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML, MediaType.TEXT_HTML, MediaType.APPLICATION_XHTML_XML})
@Produces({ContentType.APPLICATION_JSON_UTF_8, ContentType.TEXT_XML_UTF_8})
public interface JobLocksService {

    @POST
    @Path(value = "selectByPrimaryKey")
    JobLocks selectByPrimaryKey(Integer id);

    @POST
    @Path(value = "requireLock")
    int requireLock(JobLocks record);

    @POST
    @Path(value = "releaseLock")
    int releaseLock(JobLocks record);
}

JobLocksServiceImpl.java文件：

package <yourpackage>;

import lombok.extern.slf4j.Slf4j;
import <yourpackage>.Entity.JobLocks;
import <yourpackage>.Repository.JobLocksMapper;
import <yourpackage>.Service.JobLocksService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
@Slf4j
public class JobLocksServiceImpl implements JobLocksService {

    @Autowired
    JobLocksMapper jobLocksMapper;

    @Override
    public JobLocks selectByPrimaryKey(Integer id) {
        return jobLocksMapper.selectByPrimaryKey(id);
    }

    @Override
    public int requireLock(JobLocks record) {
        return jobLocksMapper.requireLock(record);
    }

    @Override
    public int releaseLock(JobLocks record) {
        return jobLocksMapper.releaseLock(record);
    }
}

? ? ? ?在Provider和Consumer中配置JobLocksService鸠珠，通過(guò)Dubbo實(shí)現(xiàn)服務(wù)的調(diào)用與消費(fèi)。

? ? ? ?最后按照下面的例子中的方式進(jìn)行調(diào)用秋麸。

@Component
@Slf4j
public class ScheduledUtil {

    @Autowired
    JobLocksService jobLocksService;

    @Scheduled(cron = "0/5 * * * * *")
    @Async
    public void scheduled(){
        JobLocks jobLocks = null;
        log.info("Current Thread:" + Thread.currentThread().getName());

        
        // 查詢(xún)id=1的記錄渐排，對(duì)應(yīng)一個(gè)定時(shí)任務(wù)
        jobLocks = jobLocksService.selectByPrimaryKey(1);
        if(null != jobLocks && jobLocks.getStatus() == 0) {
            int result = jobLocksService.requireLock(jobLocks);
            if(result == 1) {   // get the lock successfully
                try{
                    log.info(Thread.currentThread().getName() + " got the lock of job " + jobLocks.getName());
                    
                    // 在此執(zhí)行你的定時(shí)任務(wù)

                    // 用來(lái)客服集群中多個(gè)節(jié)點(diǎn)的時(shí)間漂移問(wèn)題
                    Thread.sleep(10 * 1000);
                     
                    log.info(jobLocks.getName() + " is done!");
                } catch (InterruptedException e) {
                    e.printStackTrace();
                } finally {
                    if(null != jobLocks)
                        jobLocksService.releaseLock(jobLocks);
                }
            }
        }   
    }
}

需要強(qiáng)調(diào)和注意的事項(xiàng)如下：

1. requireLock和releaseLock必須成對(duì)使用；

2. releaseLock必須放在finally語(yǔ)句塊中灸蟆，以保證鎖能夠被釋放飞盆；

3. 集群中的節(jié)點(diǎn)可能存在時(shí)間不同步的現(xiàn)象，所以可以酌情在定時(shí)任務(wù)執(zhí)行完成之后添加一定時(shí)間的sleep次乓，以客服節(jié)點(diǎn)服務(wù)器的時(shí)間漂移問(wèn)題。

   2019年5月21日星期二 于團(tuán)結(jié)湖瑞辰國(guó)際中心