mitmario.dev

Adressen und Parameter

JavaScript Im Browser 4 Min Lesezeit 3 BeispieleLektion 2 von 6

Jemand sucht nach „grün & günstig“, und dein Code baut die Adresse mit Plus zusammen. Beim Server kommen dann ein Suchbegriff „grün “ an und ein zweiter Parameter, den es gar nicht geben sollte. Eine Adresse ist Text, und gerade deshalb behandelt man sie besser nicht als Text.

URL zerlegt sie

Eine Adresse in ihre Teile zerlegen
// Der Port steht hier mit Absicht auf 8080. Bei 443 wirft der
// Browser ihn weg, weil er für https ohnehin gilt, und dann sähen
// hostname und host gleich aus.
const adresse = new URL(
  "https://mitmario.dev:8080/lernen/javascript?kurs=javascript&seite=2#abschnitt-3"
);

console.log("protocol:", adresse.protocol);
console.log("hostname:", adresse.hostname);
console.log("host:", adresse.host);
console.log("port:", adresse.port);
console.log("pathname:", adresse.pathname);
console.log("search:", adresse.search);
console.log("hash:", adresse.hash);
console.log("origin:", adresse.origin);

// Eine relative Adresse braucht eine Basis.
const relativ = new URL("/lernen/css", "https://mitmario.dev");
console.log("Zusammengesetzt:", relativ.toString());

// Und eine kaputte Adresse wirft.
try {
  new URL("/lernen/css");
} catch (fehler) {
  console.warn("Ohne Basis geht es nicht:", fehler.message);
}

new URL(...) nimmt eine Adresse und gibt ein Objekt zurück, in dem jeder Bestandteil einzeln steht.

  • protocol ist https:, mit Doppelpunkt.
  • hostname ist der Servername ohne Port, host mit. Im Beispiel steht der Port auf 8080, sonst sähe man keinen Unterschied. Einen Standardport (443 bei https, 80 bei http) wirft der Browser nämlich weg, und dann liefern beide dasselbe.
  • pathname ist der Pfad, immer mit führendem Schrägstrich.
  • search ist alles ab dem Fragezeichen, hash alles ab dem Doppelkreuz.
  • origin ist der Origin aus Lektion 10.5, also Protokoll, Domain und Port.

Eine relative Adresse braucht eine Basis als zweites Argument. Und eine Adresse, die keine ist, führt zu einem Fehler statt zu einem stillen null. Der Wortlaut der Meldung ist je nach Browser ein anderer. Wo fremde Eingaben verarbeitet werden, gehört ein try/catch darum.

searchParams

Parameter lesen und setzen
const adresse = new URL("https://mitmario.dev/suche?q=grid&stufe=neu&stufe=mittel");

console.log("q:", adresse.searchParams.get("q"));
console.log("stufe, erster Treffer:", adresse.searchParams.get("stufe"));
console.log("stufe, alle:", adresse.searchParams.getAll("stufe"));
console.log("Gibt es seite?", adresse.searchParams.has("seite"));
console.log("Fehlender Parameter:", adresse.searchParams.get("seite"));

// set ersetzt, append hängt an.
adresse.searchParams.set("seite", "2");
adresse.searchParams.append("stufe", "profi");
adresse.searchParams.delete("q");

console.log("Neu:", adresse.toString());

// Alles auf einmal als Objekt. Mehrfache Namen verlieren
// dabei ihre Zusatzwerte, deshalb nur bei einfachen Fällen.
console.log("Als Objekt:", JSON.stringify(Object.fromEntries(adresse.searchParams)));

Alles nach dem Fragezeichen bekommst du bequem über searchParams.

  • get(name) liefert den Wert oder null, wenn es ihn nicht gibt.
  • getAll(name) liefert alle Werte, denn ein Name darf mehrfach vorkommen.
  • has(name) prüft nur, ob es den Namen überhaupt gibt.
  • set ersetzt, append hängt an, delete entfernt.

Ein Parameterwert ist immer Text. Aus ?seite=2 kommt der Text "2". Willst du damit rechnen, wandelst du ihn um, wie beim Browserspeicher.

Object.fromEntries(adresse.searchParams) macht daraus in einer Zeile ein Objekt. Das ist bequem, verliert aber die Zusatzwerte mehrfach vorkommender Namen und reicht deshalb nur für einfache Fälle.

Niemals von Hand zusammenbauen

Warum man nicht selbst zusammenbaut
const begriff = "grün & günstig";
const basis = "https://mitmario.dev/suche";

// Von Hand. Sieht harmlos aus und ist kaputt.
const vonHand = `${basis}?q=${begriff}&seite=2`;
console.log("Von Hand:", vonHand);
console.log("Der Server liest als q:", new URL(vonHand).searchParams.get("q"));

