Spring Boot启动后运行代码

Question

我想在我的spring-boot应用程序开始监视目录以进行更改后运行代码.

我尝试过运行一个新线程,但此时@Autowired尚未设置服务.

我已经能够找到ApplicationPreparedEvent,在@Autowired注释设置之前触发.理想情况下,我希望在应用程序准备好处理http请求后触发该事件.

是否有更好的事件要使用,或者在应用程序在spring-boot中运行后运行代码的更好方法是什么？

Answer 1

这很简单:

@EventListener(ApplicationReadyEvent.class)
public void doSomethingAfterStartup() {
    System.out.println("hello world, I have just started up");
}

测试版本 1.5.1.RELEASE

Answer 2

尝试:

@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application extends SpringBootServletInitializer {

    @SuppressWarnings("resource")
    public static void main(final String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(Application.class, args);

        context.getBean(Table.class).fillWithTestdata(); // <-- here
    }
}

Answer 3

你试过ApplicationReadyEvent吗？

@Component
public class ApplicationStartup 
implements ApplicationListener<ApplicationReadyEvent> {

  /**
   * This event is executed as late as conceivably possible to indicate that 
   * the application is ready to service requests.
   */
  @Override
  public void onApplicationEvent(final ApplicationReadyEvent event) {

    // here your code ...

    return;
  }
}

代码来自:http://blog.netgloo.com/2014/11/13/run-code-at-spring-boot-startup/

这是文档提到的关于启动事件的内容:

...

应用程序运行时,应按以下顺序发送应用程序事件:

ApplicationStartedEvent在运行开始时发送,但在除侦听器和初始化程序注册之外的任何处理之前发送.

当要在上下文中使用的环境已知但在创建上下文之前,将发送ApplicationEnvironmentPreparedEvent.

ApplicationPreparedEvent在刷新开始之前发送,但是在加载bean定义之后发送.

刷新后发送ApplicationReadyEvent,并且已处理任何相关的回调以指示应用程序已准备好为请求提供服务.

如果启动时发生异常,则发送ApplicationFailedEvent.

...

Answer 4

为什么不创建一个在初始化时启动监视器的bean,例如:

@Component
public class Monitor {
    @Autowired private SomeService service

    @PostConstruct
    public void init(){
        // start your monitoring in here
    }
}

在init为bean完成任何自动装配之前,不会调用该方法.

Answer 5

"Spring Boot"方式是使用a CommandLineRunner.只需添加那种类型的豆子就可以了.在Spring 4.1(Boot 1.2)中,还有SmartInitializingBean一个在所有内容初始化后获得回调.还有SmartLifecycle(从春季开始).

Answer 6

您可以使用扩展类ApplicationRunner,重写该run()方法并在其中添加代码.

import org.springframework.boot.ApplicationRunner;

@Component
public class ServerInitializer implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments applicationArguments) throws Exception {

        //code goes here

    }
}

Answer 7

ApplicationReadyEvent实际上只有在您要执行的任务不是正确的服务器操作要求时才有用.启动异步任务以监视某些更改是一个很好的例子.

但是,如果您的服务器在任务完成之前处于"未就绪"状态,则最好实施,SmartInitializingSingleton因为您将在打开REST端口并且服务器开放营业之前获得回调.

不要试图@PostConstruct用于只应该发生过一次的任务.当你注意到它被多次调用时,你会得到一个粗鲁的惊喜......

Answer 8

配弹簧配置:

@Configuration
public class ProjectConfiguration {
    private static final Logger log = 
   LoggerFactory.getLogger(ProjectConfiguration.class);

   @EventListener(ApplicationReadyEvent.class)
   public void doSomethingAfterStartup() {
    log.info("hello world, I have just started up");
  }
}

Answer 9

SmartInitializingSingleton在spring> 4.1中使用bean

@Bean
public SmartInitializingSingleton importProcessor() {
    return () -> {
        doStuff();
    };

}

