摘要：文章鏈接動態(tài)腳本支持框架之使用介紹篇動態(tài)腳本支持框架之使用介紹篇相關(guān)博文動態(tài)腳本支持框架整體介紹篇這個項目主要就是為了解決數(shù)據(jù)訂正和接口驗證不方便的場景，設(shè)計的一個及其簡單的動態(tài)腳本調(diào)度框架，前面一篇整體介紹篇博文，主要介紹了這是

文章鏈接：https://liuyueyi.github.io/hexblog/2018/07/19/180719-Quick-Task-動態(tài)腳本支持框架之使用介紹篇/

相關(guān)博文：

180702-QuickTask動態(tài)腳本支持框架整體介紹篇

QuickTask這個項目主要就是為了解決數(shù)據(jù)訂正和接口驗證不方便的場景，設(shè)計的一個及其簡單的動態(tài)腳本調(diào)度框架，前面一篇整體介紹篇博文，主要介紹了這是個什么東西，整體的運行原理，以及一些簡單的使用demo

本篇博文將主要放在應(yīng)用場景的探討上，在實際的項目環(huán)境中，可以怎么用

支目前來說，有兩種簡單的使用方式，一是以獨立的jar包來運行，二是集成在已有的項目中運行；下面分別給出介紹

獨立jar包下載，首先下載原始工程，然后打出一個可執(zhí)行的jar包即可

git clone https://github.com/liuyueyi/quick-task
cd quick-task/task-core
mvn clean package -Dmaven.test.skip
cd target
java -jar task-core-0.0.1.jar --task /tmp/script

注意上面的jar包執(zhí)行中，傳入的--task參數(shù)，這個就是制定監(jiān)聽動態(tài)腳本的目錄，如上面的腳本，表示框架會自動加載 /tmp/script 目錄下的Groovy腳本，并執(zhí)行

當(dāng)腳本發(fā)生變動時，同樣會重新加載更新后的groovy并執(zhí)行，且會停掉原來的腳本

作為一個依賴來使用也是可以的，首先是添加pom依賴

    
        yihui-maven-repo
        https://raw.githubusercontent.com/liuyueyi/maven-repository/master/repository
    



    com.git.hui
    task-core
    0.0.1

然后在自己的代碼中，顯示的調(diào)用下面一行代碼即可，其中run方法的參數(shù)為動態(tài)腳本的目錄

new ScriptExecuteEngine().run("/tmp/script");

對于SpringBoot項目而言，可以在入口Application類的run方法中調(diào)用，一個demo如下

@SpringBootApplication
public class Application implements CommandLineRunner {
    public static void main(String[] args) throws Exception {
        SpringApplication app = new SpringApplication(Application.class);
        app.run(args);
    }

    @Override
    public void run(String... strings) throws Exception {
        new ScriptExecuteEngine().run("/tmp/script");
    }
}

對于傳統(tǒng)的Spring項目而言，可以新建一個Listener, 監(jiān)聽所有的bean初始化完成之后，開始注冊任務(wù)引擎，一個可參考的使用case如下

import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.context.event.SmartApplicationListener;
import org.springframework.stereotype.Component;

@Component
public class RegisterTaskEngineListener implements SmartApplicationListener {
    @Override
    public boolean supportsEventType(Class aClass) {
        return aClass == ContextRefreshedEvent.class;
    }

    @Override
    public boolean supportsSourceType(Class aClass) {
        return true;
    }

    @Override
    public void onApplicationEvent(ApplicationEvent applicationEvent) {
        new ScriptExecuteEngine().run("/tmp/script");
    }

    @Override
    public int getOrder() {
        return 0;
    }
}

兩種使用方式，從個人角度出發(fā)，并沒有什么優(yōu)劣之別，主要還是看具體的業(yè)務(wù)場景，當(dāng)希望部署一個獨立的任務(wù)腳本支持時，可能獨立的部署更加的方便，可以在內(nèi)部進行資源隔離，減少對線上生產(chǎn)環(huán)境的影響；

若是單純的把這個作為一個檢測項目運行的輔助工具時，如回調(diào)線上的服務(wù)接口，判斷輸出，獲取運行項目中的內(nèi)部參數(shù)等，集成在已有的項目中也是比較簡單的

使用了這個框架，到底有什么用處呢？或者說是否有一些適用的經(jīng)典case呢？

這種場景比較常見，但一般配套設(shè)施齊全的公司，也不會出現(xiàn)這個問題，我們最常見的查看數(shù)據(jù)有以下幾類

DB數(shù)據(jù)查看

緩存數(shù)據(jù)查看

內(nèi)存數(shù)據(jù)查看

對于DB查看，一般沒啥問題，要么可以直連查詢要么就是有查詢工具；而緩存數(shù)據(jù)的查詢，主要是我們通過序列化后存入的數(shù)據(jù)，直接從緩存中獲取可能并不太友好；對于運行時內(nèi)存中的數(shù)據(jù)，就不太好獲取了，特別是我們使用Guava緩存的數(shù)據(jù)，如何在項目運行中判斷緩存中的數(shù)據(jù)是否有問題呢？

一個查看內(nèi)存的偽代碼

