1. 程式人生 > >基於ScheduledThreadPoolExecutor簡單封裝一個註解類的任務排程框架

基於ScheduledThreadPoolExecutor簡單封裝一個註解類的任務排程框架

先發使用方法,首先建立一個TestTask類,繼承TaskScheduler下面的Task類,實現run方法。設定RepeatTime註解,註解引數:period為重複時間,delay為等待時間,

package cn.bestmk.task;

import cn.bestmk.TaskScheduler.RepeatTime;
import cn.bestmk.TaskScheduler.Task;

@RepeatTime(period = 1000*10)
public class TestTask extends Task {
    @Override
    public void run() {
        System.out.println(System.currentTimeMillis());
    }
}

main方法中呼叫TaskScheduler.init("cn.bestmk.task");啟動任務排程器,引數為task所在包名,也可以傳父級包名,任務排程器能夠掃描到子包名,排程器預設過濾掉@Deprecated註解(過時)的類

接下來發排程器原始碼(TaskScheduler.java),一個檔案

import java.io.File;
import java.io.FileFilter;
import java.io.IOException;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.net.JarURLConnection;
import java.net.URL;
import java.net.URLDecoder;
import java.util.Enumeration;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

/**
 * Created BY 醉貓
 */
public class TaskScheduler {
    static ScheduledThreadPoolExecutor pool = new ScheduledThreadPoolExecutor(20);
    public static void init(String pkg){
        Set<Class<?>> classes = getClasses(pkg);
        classes.stream().forEach(aClass -> {
            Deprecated deprecated = aClass.getAnnotation(Deprecated.class);
            if (deprecated==null) {
                RepeatTime annotation = aClass.getAnnotation(RepeatTime.class);
                if (annotation==null)return;
                try {
                    Task task= (Task) aClass.newInstance();
                    scheduleJob(task,annotation.delay(),annotation.period());//開始任務排程
                } catch (Exception e){
                }
            }
        });
    }
    static void scheduleJob(Task task,long delay,long period){
        pool.scheduleWithFixedDelay(new Runnable() {
            @Override
            public void run() {
                try {
                    task.run();
                }catch (Exception e){}
            }
        }, delay, period, TimeUnit.MILLISECONDS);
    }
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface RepeatTime{
        long delay() default 0;
        long period();
    }
    public static abstract class Task{
        public abstract void run();
    }
    /**
     * 從包package中獲取所有的Class
     *
     * @param pack
     * @return
     */
    public static Set<Class<?>> getClasses(String pack) {

        // 第一個class類的集合
        Set<Class<?>> classes = new LinkedHashSet<Class<?>>();
        // 是否迴圈迭代
        boolean recursive = true;
        // 獲取包的名字 並進行替換
        String packageName = pack;
        String packageDirName = packageName.replace('.', '/');
        // 定義一個列舉的集合 並進行迴圈來處理這個目錄下的things
        Enumeration<URL> dirs;
        try {
            dirs = Thread.currentThread().getContextClassLoader().getResources(
                    packageDirName);
            // 迴圈迭代下去
            while (dirs.hasMoreElements()) {
                // 獲取下一個元素
                URL url = dirs.nextElement();
                // 得到協議的名稱
                String protocol = url.getProtocol();
                // 如果是以檔案的形式儲存在伺服器上
                if ("file".equals(protocol)) {
                    // 獲取包的物理路徑
                    String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
                    // 以檔案的方式掃描整個包下的檔案 並新增到集合中
                    findAndAddClassesInPackageByFile(packageName, filePath,
                            recursive, classes);
                } else if ("jar".equals(protocol)) {
                    // 如果是jar包檔案
                    // 定義一個JarFile
                    JarFile jar;
                    try {
                        // 獲取jar
                        jar = ((JarURLConnection) url.openConnection())
                                .getJarFile();
                        // 從此jar包 得到一個列舉類
                        Enumeration<JarEntry> entries = jar.entries();
                        // 同樣的進行迴圈迭代
                        while (entries.hasMoreElements()) {
                            // 獲取jar裡的一個實體 可以是目錄 和一些jar包裡的其他檔案 如META-INF等檔案
                            JarEntry entry = entries.nextElement();
                            String name = entry.getName();
                            // 如果是以/開頭的
                            if (name.charAt(0) == '/') {
                                // 獲取後面的字串
                                name = name.substring(1);
                            }
                            // 如果前半部分和定義的包名相同
                            if (name.startsWith(packageDirName)) {
                                int idx = name.lastIndexOf('/');
                                // 如果以"/"結尾 是一個包
                                if (idx != -1) {
                                    // 獲取包名 把"/"替換成"."
                                    packageName = name.substring(0, idx)
                                            .replace('/', '.');
                                }
                                // 如果可以迭代下去 並且是一個包
                                if ((idx != -1) || recursive) {
                                    // 如果是一個.class檔案 而且不是目錄
                                    if (name.endsWith(".class")
                                            && !entry.isDirectory()) {
                                        // 去掉後面的".class" 獲取真正的類名
                                        String className = name.substring(
                                                packageName.length() + 1, name
                                                        .length() - 6);
                                        try {
                                            // 新增到classes
                                            classes.add(Class
                                                    .forName(packageName + '.'
                                                            + className));
                                        } catch (ClassNotFoundException e) {
                                            // log
                                            // .error("新增使用者自定義檢視類錯誤 找不到此類的.class檔案");
                                            e.printStackTrace();
                                        }
                                    }
                                }
                            }
                        }
                    } catch (IOException e) {
                        // log.error("在掃描使用者定義檢視時從jar包獲取檔案出錯");
                        e.printStackTrace();
                    }
                }
            }
        } catch (IOException e) {
            e.printStackTrace();
        }

        return classes;
    }
    /**
     * 以檔案的形式來獲取包下的所有Class
     *
     * @param packageName
     * @param packagePath
     * @param recursive
     * @param classes
     */
    public static void findAndAddClassesInPackageByFile(String packageName,
                                                        String packagePath, final boolean recursive, Set<Class<?>> classes) {
        // 獲取此包的目錄 建立一個File
        File dir = new File(packagePath);
        // 如果不存在或者 也不是目錄就直接返回
        if (!dir.exists() || !dir.isDirectory()) {
            // log.warn("使用者定義包名 " + packageName + " 下沒有任何檔案");
            return;
        }
        // 如果存在 就獲取包下的所有檔案 包括目錄
        File[] dirfiles = dir.listFiles(new FileFilter() {
            // 自定義過濾規則 如果可以迴圈(包含子目錄) 或則是以.class結尾的檔案(編譯好的java類檔案)
            public boolean accept(File file) {
                return (recursive && file.isDirectory())
                        || (file.getName().endsWith(".class"));
            }
        });
        // 迴圈所有檔案
        for (File file : dirfiles) {
            // 如果是目錄 則繼續掃描
            if (file.isDirectory()) {
                findAndAddClassesInPackageByFile(packageName + "."
                                + file.getName(), file.getAbsolutePath(), recursive,
                        classes);
            } else {
                // 如果是java類檔案 去掉後面的.class 只留下類名
                String className = file.getName().substring(0,
                        file.getName().length() - 6);
                try {
                    // 新增到集合中去
                    //classes.add(Class.forName(packageName + '.' + className));
                    //經過回覆同學的提醒,這裡用forName有一些不好,會觸發static方法,沒有使用classLoader的load乾淨
                    classes.add(Thread.currentThread().getContextClassLoader().loadClass(packageName + '.' + className));
                } catch (ClassNotFoundException e) {
                    // log.error("新增使用者自定義檢視類錯誤 找不到此類的.class檔案");
                    e.printStackTrace();
                }
            }
        }
    }
}