refactor: standardiser la journalisation des contrôleurs et l’utilisation des référentiels

This commit is contained in:
mirage
2026-03-25 15:14:14 +01:00
parent adeb2a0550
commit cceff9a02d
18 changed files with 214 additions and 252 deletions

View File

@@ -2,6 +2,8 @@
// Copyright (c) Equipe 1 - . All rights reserved.
// </copyright>
using Webzine.Repository.Contracts;
namespace Webzine.WebApplication.Controllers
{
using Microsoft.AspNetCore.Mvc;
@@ -16,16 +18,19 @@ namespace Webzine.WebApplication.Controllers
// Injection du logger via le constructeur
private readonly ILogger<AccueilController> logger;
private readonly IConfiguration configuration;
private readonly ITitreRepository titreRepository;
/// <summary>
/// Initialise une nouvelle instance de la classe <see cref="AccueilController"/>.
/// </summary>
/// <param name="logger">Service de journalisation injecté pour enregistrer les événements et les erreurs.</param>
/// <param name="configuration">Service d'injection de configuration pour accéder aux paramètres de l'application.</param>
public AccueilController(ILogger<AccueilController> logger, IConfiguration configuration)
/// <param name="titreRepository">Repository des titres injecté pour accéder aux données des titres.</param>
public AccueilController(ILogger<AccueilController> logger, IConfiguration configuration, ITitreRepository titreRepository)
{
this.logger = logger;
this.configuration = configuration;
this.titreRepository = titreRepository;
this.logger.LogDebug(1, "initialisation du AccueilController");
}
@@ -39,7 +44,8 @@ namespace Webzine.WebApplication.Controllers
var derniereChronique = this.configuration.GetValue<int>("Webzine:NombreDerniereChronique");
var topTitres = this.configuration.GetValue<int>("Webzine:NombreDeTopTitres");
var titres = FakeDataFactory.GetTitres();
var titres = this.titreRepository.FindAll()
.ToList();
var vm = new AccueilIndexViewModel
{

View File

@@ -4,26 +4,16 @@ namespace Webzine.WebApplication.Controllers;
public class ApiController : ControllerBase
{
private readonly ILogger<ApiController> _logger;
private readonly ILogger<ApiController> logger;
/// <summary>
/// Initialise une nouvelle instance du <see cref="ApiController"/> avec un service de journalisation injecté.
/// Initialise une nouvelle instance de la classe <see cref="ApiController"/>.
/// </summary>
/// <param name="logger">Service de journalisation injecté pour enregistrer les événements et les erreurs.</param>
public ApiController(ILogger<ApiController> logger)
{
this._logger = logger;
this._logger.LogDebug(1, "initialisation du ApiController");
}
/// <summary>
/// Endpoint de test pour vérifier que l'API fonctionne correctement. Retourne une chaîne de caractères "Hello World !".
/// </summary>
/// <returns>Une chaîne de caractères "Hello World !".</returns>
[HttpGet]
public string HelloWorld()
{
return "Hello World !";
this.logger = logger;
this.logger.LogDebug(1, "initialisation du ApiController");
}
/// <summary>
@@ -33,7 +23,7 @@ public class ApiController : ControllerBase
[HttpGet]
public IActionResult Version()
{
this._logger.LogInformation("Get Version was called");
this.logger.LogInformation("Get Version was called");
return Ok(new
{

View File

@@ -6,16 +6,16 @@ namespace Webzine.WebApplication.Controllers
public class ArtisteController : Controller
{
// Injection du logger via le constructeur
private readonly ILogger<ArtisteController> _logger;
private readonly ILogger<ArtisteController> logger;
/// <summary>
/// Initialise une nouvelle instance du <see cref="ArtisteController"/> avec un service de journalisation injecté.
/// Initialise une nouvelle instance de la classe <see cref="ArtisteController"/>.
/// </summary>
/// <param name="logger">Service de journalisation injecté pour enregistrer les événements et les erreurs.</param>
public ArtisteController(ILogger<ArtisteController> logger)
{
this._logger = logger;
this._logger.LogDebug(1, "initialisation du ArtisteController");
this.logger = logger;
this.logger.LogDebug(1, "initialisation du ArtisteController");
}
/// <summary>
@@ -26,12 +26,12 @@ namespace Webzine.WebApplication.Controllers
[HttpGet("/artiste/{nom}")]
public IActionResult Index(string nom)
{
this._logger.LogInformation("Tentative d'accès à l'artiste avec le nom : {NomArtiste}", nom);
this.logger.LogInformation("Tentative d'accès à l'artiste avec le nom : {NomArtiste}", nom);
if (string.IsNullOrEmpty(nom))
{
this._logger.LogWarning("Nom de l'artiste manquant dans la requête.");
return RedirectToAction("Index", "Accueil");
this.logger.LogWarning("Nom de l'artiste manquant dans la requête.");
return this.RedirectToAction("Index", "Accueil");
}
// On transforme "fatal-bazooka" en "Fatal Bazooka" pour la factory
@@ -41,15 +41,9 @@ namespace Webzine.WebApplication.Controllers
// On appelle la factory pour obtenir l'artiste unique
var artiste = ArtisteFactory.SeedArtisteByName(nomPropre);
if (artiste == null)
{
this._logger.LogWarning("Artiste non trouvé pour le nom : {NomArtiste}", nomPropre);
return RedirectToAction("Index");
}
this.logger.LogInformation("Artiste trouvé : {NomArtiste}", nom);
this._logger.LogInformation("Artiste trouvé : {NomArtiste}", nom);
return View(artiste);
return this.View(artiste);
}
}
}

View File

@@ -8,16 +8,16 @@ namespace Webzine.WebApplication.Controllers
public class ContactController : Controller
{
// Injection du logger via le constructeur
private readonly ILogger<ContactController> _logger;
private readonly ILogger<ContactController> logger;
/// <summary>
/// Initialise une nouvelle instance du <see cref="ContactController"/> avec un service de journalisation injecté.
/// Initialise une nouvelle instance de la classe <see cref="ContactController"/>.
/// </summary>
/// <param name="logger">Service de journalisation injecté pour enregistrer les événements et les erreurs.</param>
public ContactController(ILogger<ContactController> logger)
{
this._logger = logger;
this._logger.LogDebug(1, "initialisation du ContactController");
this.logger = logger;
this.logger.LogDebug(1, "initialisation du ContactController");
}
/// <summary>
@@ -26,7 +26,7 @@ namespace Webzine.WebApplication.Controllers
/// <returns>La vue Index de la page de contact.</returns>
public IActionResult Index()
{
return View();
return this.View();
}
}
}

View File

@@ -5,25 +5,38 @@ using Webzine.WebApplication.ViewModels.Titre;
namespace Webzine.WebApplication.Controllers;
/// <summary>
/// Controleur responsable de la recherche d'artistes et de titres musicaux.
/// </summary>
[Route("recherche")]
public class RechercheController : Controller
{
private readonly ILogger<RechercheController> _logger;
private readonly ITitreRepository _titreRepository;
private readonly ILogger<RechercheController> logger;
private readonly ITitreRepository titreRepository;
/// <summary>
/// Initialise une nouvelle instance de la classe <see cref="RechercheController"/>.
/// </summary>
/// <param name="logger">Service de journalisation injecté pour suivre les opérations du contrôleur.</param>
/// <param name="titreRepository">Repository des titres injecté pour effectuer les recherches d'artistes et de titres.</param>
public RechercheController(ILogger<RechercheController> logger, ITitreRepository titreRepository)
{
this._logger = logger;
this._titreRepository = titreRepository;
this.logger = logger;
this.titreRepository = titreRepository;
}
/// <summary>
/// Affiche les résultats de la recherche d'artistes et de titres en fonction du mot-clé fourni.
/// </summary>
/// <param name="mot">Le mot-clé de recherche utilisé pour trouver les artistes et les titres correspondants.</param>
/// <returns>Une vue contenant les résultats de la recherche d'artistes et de titres.</returns>
[HttpPost("")]
public IActionResult Index(string mot)
{
this._logger.LogInformation("Recherche artistes/titres pour le mot : {Mot}.", mot);
this.logger.LogInformation("Recherche artistes/titres pour le mot : {Mot}.", mot);
var titres = _titreRepository.Search(mot)
.Concat(_titreRepository.SearchByStyle(mot))
var titres = this.titreRepository.Search(mot)
.Concat(this.titreRepository.SearchByStyle(mot))
.DistinctBy(t => t.IdTitre)
.OrderBy(t => t.Libelle)
.Select(t => new TitreStyleItem
@@ -32,14 +45,13 @@ public class RechercheController : Controller
Libelle = t.Libelle,
ArtisteNom = t.Artiste?.Nom,
UrlJaquette = t.UrlJaquette,
Duree = t.Duree
Duree = t.Duree,
})
.ToList();
var artistes = _titreRepository.FindAll()
var artistes = this.titreRepository.FindAll()
.Select(t => t.Artiste)
.Where(a => a != null
&& !string.IsNullOrWhiteSpace(a.Nom)
.Where(a => !string.IsNullOrWhiteSpace(a.Nom)
&& !string.IsNullOrWhiteSpace(mot)
&& a.Nom.Contains(mot, StringComparison.OrdinalIgnoreCase))
.DistinctBy(a => a!.IdArtiste)
@@ -47,7 +59,7 @@ public class RechercheController : Controller
.Select(a => new RechercheArtisteItem
{
Nom = a!.Nom,
NombreDeTitres = a.Titres?.Count ?? 0
NombreDeTitres = a.Titres?.Count ?? 0,
})
.ToList();
@@ -55,9 +67,9 @@ public class RechercheController : Controller
{
Mot = mot,
Artistes = artistes,
Titres = titres
Titres = titres,
};
return View(vm);
return this.View(vm);
}
}

View File

@@ -17,7 +17,7 @@ public class TitreController : Controller
private readonly ITitreRepository _titreRepository;
/// <summary>
/// Initialise une nouvelle instance du <see cref="TitreController"/>.
/// Initialise une nouvelle instance de la classe <see cref="TitreController"/>.
/// </summary>
/// <param name="logger">Service de journalisation injecte.</param>
/// <param name="titreRepository">Repository des titres injecte.</param>
@@ -44,7 +44,7 @@ public class TitreController : Controller
if (titre == null)
{
this._logger.LogWarning("Titre avec ID {Id} introuvable.", id);
return RedirectToAction("Index");
return this.RedirectToAction("Index");
}
var vm = new TitreDetail
@@ -58,17 +58,17 @@ public class TitreController : Controller
NbLikes = titre.NbLikes,
UrlJaquette = titre.UrlJaquette,
UrlEcoute = titre.UrlEcoute,
ArtisteNom = titre.Artiste?.Nom,
ArtisteNom = titre.Artiste.Nom,
Styles = titre.Styles,
Commentaires = titre.Commentaires
Commentaires = titre.Commentaires,
},
CommentForm = new TitreComment
{
IdTitre = titre.IdTitre
}
IdTitre = titre.IdTitre,
},
};
return View(vm);
return this.View(vm);
}
/// <summary>
@@ -81,15 +81,15 @@ public class TitreController : Controller
{
this._logger.LogInformation("Recherche des titres pour le style : {Style}.", style);
var titresFiltres = _titreRepository.SearchByStyle(style).ToList();
var titresFiltres = this._titreRepository.SearchByStyle(style).ToList();
var vm = new TitreStyle
{
StyleName = style,
Titres = titresFiltres.Select(MapTitreItem).ToList()
Titres = titresFiltres.Select(MapTitreItem).ToList(),
};
return View(vm);
return this.View(vm);
}
/// <summary>
@@ -107,12 +107,12 @@ public class TitreController : Controller
if (titre == null)
{
this._logger.LogWarning("Impossible d'ajouter un like. Titre ID {Id} introuvable.", model.IdTitre);
return RedirectToAction("Index");
return this.RedirectToAction("Index");
}
titre.NbLikes++;
return RedirectToAction("Details", new { id = model.IdTitre });
return this.RedirectToAction("Details", new { id = model.IdTitre });
}
/// <summary>
@@ -123,10 +123,10 @@ public class TitreController : Controller
[HttpPost("comment")]
public IActionResult Comment(TitreComment model)
{
if (!ModelState.IsValid)
if (!this.ModelState.IsValid)
{
this._logger.LogWarning("Echec de validation du modele de commentaire pour le titre ID {Id}.", model.IdTitre);
return RedirectToAction("Details", new { id = model.IdTitre });
return this.RedirectToAction("Details", new { id = model.IdTitre });
}
var titre = this._titreRepository.Find(model.IdTitre);
@@ -134,7 +134,7 @@ public class TitreController : Controller
if (titre == null)
{
this._logger.LogWarning("Impossible d'ajouter le commentaire. Titre ID {Id} introuvable.", model.IdTitre);
return RedirectToAction("Index");
return this.RedirectToAction("Index");
}
var commentaire = new Commentaire
@@ -142,14 +142,14 @@ public class TitreController : Controller
Auteur = model.Auteur,
Contenu = model.Contenu,
DateCreation = DateTime.Now,
IdTitre = model.IdTitre
IdTitre = model.IdTitre,
};
titre.Commentaires.Add(commentaire);
this._logger.LogInformation("Commentaire ajoute avec succes au titre ID {Id}.", model.IdTitre);
return RedirectToAction("Details", new { id = model.IdTitre });
return this.RedirectToAction("Details", new { id = model.IdTitre });
}
private static TitreStyleItem MapTitreItem(Titre titre)
@@ -160,7 +160,7 @@ public class TitreController : Controller
Libelle = titre.Libelle,
ArtisteNom = titre.Artiste?.Nom,
UrlJaquette = titre.UrlJaquette,
Duree = titre.Duree
Duree = titre.Duree,
};
}
}