// Das Und-Zeichen im Wert hat einen neuen Parameter
// erfunden, den es nie geben sollte.
console.log("Und plötzlich gibt es:", [...new URL(vonHand).searchParams.keys()]);

// Ordentlich.
const richtig = new URL(basis);
richtig.searchParams.set("q", begriff);
richtig.searchParams.set("seite", "2");

console.log("Richtig:", richtig.toString());
console.log("Der Server liest als q:", richtig.searchParams.get("q"));

// Für einen einzelnen Wert außerhalb einer URL.
console.log("encodeURIComponent:", encodeURIComponent(begriff));

In einer Adresse haben bestimmte Zeichen eine feste Bedeutung. & trennt Parameter, = trennt Name und Wert, # beginnt den Anker, und ein Leerzeichen hat dort gar nichts zu suchen. Steht eines davon im Wert, muss es umgeschrieben werden.

Sonst wird aus einem Suchbegriff mit einem Und-Zeichen ein zusätzlicher Parameter, den nie jemand gemeint hat. So passiert es im dritten Beispiel. Der Server liest als q nur "grün ", und die Schlüssel heißen q, günstig und seite. Kein Fehler, keine Warnung.

searchParams.set erledigt das Umschreiben von selbst. Ein Leerzeichen wird dabei zum Pluszeichen und ein Umlaut zu einer Folge von Prozentzeichen, und beim Lesen kommt wieder der ursprüngliche Text heraus.

Für einen einzelnen Wert außerhalb einer URL, etwa in einem Pfadstück, gibt es encodeURIComponent. Dort wird ein Leerzeichen zu %20.

Wozu das gebraucht wird

Zwei Anwendungen kommen ständig vor.

  • Eine Ansicht, die sich teilen lässt. Der gewählte Filter steht in der Adresse, und wer den Link weitergibt, gibt die Ansicht mit. Ohne Parameter landet der Empfänger auf der leeren Startansicht.
  • Ein fetch mit Filtern. Die Adresse entsteht mit searchParams und geht als Text an fetch.

Was hier geht und was nicht

history.pushState funktioniert hier, und mit drei Zeilen in der Eingabezeile der Console kannst du das nachprüfen. Nach history.pushState({ n: 1 }, "", "?seite=2") und history.pushState({ n: 2 }, "", "?seite=3") steht in der Adresszeile über der Seite /index.html?seite=3. Der Zurück-Pfeil daneben ist dann nicht mehr grau.

Mit einem Listener davor, also addEventListener("popstate", (e) => console.log("zurück zu", e.state)), steht nach einem Klick auf Zurück zurück zu {n: 1} in der Console, und die Adresszeile springt auf ?seite=2. Auf genau diesem Verhalten baut eine teilbare Filteransicht auf. Die Adresse ändert sich, ohne dass die Seite neu geladen wird, und der Zurück-Pfeil tut trotzdem, was man erwartet.

Zwei Grenzen gibt es. history.state bleibt hier leer. Das Zustandsobjekt kommt zwar im popstate an, aber eine Abfrage dazwischen ergibt null, und draußen auf einer echten Seite stünde dort, was zuletzt hineingelegt wurde.

Und location ist hier nichts wert. Lesen kannst du es, nur ist die Antwort nicht zu gebrauchen. location.href ergibt "about:srcdoc", location.origin ergibt "null", und location.search ergibt "", auch wenn in der Adresszeile ein Parameter steht. Setzt du es, schickst du die Seite wirklich weg. Sie wird dann dreimal zurückgeholt, dazu kommt eine Zeile in der Console, und deine eigene Ausgabe ist danach weg.

Deshalb stehen hier überall URL-Objekte mit festen Texten, und alles daran gilt unverändert für die echte Adresse. Im echten Browser liest du sie mit new URL(location.href) und nimmst sie mit searchParams auseinander, auch im popstate-Handler.

In der Aufgabe wird eine Adresse zerlegt und eine neue zusammengebaut, ohne von Hand zu kleben.

Zum Mitnehmen

new URL zerlegt eine Adresse in ihre Teile, und searchParams liest und setzt die Parameter und schreibt dabei jedes Sonderzeichen richtig um. Von Hand zusammengeklebt stimmt die Adresse nicht mehr, sobald ein Und-Zeichen im Wert steht.

Jetzt du

Basis Konto, kostenlos

Zu dieser Lektion gehört eine Aufgabe. Du schreibst den Code selbst, und nach jedem Lauf sagt dir eine Prüfliste, was schon stimmt.

Dafür brauchst du das Basis Konto. Es kostet nichts, und ein Passwort gibt es auch nicht.

Was in dieser Lektion steckt

  • Artikel mit 3 Beispielen zum Ausprobieren

    Steht hier, ohne Konto lesbar.

  • Aufgabe im Editor, direkt im Browser geprüft

    Öffnet sich mit dem Basis Konto.