Mode d'emploi du projet modle MVC-entity
-----
historique
v0.1 13/07/2016 (Julien Legrand) : 1re version
-----
Actions faire aprs copie
- Renommer les projets en suivant ce schma : "CD67.[nom appli].[Entity/Factory/MVC/Tests/Batchs]"
- Renommer galement les assemblies et espaces de nom de chaque projet (dans les proprits des projets, onglet "Application")
x. Crer vos propres fichiers d'extension avec DataAnnotation ici : "CD67.ModeleMVC.Entity\Extend" et supprimer le fichier d'exemple "CD67.ModeleMVC.Entity\Extend\PARAM.cs"
x. Crer vos propres factory ici : "CD67.ModeleMVC.Factory" et supprimer le fichier d'exemple "CD67.ModeleMVC.Factory\PARAMFactory.cs"
x. Crer vos propres controller/vues ici : "CD67.ModeleMVC.MVC\Controllers" et supprimer les fichiers d'exemple :
(NOTE : personellement j'utilise la cration du controller le modle "Contrleur MV5 avec vues, utilisant Entity Framework" en gnrant les vues et avec la page de disposition que je souhaite, ensuite je modifie le code du contrleur pour utiliser les classes "Factory")
- supprimer ce fichier pour ne pas que l'on sache que vous avez utilis un modle
Description gnrale
La solution est consitue de 4 projets :
- CD67.ModeleMVC.Entity : Projet qui contient les objets mtiers, c'est dire dans le cas de projets Entity : le modle entity framework
- CD67.ModeleMVC.Factory : Projet qui contient les classes permettant la gestion des objets : les actions CRUD pour chacun minima
- CD67.ModeleMVC.MVC : Projet qui comprend le site Web MVC, le package Bootstrap est dj install
- CD67.ModeleMVC.Tests : Tests unitaires
CD67.ModeleMVC.Entity
Le modle se nomme par dfaut "EntityModel"
Le dossier "Extend" contient les extensions ventuelles de classe Entity (qui se trouvent dans "EntityModel.edmx\EntityModel.tt\").
C'est notamment utile pour ajouter les DataAnnotations permettant de dcrire le donnes en vue d'une gnration de contrles plus appropis dans les vues MVC.
Attention bien surveiller l'espace de noms lors de la cration d'une classe dans ce sous-dossier (erreur frquente) :
- par dfaut ce sera : "CD67.ModeleMVC.Entity.Extend",
- mais il faut "CD67.ModeleMVC.Entity" (le mme que les classes de bases Entity).
Le dossier "Internal" contient :
- "FormattedDbEntityValidationException.cs" : classe hrite de Exception qui permet un affichage plus complet dans les messages d'erreur pour les exceptions lies au format de donnes du modle Entity
- "Entities.cs" : classe partielle permettant d'utiliser les nouvelles Exceptions FormattedDbEntityValidationException en surchargeant "SaveChanges()"
En cas d'ajout d'une nouvelle connexion avec Entity Framework, il faut ajouter une nouvelle classe d'extension du mme type.
CD67.ModeleMVC.Factory
Les classes Factory sont nommes ainsi : "[Nom objet]Factory"
On cre autant de classe Factory que d'objet grer
Elles doivent contenir un constructeur public avec le context Entities en paramtre qui se base sur le constructeur de la classe parente.
Elles contiennent gnralement les fonctions suivantes : getById, getAll, add, update, delete.
C'est adapter chaque cas.
Le dossier "Internal" contient la classe de base "baseFactory" dont chaque "Factory" hrite.
CD67.ModeleMVC.MVC
La partie Model du projet n'est pas ncessaire que pour dfinir des classes ne servant qu' l'affichage, les classes mtiers tant dans le projet Entity.
Le dossier "Views" contient par dfaut :
- "Shared_AppLayout.cshtml" : une page de disposition pour l'application
- "DisplayTemplates\YesNo.cshtml" et "EditorTemplates\YesNo.cshtml" : ils s'agit d'exemple de personnalisation d'affichage pour un type de champ, ici "YesNo". On attribut un type avec la DataAnnotation "[UIHint("YesNo")]" dans la classe Metadata et ce sont les fichiers dans DisplayTemplates et EditorTemplates du mme nom qui seront utiliss pour crer le contrle l'affichage.
Le dossier "style" contient :
- un sous dossier "images" destin contenir toutes les images utilises dans la mise en page
- "AppStyleSheet.css" : feuille de style modifier pour le projet courant
- "ModeleStyleSheet.css" : feuille de style du modle CD67 ne pas modifier
CD67.ModeleMVC.Tests
Projet le plus important de la solution :)