Je définis des tâches planifiées avec des pattenrs de style cron au spring, à l’aide de l’annotation @Scheduled
.
Le modèle cron est stocké dans un fichier de propriétés de configuration. En fait, il existe 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 customer 1, prod customer 2, etc.) et remplace certaines des valeurs par défaut.
J’ai configuré un bean placeholder de propriété dans mon contexte de spring, ce qui me permet d’utiliser des espaces réservés de style ${}
pour importer des valeurs à partir de mes fichiers de propriétés.
Le bean job 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:
classpath:config/default-config.properties classpath:config/environment-config.properties
J’aime vraiment ça. C’est assez simple et propre avec un minimum de XML.
Cependant, j’ai une autre exigence: certains de ces emplois peuvent être totalement désactivés dans certains cas.
Donc, avant que j’utilise Spring pour les gérer, je les ai créées 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 utiliser ce paramètre dans Spring pour créer conditionnellement ou simplement ignorer le bean, en fonction de ce paramètre de configuration?
Une solution évidente consisterait à 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 toujours créé et la configuration serait un peu obscure, donc je pense qu’il doit y avoir une meilleure solution.
Une idée ?
@Component public class ImagesPurgeJob implements Job { private Logger logger = Logger.getLogger(this.getClass()); @Value("${jobs.mediafiles.imagesPurgeJob.enable}") private boolean imagesPurgeJobEnable; @Override @Transactional(readOnly=true) @Scheduled(cron = "${jobs.mediafiles.imagesPurgeJob.schedule}") public void execute() { //Do something //can use DAO or other autowired beans here if(imagesPurgeJobEnable){ Do your conditional job here... } } }
Spring Boot fournit @ConditionalOnProperty , ce qui serait parfait si vous utilisiez Spring Boot. Cette annotation est une spécialisation de @Conditional , introduite avec Spring 4.0.0.
En supposant que vous n’utilisez que le spring “ordinaire” et non le démarrage du spring, vous pouvez créer votre propre implémentation de condition pour l’utiliser avec @Conditional qui imiterait @ConditionalOnProperty de Spring Boot.
Vous pouvez regrouper les méthodes de planification par conditions dans un nombre de services et les initialiser comme suit:
@Service @ConditionalOnProperty("yourConditionPropery") public class SchedulingService { @Scheduled public void task1() {...} @Scheduled public void task2() {...} }
Votre question dit de conditionner la création réelle du haricot. Vous pouvez le faire facilement avec ce paramètre en utilisant @Profile si vous utilisez au moins Spring 3.1.
Voir la documentation ici: http://static.springsource.org/spring/docs/3.1.x/javadoc-api/org/springframework/context/annotation/Profile.html
@Component public class CurrencySyncServiceImpl implements CurrencySyncService { private static Boolean isEnableSync; /** * Currency Sync FixedDelay in minutes */ private static Integer fixedDelay; @Transactional @Override @Scheduled(fixedDelaySsortingng = "#{${currency.sync.fixedDelay}*60*1000}") public void sync() { if(CurrencySyncServiceImpl.isEnableSync) { //Do something //you can use DAO or other autowired beans here. } } @Value("${currency.sync.fixedDelay}") public void setFixedDelay(Integer fixedDelay) { CurrencySyncServiceImpl.fixedDelay = fixedDelay; } @Value("${currency.sync.isEnable}") public void setIsEnableSync(Boolean isEnableSync) { CurrencySyncServiceImpl.isEnableSync = isEnableSync; } }
Je sais que ma réponse est un hack, mais donner une expression cron valide qui ne s’exécute jamais peut résoudre le problème (dans la configuration spécifique de l’environnement), Quartz: expression Cron qui ne s’exécutera jamais
Si vous souhaitez basculer @EnableScheduling à partir d’une propriété, vous pouvez le faire dans Spring Boot en déplaçant l’annotation @EnableScheduling vers une classe de configuration et utilisez @ConditionalOnProperty comme suit:
@Configuration @EnableScheduling @ConditionalOnProperty(prefix = "com.example.scheduling", name="enabled", havingValue="true", matchIfMissing = true) public class SchedulingConfiguration { }
Cela désactivera la planification pour l’application. Cela peut être utile dans une situation où vous souhaitez pouvoir exécuter l’application une fois ou planifiée en fonction de son démarrage.
D’après le commentaire de Wilkinsona ici: https://github.com/spring-projects/spring-boot/issues/12682
Vous pouvez également créer un bean en fonction de la condition et que Bean peut avoir une méthode programmée.
@Component @Configuration @EnableScheduling public class CustomCronComponent { @Bean @ConditionalOnProperty(value = "my.cron.enabled", matchIfMissing = true, havingValue = "true") public MyCronTask runMyCronTask() { return new MyCronTask(); } }
et
@Component public class MyCronTask { @Scheduled(cron = "${my.cron.expression}") public void run() { Ssortingng a = ""; } }