作为替代方案,CommandLineRunner可以实现bean或使用bean注释bean方法@PostConstruct.

Answer 10

在 Spring Boot 应用程序启动后执行代码块的最佳方法是使用 PostConstruct 注释。或者您也可以使用命令行运行程序。

1. 使用 PostConstruct 注解

@Configuration
public class InitialDataConfiguration {

    @PostConstruct
    public void postConstruct() {
        System.out.println("Started after Spring boot application !");
    }

}

2. 使用命令行 runner bean

@Configuration
public class InitialDataConfiguration {

    @Bean
    CommandLineRunner runner() {
        return args -> {
            System.out.println("CommandLineRunner running in the UnsplashApplication class...");
        };
    }
}

Answer 11

我真的很喜欢EventListener@cahen ( /sf/answers/3144638171/ )使用注释的建议，因为它非常干净。不幸的是，我无法在 Spring + Kotlin 设置中使用它。对 Kotlin 有用的是将类添加为方法参数：

@EventListener 
fun doSomethingAfterStartup(event: ApplicationReadyEvent) {
    System.out.println("hello world, I have just started up");
}

Answer 12

您有多种选择：

使用CommandLineRunnerorApplicationRunner作为 Bean 定义：

Spring Boot 在应用程序启动过程快结束时执行这些。在大多数情况下，意志CommandLineRunner可以完成这项工作。以下是使用 Java 8 实现 CommandLineRunner 的示例：

@Bean
public CommandLineRunner commandLineRunner() {
   return (args) -> System.out.println("Hello World");
}

请注意，这args是参数的字符串数组。您还可以提供此接口的实现并将其定义为 Spring 组件：

@Component
public class MyCommandLineRunner implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        System.out.println("Hello World");
    }
}

如果您需要更好的参数管理，您可以使用ApplicationRunner。ApplicationRunner 采用ApplicationArguments具有增强参数管理选项的实例。

您还可以使用 Spring 的注释来订购 CommandLineRunner和beans ：ApplicationRunner@Order

 @Bean
 @Order(1)
 public CommandLineRunner commandLineRunner() {
    return (args) -> System.out.println("Hello World, Order 1");
 }

 @Bean
 @Order(2)
 public CommandLineRunner commandLineRunner() {
    return (args) -> System.out.println("Hello World, Order 2");
 }

使用Spring Boot的ContextRefreshedEvent：

Spring Boot 在启动时发布多个事件。这些事件指示应用程序启动过程中的一个阶段的完成。您可以监听ContextRefreshedEvent并执行自定义代码：

@EventListener(ContextRefreshedEvent.class)
public void execute() {
    if(alreadyDone) {
      return;
    }
    System.out.println("hello world");
} 

ContextRefreshedEvent已发表多次。因此，请确保检查代码执行是否已完成。

Answer 13

Spring boot 提供了一个 ApplicationRunner 接口，其中包含一个在应用程序启动时调用的 run() 方法。但是，我们没有传递给回调方法的原始 String 参数，而是有一个 ApplicationArguments 类的实例。

@Component
public class AppStartupRunner implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        //some logic here
    }
}

Answer 14

提供一个Dave Syer答案的示例，该示例的工作原理很不错：

@Component
public class CommandLineAppStartupRunner implements CommandLineRunner {
    private static final Logger logger = LoggerFactory.getLogger(CommandLineAppStartupRunner.class);

    @Override
    public void run(String...args) throws Exception {
        logger.info("Application started with command-line arguments: {} . \n To kill this application, press Ctrl + C.", Arrays.toString(args));
    }
}

Answer 15

试试这个，当应用程序上下文完全启动时，它将运行您的代码。

 @Component
public class OnStartServer implements ApplicationListener<ContextRefreshedEvent> {

    @Override
    public void onApplicationEvent(ContextRefreshedEvent arg0) {
                // EXECUTE YOUR CODE HERE 
    }
}