Sujet de TP Angular

Votre aventure dans le monde merveilleux des frameworks JavaScript commence avec Angular.

Angular est un framework développé par Google. Ce framework se base principalement sur la définition de composants et de services. L'objectif est d'avoir un code modulaire et réutilisable. Le langage recommandé pour programmer avec Angular et celui que nous allons utiliser est Typescript. On peut aussi utiliser Javascript 5/6 ou bien Dart.

Pour vous aider dans votre quète, le professeur Chen vous a laissé des instructions ainsi que les éléments de bases pour créer un Pokédex à cette adresse : https://github.com/barais/teaching-jxs-angular (l'utilisation d'une bicyclette est conseillée pour s'y rendre plus vite).

C'est un clone du sujet développé par Guillaume Becan (ancien doctorant de l'équipe).

Step 0

Vérifiez l'installation de nodejs à l'aide de nvm (voir guid d'install http://olivier.barais.fr/blog/posts/teaching/istic/m2/french/2018/09/10/Operation_portable_M2_ISTIC.html

Installez ng-cli

npm install -g @angular/cli

Step 1: Initialisation du projet

# génération d'un nouveau projet
ng new pokdemo
cd pokedemo

# lancement du serveur
ng serve

Observez bien le squelette du projet généré. Il vient avec un point d'entrée (main.ts) et le fichier index.html racine. Ce dernier charge un composant sous la directive (selector) <app-root></app-root>. Cette directive demande l'instantiation d'un composant app défini dans le répertoire app. Ce composant est défini par une classe app.component.ts, un template app.component.html, une classe de test app.component.spec.ts, un fichier de définition de module app.module.html et un fichier de style app.component.css.

Changez le template app-component.html en remplaçant le code du template par les lignes suivantes. Vous constaterez que l'application est rechargée automatiquement.

<div style="text-align:center">
  <h1>
   {{ title }}!
  </h1>
</div>

Step 2: Recherche d'un pokémon via son numéro

La première étape pour développer notre pokédex consiste à proposer au dresseur de rechercher un pokémon via son numéro. Nous allons donc créer un composant Angular qui va contenir et gérer cette interface. Pour créer un composant, il suffit de créer une classe et de lui ajouter l'annotation @Component. Cette annotation peut être complétée par plusieurs paramètres. Par exemple:

selector permet de définir le nom de l'élément html qui sera remplacé par notre composant
templateUrl permet de spécifier le fichier html qui servira de vue au composant
styleUrls permet de spécifier les différentes feuilles de style CSS appliquées au composant

@Component({
selector: "my-component",
templateUrl: "app/my-component.html",
styleUrls: "app/my-component.css",
})
export class MyComponent {
}

Pour faciliter la création d’un composant, nous allons utiliser l’outil angular-cli. Cet outil permet en particulier de générer facilement les différents concepts liés à Angular comme les composants, les services ou les directives. Par exemple, pour générer le composant précédent, il suffit de taper

ng generate component my-component

Vous constaterez que ng-cli génère automatiquement une structure pour vous avec un répertoire par composant.

Q1 :

Créer un composant avec un élément <input> afin de récupérer l'id recherché. Ajouter votre composant à la liste des directives et au template du composant my-component.

Charger ce composant en ahjoutant le selector de ce composant dans le template du composant app.component.html

<app-my-component></app-my-component>

Vous constaterez que la page web contient maintenant le code html résultat du composant my-component à l'intérieur du composant app.component.

Nous allons maintenant utiliser le data-binding d'Angular pour lier l'élément <input> à un attribut de notre composant. En quelque sorte, nous allons lier la vue à notre modèle.

Pour cela il nous faut charger un module supplémentaire. Dans app.module.ts ajoutez un import

import { FormsModule } from '@angular/forms';

et dans la section import, ajoutez le chargement de ce module pour votre application

  imports: [
    FormsModule, //Line to add
    BrowserModule
  ],

Pour ajoutez le databinding, on utilise la directive ngModel qui s'utilise comme ceci dans le fichier my-component-component.html :

<input [(ngModel)]="id">

Ce code lie la valeur de l'élément input à l'attribut id de notre composant.

Il faut aussi aussi ajouter l'attribut dans la classe métier du composant. Dans my-component-component.ts, ajouter l'attribut id de type string

  id: string = '';

Q2 :

Créer un attribut id et lier le à l'élément <input> précédemment créé.

Pour tester le lien entre l'attribut et l'élément HTML, nous allons utiliser une autre syntaxe utilisant aussi le méchanisme de data-binding : {{myAttribute}}. Cette syntaxe permet d'afficher la valeur d'un attribut du composant sur la page.

Ajoutez {{id}} quelque part au sein de cotre template de votre composant (my-component-component.html ).

Vous constaterez que dès que l'input est modifié par l'utilisateur, la vue contenant la valeur de l'id est elle aussi modifiée.

Q3 :

Créer un deuxième champs input en mode readonly et lié les deux par un id. Afficher la valeur de l'id renseigné dans la balise <input> venant d'être insérée.

Q3bis :

comprendre pourquoi il devient difficile de faire une attaque XSS sur une application angular

lien

Recherche dans une liste

Malheureusement, seul le professeur Chen connaît précisément le numéro de tous les pokémons. Pour aider les jeunes dresseurs à utiliser le pokédex, nous allons offrir la liste des pokémons ainsi qu'un champ de recherche pour filtrer cette liste.

Q4 :

Créer une classe Pokemon qui comporte un id et un nom. Nous compléterons la classe au fur et à mesure du TP.

ng g class pokemon

Q5 :

Créer une liste fictive (4-5 éléments suffiront) de pokémons dans le composant précédemment créé.

Q6 :

Afficher la liste des pokémons dans https://angular.io/guide/template-syntax#ngforof une balise <select> en utilisant *ngFor

Q7 :

Récupérer le choix du dresseur en liant la balise <select> au modèle avec ngModel.

Q8 :

Comme la liste des pokémons peut être très longue, nous allons proposer au dresseur de filtrer la liste.

Ajouter un champ de texte et récupérer sa valeur dans un attribut. Nous allons devoir créer un filtre à l'aide d'un pipe Angular.

Tout d'abord créons un pipe.

ng g pipe filter-pokemon--pipe

dans la classe généré pour le pipe, vous verrez ce filtre prend deux paramètres : le nom de l’attribut à filtrer et la valeur à rechercher. La fonction transforme ressemblera à cela.

  transform(value: any[], property?: string, searchString?: string): any {
    if (typeof value !== 'undefined') {
      return value.filter((e) => {
        return e[property].toLowerCase().indexOf(searchString.toLowerCase()) !== -1;
      });
    } else {
      return [];
    }
  }

En partant de la page de documentation sur les pipes, faites en sorte de permettre le filtre de votre liste depuis une entrée utilisateur.

Q9 :

Pour valider le choix du dresseur, nous allons ajouter un bouton « Go ! » dont le comportement sera défini dans notre composant. Pour lier un évènement à notre composant, on utilise la syntaxe qui permet d'appeler une méthode de notre composant.

(eventName)="codeToExecute()"

Ajouter un <button> à la page et lier l'évènement click à une méthode du contrôleur. Pour le moment la méthode se contentra d'afficher l'id ou le nom du pokémon recherché dans la console.

Intégration de composants existants

Q9 bis:

Intégration de composants material UI.

En suivant ce guide, intgréer un composant angular à votre application. Regardez le nombre de module util à la comilation et le nombre de dépendances utilisés. (Dans votre node_module)

Accès à une API

Le site http://pokeapi.co/ propose une API contenant de nombreuses informations sur les pokémons. En particulier, l'API offre la liste des pokémons (api/v2/pokedex/1) ainsi que des informations détaillées pour chacun d'entre eux (api/v2/pokemon/54 ou api/v2/pokemon/psyduck). Nous allons utiliser cette API comme source d'information pour notre pokédex.

Angular fournit un service HTTP qui va nous permettre de communiquer avec PokéAPI. Angular utilise l'injection de dépendances pour fournir les services. Cela permet en particulier d'instancier un service qu'une seule fois pour toute l'application ou bien une partie de celle-ci. Pour encapsuler l'accès à l'API, nous allons nous même créer un service. Un service Angular est en fait une classe.

Q10 :

Créer un service pour gérer l'accès à PokéAPI.

ng generate service

Ajouter un paramètre à son constructeur afin de récupérer le service http. Ajouter aussi l'annotation @Injectable() afin de spécifier à Angular que votre service comporte une dépendance vers un autre service.

Q11 :

Créer une méthode pour récupérer la liste des pokémons en utilisant le service http.

Q12 :

Utiliser ce service dans le composant de recherche de pokémons pour remplacer la liste fictive de pokémons. Pour cela, ajouter le paramètre providers au module AppModule comme ceci :

providers: [PokeApiService]

Ainsi Angular saura quelle classe injecter dans vos composants.

Q13 :

Créer une autre méthode pour récupérer les informations sur un pokémon. Compléter la classe Pokémon afin de recueillir ces informations.

Q14 :

Créer un nouveau composant dédié à l'affichage des informations d'un pokémon. Utiliser le service précédemment créé pour récupérer les informations d'un pokémon. Combiner les différents mécanismes de data-binding vus jusqu'ici pour afficher l'id, le nom et les statistiques d'un pokémon.

Communication entre contrôleurs

À présent, nous avons deux parties à notre application. La première permet de rechercher un pokémon grâce à son numéro ou son nom. La deuxième récupère et affiche les informations d'un pokémon. Il ne reste plus qu'à relier ces deux parties pour finaliser notre pokédex. Pour faire communiquer nos deux composants, nous allons créer un nouveau service qui va contenir les informations à partager. Comme pour le service dédié à l'API, ce service ne sera instancié qu'une seule fois et permettra donc l'échange d'informations.

Q15 :

Créer un service contenant l'id du pokémon recherché. Injecter ce service dans le composant de recherche et le composant d'affichage des informations. On n'oublira pas de l'ajouter dans les providers du module AppModule. Les deux composants ont maintenant un service pour partager des informations liés et utilisent les mêmes informations. Cependant, les informations du pokémon ne sont pas mises à jour si le dresseur change le numéro ou le nom du pokémon recherché. Pour détecter les changements de ces deux attributs, nous allons utiliser la notion d'observable.

Q16 :

Créer un observable dans le service précédemment créé. Le composant d'affichage d'informations d'un pokémon peut maintenant souscrire à cet observable pour détecter le changement de pokémon.

Adelourmel / teaching-jxs-angular