如何使用Spring Boot执行ApplicationRunner (Kotlin)

基础概念

ApplicationRunner 是 Spring Boot 提供的一个接口，用于在应用程序启动后执行一些初始化任务。它允许你在 Spring Boot 应用程序完全启动并准备好接收请求之前运行自定义代码。

类型与应用场景

单例模式：通常情况下，ApplicationRunner 实现类会被注册为单例 Bean。
多实例模式：如果需要多个实例，可以使用 @Order 注解来控制执行顺序。

应用场景包括但不限于：

数据库连接初始化
缓存预热
日志系统初始化
第三方服务的初始化

示例代码

以下是一个使用 Kotlin 实现 ApplicationRunner 的示例：

import org.springframework.boot.ApplicationArguments
import org.springframework.boot.ApplicationRunner
import org.springframework.stereotype.Component

@Component
class MyApplicationRunner : ApplicationRunner {

    override fun run(args: ApplicationArguments?) {
        println("Application started with arguments: ${args?.rawArgs}")
        // 在这里执行你的初始化任务
    }
}

遇到问题及解决方法

问题：`ApplicationRunner` 没有被执行

原因：

组件扫描问题：确保 MyApplicationRunner 类所在的包被 Spring Boot 应用程序的主类扫描到。
Bean 注册问题：确保 MyApplicationRunner 类被正确注解为 @Component 或其他 Spring 管理的注解。

解决方法：

确保主类上有 @SpringBootApplication 注解，并且它位于正确的包层次结构中。
检查 MyApplicationRunner 类是否被正确注解为 @Component。

@SpringBootApplication
class MyApplication

fun main(args: Array<String>) {
    runApplication<MyApplication>(*args)
}

问题：执行顺序问题

原因：如果有多个 ApplicationRunner 实现类，可能需要控制它们的执行顺序。

解决方法：使用 @Order 注解来指定执行顺序。

import org.springframework.boot.ApplicationArguments
import org.springframework.boot.ApplicationRunner
import org.springframework.core.annotation.Order
import org.springframework.stereotype.Component

@Component
@Order(1) // 数字越小优先级越高
class FirstApplicationRunner : ApplicationRunner {
    override fun run(args: ApplicationArguments?) {
        println("First runner executed")
    }
}

@Component
@Order(2)
class SecondApplicationRunner : ApplicationRunner {
    override fun run(args: ApplicationArguments?) {
        println("Second runner executed")
    }
}

通过这种方式，可以确保 FirstApplicationRunner 在 SecondApplicationRunner 之前执行。