快捷導(dǎo)航

Spring @Order注解的使用小結(jié)

更新時間：2025年01月31日 10:28:13 作者：立小言先森

本文主要介紹了Spring @Order注解的使用小結(jié),文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

1.@Order的注解源碼解讀
2.Ordered接口類
3.創(chuàng)建BlackPersion、YellowPersion類，這兩個類都實現(xiàn)CommandLineRunner
4.啟動應(yīng)用程序打印出結(jié)果
5.到這里可能會疑惑IOC容器是如何根據(jù)優(yōu)先級值來先后執(zhí)行程序的，那接下來看容器是如何加載component的

注解@Order或者接口Ordered的作用是定義Spring IOC容器中Bean的執(zhí)行順序的優(yōu)先級，而不是定義Bean的加載順序，Bean的加載順序不受@Order或Ordered接口的影響；

1.@Order的注解源碼解讀

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
@Documented
public @interface Order {

	/**
	 * 默認(rèn)是最低優(yōu)先級,值越小優(yōu)先級越高
	 */
	int value() default Ordered.LOWEST_PRECEDENCE;

}

注解可以作用在類(接口、枚舉)、方法、字段聲明（包括枚舉常量）；
注解有一個int類型的參數(shù)，可以不傳，默認(rèn)是最低優(yōu)先級；
通過常量類的值我們可以推測參數(shù)值越小優(yōu)先級越高；

2.Ordered接口類

package org.springframework.core;

public interface Ordered {
    int HIGHEST_PRECEDENCE = -2147483648;
    int LOWEST_PRECEDENCE = 2147483647;

    int getOrder();
}

3.創(chuàng)建BlackPersion、YellowPersion類，這兩個類都實現(xiàn)CommandLineRunner

實現(xiàn)CommandLineRunner接口的類會在Spring IOC容器加載完畢后執(zhí)行，適合預(yù)加載類及其它資源；也可以使用ApplicationRunner,使用方法及效果是一樣的

package com.yaomy.common.order;

import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

/**
 * @Description: Description
 * @ProjectName: spring-parent
 * @Version: 1.0
 */
@Component
@Order(1)
public class BlackPersion implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("----BlackPersion----");
    }
}

package com.yaomy.common.order;

import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

/**
 * @Description: Description
 * @ProjectName: spring-parent
 * @Version: 1.0
 */
@Component
@Order(0)
public class YellowPersion implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("----YellowPersion----");
    }
}

4.啟動應(yīng)用程序打印出結(jié)果

----YellowPersion----
----BlackPersion----

我們可以通過調(diào)整@Order的值來調(diào)整類執(zhí)行順序的優(yōu)先級，即執(zhí)行的先后；當(dāng)然也可以將@Order注解更換為Ordered接口，效果是一樣的

5.到這里可能會疑惑IOC容器是如何根據(jù)優(yōu)先級值來先后執(zhí)行程序的，那接下來看容器是如何加載component的

看如下的啟動main方法

@SpringBootApplication
public class CommonBootStrap {
    public static void main(String[] args) {
        SpringApplication.run(CommonBootStrap.class, args);
    }
}

這個不用過多的解釋，進入run方法…

    public ConfigurableApplicationContext run(String... args) {
        StopWatch stopWatch = new StopWatch();
        stopWatch.start();
        ConfigurableApplicationContext context = null;
        Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList();
        this.configureHeadlessProperty();
        SpringApplicationRunListeners listeners = this.getRunListeners(args);
        listeners.starting();

        Collection exceptionReporters;
        try {
            ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
            ConfigurableEnvironment environment = this.prepareEnvironment(listeners, applicationArguments);
            this.configureIgnoreBeanInfo(environment);
            Banner printedBanner = this.printBanner(environment);
            context = this.createApplicationContext();
            exceptionReporters = this.getSpringFactoriesInstances(SpringBootExceptionReporter.class, new Class[]{ConfigurableApplicationContext.class}, context);
            this.prepareContext(context, environment, listeners, applicationArguments, printedBanner);
            this.refreshContext(context);
            this.afterRefresh(context, applicationArguments);
            stopWatch.stop();
            if (this.logStartupInfo) {
                (new StartupInfoLogger(this.mainApplicationClass)).logStarted(this.getApplicationLog(), stopWatch);
            }

            listeners.started(context);
            //這里是重點，調(diào)用具體的執(zhí)行方法
            this.callRunners(context, applicationArguments);
        } catch (Throwable var10) {
            this.handleRunFailure(context, var10, exceptionReporters, listeners);
            throw new IllegalStateException(var10);
        }

        try {
            listeners.running(context);
            return context;
        } catch (Throwable var9) {
            this.handleRunFailure(context, var9, exceptionReporters, (SpringApplicationRunListeners)null);
            throw new IllegalStateException(var9);
        }
    }
   private void callRunners(ApplicationContext context, ApplicationArguments args) {
        List<Object> runners = new ArrayList();
        runners.addAll(context.getBeansOfType(ApplicationRunner.class).values());
        runners.addAll(context.getBeansOfType(CommandLineRunner.class).values());
        //重點來了，按照定義的優(yōu)先級順序排序
        AnnotationAwareOrderComparator.sort(runners);
        Iterator var4 = (new LinkedHashSet(runners)).iterator();
        //循環(huán)調(diào)用具體方法
        while(var4.hasNext()) {
            Object runner = var4.next();
            if (runner instanceof ApplicationRunner) {
                this.callRunner((ApplicationRunner)runner, args);
            }

            if (runner instanceof CommandLineRunner) {
                this.callRunner((CommandLineRunner)runner, args);
            }
        }

    }

    private void callRunner(ApplicationRunner runner, ApplicationArguments args) {
        try {
            //執(zhí)行方法
            runner.run(args);
        } catch (Exception var4) {
            throw new IllegalStateException("Failed to execute ApplicationRunner", var4);
        }
    }

    private void callRunner(CommandLineRunner runner, ApplicationArguments args) {
        try {
            //執(zhí)行方法
            runner.run(args.getSourceArgs());
        } catch (Exception var4) {
            throw new IllegalStateException("Failed to execute CommandLineRunner", var4);
        }
    }