Résolvez le problème de la réception du post-données JSON vide dans YII2

Ce didacticiel vise à résoudre le problème que le backend ne peut pas recevoir correctement les données lors de l'envoi d'une demande de post via le contenu-type: application / JSON dans l'application YII2. Par défaut, le composant de demande de Yii2 analyse uniquement les données de formulaire traditionnelles telles que l'application / x-www-form-urlencoded. Pour s'assurer que les données JSON sont correctement identifiées et traitées, les développeurs doivent ajouter yii \ web \ jsonParser au composant de demande dans le fichier de configuration YII2, afin que le cadre puisse analyser automatiquement le corps de la demande JSON et obtenir avec succès les données soumises dans le contrôleur.

Description du problème: JSON Post réception des données est vide

Lors du développement d'applications Web, les architectures de séparation frontale et back-end envoient souvent des données de format JSON via JavaScript Fetch ou XMLHTTPRequest. Cependant, dans le cadre YII2, même si le code d'état de la demande frontale est de 200, la méthode YII :: $ app-> request-> post () dans le contrôleur back-end peut ne pas être en mesure d'obtenir les données JSON attendues, mais renvoyez plutôt une valeur nul.

Voici un exemple d'un frontal JavaScript typique envoyant des données JSON:

 Soit csrfToken = document.QuerySelector ("meta [name = 'csrf-token']"). Contenu;
Soit csrfparam = document.QuerySelector ("meta [name = 'csrf-param']"). Contenu;

fetch ("http://site.se/react/save-babysitter", {
  Méthode: "Post",
  En-têtes: {
    "Contenu-type": "application / json",
    "Accepter": "application / json",
    "CSRF-Param": CSRFPARAM, // Paramètres CSRF "X-CSRF-TOKK
  },
  corps: json.stringify ({
    'id': e.id, // Exemples de données: ID
    'nom': this.state.changename // Exemples de données: nom
  })
}). puis (réponse => réponse.json ())
  .Then ((data) => console.log (data));

Le code de contrôleur backend YII2 correspondant peut ressembler à ceci:

 Fonction publique ActionSaveBabySitter () {
    $ request = yii :: $ app-> request;
    $ name = $ request-> post ('name'); // À l'heure actuelle, la variable $ name peut être vide // Dans la question d'origine, essayez de JSON_DECODE la valeur vide, résultant en une erreur // echo json_decode ($ name); 

    // En fait, il devrait être de vérifier si $ le nom a reçu correctement si (vide ($ name)) {
        return $ this-> asjson (['status' => 'error', 'message' => 'le nom est vide']);
    } autre {
        return $ this-> asjson (['status' => 'succès', 'reçue_name' => $ name]);
    }
}

Dans ce cas, bien que le code d'état HTTP soit de 200, $ request-> post ('name') ne peut pas obtenir la valeur de nom envoyée par le frontal.

Analyse des causes profondes

Le composant de demande du framework YII2 YII \ web \ demande par défaut, seules les données de la variable globale $ _post sont analysées. Les serveurs Web (tels qu'Apache ou Nginx) analysent généralement uniquement les données corporelles de la demande avec l'application de type de contenu / x-www-form-urlencod ou multipart / form-data en variables globales $ _post.

Lorsque le côté actuel utilise le contenu: application / json pour envoyer des données, le contenu du corps de demande est la chaîne JSON d'origine, que le serveur Web ne va pas automatiquement et ne remplira pas $ _POST. Par conséquent, $ _POST reste vide, et la méthode $ request-> post () de Yii2 ne peut naturellement obtenir aucune donnée.

Solution: configurer l'analyseur de demande JSON

Pour que YII2 identifie et analyse correctement les corps de demande de type d'application / JSON, nous devons ajouter un analyseur JSON pour le composant de demande dans le fichier de configuration d'application de YII2 (généralement config / web.php).

L'opération spécifique consiste à ajouter l'attribut PARSER dans la configuration de la demande dans le tableau des composants et à spécifier que l'analyseur correspondant à l'application / json est yii \ web \ jsonParser.

 // config / web.php
Retour [
    'id' => 'your-app-id',
    // ... Autres configurations ...
    'Components' => [
        'request' => [
            'CookieValidationKey' => 'Votre secret-key', // Assurez-vous de définir une clé sûre
            'analysers' => [
                'application / json' => 'yii \ web \ jsonparser',
                // Si vous devez prendre en charge d'autres types de contenu, vous pouvez également ajouter // "application / xml '=>' yii \ web \ xmlparser ',
            ],
            // ... Autres configurations du composant de demande ...
        ],
        // ... autres composants ...
    ],
    // ... Autres configurations ...
]]

