好像知道的人不多?Spring容器关闭执行销毁方法有几种,看完MQ源码我才知道SmartLifecycle最快

什么是Spring的扩展点?

这个问题让我很深刻,记得之前有一个面试就被问到有没有使用过。

那他是什么?

先来看下Spring容器的加载过程

可以看到Bean从无到有主要是经历了四个步骤

就是在成熟态的时候,在初始化生命周期执行回调方法

主要是以接口或者注解的形式对外提供,注入到IOC容器中,完成对应的功能。

哪些场景下,我们需要使用退出前销毁

主要是希望在销毁之前在做一些事情,比如像池化技术正确的断开,JVM内存回收,还有业务逻辑执行。

业务场景

直接进入正题,我先说一说我的业务场景,在执行任务A的时候,这时候服务重启了,因为任务A加了分布式锁,所以在

重启服务的时候,补偿机制拿到了任务A发现锁依然被占用着,所以我就希望能够在应用关闭之前把锁给释放掉,减少

对补偿机制的影响。

补充:这里其实也可以用Redisson,来进行锁续期,一段时间过后自己释放,但是系统中更多时候使用简单的分布式

锁就可以满足,避免引入Redisson这么重的框架。

解决方案

将当前执行任务的redis锁记录下来

在Spring应用关系的时候,调用销毁方法进行锁的释放

采用SmartLifecycle和DisposableBean相互配合来执行destroy()方法

具体实现:

@Service

public class UserServiceImpl implements UserService, DisposableBean, SmartLifecycle {

    private volatile boolean running = false;

    private List<String> lockKeys = new ArrayList<>();

    @Resource

    HelloService helloService;

    @Override

    public void get() {

        String key = "redis:key";

        //伪代码

        RedissonUtil.lock(key);

        try {

            lockKeys.add(key);

        } catch (Exception ex){

            ex.printStackTrace();

            //...

        } finally {

            RedissonUtil.unlock(key);

            lockKeys.remove(key);

        }


    }

    @Override

    public void destroy() {

        // 删除正在执行中的key

        RedissonUtil.deletes(lockKeys);

        running = false;

    }

    @Override

    public void start() {

        System.out.println("start >>>>");

        running = true;

    }

    @Override

    public void stop() {

        System.out.println("stop >>>>");

        // 删除正在执行中的key

        RedissonUtil.deletes(lockKeys);

    }

    @Override

    public boolean isRunning() {

        return running;

    }

    @Override

    public int getPhase() {

        return Integer.MAX_VALUE;

    }

}

利用DisposableBean和SmartLifecycle进行双重的销毁机制,如果已经执行了DisposableBean的销毁方法

那可以修改running的值为false,就不会再进行stop()的执行了

Spring执行关闭的时机

1.JVM关闭

2.对象销毁时候

3.容器停止

关闭前执行销毁方法有哪些

1.DisposableBean

调用时机:Bean对象销毁的时候

@Service

public class UserServiceImpl implements UserService, DisposableBean {

    @Override

    public void destroy() {

        System.out.println("destroy>>>>>");

    }

}

2.SmartLifecycle

调用时机:Spring容器发出关闭通知

@Service

public class UserServiceImpl implements UserService, SmartLifecycle {

    @Override

    public void start() {

        System.out.println("start >>>>");

        running = true;

    }

    @Override

    public void stop() {

        System.out.println("stop >>>>");

    }

    @Override

    public boolean isRunning() {

        return running;

    }

    @Override

    public int getPhase() {

        return Integer.MAX_VALUE;

    }

}

3.InitializingBean

这个方式比较特殊,就是在初始化的时候,提前设置好了钩子函数addShutdownHook

调用时机:监听到JVM关闭

@Service

public class UserServiceImpl implements UserService, InitializingBean {

    @Override

    public void afterPropertiesSet() {

        Runtime.getRuntime().addShutdownHook(new Thread(() -> {

            helloService.get();

            System.out.println("addShutdownHook>>>>>");

        }));

    }

}

4.@PreDestroy注解

@PreDestroy

public void preDestroy(){

    System.out.println("PreDestroy>>>>");

}

5.Xml和@Bean绑定destoryMethod方法

对比执行结果:

SmartLifecycle > @PreDestroy,DisposableBean > addShutdownHook

2022-09-05 23:06:04.046 INFO 11807 --- [ main] c.l.d.SpringBootDemoDockerApplication : Started SpringBootDemoDockerApplication in 1.4 seconds (JVM running for 1.752)

ApplicationRunner>>>>>

CommandLineRunner>>>项目启动完毕后,倒数10秒关闭

thread1...

thread1...

thread1...

thread1...

stop >>>>

