Wie lässt sich ein Wert nach dessen Änderung z.B. auf mehreren Textfeldern synchronisiert darstellen?
In vielen Programmiersprachen bietet sich hierfür das Entwurfsmuster 'Observer-Pattern' an, dass in verschiedenen Sprachen sehr unterschiedlich implementiert wurde. Das Prinzip gestaltet sich allerdings gleich: Der 'Erzähler' (Observable) hält Informationen bereit an die sich 'Zuhörer' (Listener) registrieren können. Sobald der 'Erzähler' neue Informationen bekommt, benachrichtigt er seine 'Zuhörer'.
Beispiel
Listener erstellen
Als erstes wird ein Listener erstellt. Ein Listener ist ein Schlüssel-Wert Paar, dessen Wert eine Funktion ist, die bei einer Wertänderung auf dem Observable, aufgerufen wird. Somit kann mit dieser Funktion auf eine Wertänderung reagiert werden. Diese Funktion nimmt zwei Parameter entgegen, als erstes dennewValue und als zweites den oldValue.
In diesem Beispiel wird die Variable listenerVariable immer mit dem newValue-Wert überschrieben, wenn der Listener vom Observable über eine Wertänderung benachrichtigt wird. oldValue wird in diesem Beispiel nicht verwendet.
Nachdem ein 'Zuhörer' (Listener) erstellt wurde, braucht es noch den 'Erzähler' (Observable).
Dafür gibt es die Funktion Observable welche als ersten Parameter den initialen Wert entgegennimmt.
Mit der Funktion addListener wird der zuvor erstellte Listener registriert.
let obsExample =Observable(42) // new Observable with initValue 42 (addListener)( listenerExample ); // append Listener to the Observable
Nachdem einer Listener mit einem Observable verknüpft ist, erhält der Listener sofort den aktuellsten Stand (initialen Wert) vom Observable. In diesem Beispiel die Zahl '42'.
listenerVariable // 42
Aktueller Wert abfragen
Die Funktion getValue gibt den aktuellen Wert aus dem Observable zurück.
obsExample( getValue ); // 42
Wertänderung
Mit der Funktion setValue wird dem Observable ein neuer Wert mitgeteilt. Alle verbundene Listener werden benachrichtig und der neue Wert als newValue __mitgegeben. Der vorherige Wert als oldValue. Die Funktion setValue gibt ein neues Observable zurück.
obsExample =obsExample( setValue )(11) // set new value and update all listenerslistenerVariable // 11obsExample( getValue ); // 11
Listener entfernen
Wenn ein Listener wieder von einem Observable entfernt werden soll, gibt es dafür die FunktionremoveListener. Diese Funktion gibt wieder ein Observable zurück.
let listenerVariable; // undefinedconstlistenerExample=newListener( nVal => oVal => listenerVariable = nVal );// create observable and add listenerlet obsExample =Observable(42) (addListener)(listenerExample); listenerVariable // 42 <- get the value from initialValue// set new value and update listenersobsExample =obsExample(setValue)(11);// receive the updatelistenerVariable // 11 // remove listenerobsExample =obsExample(removeListener)(lisExample); // set new value and update listenersobsExample =obsExample(setValue)(67); // receive no updates anymore listenerVariable // 11
Observable Text-Input Beispiel
In diesem Beispiel-Projekt gibt es ein 'Observable', welches auf die Wertänderungen eines Text-Input-Feldes auf dem UI reagiert. Dabei werden alle 'Listener' mit dem neuen und alten Wert informiert.
In der Demo sind die Checkboxen neben den Labels zum entfernen und hinzufügen der Listener da.
Demo
Es gibt vorgefertigte Listener-Funktionen, welche im Beispiel benutzt werden.
/* Listener-Functions */const listenerLogToConsole = nVal => oVal => console.log(`Value: new = ${nVal}, old = ${oVal}`)
constlistenerNewValueToDomElementTextContent= element => nVal => oVal =>element.textContent = nValconstlistenerOldValueToDomElementTextContent= element => nVal => oVal =>element.textContent = oValconst listenerNewValueLengthToElementTextContent = element => nVal => oVal => element.textContent = nVal.length
Implementation
// Get the elements from the Domconst [inputText,newValue,oldValue,sizes] =getDomElements("inputText","newValue","oldValue","sizes");// Create ListenerconstlistenerNewValue=newListener( listenerNewValueToDomElementTextContent (newValue) );constlistenerOldValue=newListener( listenerOldValueToDomElementTextContent (oldValue) );constlistenerNewValueSize=newListener( listenerNewValueLengthToElementTextContent (sizes) );constlistenerConsoleLog=newListener( listenerLogToConsole );// Create Observable-Object, define the Initial-Value and append the Listenerslet textInputObservables =Observable("") (addListener)( listenerNewValue ) (addListener)( listenerOldValue ) (addListener)( listenerNewValueSize ) (addListener)( listenerConsoleLog );// Connect the Observables with the Input-Text-Field.// Every change in the Input-Field execute the 'setValue'-Function with the new value from Input-Field.inputText.oninput= _ => textInputObservables =textInputObservables(setValue)(inputText.value);
In diesem Beispiel-Projekt wird gezeigt wie ein Color-Picker mit dem Observable gebaut werden kann.
Es gibt ein Observable das die Farbe verwaltet, an welches sich Listener wie Background, Labels und Inputs registrieren können. Die Input-Felder (Text-Input und Slider) sind dabei nicht nur Listener sondern auch gleichzeitig dafür da, dem Observable neue Werte zu übermitteln. Die Elemente Text-Input und Slider-Input sind bidirektional mit dem Observerable verbunden. Um das zu demonstrieren wurden Buttons im UI hinzugefügt zum an- und abmelden der Listener.
Demo
Implementation
Der observierte Farbwert ist als Triple implementiert:triple(red, green, blue)
// Get the elements from the Domconst [resultColor,rgbValue,hex,hsl] =getDomElements("resultColor","rgbValue","hex","hsl");const [inputR,inputG,inputB] =getDomElements("inputR","inputG","inputB");const [rangeR,rangeG,rangeB] =getDomElements("rangeR","rangeG","rangeB");// Getter methods for the RPG-Values (triple)constgetRed= firstOfTriple;constgetGreen= secondOfTriple;constgetBlue= thirdOfTriple;// Create Listeners for every color (red, green, blue) to Text- & Slider-InputconstlistenerInputR=newListener( nVal => _ =>inputR.value =nVal( getRed ));constlistenerRangeR=newListener( nVal => _ =>rangeR.value =nVal( getRed ));constlistenerInputG=newListener( nVal => _ =>inputG.value =nVal( getGreen ));constlistenerRangeG=newListener( nVal => _ =>rangeG.value =nVal( getGreen ));constlistenerInputB=newListener( nVal => _ =>inputB.value =nVal( getBlue ));constlistenerRangeB=newListener( nVal => _ =>rangeB.value =nVal( getBlue ));// Create Listeners for the Background-Result, RGB- & Hex-Labelsconst listenerBgColorRGB = newListener( nVal => _ => resultColor.style.backgroundColor = toRGBString( nVal(getRed), nVal(getGreen), nVal(getBlue) ));
const listenerRgbTextRGB = newListener( nVal => _ => rgbValue.value = toRGBString( nVal(getRed), nVal(getGreen), nVal(getBlue) ));
const listenerHexTextRGB = newListener( nVal => _ => hex.textContent = toHexString( nVal(getRed), nVal(getGreen), nVal(getBlue) ));
// Create Observable-Object, define the three initial-Values RGB and append the Listenerslet rgbObservable =Observable(triple(55)(215)(150)) (addListener)( listenerInputR ) (addListener)( listenerRangeR ) (addListener)( listenerInputG ) (addListener)( listenerRangeG ) (addListener)( listenerInputB ) (addListener)( listenerRangeB ) (addListener)( listenerBgColorRGB ) (addListener)( listenerRgbTextRGB ) (addListener)( listenerHexTextRGB );// Connecting the Observables with every Input-Field (Range and Text).inputR.oninput= _ => rgbObservable =rgbObservable(setValue)( triple (inputR.value) (rgbObservable(getValue)(getGreen)) (rgbObservable(getValue)(getBlue)) );rangeR.oninput= _ => rgbObservable =rgbObservable(setValue)( triple (rangeR.value) (rgbObservable(getValue)(getGreen)) (rgbObservable(getValue)(getBlue)) );...
In diesem Beispiel-Projekt gibt es ein Observable das Witze verwaltet. Die Witze werden mit Klick auf den Button von einem REST-API abgefragt. Sobald ein neuer Witz veröffentlich wird, werden alle Listener informiert. Es existieren zwei Listener, der eine rendert die Witze auf dem UI und der andere löst ein Text-To-Speech-Skript aus.
Demo
Implementation
// Either all the necessary Dom-Element exist and or display all missed ElementeitherElementsOrErrorsByFunction(eitherDomElement)("jokeHistory","norrisBtn","nerdyBtn","trumpBtn")(err => document.body.innerHTML = Box(err)(mapf)(convertStackToArray)(mapf)(s => s.join(", <br>"))(fold)(txt => `<div style="background: orangered"> <br> ${txt}</div>`))
(result => {// receive founded the elementsconst [jokeHistory,norrisBtn,nerdyBtn,trumpBtn] =convertListMapToArray(result)// create the Listeners (text-to-speech & display to view)constlistenerSpeak=newListener(nValue => oValue =>speak(nValue(snd)));constlistenerJokeToDom=newListener(nValue => oValue => {consttemplate=document.createElement('fieldset');template.className ="joke"template.innerHTML =`<legend>${nValue(fst)}</legend><p class="jokeText">${nValue(snd)}</p>`jokeHistory.insertAdjacentElement('afterbegin', template) });// create the Observable with pair data structure ("Title")("Joke")constjokePairObserver=Observable( pair("nobody")("tell me a joke") ) (addListener)( listenerSpeak ) (addListener)( listenerJokeToDom )// Jokes-API-URLsconstjokeNorrisUrl="https://api.chucknorris.io/jokes/random"; // jsonKey: valueconstjokeNerdUrl="https://v2.jokeapi.dev/joke/Programming?type=single"// jsonKey: jokeconsttrumpTweetUrl="https://www.tronalddump.io/random/quote"; // jsonKey: value// Constructor for a Joke-ObjectconstjokeCtor= name => btn => url => jsonKey =>convertObjToListMap({name, btn, url, jsonKey});// creat Joke-ObjectconstnorrisJoke=jokeCtor("Chuck Norris - Joke")(norrisBtn)(jokeNorrisUrl)("value");constnerdJoke=jokeCtor("Nerd - Joke" )(nerdyBtn )(jokeNerdUrl )("joke" );consttrumpTweet=jokeCtor("Trump Tweet" )(trumpBtn )(trumpTweetUrl)("value");// combine the Joke-Objects into a stackconstjokes=convertElementsToStack(norrisJoke, nerdJoke, trumpTweet);// add the Joke-Buttons a on-click event listener for request the Jokes and update the ObservableforEach(jokes)((joke, _) =>getElementByKey(joke)("btn").onclick= _ =>HttpGet( getElementByKey(joke)("url") )(resp =>jokePairObserver(setValue)(Box(resp) (mapf)(JSON.parse) (fold)(x => pair( getElementByKey(joke )( "name"))( x[getElementByKey(joke)("jsonKey")] )))));
})
Für dieses Beispiel wurde extra eine Funktionen erstellt um HTTP-Get anfragen zu tätigen. Sie bieten einen einfachen Weg, Daten von einer URL zu erhalten.
Mit der Funktion HttpGet wird asynchrone anfrage abgesetzt. Die Anfrage wird nach 30 Sekunden Time-out automatisch beendet, wenn vom Webserver bis dahin keine Antwort kommt. Die Funktion HttpGet erwartet als ersten Parameter eine URL und als zweiten Parameter eine Callback-Funktion __mit der Antwort vom Webserver.
Analog zu HttpGet gibt es die Synchrone-Variante: HttpGetSync.
Denn Callback braucht es nicht, da der Response direkt als Rückgabewert zurück gegeben werden kann.
Der observableBody wird bei diesen Funktion immer zurückgegeben. Es ermöglicht eine Verkettung der Funktionen mit einem Observable.
Nachdem anwenden einer Observable-Funktion ist es wichtig den Rückgabewert in einer Variablen zu speichern, weil dieser das aktuelle Observable enthält. Anschliessend kann darauf immer weitere Observable-Funktion angewandt werden.
let obsExample =Observable(0)obsExample =obsExample( addListener )( /* dein Listener */ )obsExample =obsExample( removeListener )( /* dein Listener */ )obsExample =obsExample( setValue )( /* dein neuer Wert */ )
Die Variable, die das Observable enthält, kann mit dem const Schlüsselwort deklariert werden und ist somit auch immutable. Dadurch kann diese Variable nicht überschrieben werden und es können dann keine Listener hinzugefügt werden oder entfernt werden.
constlistenerLog=newListener( listenerLogToConsole );// 'const' deklariert die Observable als eine Konstante (immutable)constobsExample=Observable(0) (addListener)( listenerLog )// Die Observable kann nicht mehr verändert werdenobsExample =obsExample( removeListener)( listenerLog ) // entfernen nicht möglichobsExample =obsExample( addListener )( listenerLog ) // hinzufügen nicht möglich
Das Observable sollte nicht mit mehr als 5'000 Listener verbunden werden, weil ansonsten ein "Uncaught RangeError: Maximum call stack size exceeded" __auftretten könnte.
Mit bis zu 100 Listener und vielen Wertänderungen (zb. 100'000) auf einmal hat das Observable kein Problem.
Mit der Funktion newListenerWithCustomKey wir ein neuer Listener erstellt. Die Funktion nimmt als erstes den Schlüssel, als zweites die Funktion, die auf die Wertänderung reagiert, entgegen.
Der Schlüssel muss mit dem JavaScript "===" - Operator verglichen werden können.
Der Schlüssel von einem Listener muss eindeutig sein in einem Observable.
Mit der Funktion newListener wir ein neuer Listener erstell. Der Key muss im Vergleich zu newListenerWithCustomKey nicht angeben werden, weil dieser automatisch generiert wird.
Der generateRandomKey erzeugt einen String der Länge sechs mit zufälligen Buchstaben (Gross-/Kleinschreibung) & Zahlen. Siehe implementation: generateRandomKey