【Java】一个标准的后台线程的封装

前言:

我们日常总会碰到这样的需求:

  • 把这个任务放到另外一个线程执行。
  • 我需要周期性执行任务的线程。那我们通常都是怎么解决这个问题呢?
  • 对于问题1,最简单的做法就是new thread,然后结束了。但在生产环境中,你常常会困扰,我这个线程到底执行没,或者是否正在执行。任务报错了日志在哪里呢?
  • 对于问题2,我们可能会选择定时器,ScheduledExecutor,但如果你想追踪你的线程运行情况,或者捕获异常,这都没法随心所欲

针对上面常见的两个问题,我自己封装了一个标准的后台线程模型

一、完整代码实现

/**
 * DefaultThread 后台标准线程
 */
public final class DefaultThread extends Thread {
    /** log */
    private static final Logger log = InternalLoggerFactory.getLogger(DefaultThread.class);
    
    /** 标准后台线程循环间隔时间 - 1分钟 */
    public static final long DEFAULT_INTERVAL = 60 * 1000;
    /** 标准后台线程循环最小间隔 - 300ms */
    public static final long MIN_INTERVAL = 300;
    
    /** 默认日志输出级别 -- debug */
    public static final LogLevel DEFAULT_LEVEL = LogLevel.DEBUG;
    
    private String name;
    private Runnable runnable;
    private boolean runOnce;
    private volatile boolean stop;
    private volatile long interval;
    private volatile LogLevel level = DEFAULT_LEVEL;
   
    /**
     * 构造函数
     * <p>将构造一个标准后台线程,每分钟运行1次
     * @param name
     * @param runnable
     */
    public DefaultThread(String name, Runnable runnable) {
        super(name);
        this.name = name;
        this.runnable = runnable;
        this.runOnce = false;
        this.stop = false;
        this.interval = DEFAULT_INTERVAL;
    }
    
    /**
     * 构造函数
     * <p>将构造一个标准后台线程
     * @param name
     * @param runnable
     * @param runOnce
     * @param interval
     */
    public DefaultThread(String name, Runnable runnable, boolean runOnce) {
        super(name);
        this.name = name;
        this.runnable = runnable;
        this.runOnce = runOnce;
        this.stop = false;
        this.interval = DEFAULT_INTERVAL;
    }
    
    /**
     * 构造函数
     * <p>将构造一个标准后台线程,指定间隔运行一次(不能小于最小间隔时间{@link #MIN_INTERVAL}})
     * @param name
     * @param runnable
     * @param runOnce
     * @param interval
     */
    public DefaultThread(String name, Runnable runnable, long interval) {
        super(name);
        this.name = name;
        this.runnable = runnable;
        this.runOnce = false;
        this.stop = false;
        this.interval = Math.max(MIN_INTERVAL, interval);
    }
    
    @Override
    public void start() {
        super.start();
    }

    public void stop() {
        try {
            this.interrupt();
        } catch (Exception e) {
            // Ignore
        }
        this.stop = true;
    }

    /**
     * 获得线程名称
     */
    public String getThreadName() {
        return this.name;
    }
    
    /**
     * 设置日志隔离级别
     */
    public void setLogLevel(LogLevel level) {
        this.level = level;
    }
    
    /**
     * 执行任务
     * @see java.lang.Thread#run()
     */
    public final void run() {
        if (runOnce) {
            runOnce();
            return;
        }
        
        while (!stop) {
            runOnce();
            
            try {
                sleep(interval);
            } catch (InterruptedException e) {
                // Ignore this Exception
            }
        }
    }

    /**
     * 执行一次
     */
    private void runOnce() {
        long startTime = 0;
        if (log.isLogEnabled(level)) {
            startTime = System.currentTimeMillis();
        }
        
        try {
            runnable.run();
        } catch (Throwable t) {
            log.error("thread run error [name:{}, runOnce:{}]", t, name, runOnce);
        }
        
        if (log.isLogEnabled(level)) {
            log.log(level, "{}#{}", (System.currentTimeMillis() - startTime));
        }
    }

二、代码解读

线程名称变成强制性
创建标准线程,必须指定线程名称,这是为了方便在jstack等工具中追踪

可以定义为周期性执行
周期性执行中做了预防措施,防止定义过小的周期,引起死循环,占用过高CPU

每次执行可追踪
每次执行,如果在debug模式下将记录执行时间,对执行异常也进行捕获打印日志,方便追踪bug

线程可停止
Java提供的线程并没有提供停止方法,该封装中通过一个标志位实现该功能,能够中断线程

结语:

线程虽然简单,但在实际使用中也要注意规范,每个线程都是随意new,随意使用的话会造成后续维护,bug追踪方便极大的困难。建议项目中的线程都遵从同一个标准。本文仅是个人实践拙见,欢迎拍砖!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,117评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,963评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,897评论 0 240
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,805评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,208评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,535评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,797评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,493评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,215评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,477评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,988评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,325评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,971评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,807评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,544评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,455评论 2 266

推荐阅读更多精彩内容