© Kellie L. Folkerts/Shutterstock.com
SharePoint-Clientprogrammierung mit JavaScript

SharePoint überall


Das Fundament des Siegeszugs von JavaScript sind moderne Browser und gestiegene Ansprüche an die Benutzerfreundlichkeit von Webapplikationen. Das macht vor SharePoint nicht halt. Ob als Web Part im Kontext von SharePoint oder in Apps, mit dem Client-API oder REST-Diensten lassen sich schnell, elegant und vor allem einfach kleinere bis mittelgroße Lösungen schaffen.

JavaScript – korrekt eigentlich ECMAScript [1] – hat sich von der kleinen Skriptsprache zu „der“ Sprache des Webs entwickelt. Kaum eine Webanwendung kommt ohne aus, und die Fälle, in denen komplexe Applikationen wie ERP oder Konfiguratoren aufs Web portiert werden, häufen sich. Dahinter steckt der Wunsch nach mehr Clientunabhängigkeit, denn Clients machen in vielen Unternehmen den Löwenanteil der Administrationskosten aus. Themen wie Sicherheit, Deployment und Wartung sind in Webumgebungen deutlich einfacher. Ebenso ist die Anbindung mobiler Geräte und Tablets nicht mit drastischen Technologiewechseln verbunden. Auf diesen Bedarf haben die Browserhersteller reagiert und bieten inzwischen stabile und schnelle Script Engines und mit HTML5 eine leistungsfähige Beschreibungssprache.

Zeitgleich hat auch die Werkzeugkiste zugelegt und JavaScript lässt sich gut debuggen, testen und in verschiedenen Szenarien ausführen. Die Sprache selbst ist einigermaßen gewöhnungsbedürftig, wenn man einen Hintergrund in C# oder VB.NET hat. Hier hilft nur lernen und vor allem – ernst nehmen. Wer JavaScript belächelt und als „Kindersprache“ abtut, dann und wann mal eine kleine Lösung zusammenhackt, der wird über kurz oder lang kläglich scheitern.

Konzepte

Jede Programmiersprache hat bestimmte Grundprinzipien, Konzepte und Stile. Die übliche Einordnung in „objektorientiert“, „imperativ“ usw. reicht zum Verständnis nicht, zumal moderne Sprachen sich hier recht freizügig gleich mehrerer Merkmale bedienen. Die strenge Einordnung ist auch gefährlich, weil sie den Entwickler in die Irre führt. Besonders kritisch ist dies bei JavaScript, weil hier gleich mehrere Prinzipien genutzt und dann in einen sehr eigenen Stil transportiert werden.

Am auffälligsten ist dabei das Thema Vererbung. Douglas Crockford beschreibt dies sehr plakativ in seinem Artikel „The World’s Most Misunderstood Programming Language“ [2]. Er erinnert daran, dass sich die Sprache drastisch entwickelt hat und viel Falsches geschrieben wurde, auch in anerkannten Fachbüchern; das vieles obsolet ist und einige Implementierungen in Browsern schlicht so schlecht und unvollständig waren, dass das voll Potenzial der Sprache nicht hervortrat. Auch die Beschreibung des Sprachstandards selbst durch das ECMA-Komitee ist verhältnismäßig dürftig, was Implementierern das Leben unnütz schwer macht. Die einfache Erreichbarkeit durch „Amateure“ (wie Crockford es nennt) trägt auch zu einer Flut schlechter Beispiele bei. Warum also JavaScript in SharePoint nutzen? So richtig gut klingt das alles nicht.

Der aktuelle Standard von ECMAScript 5 ECMA-262 [3], bietet vieles, was eine „echte“ Programmiersprache ausmacht. Die wichtigste Schlussfolgerung von Crockford ist, dass klassische Vererbung kein Konzept der Sprache JavaScript ist. Die angebotene prototypische Vererbung und das äußerst flexible Objektmodell bieten elegante und schnelle Konstrukte für alle Alltagsaufgaben. Im Kern basiert dies auf der allen Objekten eigenen Eigenschaft prototype. Diese bietet Vererbung und gemeinsame Eigenschaften. Listing 1 zeigt eine einfache Vererbung, basierend auf diesem Pattern.

