PascalCase und camelCase sind tolle Namenskonventionen, um beispielsweise in .NET zu programmieren. Diese auch bei URLs zu verwenden wie bei ASP.NET MVC standardm\u00e4\u00dfig der Fall ist allerdings zuviel des Guten: Hier hat sich die Schreibweise in Kleinbuchstaben durchgesetzt. Mehrere W\u00f6rter trennt man zur besseren Lesbarkeit meist mit einem Minus, selten auch mit Unterstrichen. Von Haus aus bietet ASP.NET leider nur die M\u00f6glichkeit, Controller und Actions klein zu schreiben. Eine Trennung mit Minuszeichen ist nicht vorgesehen, wodurch bei l\u00e4ngeren Bezeichnungen die Lesbarkeit leidet. In folgendem Artikel zeigen wir euch n\u00fctzliche Hilfsklassen, mit denen ihr die URLs nach euren W\u00fcnschen anpassen k\u00f6nnt.<\/p>\n
Vom Konzept her werden wir die generierten URLs in unser eigenes Format umwandeln. Bevor die Anfrage von ASP.NET verarbeitet wird, wandeln wir diese wieder in das urspr\u00fcngliche PascalCase-Format um. Denn intern soll ASP.NET schlie\u00dflich nach wie vor mit den CamelCase-Bezeichnungen arbeiten. Wer selbst dies nicht m\u00f6chte, kann den letzten Schritt weglassen. Um dies zu bewerkstelligen, ben\u00f6tigen wir eine Klasse zur Umwandlung in beide Richtungen:<\/p>\n
\r\nusing System;\r\nusing System.Collections.Generic;\r\nusing System.Linq;\r\nusing System.Text;\r\n\r\n\/\/\/<summary>\r\n\/\/\/ Wandelt CamelCase in mit minus-getrennte-urls um und umgekehrt\r\n\/\/\/ <\/summary>\r\npublic class HyphenatedConverter {\r\n \/\/\/<summary>\r\n \/\/\/ Wandelt die Gro\u00dfbuchstaben eines PascalCase-Strings in Kleinbuchstaben um, die mit einem Minus getrennt werden (PascalCase => pascal-case)\r\n \/\/\/ <\/summary>\r\n public static string FromPascalCase(string inputContent) {\r\n List<char> convertedContent = inputContent.ToList();\r\n for (int i = 0; i < convertedContent.Count; i++) { var currentChar = convertedContent[i]; if (currentChar == '?') { break; } if (Char.IsUpper(currentChar)) { convertedContent[i] = convertedContent[i].ToString().ToLower().FirstOrDefault(); if (i > 0) {\r\n convertedContent.Insert(i, '-');\r\n }\r\n }\r\n }\r\n return new string(convertedContent.ToArray());\r\n }\r\n \/\/\/<summary>\r\n \/\/\/ Revidiert die Umwandlung von FromPascalCase: Aus pascal-case wird wieder PascalCase\r\n \/\/\/ <\/summary>\r\n public static string ToPascalCase(string inputContent) {\r\n if (inputContent.Length == 0)\r\n return inputContent;\r\n\r\n var convertedContent = new StringBuilder();\r\n convertedContent.Append(Char.ToUpperInvariant(inputContent[0]));\r\n\r\n for (int i = 1; i < inputContent.Length; i++) {\r\n if (inputContent[i] == '-') {\r\n if (i + 1 < inputContent.Length) {\r\n convertedContent.Append(Char.ToUpperInvariant(inputContent[i + 1]));\r\n i++;\r\n }\r\n } else {\r\n convertedContent.Append(inputContent[i]);\r\n }\r\n }\r\n\r\n return convertedContent.ToString();\r\n }\r\n}\r\n \r\n<\/pre>\nMit\u00a0FromPascalCase<\/strong> wird PascalCaseUrl in pascal-case-url umwandelt, wogegen\u00a0ToPascalCase<\/strong> die umgekehrte Konvertierung durchf\u00fchrt. Diese beiden Funktionen ben\u00f6tigen wir im folgenden Schritt.<\/p>\nSchritt #2: Virtuelle Pfade anpassen<\/strong><\/h3>\nZuerst widmen wir uns den Links, die \u00fcber virtuelle Pfade generiert werden. Dies ist beispielsweise der Fall, wenn wir mit Razor-Hilfsklassen wie @Html.ActionLink() einen Link erzeugen. Dazu erzeugen wir eine neue Klasse – hier\u00a0HyphenatedRoute<\/strong> genannt – die von\u00a0Route<\/strong> erbt. Dort muss die Methode\u00a0GetVirtualPath<\/strong> \u00fcberschrieben werden. Diese ist f\u00fcr die Generierung des Linkes zust\u00e4ndig.<\/p>\n\r\nusing System.Web.Routing;\r\n\r\n\/\/\/<summary>\r\n\/\/\/ Erzeugt eine Route, in denen die W\u00f6rter nicht durch Gro\u00dfbuchstaben (CamelCase), sondern mithilfe von Bindestrichen getrennt werden (z.B. index-seite)\r\n\/\/\/ <\/summary>\r\npublic class HyphenatedRoute : Route {\r\n public HyphenatedRoute(string url, object defaults) : base(url, new RouteValueDictionary(defaults), new HyphenatedRouteHandler()) { }\r\n public HyphenatedRoute(string url, RouteValueDictionary defaults) : base(url, defaults, new HyphenatedRouteHandler()) { }\r\n public HyphenatedRoute(string url, RouteValueDictionary defaults, RouteValueDictionary constrains, IRouteHandler routeHandler) : base(url, defaults, constrains, routeHandler) { }\r\n public HyphenatedRoute(string url, RouteValueDictionary defaults, RouteValueDictionary constrains, RouteValueDictionary dataTokens, IRouteHandler routeHandler) : base(url, defaults, constrains, dataTokens, routeHandler) { }\r\n\r\n \/\/\/<summary>\r\n \/\/\/ Diese Funktion wird von MVC-Hilfsklassen aufgerufen, um AC-Links zu generieren\r\n \/\/\/ <\/summary>\r\n public override VirtualPathData GetVirtualPath(RequestContext requestContext, RouteValueDictionary values) {\r\n values["controller"] = HyphenatedConverter.FromPascalCase(values["controller"] as string);\r\n values["action"] = HyphenatedConverter.FromPascalCase(values["action"] as string);\r\n return base.GetVirtualPath(requestContext, values);\r\n }\r\n}\r\n<\/pre>\nDer Konstruktor der Route-Klasse besitzt etliche \u00dcberladungen, die man leider bei Bedarf alle manuell implementiere muss. In diesem Beispiel sind nur die g\u00e4ngigsten und zwei von mir ben\u00f6tigte mit dabei, dies muss gegebenenfalls angepasst werden.<\/p>\n
Schritt 3: R\u00fcckumwandlung bei eingehenden Anfragen<\/strong><\/h3>\nWie zu Beginn schon angek\u00fcndigt m\u00fcssen wir unser eigenes URL-Format bei eingehenden Anfragen wieder in das urspr\u00fcngliche PascalCase-Format umwandeln, damit die Anfrage korrekt verarbeitet werden kann. Hierzu ist eine Klasse n\u00f6tig, die von\u00a0MvcRouteHandlerb<\/strong> erbt. Im Prinzip findet hier der umgekehrte Prozess aus dem letzten Schritt statt:<\/p>\n\r\nusing System.Web;\r\nusing System.Web.Mvc;\r\nusing System.Web.Routing;\r\n\r\n\/\/\/<summary>\r\n\/\/\/ Wandelt durch Bindestriche getrennte Routen intern wieder in ihre PascalCase-Variante um, damit diese vom MVC-Framework korrekt weiterverarbeitet werden k\u00f6nnen\r\n\/\/\/ <\/summary>\r\npublic class HyphenatedRouteHandler : MvcRouteHandler {\r\n\r\n protected override IHttpHandler GetHttpHandler(RequestContext requestContext) {\r\n var values = requestContext.RouteData.Values;\r\n\r\n values["action"] = HyphenatedConverter.ToPascalCase(values["action"].ToString());\r\n values["controller"] = HyphenatedConverter.ToPascalCase(values["controller"].ToString());\r\n\r\n return base.GetHttpHandler(requestContext);\r\n }\r\n}\r\n<\/pre>\nNun ist unsere Route einsatzbereit und kann in der Routen-Konfiguration verwendet werden. Standardm\u00e4\u00dfig geschieht dies in der Klasse\u00a0RouteConfig<\/strong>, die sich im Ordner\u00a0App_Start<\/strong> befindet. Anstelle der Instanz einer\u00a0Route<\/strong>-Klasse \u00fcbergeben wir der RouteCollection einfach unsere selbst definierte HyphenatedConverter-Klasse. F\u00fcr die standardm\u00e4\u00dfige Action-Controller-Route mit optionaler Id sieht dies beispielsweise wie folgt aus:<\/p>\n\r\nusing System.Web.Mvc;\r\nusing System.Web.Routing;\r\npublic class RouteConfig {\r\n public static void RegisterRoutes(RouteCollection routes) {\r\n var acRoute = new HyphenatedRoute(\r\n url: "{controller}\/{action}\/{id}",\r\n defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }\r\n );\r\n routes.Add(acRoute);\r\n }\r\n}\r\n<\/pre>\nDa unsere eigene Route mit der Route-Klasse kompatibel ist, muss lediglich die Klassenbezeichnung angepasst werden. Eventuell n\u00f6tige Konstruktoren k\u00f6nnen identisch mit denen der Route-Klasse bei Bedarf eingef\u00fcgt werden, wie bereits oben erw\u00e4hnt. Man muss lediglich darauf achten, als IRouteHandler jeweils den benutzerdefinierten Handler (hier HyphenatedRouteHandler<\/strong>) zu \u00fcbergeben.<\/p>\nNat\u00fcrlich kann man dieses Beispiel auch als Grundlage nehmen, um seine komplett eigenen Namenskonventionen f\u00fcr URLs zu entwickeln.<\/strong> Allerdings ist aus verschiedenen Gr\u00fcnden zu empfehlen, hier nicht zu sehr vom g\u00e4ngigen Standard abzuweichen. Beispielsweise sind die Pfade von gesetzten Cookies schreibungsabh\u00e4ngig. Ein Cookie im Pfad \/myapp<\/strong> ist daher beim Aufruf von \/MyApp<\/strong> oder auch myApp<\/strong> nicht verf\u00fcgbar.<\/p>\nData Annotiations als Alternative?<\/strong><\/h3>\nASP.NET bietet mit dem ActionName-Attribute die M\u00f6glichkeit, den Namen der Action in der URL unabh\u00e4ngig von ihrem internen Namen zu verwenden:<\/p>\n
\r\n[ActionName("register-account")]\r\npublic ActionResult RegisterAccount() {\r\n return View("RegisterAccount");\r\n}\r\n<\/pre>\nDie Action RegisterAccount<\/strong> w\u00fcrde somit in der URL als register-account<\/strong> bezeichnet. Dieses Vorgehen hat jedoch mehrere Nachteile: Das Attribute muss f\u00fcr jede Action manuell gesetzt werden. Au\u00dferdem wird der benutzerdefinierte Name auch f\u00fcr die Ansicht genutzt. Im obigen Beispiel m\u00fcsste diese also register-account.cshtml<\/strong> hei\u00dfen statt RegisterAccount.cshtml<\/strong>. Diese Alternative ist daher eher weniger empfehlenswert.<\/p>\n","protected":false},"excerpt":{"rendered":"PascalCase und camelCase sind tolle Namenskonventionen, um beispielsweise in .NET zu programmieren. Diese auch bei URLs zu verwenden wie bei ASP.NET MVC standardm\u00e4\u00dfig der Fall ist allerdings zuviel des Guten: Hier hat sich die Schreibweise in Kleinbuchstaben durchgesetzt. Mehrere W\u00f6rter trennt man zur besseren Lesbarkeit meist mit einem Minus, selten auch mit Unterstrichen. Von Haus …<\/p>\n","protected":false},"author":5,"featured_media":3659,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[61],"tags":[336,413,426],"class_list":["post-3656","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-softwareentwicklung","tag-asp-net","tag-asp-net-mvc","tag-asp-net-mvc6"],"_links":{"self":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/3656","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/comments?post=3656"}],"version-history":[{"count":14,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/3656\/revisions"}],"predecessor-version":[{"id":3672,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/posts\/3656\/revisions\/3672"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/media\/3659"}],"wp:attachment":[{"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/media?parent=3656"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/categories?post=3656"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/u-labs.de\/portal\/wp-json\/wp\/v2\/tags?post=3656"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}