DocumentationCommerceGuide de configuration

Configuration d’une tâche cron personnalisée

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Expérimenté
  • Administration
  • Développeur

Ce tutoriel détaillé explique comment créer une tâche cron personnalisée et éventuellement un groupe cron dans un exemple de module. Vous pouvez utiliser un module que vous avez déjà ou vous pouvez utiliser un exemple de module de notre référentiel magento2-samples.

L’exécution de la tâche cron entraîne l’ajout d’une ligne à la table cron_schedule avec le nom de la tâche cron, custom_cron.

Nous vous montrons également comment créer éventuellement un groupe cron, que vous pouvez utiliser pour exécuter des tâches cron personnalisées avec des paramètres autres que les paramètres par défaut de l’application Commerce.

Dans ce tutoriel, nous supposons que :

  • L’application Commerce est installée dans /var/www/html/magento2.
  • Le nom d'utilisateur et le mot de passe de votre base de données Commerce sont tous deux magento
  • Vous effectuez toutes les actions en tant que propriétaire du système de fichiers

Étape 1 : Obtention d’un exemple de module

Pour configurer une tâche cron personnalisée, vous avez besoin d’un exemple de module. Nous suggérons le module magento-module-minimal.

Si vous disposez déjà d’un exemple de module, vous pouvez l’utiliser. Ignorez cette étape et l’étape suivante et passez à l’étape 3 : Création d’une classe pour exécuter cron.

Pour obtenir un exemple de module :

  1. Connectez-vous à votre serveur Commerce en tant que propriétaire du système de fichiers ou passez à cet emplacement.

  2. Accédez à un répertoire qui ne se trouve pas dans la racine de votre application Commerce (par exemple, votre répertoire racine).

  3. Cloner le référentiel magento2-samples.

    code language-bash 
    git clone git@github.com:magento/magento2-samples.git

    Si la commande échoue avec l’erreur Permission denied (publickey)., vous devez ajouter votre clé publique SSH à GitHub.com.

  4. Créez un répertoire dans lequel copier l’exemple de code :

    code language-bash 
    mkdir -p /var/www/html/magento2/app/code/Magento/SampleMinimal

  5. Copiez l’exemple de code de module :

    code language-bash 
    cp -r ~/magento2-samples/sample-module-minimal/* /var/www/html/magento2/app/code/Magento/SampleMinimal

  6. Vérifiez correctement les fichiers copiés :

    code language-bash 
    ls -al /var/www/html/magento2/app/code/Magento/SampleMinimal

    Vous devriez voir le résultat suivant :

    code language-none 
    drwxrwsr-x.   4 magento_user apache  4096 Oct 30 13:19 .
drwxrwsr-x. 121 magento_user apache  4096 Oct 30 13:19 ..
-rw-rw-r--.   1 magento_user apache   372 Oct 30 13:19 composer.json
drwxrwsr-x.   2 magento_user apache  4096 Oct 30 13:19 etc
-rw-rw-r--.   1 magento_user apache 10376 Oct 30 13:19 LICENSE_AFL.txt
-rw-rw-r--.   1 magento_user apache 10364 Oct 30 13:19 LICENSE.txt
-rw-rw-r--.   1 magento_user apache  1157 Oct 30 13:19 README.md
-rw-rw-r--.   1 magento_user apache   270 Oct 30 13:19 registration.php
drwxrwsr-x.   3 magento_user apache  4096 Oct 30 13:19 Test

  7. Mise à jour de la base de données et du schéma Commerce :

    code language-bash 
    bin/magento setup:upgrade

  8. Nettoyez le cache :

    code language-bash 
    bin/magento cache:clean

Etape 2 : vérification de l'exemple de module

Avant de poursuivre, vérifiez que l’exemple de module est enregistré et activé.

  1. Exécutez la commande suivante :

    code language-bash 
    bin/magento module:status Magento_SampleMinimal

  2. Assurez-vous que le module est activé.

    code language-none 
    Module is enabled
TIP
Si la sortie indique que le Module does not exist, passez soigneusement en revue l'étape 1. Assurez-vous que votre code se trouve dans le répertoire approprié. L’orthographe et la casse sont importantes ; en cas de différence, le module ne se charge pas. De plus, n’oubliez pas d’exécuter magento setup:upgrade.

Étape 3 : Création d’une classe pour exécuter cron

Cette étape affiche une classe simple pour créer une tâche cron. La classe écrit uniquement une ligne dans la table cron_schedule qui confirme qu’elle est configurée avec succès.

Pour créer une classe :

  1. Créez un répertoire pour la classe et modifiez-le :

    code language-bash 
    mkdir /var/www/html/magento2/app/code/Magento/SampleMinimal/Cron && cd /var/www/html/magento2/app/code/Magento/SampleMinimal/Cron

  2. Création d’un fichier nommé Test.php dans ce répertoire avec les contenus suivants :

    code language-php 
    <?php
namespace Magento\SampleMinimal\Cron;

use Psr\Log\LoggerInterface;

class Test {
    protected $logger;

    public function __construct(LoggerInterface $logger) {
        $this->logger = $logger;
    }

   /**
    * Write to system.log
    *
    * @return void
    */
    public function execute() {
        $this->logger->info('Cron Works');
    }
}

