SpringApplication的几种常用方式

  在之前的两篇SpringBoot 入门介绍中，都使用了在main方法中执行SpringApplication.run()这种方式来启动我们的工程

// 方式一

@SpringBootApplication public class Application {

 

    public static void main(String[] args) {

        SpringApplication.run(Application.class, args);

    }

 

}

  如果我们需要在SpringBoot启动过程中添加一些定制代码（如定制启动Banner，设置自定义监听器等），这种方式就无法满足我们的要求了，因此，官方文档提供了其他的启动方式来满足我们定制需求。在给出官方文档提供的启动方式之前，我们进入SpringApplication.run()方法简单看下底层做了些什么作。

  可以看到，SpringApplication.run()的底层其实就是new了一个SpringApplication的对象，并执行run()方法，run()方法里面执行了哪些动作在之后的文章中详细说明。接着我们来看官方文档提供的启动方式

// 方式二public static void main(String[] args) {

    SpringApplication app = new SpringApplication(MySpringConfiguration.class);

    app.run(args);

}

• 5

到了这里，就不在多说什么了。
  有时我们需要创建多层次的ApplicationContext （例如，父子关系的Spring的ApplicationContext 和SpringMVC），这时我们可以使用官方提供的另外一种“平滑”的API调用方式来启动工程，即使用SpringApplicationBuilder讲多个方法调用串起来，通过parent() 和 child()来创建多层次的ApplicationContext。如果查看底层代码，可以看到除了调用child()方法略有不同，其他的和前两种方法几乎一样。

// 方式三public static void main(String[] args) {

    new SpringApplicationBuilder()

        .sources(Parent.class)

        .child(Application.class)

        .run(args);

}

以上三方式是SpringBoot最常用的启动方式，当然，官方还提供了通过配置application.properties文件在SpringBoot启动过程中添加一些定制逻辑的方案。

二、定制启动Banner

  如果在启动时，打印的如下这个图案（Banner）不符合我们的审美咋办？如果我们要在图案中加入公司标志或者版权声明咋办？如果我们不想打印Banner咋办？

 

  SpringBoot为我们提供了修改Banner的方法。我们可以在类路径下banner.txt、banner.gif、banner.jpg或者banner.png来定制Banner（banner.gif、banner.jpg或者banner.png会“翻译”成对应的ASCII艺术图案），当然，我们也可以在SpringBoot配置文件中指定banner.location或者banner.image.location对应的Banner路径来定制Banner。
  需要注意的是，当文本文件（banner.txt）和图像文件（banner.gif/jpg/png）是可以同时在控制台显示，但如果有多个图像文件，只会显示其中排序靠后的一个（即优先级png>jpg>gif）。

在banner.txt中还支持使用一些变量：
spring−boot.version：SpringBoot的版本spring−boot.version：SpringBoot的版本{spring-boot.formatted-version}：格式化后的SpringBoot的版本
application.version：应用版本（在MANIFEST.MF文件中定义）application.version：应用版本（在MANIFEST.MF文件中定义）{application.formatted-version}：格式化后的应用版本（在MANIFEST.MF文件中定义）
application.title：应用名称（在MANIFEST.MF文件中定义）application.title：应用名称（在MANIFEST.MF文件中定义）{Ansi.NAME} (AnsiColor.NAME,AnsiColor.NAME,{AnsiBackground.NAME}, ${AnsiStyle.NAME})： ANSI控制码

 

  如果我们通过代码生成定制的Banner，那么可以自己实现Banner接口，通过实现printBanner()方法，并结合使用SpringApplication.setBanner(​)或者SpringApplicationBuilder.banner()的方式来打印定制的Banner。

  如果我们不想打印Banner，可以使用通过在代码中设置Banner.Mode.OFF的方式关闭Banner打印。当然，也可以通过在配置文件中设置 spring.main.banner-mode=off 的方式进行关闭。

@SpringBootApplicationpublic class Application {

 

    public static void main(String[] args) {

        SpringApplication application = new SpringApplication(Application.class);

        // 方式一

        application.setBannerMode(Banner.Mode.OFF);

        application.run(args);

 

         // 方式二

        /*new SpringApplicationBuilder()

                .sources(Application.class)

                .bannerMode(Banner.Mode.OFF)

                .run(args);*/

    }

}

 

