Social Component Framework

30. Dezember 2024

Erstellt für:

  • Admin

Das Social Component Framework (SCF) vereinfacht die Konfiguration, Anpassung und Erweiterung von Communities-Komponenten sowohl auf Server- als auch auf Client-Seite.

Die Vorteile des Rahmens:

  • Funktionell: Vorkonfigurierte, einfache Integration mit wenig oder keiner Anpassung für 80 % der Anwendungsfälle.
  • Skinnable: Konsistente Verwendung von HTML-Attributen für CSS-Stile.
  • Erweiterbar: Die Implementierung der Komponente ist objektorientiert und vereinfacht die Geschäftslogik - Sie können einfach inkrementelle Geschäftsanmeldungen auf dem Server hinzufügen.
  • Flexibel: Einfache JavaScript-Vorlagen ohne Logik, die einfach überlagert und angepasst werden können.
  • Zugänglich: Die HTTP-API unterstützt das Posten von jedem Client aus, einschließlich mobiler Apps.
  • Tragbar: Integrieren/Einbetten in jede Web-Seite, die auf einer beliebigen Technologie basiert.

Erkunden Sie eine Autoren- oder Veröffentlichungsinstanz mit dem interaktiven Handbuch für Community-Komponenten.

Überblick

In SCF besteht eine Komponente aus einem SocialComponent-POJO, einer Handlebars-JS-Vorlage (zum Rendern der Komponente) und CSS (zum Gestalten der Komponente).

Eine Handlebars-JS-Vorlage kann die JS-Komponenten für das Modell/die Ansicht erweitern, um Benutzerinteraktionen mit der Komponente auf dem Client zu handhaben.

Wenn eine Komponente die Änderung von Daten unterstützen muss, kann die Implementierung der SocialComponent-API geschrieben werden, um das Bearbeiten/Speichern von Daten ähnlich dem Modell/den Datenobjekten in herkömmlichen Web-Anwendungen zu unterstützen. Darüber hinaus können Vorgänge (Controller) und ein Vorgangs-Service hinzugefügt werden, um Vorgangsanfragen zu verarbeiten, Geschäftslogik auszuführen und die APIs für das Modell/die Datenobjekte aufzurufen.

Die SocialComponent-API kann erweitert werden, um Daten bereitzustellen, die von einem Client für eine Ansichtsebene oder einen HTTP-Client benötigt werden.

Wie Seiten für den Client gerendert werden

scf-page-rendering

Komponentenanpassung und -erweiterung

Um die Komponenten anzupassen oder zu erweitern, schreiben Sie nur die Überlagerungen und Erweiterungen in Ihr Verzeichnis "/apps“, was den Prozess der Aktualisierung auf zukünftige Versionen vereinfacht.

  • Für die Enthäutung:

  • Für Look-and-Feel:

    • Ändern Sie die JS-Vorlage und das CSS.

  • Für Look-and-Feel und UX:

  • So ändern Sie die für die JS-Vorlage oder den GET-Endpunkt verfügbaren Informationen:

  • So fügen Sie eine benutzerdefinierte Verarbeitung während der Vorgänge hinzu:

  • Hinzufügen eines benutzerdefinierten Vorgangs:

    • Erstellen Sie einen Sling-POST-Vorgang.
    • Verwenden Sie vorhandenennach Bedarf.
    • Fügen Sie JavaScript-Code hinzu, um Ihren Vorgang nach Bedarf Client-seitig aufzurufen.

Server-seitiges Framework

Das Framework stellt APIs für den Zugriff auf Funktionen auf dem Server bereit und unterstützt die Interaktion zwischen dem Client und dem Server.

Java™-APIs

Die Java™-APIs bieten abstrakte Klassen und Schnittstellen, die einfach vererbt oder unterklassifiziert werden können.

Die wichtigsten Klassen werden auf der Seite Server-seitige Anpassung beschrieben.

Unter Übersicht über den Speicherressourcenanbieter erfahren Sie mehr über die Arbeit mit benutzergenerierten Inhalten.

HTTP-API

Die HTTP-API unterstützt die einfache Anpassung und Auswahl von Client-Plattformen für PhoneGap-Apps, native Apps und andere Integrationen und Mashups. Darüber hinaus ermöglicht die HTTP-API einer Community-Site, als Service ohne Client ausgeführt zu werden, sodass Framework-Komponenten in jede Web-Seite integriert werden können, die auf einer beliebigen Technologie basiert.

HTTP-API - GET-Anfragen

Für jede SocialComponent stellt das Framework einen HTTP-basierten API-Endpunkt bereit. Auf den Endpunkt wird zugegriffen, indem eine GET-Anfrage mit einem ".social.json“-Selektor und einer Erweiterung an die Ressource gesendet wird. Mit Sling wird die Anfrage an den -DefaultSocialGetServlet übergeben.

DefaultSocialGetServlet

  1. Übergibt die Ressource (resourceType) an den SocialComponentFactoryManager und empfängt eine SocialComponentFactory, die einen SocialComponent auswählen kann, der die Ressource darstellt.

  2. Ruft die Factory auf und empfängt ein SocialComponent, das die Ressource und die Anfrage verarbeiten kann.

  3. Ruft die SocialComponent auf, die die Anfrage verarbeitet und eine JSON-Darstellung der Ergebnisse zurückgibt.

  4. Gibt die JSON-Antwort an den Client zurück.

GET Request

Ein standardmäßiges GET-Servlet überwacht .social.json-Anfragen, auf die die SocialComponent mit anpassbarem JSON antwortet.

SCF-Framework