Étape 4 : Créer crontab.xml

Le fichier crontab.xml définit une planification pour exécuter votre code cron personnalisé.

Créez crontab.xml comme suit dans le répertoire /var/www/html/magento2/app/code/Magento/SampleMinimal/etc :

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd">
    <group id="default">
        <job name="custom_cronjob" instance="Magento\SampleMinimal\Cron\Test" method="execute">
            <schedule>* * * * *</schedule>
        </job>
    </group>
</config>

Le crontab.xml précédent exécute la classe Magento/SampleMinimal/Cron/Test.php une fois par minute, ce qui entraîne l’ajout d’une ligne à la table cron_schedule.

Pour que le planning cron puisse être configuré à partir de l’administrateur, utilisez le chemin de configuration de votre champ de configuration système.

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/crontab.xsd">
    <group id="default">
        <job name="custom_cronjob" instance="Magento\SampleMinimal\Cron\Test" method="execute">
            <config_path>system/config/path</config_path>
        </job>
    </group>
</config>

Où system/config/path est un chemin de configuration système défini dans etc/adminhtml/system.xml d’un module.

Étape 5 : Compilation et nettoyage du cache

Compilez le code à l’aide de cette commande :

bin/magento setup:di:compile

Et effacez le cache à l’aide de cette commande :

bin/magento cache:clean

Étape 6 : vérification de la tâche cron

Cette étape montre comment vérifier la tâche cron personnalisée avec succès en utilisant une requête SQL sur la table de base de données cron_schedule.

Pour vérifier cron :

  1. Exécutez les tâches Commerce cron :

    code language-bash 
    bin/magento cron:run

  2. Saisissez la commande magento cron:run deux ou trois fois.

    La première fois que vous tapez la commande, les tâches cron sont exécutées. Vous devez saisir la commande au moins deux fois.

  3. Exécutez la requête SQL SELECT * from cron_schedule WHERE job_code like '%custom%' comme suit :

    1. Entrée mysql -u magento -p

    2. À l’invite mysql>, saisissez use magento;

    3. Entrée SELECT * from cron_schedule WHERE job_code like '%custom%';

      Le résultat doit être similaire à ce qui suit :

      code language-none 
      +-------------+----------------+---------+----------+---------------------+---------------------+---------------------+---------------------+