三、SpringBoot事件和监听器

  事件是用来通知监听事件的监听器某件事情的处理状态，在SpringBoot启动过程中，除了Spring框架的事件外，SpringBoot还会触发其他的一些事件，这些事件按下列顺序触发：
（1）ApplicationStartingEvent：项目刚启动时触发，此时除了注册监听器和初始器之外，其他所有处理都没有开始；
（2）ApplicationEnvironmentPreparedEvent：上下文得到环境信息之后触发，此时上下文创建还没有创建；
（3）ApplicationPreparedEvent：bean的定义信息加载完成之后触发，此时bean还没有初始化；
（4）ApplicationReadyEvent：在所有bean初始化完毕，所有回调处理完成，系统准备处理服务请求时触发；
（5）ApplicationFailedEvent：启动过程出现异常时候触发。

  知道SpringBoot启动时发送的时间后，我们就能自定义监听器对这些事件进行监听，从而达到扩展启动流程的目的。我们的自定义监听器需要实现ApplicationListener接口，同时指定需要监听哪个事件。

 

  然后在main方法中，将自定义监听器加入到SpringApplication中。

 

  除了上述代码的方式添加监听器外，还可以通过在classpath下创建META-INF/spring.factories文件，并将自定义监听器通过键值对的形式（org.springframework.context.ApplicationListener = com.qzc.demo4.MyListener）加入到SpringApplication中。

 

  执行main方法启动工程

 

四、SpringBoot的Web环境信息

  ApplicationContext是Spring框架中一个很重要的接口，它扩展了BeanFactory，增加了很多常用的功能。SpringBoot启动过程中，SpringApplication通常会选择合适的ApplicationContext实现类，在默认情况下，如果是Web应用，则会创建AnnotationConfigEmbeddedWebApplicationContext类的对象；否则会创建AnnotationConfigApplicationContext类的对象。
  通过查看SpringApplication,run()的底层代码，可以看到，创建什么类型的ApplicationContext是由 webEnvironment 这个布尔变量来决定的，而 webEnvironment 这个变量是由项目的classpath下是否存在javax.servlet.Servlet或者org.springframework.web.context.ConfigurableWebApplicationContext，如果存在其中的一个，则为true；否则为false。

 

  我们可以通过SpringApplication.setWebEnvironment()方法来改变webEnvironment 变量从而改变ApplicationContext的具体类型。当然，我们还可以通过setApplicationContextClass()方法来完全定制ApplicationContext。

        SpringApplication application = new SpringApplication(Application.class);

        application.setWebEnvironment(false);

        // application.setApplicationContextClass(...);

        application.run(args);

 

五、SpringBoot的ApplicationRunner接口 和 CommandLineRunner接口

  如果我们想在SpringBoot启动时传入一些参数进行一些特殊的业务逻辑处理，此时我们可以去实现ApplicationRunner 或者 CommandLineRunner 接口，这两个接口都只有一个run()方法，该run()方法会在SpringApplication.run(​) 完成之前被调用。另外，如果我们有多个类实现了ApplicationRunner 或者 CommandLineRunner 接口，我们可以在该类上标注@Order注解或者让该类再实现org.springframework.core.Ordered接口来保证执行的顺序。
  ApplicationRunner 和 CommandLineRunner 的区别就是封装参数的形式不一样，ApplicationRunner将参数封装到ApplicationArguments类中，而CommandLineRunner 将参数传到String可变数组中。

@Component@Order(1) // 数值越小，优先级越高public class MyCommandLineRunner implements CommandLineRunner {//public class MyCommandLineRunner implements CommandLineRunner, Order {

    @Override

    public void run(String... args) {

        if (args != null) {

            for (String s : args) {

                System.out.println("MyCommandLineRunner:" + s);

            }

        }

    }

 

}

 

 

@Component@Order(2) // 数值越小，优先级越高public class MyApplicationRunner implements ApplicationRunner {// public class MyApplicationRunner implements ApplicationRunner, Order {

    @Override

    public void run(ApplicationArguments args) {

        if (args != null) {

            String[] argArr = args.getSourceArgs();

            for (String s : argArr) {

                System.out.println("MyApplicationRunner:" + s);

            }

        }

    }

}

 

@SpringBootApplicationpublic class Application {

 

    public static void main(String[] args) {

        SpringApplication application = new SpringApplication(Application.class);

        application.run(args);

    }

 

}

 

  在IDEA中进行如下配置