springboot SmartLifeCycle说明

我就是我 2023-07-17 04:50 8阅读 0赞

--------------------

### springboot SmartLifeCycle说明 ###

**应用：在spring ioc容器创建之后、关闭之前执行自定义的操作**

## ##

### \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ###

**相关类及接口**

**LifeCycle**

public interface Lifecycle {
        void start();   //容器启动后调用
    
        void stop();    //容器关闭前调用
    
        boolean isRunning();  //当前应用是否正在运行
    }

**SmartLifeCycle**

public interface SmartLifecycle extends Lifecycle, Phased {
        int DEFAULT_PHASE = 2147483647;
    
        default boolean isAutoStartup() {  //自动调用start()、stop()方法，默认自动调用
            return true;
        }
    
        default void stop(Runnable callback) {
            this.stop();    //调用stop()方法
            callback.run(); //如果不调用该方法，等待30s关闭容器；如果调用了该方法，不需要等待就可关闭容器
        }
    
        default int getPhase() {  //如果有多个继承了SmartLifeCycle接口的类，返回值小的start()方法先调用，stop()方法相反
            return 2147483647;
        }
    }

**DefaultLifecycleProcessor**

public class DefaultLifecycleProcessor implements LifecycleProcessor, BeanFactoryAware {
        private final Log logger = LogFactory.getLog(this.getClass());
        private volatile long timeoutPerShutdownPhase = 30000L;
        private volatile boolean running;
        @Nullable
        private volatile ConfigurableListableBeanFactory beanFactory;
    
    ***************
    构造方法
    
        public DefaultLifecycleProcessor() {
        }
    
    ***************
    相关方法
    
        public void setTimeoutPerShutdownPhase(long timeoutPerShutdownPhase) {
            this.timeoutPerShutdownPhase = timeoutPerShutdownPhase;
        }//设置容器关闭时等待时间，默认为30s

### \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ###

**示例：stop(Runnable callback)使用默认方法，调用callback.run()**

**CustomSmartLifeCycle**

@Component
    public class CustomSmartLifeCycle implements SmartLifecycle {
    
        private boolean isRunning=false;
    
        public void setRunning(boolean running) {
            isRunning = running;
        }
    
        @Override
        public boolean isRunning() {
            return isRunning;
        }
    
        @Override
        public void start() {
            System.out.println("开始执行："+LocalDateTime.now());
            this.setRunning(true);
        }
    
        @Override
        public void stop() {
            System.out.println("stop："+ LocalDateTime.now());
            this.setRunning(false);
        }
    }

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**控制台输出**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70][]

**说明：ctrl+c，应用立即关闭**

### \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ###

**示例：stop(Runnable callback)不调用callback.run()**

**CustomSmartLifeCycle**

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**控制台输出**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 1][]

**说明：ctrl+c，应用在30s后关闭**

### \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ###

**示例：设置默认关闭时间**

**CustomSmartLifeCycle**

**WebConfig**

@Configuration
    public class WebConfig {
    
        @Bean("lifecycleProcessor")  //需指定bean的id：lifecycleProcessor
        public DefaultLifecycleProcessor initDefaultLifeCycleProcessor(){
            DefaultLifecycleProcessor defaultLifecycleProcessor=new DefaultLifecycleProcessor();
            defaultLifecycleProcessor.setTimeoutPerShutdownPhase(20000L);
    
            return defaultLifecycleProcessor;
        }
    }

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**控制台输出**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 2][]

**说明：默认关闭时间设置为20s**

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70]: /images/20230528/d291ca6c554146fa930b0ba776e7cb8b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 1]: /images/20230528/6aabaa1a98a343b0a5f2397e146ed545.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70 2]: /images/20230528/11149d9fad3645df9a3c3e2cf85b0745.png