Skip to content

6. Internationalisierung

6.1. Beispiel 16: Eine zweisprachige Anwendung

Im Kurs [NestJS] übersetzte der Server die Seiten, bevor er sie sendete. Hier findet die Übersetzung im Browser mit der Bibliothek [vue-i18n] statt, und der Sprachwechsel erfordert keinerlei Interaktion mit dem Server mehr.

6.1.1. Wörterbücher

Ein Wörterbuch pro Sprache im JSON-Format. Jeder Text hat einen Schlüssel ([HOME.HELLO]):

{
  "APP": {
    "TITLE": "Exemple 16 - une application en deux langues",
    "LANGUAGE": "Langue"
  },
  "HOME": {
    "HELLO": "Bonjour {name} !",
    "TODAY": "Nous sommes le {date}.",
    "PRICE": "Une consultation coûte {price}.",
    "APPOINTMENTS": "aucun rendez-vous | un rendez-vous | {n} rendez-vous",
    "ADD": "Ajouter un rendez-vous",
    "REMOVE": "En retirer un"
  },
  "ERRORS": {
    "LOGIN_TAKEN": "Ce login est déjà utilisé par un autre compte.",
    "TOO_MANY_ATTEMPTS": "Trop de tentatives infructueuses. Réessayez dans {minutes} minute(s)."
  },
  "SERVER": {
    "TITLE": "Traduire une réponse du serveur",
    "EXPLANATION": "Le serveur RdvMedecins ne renvoie que des clés. C'est le client qui les traduit :"
  }
}
{
  "APP": {
    "TITLE": "Example 16 - a two-language application",
    "LANGUAGE": "Language"
  },
  "HOME": {
    "HELLO": "Hello {name}!",
    "TODAY": "Today is {date}.",
    "PRICE": "A consultation costs {price}.",
    "APPOINTMENTS": "no appointment | one appointment | {n} appointments",
    "ADD": "Add an appointment",
    "REMOVE": "Remove one"
  },
  "ERRORS": {
    "LOGIN_TAKEN": "This login is already used by another account.",
    "TOO_MANY_ATTEMPTS": "Too many failed attempts. Try again in {minutes} minute(s)."
  },
  "SERVER": {
    "TITLE": "Translating a server response",
    "EXPLANATION": "The RdvMedecins server only sends keys. The client translates them:"
  }
}
  • Zeile 7: [{name}] ist ein Nachrichtenparameter;
  • Zeile 10: eine Plural-Nachricht: Ihre Formen werden durch [|] getrennt (null, eins, mehrere); [{n}] ist die Zahl;
  • Zeilen 14–17: Es sind DIESELBEN Schlüssel, die der Server in seinen Fehlerantworten zurückgibt (siehe folgendes Kapitel).

6.1.2. Die Konfiguration

// =========================================================================
// 16-i18n/src/i18n.ts - die Konfiguration von vue-i18n
// -------------------------------------------------------------------------
// vue-i18n ist die Übersetzungsbibliothek von Vue.js. Wir übergeben ihr:
//   - ein WÖRTERBUCH pro Sprache (Dateien locales/fr.json, locales/en.json),
//     in dem jeder Text einen SCHLÜSSEL hat ("HOME.HELLO");
//   - die Startsprache (hier die in localStorage gespeicherte, andernfalls die
//     des Browsers, andernfalls Englisch);
//   - sprachspezifische Datums- und Zahlenformate.
// In den Komponenten liefert t('HOME.HELLO', { name: 'Marie' }) den
// Text der AKTUELLEN Sprache; ein Sprachwechsel aktualisiert die gesamte Seite.
//
// Es ist clientseitig dasselbe Prinzip wie im NestJS-Kurs (Wörterbücher
// i18n/*.json + Helper {{t}}) - nur dass die Übersetzung jetzt im
// Browser erfolgt und ein Sprachwechsel vom Server nichts mehr verlangt.
// =========================================================================

import { createI18n } from 'vue-i18n';
import fr from './locales/fr.json';
import en from './locales/en.json';

export type Language = 'fr' | 'en';
export const LANGUAGE_KEY = 'example16.language';

function initialLanguage(): Language {
  const stored = localStorage.getItem(LANGUAGE_KEY);
  if (stored === 'fr' || stored === 'en') {
    return stored;
  }
  return navigator.language.startsWith('fr') ? 'fr' : 'en';
}

// der Typ der Nachrichten: der des englischen Wörterbuchs (das "Modell")
type Messages = typeof en;

export const i18n = createI18n<[Messages], Language>({
  legacy: false, // die "Composition"-API (useI18n), die von <script setup>
  locale: initialLanguage(),
  fallbackLocale: 'en', // ein im Französischen fehlender Schlüssel: Der englische wird verwendet
  messages: { fr, en },
  // d(date, 'long') und n(number, 'euros'): sprachspezifische Formate
  datetimeFormats: {
    fr: { long: { dateStyle: 'full' } },
    en: { long: { dateStyle: 'full' } },
  },
  numberFormats: {
    fr: { euros: { style: 'currency', currency: 'EUR' } },
    en: { euros: { style: 'currency', currency: 'EUR' } },
  },
});
  • Zeile 19: [Vite] kann eine JSON-Datei importieren: Dies liefert ein Objekt;
  • Zeilen 25–31: die in [localStorage] gespeicherte Sprache, andernfalls die Sprache des Browsers ([navigator.language]), andernfalls Englisch;
  • Zeilen 36–50: das Konfigurationsobjekt:
    • [legacy: false]: die Composition API ([useI18n]), die von [<script setup>];
    • [fallbackLocale: 'en']: Ein im französischen Wörterbuch fehlender Schlüssel wird dem englischen Wörterbuch entnommen;
    • [datetimeFormats], [numberFormats]: für jede Sprache spezifische Datums- und Zahlenformate.