<script>
function Person(firstName,lastName) {
this.firstName = firstName;
this.lastName = lastName;
}
// Funktion mit new == Konstruktor
var bob = new Person("Bob", "Crites");
var anil = new Person("Anil", "Madhavan");
// Zugriff auf Eigenschaften
bob.firstName === "Bob";
// Damit alle Objekte erben, wird prototype benutzt
Person.prototype.getFullName = function() {
return this.firstName + " " + this.lastName;
}
// Zugriff auf prototype
if (bob.getFullName() === "Bob Crites") {
console.info("Erfolg!");
}
</script>

Listing 1: Prototypische Vererbung

Der Sichtbereich der Variablen (Scope) ist ein weiteres Thema, das man sehr früh lernen muss. „var oder nicht var“ ist die Frage. Und die korrekte Antwort ist: immer var. Das Schlüsselwort deklariert nicht eine Variable, sondern legt den Sichtbereich fest. Davon gibt es nur zwei: Funktion und global. Funktion ist alles innerhalb von function, global alles andere. Da sich global schwer einschätzen lässt, sollten Variablen immer in einer Funktion deklariert werden. Das führt zu typischen Pattern, wie dem Modul-Pattern (Listing 2). Das Prinzip erledigt gleich mehrere Aufgaben:

  • Es gibt private Variablen
  • Es gibt eine Art Schnittstelle, also private und öffentliche Methoden
  • Das Konstrukt kann auf mehrere Dateien aufgeteilt werden (ähnlich wie partial in C#)
var MODULE = (function (my) {
// Privater Startwert
var counterInitialValue = 0;
// Private Zählvariable
var cnt;
// Konstruktor, öffentlich über return
var counterConstructor = function () {
cnt = counterInitialValue;
};
// vererbbare Methode
counterConstructor.prototype.increment = function () {
cnt++;
};
// vererbbare Methode
counterConstructor.prototype.show = function () {
alert(cnt);
};
// Öffentliche Schnittstelle
return {
Counter: counterConstructor
};
// Mehr Funktionen können auf Dateien aufgeteilt sein
})(MODULE || {});
// Eine Instanz
var c = new MODULE.Counter();
c.increment();
c.increment();
c.show();
// Eine weitere Instanz
var c2 = new MODULE.Counter();
c2.increment();
// Diese Zuweisung bewirkt nichts - cnt ist privat
c2.cnt = 99;
c2.show();

Listing 2: Modul-Pattern

Das Modul selbst ist eine Art statische oder Singleton-Klasse, es kann aber als Objekt-Factory dienen und interne Objekte anbieten. Das wird durch new auf dem Rückgabewert gemacht. Mit diesen wenigen Sprachmerkmalen – verschachtelte Funktionen, Funktions-Scope, Prototypen und ein paar knackigen Abkürzungen (wie {}, für new Object()), steht eine spannende und leistungsfähige Programmierwelt bereit. Zeit also, sich um die Nutzung in der SharePoint-Welt zu kümmern.

Dokumentations-Anti-Pattern

Der Einstieg in JavaScript-API von SharePoint sollte leicht gelingen, denn es gibt natürlich eine Referenz [5]. Leider ist diese derart schlecht und unvollständig, dass man sogar mit gediegenen JavaScript-Kenntnissen keine ernsthafte Applikation zustande bringt. Die meisten Objekte sind überhaupt nicht beschrieben, Beispiele sind selten und Erklärungen, warum etwas existiert, hat man nicht für nötig befunden. Zudem bettet sich das API in eine Reihe anderer Programmiermodelle für SharePoint ein, die alle...

headline from sands settings