class DemoScript implements ITask {
    @Override
    void run() {
        // 獲取目標(biāo)對象
        xxxBean = ApplicationContextHolder.getBean(xxx.class);
        xxxBean.getXXX();
    }
}

上面的腳本中，關(guān)鍵就是在于獲取目標(biāo)對象，拿到目標(biāo)對象之后，再獲取內(nèi)部的局部變量或者內(nèi)存數(shù)據(jù)就比較簡單了（不能直接訪問的局部變量可以通過反射獲?。?/p>

所以關(guān)鍵就是獲取目標(biāo)對象，有下面幾種思路可供參考：

目標(biāo)對象時單例或者靜態(tài)類，則可以直接訪問

如果項目運行在Spring容器中，且目標(biāo)對象為Bean，則可以通過 ApplicationContext#getBean 方式獲取

在問題復(fù)現(xiàn)的場景下，比較常用了，傳入相同的參數(shù)，判斷接口的返回結(jié)果是否ok，用于定位數(shù)據(jù)異常

class DemoScript implements ITask {
    @Override
    void run() {
        // 獲取目標(biāo)對象
        xxxService = ApplicationContextHolder.getBean(xxx.class);
        
        req = buildRequest();
        result = xxxService.execute(req);
        log.info("result: {}", result);
    }
}

其實實際使用起來和前面沒什么區(qū)別，無非是線獲取到對應(yīng)的Service，然后執(zhí)行接口，當(dāng)然在Spring的生態(tài)體系中，一個可展望的點就是支持自動注入依賴的bean

首先明確一點，在我們的框架中，所有的任務(wù)都是隔離的，獨立的線程中調(diào)度的，當(dāng)我們希望一個新的任務(wù)每隔多久執(zhí)行一次，可以怎么做？

一個簡單的偽代碼如下

class DemoScript implements ITask {
    private volatile boolean run = false;
    @Override
    void run() {
        run = true;
        while(true) {
          doXXX();
          
          try {
            Thread.sleep(1000);
          } catch(Exception e) {
          }
          
          if(!run) break;
        }
    }
    
    @Override
    void interrupt() {
        run = false;
    }
}

注意下上面的實現(xiàn)，在run方法中，有一個死循環(huán)，一直在重復(fù)的調(diào)用 doxxx() 方法，在內(nèi)部通過 Thread.sleep() 來控制頻率

在腳本改變或刪除之后，框架會回調(diào) interrupt 方法，因此會將上面的run變量設(shè)置為false，從而結(jié)束死循環(huán)

注意：

對于定時任務(wù)而言，后續(xù)會擴展一個對應(yīng)ScheduleTask抽象類出來，將循環(huán)和中斷的邏輯封裝一下，對于使用方而言，只需要寫業(yè)務(wù)邏輯即可，不需要關(guān)心這些重復(fù)的邏輯

這種更多的是把這個框架作為一個調(diào)度來用，我們接收mq的消息，然后在動態(tài)腳本中進行處理，再傳給第三方(如果集成在自己的項目中時，一個demo就是可以直接調(diào)用項目中的Dao保存數(shù)據(jù)）

一個RabbitMq的消費任務(wù)，對應(yīng)的偽代碼如下

class DemoScript implements ITask {
    @Override
    void run() {
      ConnectionFactory fac = new CachingConnectionFactory();
      fac.setHost("127.0.0.1");
      fac.setPort(5672);
      fac.setUsername("admin")
      fac.setPassword("admin")
      fac.setVirtualHost("/")
      
      //創(chuàng)建連接
      Connection connection = factory.newConnection();

      //創(chuàng)建消息信道
      final Channel channel = connection.createChannel();

      //消息隊列
      channel.queueDeclare(queue, true, false, false, null);
      //綁定隊列到交換機
      channel.queueBind(queue, exchange, routingKey);
     
      Consumer consumer = new DefaultConsumer(channel) {
            @Override
            public void handleDelivery(String consumerTag, Envelope envelope, AMQP.BasicProperties properties,
                    byte[] body) throws IOException {
                String message = new String(body, "UTF-8");

                try {
                    System.out.println(" [" + queue + "] Received "" + message);
                } finally {
                    channel.basicAck(envelope.getDeliveryTag(), false);
                }
            }
        };

        // 取消自動ack
        channel.basicConsume(queue, false, consumer);   
    }
}

注意：

對于RabbitMQ的任務(wù)，后續(xù)計劃封裝一個抽象的任務(wù)腳本，使業(yè)務(wù)方只需要關(guān)注自己的消息處理即可，上面只是一個業(yè)務(wù)場景的使用演示

博文：

180628-動態(tài)任務(wù)執(zhí)行框架想法篇

180702-QuickTask動態(tài)腳本支持框架整體介紹篇

項目：

https://github.com/liuyueyi/quick-task

一灰灰的個人博客，記錄所有學(xué)習(xí)和工作中的博文，歡迎大家前去逛逛

盡信書則不如，已上內(nèi)容，純屬一家之言，因個人能力有限，難免有疏漏和錯誤之處，如發(fā)現(xiàn)bug或者有更好的建議，歡迎批評指正，不吝感激

微博地址: 小灰灰Blog

QQ： 一灰灰/3302797840