2022-09-05 23:06:14.054  INFO 11807 --- [          main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Shutting down ExecutorService 'applicationTaskExecutor'

PreDestroy>>>>

destroy>>>>>

thread1...

thread1...

get

addShutdownHook>>>>>

SmartLifecycle接口源码

了解一下SmartLifecycle接口到底由哪些组成的

/**

* 当上下文被刷新(所有对象已被实例化和初始化之后)时,将调用该方法

* isAutoStartup默认为true则调用start,否则需要自己手动调用

*/

@Override

public void start() {

    System.out.println("start >>>>");

    running = true;

}

/**

* 接口Lifecycle子类的方法,只有非SmartLifecycle的子类才会执行该方法。

* 1. 该方法只对直接实现接口Lifecycle的类才起作用,对实现SmartLifecycle接口的类无效。

* 2. 方法stop()和方法stop(Runnable callback)的区别只在于,后者是SmartLifecycle子类的专属。

*/

@Override

public void stop() {

    System.out.println("stop >>>>");

}

/**

* 只有该方法返回false时,start方法才会被执行

* 只有该方法返回true时,stop(Runnable callback)或stop()方法才会被执

* @return

*/

@Override

public boolean isRunning() {

    return running;

}

/**

* 返回 Integer.MAX_VALUE 仅表明

* 我们将是第一个关闭的 bean 和最后一个启动的 bean

* 关闭容器的第一时间调用stop()方法

*/

@Override

public int getPhase() {

    return Integer.MAX_VALUE;

}

/**

* 如果该`Lifecycle`类所在的上下文在调用`refresh`时,希望能够自己自动进行回调,则返回`true`,

* false的值表明组件打算通过显式的start()调用来启动,类似于普通的Lifecycle实现。

*/

@Override

public boolean isAutoStartup() {

    return false;

}

/**

* SmartLifecycle子类的才有的方法,当isRunning方法返回true时,该方法才会被调用。

* 很多框架中的源码中,都会把真正逻辑写在stop()方法内。

*/

@Override

public void stop(Runnable callback) {

    stop();

    // 如果你让isRunning返回true,需要执行stop这个方法

    // 在程序退出时,Spring的DefaultLifecycleProcessor会认为这个MySmartLifecycle没有stop完成,

    // 程序会一直卡着结束不了,等待一定时间(默认超时时间30秒)后才会自动结束。

    callback.run();

}

SmartLifecycle#isRunning判断是否已经执行,false表示还未执行

则调用SmartLifecycle#start()执行

当关闭的时候isRunning为ture已经执行

则调用SmartLifecycle#stop()执行

学习MQ如何进行退出前优雅执行销毁方法

DefaultRocketMQListenerContainer.class

public class DefaultRocketMQListenerContainer implements InitializingBean,

    RocketMQListenerContainer, SmartLifecycle, ApplicationContextAware {

    private final static Logger log = LoggerFactory.getLogger(DefaultRocketMQListenerContainer.class);

    private boolean running;

    ...


    @Override

    public void destroy() {

        this.setRunning(false);

        if (Objects.nonNull(consumer)) {

            consumer.shutdown();

        }

        log.info("container destroyed, {}", this.toString());

    }

    @Override

    public boolean isAutoStartup() {

        return true;

    }

    @Override

    public void stop(Runnable callback) {

        stop();

        callback.run();

    }

    @Override

    public void start() {

        if (this.isRunning()) {

            throw new IllegalStateException("container already running. " + this.toString());

        }

        try {

            consumer.start();

        } catch (MQClientException e) {

            throw new IllegalStateException("Failed to start RocketMQ push consumer", e);

        }

        this.setRunning(true);

        log.info("running container: {}", this.toString());

    }

    @Override

    public void stop() {

        if (this.isRunning()) {

            if (Objects.nonNull(consumer)) {

                consumer.shutdown();

            }

            setRunning(false);

        }

    }

    @Override

    public boolean isRunning() {

        return running;

    }

    private void setRunning(boolean running) {

        this.running = running;

    }

    @Override

    public int getPhase() {

        // Returning Integer.MAX_VALUE only suggests that

        // we will be the first bean to shutdown and last bean to start

        return Integer.MAX_VALUE;

    }

    @Override

    public void afterPropertiesSet() throws Exception {

        initRocketMQPushConsumer();

        this.messageType = getMessageType();

        this.methodParameter = getMethodParameter();

        log.debug("RocketMQ messageType: {}", messageType);

    }

}

RocketMQ在这里进行了几个步骤需要我们关注

1.他将getPhase的值设置为最大,在容器关闭的第一时间调用stop()方法

2.同时实现了SmartLifecycle和RocketMQListenerContainer接口,分别实现了stop()和destroy()方法,

3.进行双重关闭,如果和destroy()先执行了,则将running设置为false,不在执行stop()


原文链接:https://juejin.cn/post/7139920679683489823

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

推荐阅读更多精彩内容