在 Spring 启动时执行方法

Question

当应用程序第一次启动时，是否有任何 Spring 3 功能可以执行某些方法？ 我知道我可以用@Scheduled注释设置一个方法，它会在启动后立即执行，但它会定期执行。

Answer 1

如果“应用程序启动”是指“应用程序上下文启动”，那么是的，有很多方法可以做到这一点，最简单的（无论如何对于单例 bean）是使用@PostConstruct注释您的方法。 查看链接以查看其他选项，但总而言之，它们是：

• 用@PostConstruct注释的方法
• afterPropertiesSet()由InitializingBean回调接口定义
• 自定义配置的 init() 方法

从技术上讲，这些是bean生命周期的钩子，而不是上下文生命周期，但在 99% 的情况下，两者是等效的。

如果您需要专门挂钩上下文启动/关闭，那么您可以改为实现Lifecycle接口，但这可能是不必要的。

Answer 2

这可以通过ApplicationListener轻松完成。 我让这个工作听 Spring 的ContextRefreshedEvent ：

import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.stereotype.Component;

@Component
public class StartupHousekeeper implements ApplicationListener<ContextRefreshedEvent> {

  @Override
  public void onApplicationEvent(final ContextRefreshedEvent event) {
    // do whatever you need here 
  }
}

应用程序侦听器在 Spring 中同步运行。 如果你想确保你的代码只执行一次，只需在你的组件中保留一些状态。

更新

与Spring 4.2+，你也可以使用开始@EventListener注释观察ContextRefreshedEvent （感谢@bphilipnyc指出这一点）：

import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.stereotype.Component;

@Component
public class StartupHousekeeper {

  @EventListener(ContextRefreshedEvent.class)
  public void contextRefreshedEvent() {
    // do whatever you need here 
  }
}

Answer 3

在 Spring 4.2+ 中，您现在可以简单地执行以下操作：

@Component
class StartupHousekeeper {

    @EventListener(ContextRefreshedEvent.class)
    public void contextRefreshedEvent() {
        //do whatever
    }
}

Answer 4

如果您使用的是 spring-boot，这是最好的答案。

我觉得@PostConstruct和其他各种生命周期感叹词都是迂回的方式。 由于意外的 bean/上下文生命周期事件，这些可能直接导致运行时问题或导致不太明显的缺陷。 为什么不直接使用纯 Java 调用您的 bean？ 您仍然以“弹簧方式”调用 bean（例如：通过弹簧 AoP 代理）。 最重要的是，它是纯 java，没有比这更简单的了。 不需要上下文侦听器或奇怪的调度程序。

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext app = SpringApplication.run(DemoApplication.class, args);

        MyBean myBean = (MyBean)app.getBean("myBean");

        myBean.invokeMyEntryPoint();
    }
}

Answer 5

使用 SpringBoot，我们可以通过@EventListener注解在启动时执行一个方法

@Component
public class LoadDataOnStartUp
{   
    @EventListener(ApplicationReadyEvent.class)
    public void loadData()
    {
        // do something
    }
}

Answer 6

对于在尝试引用 @PostConstruct 注释时收到警告的 Java 1.8 用户，我最终选择了使用 @Scheduled 注释，如果您已经有一个带有 fixedRate 或 fixedDelay 的 @Scheduled 作业，您可以这样做。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

@EnableScheduling
@Component
public class ScheduledTasks {

private static final Logger LOGGER = LoggerFactory.getLogger(ScheduledTasks.class);

private static boolean needToRunStartupMethod = true;

    @Scheduled(fixedRate = 3600000)
    public void keepAlive() {
        //log "alive" every hour for sanity checks
        LOGGER.debug("alive");
        if (needToRunStartupMethod) {
            runOnceOnlyOnStartup();
            needToRunStartupMethod = false;
        }
    }

    public void runOnceOnlyOnStartup() {
        LOGGER.debug("running startup job");
    }

}

Answer 7

我们所做的是扩展org.springframework.web.context.ContextLoaderListener以在上下文启动时打印一些内容。

public class ContextLoaderListener extends org.springframework.web.context.ContextLoaderListener
{
    private static final Logger logger = LoggerFactory.getLogger( ContextLoaderListener.class );

    public ContextLoaderListener()
    {
        logger.info( "Starting application..." );
    }
}

然后在web.xml配置子类：

<listener>
    <listener-class>
        com.mycomp.myapp.web.context.ContextLoaderListener
    </listener-class>
</listener>

Answer 8

注意，仅当您的runOnceOnStartup方法依赖于完全初始化的 spring 上下文时才建议这样runOnceOnStartup 。 例如：你想调用一个带有事务划分的 dao

您还可以使用固定延迟设置非常高的预定方法

@Scheduled(fixedDelay = Long.MAX_VALUE)
public void runOnceOnStartup() {
    dosomething();
}

这样做的好处是整个应用程序都已连接起来（交易、Dao 等）

在调度任务运行一次中看到，使用 Spring 任务命名空间

Answer 9

发布了另一个实现 WebApplicationInitializer 的解决方案，并在任何 spring bean 实例化之前被调用，以防有人有该用例

使用 Spring 配置初始化默认语言环境和时区

Answer 10

AppStartListener implements ApplicationListener {
    @Override
    public void onApplicationEvent(ApplicationEvent event) {
        if(event instanceof ApplicationReadyEvent){
            System.out.print("ciao");

        }
    }
}

Answer 11

如果你想在你的应用程序完全运行之前配置一个 bean，你可以使用@Autowired ：

@Autowired
private void configureBean(MyBean: bean) {
    bean.setConfiguration(myConfiguration);
}

Answer 12

您可以在您的组件上使用@EventListener ，它将在服务器启动和所有 bean 初始化后调用。

@EventListener
public void onApplicationEvent(ContextClosedEvent event) {

}

Answer 13

对于文件StartupHousekeeper.java位于包com.app.startup ，

在StartupHousekeeper.java执行此StartupHousekeeper.java ：

@Component
public class StartupHousekeeper {

  @EventListener(ContextRefreshedEvent.class)
  public void keepHouse() {
    System.out.println("This prints at startup.");
  }
}

并在myDispatcher-servlet.java执行此myDispatcher-servlet.java ：

<?xml version="1.0" encoding="UTF-8"?>
<beans>

    <mvc:annotation-driven />
    <context:component-scan base-package="com.app.startup" />

</beans>