| schedule_id | job_code       | status  | messages | created_at        | scheduled_at        | executed_at         | finished_at     |
+-------------+----------------+---------+----------+---------------------+---------------------+---------------------+---------------------+
|        3670 | custom_cronjob | success | NULL     | 2016-11-02 09:38:03 | 2016-11-02 09:38:00 | 2016-11-02 09:39:03 | 2016-11-02 09:39:03 |
|        3715 | custom_cronjob | success | NULL     | 2016-11-02 09:53:03 | 2016-11-02 09:53:00 | 2016-11-02 09:54:04 | 2016-11-02 09:54:04 |
|        3758 | custom_cronjob | success | NULL     | 2016-11-02 10:09:03 | 2016-11-02 10:09:00 | 2016-11-02 10:10:03 | 2016-11-02 10:10:03 |
|        3797 | custom_cronjob | success | NULL     | 2016-11-02 10:24:03 | 2016-11-02 10:24:00 | 2016-11-02 10:25:03 | 2016-11-02 10:25:03 |
+-------------+----------------+---------+----------+---------------------+---------------------+---------------------+---------------------+

  4. (Facultatif) Vérifiez que les messages sont écrits dans le journal du système Commerce :

    code language-bash 
    cat /var/www/html/magento2/var/log/system.log

    Vous devriez voir une ou plusieurs entrées comme suit :

    code language-none 
    [2016-11-02 22:17:03] main.INFO: Cron Works [] []

    Ces messages proviennent de la méthode execute dans Test.php :

    code language-php 
    public function execute() {
     $this->logger->info('Cron Works');

Si la commande SQL et le journal système ne contiennent aucune entrée, exécutez la commande magento cron:run plusieurs fois et attendez. La mise à jour de la base de données peut prendre un certain temps.

Étape 7 (facultative) : configuration d’un groupe cron personnalisé

Cette étape indique comment configurer éventuellement un groupe cron personnalisé. Vous devez configurer un groupe cron personnalisé si vous souhaitez que votre tâche cron personnalisée s’exécute selon un planning différent de celui des autres tâches cron (généralement une fois par minute) ou si vous souhaitez que plusieurs tâches cron personnalisées s’exécutent avec des paramètres différents.

Pour configurer un groupe cron personnalisé :

  1. Ouvrez crontab.xml dans un éditeur de texte.

  2. Remplacez <group id="default"> par <group id="custom_crongroup">

  3. Quittez l’éditeur de texte.

  4. Créez /var/www/html/magento2/app/code/Magento/SampleMinimal/etc/cron_groups.xml avec les contenus suivants :

    code language-xml 
    <?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Cron:etc/cron_groups.xsd">
    <group id="custom_crongroup">
        <schedule_generate_every>1</schedule_generate_every>
        <schedule_ahead_for>4</schedule_ahead_for>
        <schedule_lifetime>2</schedule_lifetime>
        <history_cleanup_every>10</history_cleanup_every>
        <history_success_lifetime>60</history_success_lifetime>
        <history_failure_lifetime>600</history_failure_lifetime>
        <use_separate_process>1</use_separate_process>
    </group>
</config>

Pour une description de la signification des options, voir Personnalisation de la référence des crons.

Étape 8 : Vérification de votre groupe cron personnalisé

Cette étape facultative montre comment vérifier votre groupe cron personnalisé à l’aide de l’administrateur.

Pour vérifier votre groupe cron personnalisé :

  1. Exécutez les tâches Commerce cron pour votre groupe personnalisé :

    code language-bash 
    php /var/www/html/magento2/bin/magento cron:run --group="custom_crongroup"

    Exécutez la commande au moins deux fois.

  2. Nettoyez le cache :

    code language-bash 
    php /var/www/html/magento2/bin/magento cache:clean

  3. Connectez-vous à l’administrateur en tant qu’administrateur.

  4. Cliquez sur Magasins > Paramètres > Configuration > Avancé > Système.

  5. Dans le volet de droite, développez Cron.

    Votre groupe cron s’affiche comme suit :

    Votre groupe cron personnalisé

recommendation-more-help
386822bd-e32c-40a8-81c2-ed90ad1e198c