Exécution de la méthode au démarrage dans Spring

Question

Existe-t-il une fonctionnalité de Spring 3 permettant d'exécuter certaines méthodes lorsque l'application démarre pour la première fois ? Je sais que je peux faire l'astuce de définir une méthode avec @Scheduled et elle s'exécute juste après le démarrage, mais ensuite elle s'exécutera périodiquement.

Answer 1

Si par "démarrage de l'application" vous voulez dire "démarrage du contexte de l'application", alors oui, il y a plusieurs façons de procéder le plus simple (pour les beans singletons, en tout cas) étant d'annoter votre méthode avec @PostConstruct . Jetez un coup d'œil au lien pour voir les autres options, mais en résumé, elles sont les suivantes :

• Méthodes annotées avec @PostConstruct
• afterPropertiesSet() tel que défini par le InitializingBean interface de rappel
• Une méthode init() configurée de manière personnalisée

Techniquement, il s'agit de crochets dans le haricot plutôt que le cycle de vie du contexte, mais dans 99 % des cas, les deux sont équivalents.

Si vous avez besoin de vous brancher spécifiquement sur le contexte de démarrage/arrêt, alors vous pouvez mettre en œuvre la Lifecycle interface à la place, mais c'est probablement inutile.

Answer 2

Cela se fait facilement avec un ApplicationListener . J'ai réussi à le faire fonctionner en écoutant les chansons de 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 
  }
}

Les écouteurs d'application s'exécutent de manière synchrone dans Spring. Si vous voulez vous assurer que votre code n'est exécuté qu'une seule fois, il suffit de conserver un certain état dans votre composant.

UPDATE

À partir de la version 4.2+ de Spring, vous pouvez également utiliser la fonction @EventListener pour observer le ContextRefreshedEvent (merci à @bphilipnyc pour l'avoir signalé) :

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

Dans Spring 4.2+, vous pouvez maintenant simplement faire :

@Component
class StartupHousekeeper {

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

Answer 4

Si vous utilisez un pied à ressort, c'est la meilleure réponse.

J'ai l'impression que @PostConstruct et autres diverses interjections du cycle de vie sont des moyens détournés. Elles peuvent conduire directement à des problèmes d'exécution ou provoquer des défauts moins évidents dus à des événements inattendus du cycle de vie du bean/contexte. Pourquoi ne pas invoquer directement votre bean en utilisant Java ? Vous invoquez toujours le bean à la "manière Spring" (par exemple, via le proxy AoP de Spring). Et le mieux, c'est que c'est du simple Java, il n'y a pas plus simple que ça. Pas besoin d'écouteurs de contexte ou d'ordonnanceurs bizarres.

@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

Pour les utilisateurs de Java 1.8 qui reçoivent un avertissement lorsqu'ils essaient de faire référence à l'annotation @PostConstruct, j'ai fini par me servir de l'annotation @Scheduled, ce que vous pouvez faire si vous avez déjà un travail @Scheduled avec fixedRate ou fixedDelay.

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");
    }

}