Wie betten Sie andere Programmiersprachen in Ihren Code ein?

Question

Mit C# für ASP.NET und MOSS-Entwicklung müssen wir JavaScript oft in unseren C# -Code einbetten. Um dies zu erreichen, scheint es zwei vorherrschende Denkschulen zu sein:

string blah = "asdf"; 
StringBuilder someJavaScript = new StringBuilder(); 
someJavaScript.Append("<script language='JavaScript' >"); 
someJavaScript.Append("function foo()\n"); 
someJavaScript.Append("{\n"); 
someJavaScript.Append(" var bar = '{0}';\n", blah); 
someJavaScript.Append("}\n"); 
someJavaScript.Append("</script>"); 

Die andere Denkschule ist so etwas wie diese:

string blah = "asdf"; 
string someJavaScript = @" 
    <script language='JavaScript' > 
    function foo() 
    { 
     var bar = '" + blah + @"'; 
    } 
    </script>"; 

Gibt es einen besseren Weg, als eine dieser beiden Methoden? Ich mag den zweiten persönlich, wie Sie den gesamten Abschnitt von JavaScript (oder anderen Sprachblock, ob SQL oder was Sie haben) sehen, und es hilft auch beim Kopieren des Codes zwischen einem anderen Editor für die jeweilige Sprache.

Edit:
Ich sollte erwähnen, dass das Endziel JavaScript in der endgültigen Webseite formatiert ist.

Ich änderte auch das Beispiel, um Interaktion mit dem generierten Code anzuzeigen.

Answer 1

Der zweite Weg ist offensichtlich, Art und Weise, klarer. Es konnte wirklich keinen Grund geben, den ersten zu machen.

Ich würde jedoch verlängern sie dies:

string someJavaScript = string.Format(@" 
    <script language='JavaScript' > 
     function foo() 
     { 
      var bar = '{0}'; 
     } 
    </script>", blah); 

Wenn Sie mehrere Dinge innerhalb der Zeichenfolge zu halten, werden die string.Format Methode besser lesbar werden, anstatt Inline-Verkettung.

Answer 2

Wie fügt man der Datei das JavaScript als Resource-Abschnitt hinzu, so dass es als ein (eingebettetes) Skript aus dem Resource-Abschnitt der ausführbaren Datei geladen werden kann?

Answer 3

Das String-Literal aus einem Grund: Lesbarkeit.

(Performance ist kein Thema, das ist MOSS wir reden ...)

Answer 4

Die zweite Möglichkeit, obwohl eine externe Datei verwendet wird, ist viel besser und ermöglicht Änderungen an der Anwendung vorgenommen werden, ohne alles neu zu kompilieren.

Sie benötigen auch eine schöne, lesbare Möglichkeit, Variablen einzufügen. Der einfachste Ansatz ist die Verwendung von string.Format, aber dann ist jede Variable {0} oder {1} und kann daher nicht lesbar sein.

Wie wäre:

public static string Insert(object dictionary, string into) 
{ 
    foreach (PropertyInfo property in dictionary.GetType().GetProperties()) 
     into = into.Replace("<%" + property.Name + "%>", 
          property.GetValue(dictionary, null).ToString()); 

    return into; 
} 

Dann können Sie dies tun:

string js = Insert(new { divList, url }, 
        @"jQuery(document).ready(function(){ 
         jQuery('#<%divList%>').jqGrid({ 
          url:'<%url%>', 
          datatype: 'json', 
          mtype: 'GET', ... etc..."); 

Oder, wenn das Skript in einer externen Datei ist:

string js = Insert(new { divList, url }, File.ReadAllText("someFile.js")); 

Sie können ein beliebiges Objekt übergeben und Seine Eigenschaften sind direkt über eine ASP-artige Escape-Syntax zugänglich.

Die obige Implementierung ist natürlich nicht sehr effizient, aber sie ist kurz.

Eine andere Möglichkeit besteht darin, eine ASPX-Seite zu schreiben, die JavaScript zurückgibt, und Sie können sie dann in Ihre HTML-Seiten mit einer <script>-Referenz einfügen. Sie können set the ContentType of the pageapplication/x-javascript sein.

Dadurch können Sie normale ASP.NET <%= %> Tags verwenden, um es zu ändern, und wird bereits eine schnelle, robuste Lösung mit externen Dateien sein, automatisch kompilieren, wenn Sie Änderungen am Skript vornehmen.

Answer 5

Wir haben eine Bibliothek nur für diesen Zweck geschrieben, die eine fließende Syntax zum Einbetten von JavaScript in C# -Code bietet. Sie können mehr darüber lesen here.

Kurz gesagt, Ihr Beispiel geschrieben werden würde, wie:

var function = JS.Function("foo").Do(
    JS.Var(JS.Id("bar").AssignWith(blah))); 
string someJavaScript = "<script>" + function + "</script>"; 

Zum einen wird es sicher, dass der Inhalt der Variable blah richtig zitiert wird, wenn es Sonderzeichen enthält, zum Beispiel.