Grâce à la configuration ci-dessus, lorsque Yii2 reçoit une demande avec une application de type contenu / JSON, yii \ web \ jsonParser interviendra automatiquement, analysera la chaîne JSON dans le corps de demande dans un tableau ou un objet PHP, et le remplit dans la propriété yii :: $ app-> request-> bodyParams.

Accès correct aux données JSON

Une fois la configuration terminée, dans le contrôleur, vous pouvez obtenir des données JSON analysées via yii :: $ app-> request-> post () ou yii :: $ app-> request-> getBodyParam () tout comme l'accès aux données de post normal.

 Fonction publique ActionSaveBabySitter () {
    $ request = yii :: $ app-> request;

    // Pour le moment, YII2 a automatiquement analysé le corps de demande JSON // Vous pouvez directement obtenir le paramètre spécifique $ id = $ request-> post ('id'); 
    $ name = $ request-> post ('name');

    // ou obtenir tous les tableaux de paramètres analysés via getBodyParams () // $ data = $ request-> getBodyParams ();
    // $ id = $ data ['id'] ?? nul;
    // $ name = $ data ['name'] ?? nul;

    if (vide ($ id) || vide ($ name)) {
        Yii :: error ("Données vides reçues: id = {$ id}, name = {$ name}", __Method__);
        return $ this-> asjson (['status' => 'error', 'message' => 'id ou nom ne peut pas être vide.']);
    }

    // Exemple: traiter les données et renvoyer une réponse // par exemple, enregistrer dans une base de données et d'autres opérations // ...

    return $ this-> asjson (['status' => 'succès', 'reçue_id' => $ id, 'reçue_name' => $ name]);
}

Notes et résumé

1. L'importance du type de contenu: lorsque le front-end envoie une demande, il est important de s'assurer que le type de contenu dans les en-têtes est défini sur Application / JSON, qui est la clé pour que l'analyseur back-end identifie et traite correctement les données JSON.
2. Protection du CSRF: le mécanisme de protection CSRF de YII2 est toujours efficace même s'il s'agit d'une demande JSON. C'est la bonne façon d'envoyer des jetons CSRF via CSRF-Param et X-CSRF-Token dans le code JS frontal. YII2 vérifiera automatiquement ces jetons en fonction de la configuration.
3. Vérification des données: Même si les données sont reçues avec succès, il est nécessaire de vérifier et de filtrer strictement les données reçues sur le backend pour éviter les vulnérabilités de contribution et de sécurité malveillantes.
4. getBodyParams () et post (): yii :: $ app-> request-> Post () Méthode Une fois que l'analyseur JSON a été configuré, il trouvera automatiquement la valeur de la clé correspondante à partir des bodyparams analysés. Par conséquent, en général, utilisez simplement la méthode post () directement. Si vous avez besoin d'obtenir tous les tableaux de paramètres analysés, vous pouvez utiliser getBodyParams ().
5. Autres analyseurs: Si votre application doit également gérer d'autres corps de demande de formulaires non standard (tels que XML), vous pouvez également configurer les analyseurs correspondants dans les analyseurs.

Grâce à la configuration ci-dessus, les applications YII2 pourront traiter de manière transparente les demandes de format JSON envoyé par le frontal, assurant la transmission et le traitement corrects des données, améliorant ainsi l'efficacité de la collaboration frontale et de la robustesse des applications.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!