Window: btoa() Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2016.

Die btoa() Methode der Window Schnittstelle erstellt einen Base64-kodierten ASCII String aus einem Binärstring (d.h. ein String, bei dem jedes Zeichen im String als Byte von Binärdaten behandelt wird).

Sie können diese Methode verwenden, um Daten zu kodieren, die sonst Kommunikationsprobleme verursachen könnten, sie zu übertragen und dann die Window.atob() Methode verwenden, um die Daten wieder zu dekodieren. Zum Beispiel können Sie Steuerzeichen wie ASCII-Werte von 0 bis 31 kodieren.

Betrachten Sie auch die Verwendung der Uint8Array.prototype.toBase64() Methode, wenn Ihre Daten in einem Uint8Array Objekt vorliegen, um die Erstellung eines Strings mit Rohdatenbytes zu vermeiden.

Syntax

js
btoa(stringToEncode)

Parameter

stringToEncode

Der zu kodierende Binärstring. Strings in JavaScript sind als UTF-16 kodiert, das bedeutet, dass jedes Zeichen einen Codepunkt kleiner als 256 haben muss, der ein Byte Daten darstellt.

Rückgabewert

Ein ASCII-String, der die Base64-Darstellung von stringToEncode enthält.

Ausnahmen

InvalidCharacterError DOMException

Der String enthielt ein Zeichen, das nicht in ein einzelnes Byte passte. Siehe "Unicode-Zeichenketten" weiter unten für mehr Details.

Beispiele

js
const encodedData = window.btoa("Hello, world"); // encode a string
const decodedData = window.atob(encodedData); // decode the string

Unicode-Zeichenketten

Base64 erwartet von seinem Design her Binärdaten als Eingabe. Im Hinblick auf JavaScript-Strings bedeutet dies Strings, bei denen der Codepunkt jedes Zeichens nur ein Byte belegt. Wenn Sie einen String in btoa() übergeben, der Zeichen enthält, die mehr als ein Byte beanspruchen, erhalten Sie einen Fehler, da dies nicht als Binärdaten betrachtet wird:

js
const ok = "a";
console.log(ok.codePointAt(0).toString(16)); //   61: occupies < 1 byte

const notOK = "✓";
console.log(notOK.codePointAt(0).toString(16)); // 2713: occupies > 1 byte

console.log(window.btoa(ok)); // YQ==
console.log(window.btoa(notOK)); // error

Da btoa die Codepunkte seines Eingabestrings als Byte-Werte interpretiert, führt ein Aufruf von btoa bei einem String zu einer "Character Out Of Range"-Ausnahme, wenn der Codepunkt eines Zeichens 0xff überschreitet. Für Anwendungsfälle, bei denen Sie beliebigen Unicode-Text kodieren müssen, ist es notwendig, den String zuerst in seine Bestandteile in UTF-8 umzuwandeln und dann die Bytes zu kodieren.

Die einfachste Lösung ist die Verwendung von TextEncoder und TextDecoder, um zwischen UTF-8 und Ein-Byte-Darstellungen des Strings zu konvertieren:

js
function base64ToBytes(base64) {
  const binString = atob(base64);
  return Uint8Array.from(binString, (m) => m.codePointAt(0));
}

function bytesToBase64(bytes) {
  const binString = Array.from(bytes, (byte) =>
    String.fromCodePoint(byte),
  ).join("");
  return btoa(binString);
}

// Usage
bytesToBase64(new TextEncoder().encode("a Ā 𐀀 文 🦄")); // "YSDEgCDwkICAIOaWhyDwn6aE"
new TextDecoder().decode(base64ToBytes("YSDEgCDwkICAIOaWhyDwn6aE")); // "a Ā 𐀀 文 🦄"

Umwandlung beliebiger Binärdaten

Die Funktionen bytesToBase64 und base64ToBytes im vorhergehenden Abschnitt können direkt verwendet werden, um zwischen Base64-Strings und Uint8Arrays zu konvertieren.

Für eine bessere Leistung ist asynchrone Konvertierung zwischen Base64-Daten-URLs nativ innerhalb der Webplattform über die FileReader und fetch APIs möglich:

js
async function bytesToBase64DataUrl(bytes, type = "application/octet-stream") {
  return await new Promise((resolve, reject) => {
    const reader = Object.assign(new FileReader(), {
      onload: () => resolve(reader.result),
      onerror: () => reject(reader.error),
    });
    reader.readAsDataURL(new File([bytes], "", { type }));
  });
}

async function dataUrlToBytes(dataUrl) {
  const res = await fetch(dataUrl);
  return new Uint8Array(await res.arrayBuffer());
}

// Usage
await bytesToBase64DataUrl(new Uint8Array([0, 1, 2])); // "data:application/octet-stream;base64,AAEC"
await dataUrlToBytes("data:application/octet-stream;base64,AAEC"); // Uint8Array [0, 1, 2]

Hinweis: Für unterstützende Umgebungen sollten Sie auch die nativen Methoden Uint8Array.fromBase64(), Uint8Array.prototype.toBase64() und Uint8Array.prototype.setFromBase64() in Betracht ziehen.

Spezifikationen

Specification
HTML
# dom-btoa-dev

Browser-Kompatibilität

Siehe auch