浅析Spring-Lifecycle的使用

红太狼 2024-03-24 06:25 50阅读 0赞

## 前言 ##

如果我想在容器本身的生命周期（比如容器启动、停止）上做一些工作怎么办呢？Spring 提供了以下接口。

### Lifecycle ###

定义启动/停止生命周期方法的通用接口。

public interface Lifecycle {
    
        /**
         * 容器启动后调用
         */
    	void start();
    
    
        /**
         * 容器停止时调用
         */
    	void stop();
            
       /**
         * 检查此组件是否正在运行。
         * 1. 只有该方法返回false时，start方法才会被执行。
         * 2. 只有该方法返回true时，stop()方法才会被执行。
         */
    	boolean isRunning();
    
    }
    复制代码

#### 自定义Lifecycle实现类 ####

@Component
    public class CustomizeLifecycle implements Lifecycle {
    
    	private volatile boolean running = false;
    
    	@Override
    	public void start() {
    		running = true;
    		System.out.println("start ==== ");
    	}
    
    	@Override
    	public void stop() {
    		running = false;
    		System.out.println("stop ==== ");
    	}
    
    	@Override
    	public boolean isRunning() {
    		return running;
    	}
    }
    复制代码

#### 测试 ####

@ComponentScan(basePackages = {"com.gongj.lifecycle"})
    public class AppApplication {
    
    
    	public static void main(String[] args) {
    		AnnotationConfigApplicationContext context =
    				new AnnotationConfigApplicationContext(AppApplication.class);
    		context.start();
    		context.stop();
    	}
    }
    
    结果：
    isRunning ====> false
    start ====> 
    isRunning ====> true
    stop ====> 
    复制代码

使用 `Lifecycle`这种方式，需要显示的调用容器的 `start`、`stop`方法。 显得笨重，所以我们使用另外一种方式 ：`SmartLifecycle`。

### SmartLifecycle ###

public interface SmartLifecycle extends Lifecycle, Phased {
    
    	int DEFAULT_PHASE = Integer.MAX_VALUE;
    
    	default boolean isAutoStartup() {
    		return true;
    	}
    
    	default void stop(Runnable callback) {
    		stop();
    		callback.run();
    	}
    
    	@Override
    	default int getPhase() {
    		return DEFAULT_PHASE;
    	}
    
    }
    复制代码

看到的源码定义，`SmartLifecycle`除了继承`Lifecycle`之外，还继承了 `Phased`。并且新增了几个方法：

*  isAutoStartup：是否自动启动。为 treu，则自动调用`start()`；为 false，则需要显示调用 `start()`。
 *  stop：当 isRunning 方法返回 true 时，该方法才会被调用。
 *  getPhase：来自于 `Phased` 接口，当容器中有多个实现了 `SmartLifecycle`的类，这个时候可以依据 `getPhase`方法返回值来决定`start` 方法、 `stop`方法的执行顺序。 `start` 方法执行顺序按照 `getPhase`方法返回值从小到大执行，而 `stop`方法则相反。比如： 启动时：1 比 3 先执行，-1 比 1 先执行，退出时：3 比 1 先退出，1 比 -1 先退出。

#### 自定义SmartLifecycle实现类 ####

@Component
    public class CustomizeSmartLifecycle implements SmartLifecycle {
    
    	private volatile boolean running = false;
    
    	@Override
    	public void start() {
    		running = true;
    		System.out.println("CustomizeSmartLifecycle start()");
    	}
    
    	@Override
    	public void stop() {
    		System.out.println("CustomizeSmartLifecycle stop()");
    		running = false;
    	}
    
    	@Override
    	public boolean isRunning() {
    		System.out.println("CustomizeSmartLifecycle isRunning() ==== " + running);
    		return running;
    	}
    
    	@Override
    	public boolean isAutoStartup() {
    		return true;
    	}
    
    	@Override
    	public void stop(Runnable callback) {
    		System.out.println("CustomizeSmartLifecycle stop(Runnable callback)");
    		callback.run();
    	}
    
    	@Override
    	public int getPhase() {
    		return 1;
    	}
    }
    复制代码