1
2
3
4
5
6
7
import { createApp } from 'vue';
import 'bootstrap/dist/css/bootstrap.min.css';
import App from './App.vue';
import { i18n } from './i18n';

// app.use(i18n): t(), d(), n() werden in allen Komponenten verfügbar
createApp(App).use(i18n).mount('#app');

6.1.3. Die Seite

<!--
  =========================================================================
  16-i18n/src/App.vue - a translated page
  -------------------------------------------------------------------------
    - t('KEY')                  a text;
    - t('KEY', { name: ... })   a text with parameters ({name} in the dictionary);
    - t('KEY', n)               a plural: "none | one | {n}" depending on n;
    - d(date, 'long')           a date, in the format of the language;
    - n(number, 'euros')        a number, in the format of the language;
    - locale                    the current language: modifying it translates everything again.
  =========================================================================
-->
<script setup lang="ts">
import { ref, watch } from 'vue';
import { useI18n } from 'vue-i18n';
import { LANGUAGE_KEY, type Language } from './i18n';

const { t, d, n, locale } = useI18n();
const count = ref(2);

// bei jedem Sprachwechsel: Er wird gespeichert, und das Attribut lang der
// Seite wird aktualisiert (nützlich für Screenreader, Rechtschreibprüfungen)
watch(
  locale,
  (language) => {
    localStorage.setItem(LANGUAGE_KEY, language);
    document.documentElement.lang = language;
    document.title = t('APP.TITLE');
  },
  { immediate: true },
);

function choose(language: Language): void {
  locale.value = language;
}

// das, was der RdvMedecins-Server zurückgeben würde (siehe das Kapitel zur Blackbox)
const serverResponses = [
  { statusCode: 409, key: 'ERRORS.LOGIN_TAKEN' },
  { statusCode: 429, key: 'ERRORS.TOO_MANY_ATTEMPTS', params: { minutes: '15' } },
];
</script>

<template>
  <div class="container py-4" style="max-width: 720px">
    <div class="d-flex justify-content-between align-items-center mb-3">
      <h1 class="h3 mb-0">{{ t('APP.TITLE') }}</h1>
      <div class="btn-group btn-group-sm" role="group" :aria-label="t('APP.LANGUAGE')">
        <button class="btn" :class="locale === 'fr' ? 'btn-primary' : 'btn-outline-primary'" @click="choose('fr')">FR</button>
        <button class="btn" :class="locale === 'en' ? 'btn-primary' : 'btn-outline-primary'" @click="choose('en')">EN</button>
      </div>
    </div>

    <div class="card p-3 mb-3">
      <p>{{ t('HOME.HELLO', { name: 'Marie' }) }}</p>
      <p>{{ t('HOME.TODAY', { date: d(new Date(), 'long') }) }}</p>
      <p>{{ t('HOME.PRICE', { price: n(1234.5, 'euros') }) }}</p>
      <!-- t(key, number) wählt die richtige Pluralform -->
      <p class="fw-bold">{{ t('HOME.APPOINTMENTS', count) }}</p>
      <div class="d-flex gap-2">
        <button class="btn btn-sm btn-outline-success" @click="count++">{{ t('HOME.ADD') }}</button>
        <button class="btn btn-sm btn-outline-secondary" :disabled="count === 0" @click="count--">{{ t('HOME.REMOVE') }}</button>
      </div>
    </div>

    <div class="card p-3">
      <h2 class="h6">{{ t('SERVER.TITLE') }}</h2>
      <p>{{ t('SERVER.EXPLANATION') }}</p>
      <ul class="mb-0">
        <li v-for="r in serverResponses" :key="r.key">
          <code>{{ JSON.stringify(r) }}</code><br>
          <!-- der Schlüssel des Servers IST ein Schlüssel des Wörterbuchs; params liefert seine Parameter -->
          &rarr; {{ t(r.key, r.params ?? {}) }}
        </li>
      </ul>
    </div>
  </div>
</template>
  • Zeile 18: Übersetzungswerkzeuge:
    • [t(key, params)]: ein Text;
    • [t(key, n)]: ein Plural;
    • [d(date, 'long')]: ein Datum im Format der Sprache;
    • [n(number, 'euros')]: eine Zahl im Format der Sprache;
    • [locale]: die aktuelle Sprache, ein [ref]. Ihre Änderung übersetzt die gesamte Seite neu;
  • Zeilen 23–30: Bei jedem Sprachwechsel wird die Auswahl gespeichert und das Attribut [lang] der Seite aktualisiert (nützlich für Screenreader und Rechtschreibprüfungen);
  • Zeilen 38–41: zwei Fehlerantworten, wie sie vom Server [RdvMedecins] zurückgegeben werden;
  • Zeile 73: Der vom Server gesendete Schlüssel ist ein Wörterbuchschlüssel; seine Parameter sind die der Nachricht.

Auf Französisch (französischer Browser):

Image

Auf Englisch, nach einem Klick auf „Add an appointment“:

Image