Comment activer ou désactiver de manière conditionnelle les tâches planifiées dans Spring ?

Question

Je suis en train de définir des tâches planifiées avec des modèles de style cron dans Spring, en utilisant la fonction @Scheduled annotation.

Le modèle de cron est stocké dans un fichier de propriétés de configuration. En fait, il y a deux fichiers de propriétés : une configuration par défaut et une configuration de profil qui dépend de l'environnement (par exemple dev, test, prod client 1, prod client 2, etc.) et qui remplace certaines des valeurs par défaut.

J'ai configuré un bean placeholder de propriété dans mon contexte de printemps qui me permet d'utiliser ${} pour importer les valeurs de mes fichiers de propriétés.

Le travail des haricots ressemble à ceci :

@Component
public class ImagesPurgeJob implements Job {

    private Logger logger = Logger.getLogger(this.getClass());

    @Override
    @Transactional(readOnly=true)
    @Scheduled(cron = "${jobs.mediafiles.imagesPurgeJob.schedule}")
    public void execute() {
        //Do something
            //can use DAO or other autowired beans here
    }
}

Parties pertinentes de mon contexte XML :

<!-- Enable configuration of scheduled tasks via annotations -->
    <task:annotation-driven/>

<!-- Load configuration files and allow '${}' style placeholders -->
    <bean class="org.springframework.context.support.PropertySourcesPlaceholderConfigurer">
        <property name="locations">
            <list>
                <value>classpath:config/default-config.properties</value>
                <value>classpath:config/environment-config.properties</value>
            </list>
        </property>
        <property name="ignoreUnresolvablePlaceholders" value="true"/>
        <property name="ignoreResourceNotFound" value="false"/>
    </bean>

J'aime vraiment ça. C'est assez simple et propre avec un minimum de XML.

J'ai toutefois une autre exigence : certains de ces emplois peuvent être totalement handicapés dans certains cas.

Donc, avant d'utiliser Spring pour les gérer, je les créais manuellement et il y a un paramètre booléen avec le paramètre cron dans les fichiers de configuration, pour spécifier si le travail doit être activé ou non :

jobs.mediafiles.imagesPurgeJob.enable=true or false
jobs.mediafiles.imagesPurgeJob.schedule=0 0 0/12 * * ?

Comment puis-je utiliser ce paramètre dans Spring pour créer conditionnellement ou tout simplement ignorer le bean, en fonction de ce paramètre de configuration ?

Une solution de contournement évidente serait de définir un modèle cron qui ne serait jamais évalué, de sorte que le travail ne soit jamais exécuté. Mais le bean serait quand même créé et la configuration serait un peu obscure, donc je pense qu'il doit y avoir une meilleure solution.

Answer 1

Nous pouvons désactiver la création de bean de la classe ayant ces méthodes planifiées en utilisant @Conditional annotation. Ceci est très similaire à @ConditionalOnProperty . Ceci est utilisé pour faire tourner conditionnellement un bean sur le contexte Spring. Si nous définissons la valeur à false alors le haricot ne sera pas filé et chargé au printemps. Voici le code.

application.properties:

    com.boot.enable.scheduling=enable

Condition :

public class ConditionalBeans implements Condition {
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        return "enabled".equalsIgnoreCase(context.getEnvironment().getProperty("com.boot.enable.scheduling"));
    }
}

Mon horaire de cours

@Service
@Conditional(ConditionalSchedules.class)
public class PrintPeriodicallyService {

    @Scheduled(fixedRate = 3000)
    public void runEvery3Seconds() {
        System.out.println("Current time : " + new Date().getTime());
    }
}

Cette approche offre une grande flexibilité, la génération des conditions étant totalement sous notre contrôle.