Beste Möglichkeit, die Lokalisierung von Ausnahmemeldungen in Spring Boot zu handhaben

Da Anwendungen wachsen, um ein globales Publikum zu bedienen, wird die Lokalisierung zu einem entscheidenden Aspekt der Softwareentwicklung. Durch die Lokalisierung können sich Anwendungen an verschiedene Sprachen und Regionen anpassen und so ein benutzerfreundliches Erlebnis bieten. 

In diesem Artikel werde ich meine bevorzugte Art der Behandlung lokalisierter Ausnahmen in einer Spring Boot-Anwendung vorstellen.

Warum brauchen wir eine Lokalisierung für Ausnahmemeldungen?

Die Lokalisierung von Ausnahmemeldungen auf der Backend-Seite ist für die Schaffung eines nahtlosen Benutzererlebnisses von entscheidender Bedeutung, insbesondere bei Anwendungen, die auf ein globales Publikum ausgerichtet sind. 

Indem wir diese Nachrichten im Backend lokalisieren und direkt an das Frontend senden, können wir den Frontend-Entwicklern die Verantwortung für die Verwaltung mehrerer Sprachen abnehmen. Dieser Ansatz stellt sicher, dass die Fehlermeldungen über alle Plattformen und Sprachen hinweg konsistent sind, sodass sich Frontend-Entwickler auf die benutzerfreundliche Anzeige dieser Meldungen konzentrieren können, beispielsweise in einem Fehler-Toast. 

Dadurch ist es nicht erforderlich, dass das Frontend benutzerdefinierte Ausnahmemeldungen für jede Sprache verarbeitet, wodurch Doppelarbeit und Fehlerpotenzial reduziert werden und sichergestellt wird, dass alle Benutzer klares und relevantes Feedback in ihrer bevorzugten Sprache erhalten.

Wie erreichen wir unser Ziel bequem im Backend?

Befolgen Sie die folgenden Schritte, um unser Ziel zu erreichen. 

Allgemeine Ausnahmeklasse

Erstellen Sie zunächst eine Klasse, die von RuntimeException ausgeht, und nennen Sie sie ResponseException. Mit dieser benutzerdefinierten Ausnahme können Sie anwendungsspezifische Fehler kontrollierter behandeln.

public class ResponseException extends RuntimeException {

}

Antwortfehlerklasse

Erstellen Sie eine separate Klasse, die in der Antwort zurückgegeben wird, wenn eine Ausnahme auftritt. Diese Klasse kann Felder wie Nachricht, Zeitstempel, Fehlercode und alle anderen relevanten Informationen enthalten, die Sie an das Frontend übergeben möchten.

public record ErrorResponse(int status, String message) {

}

Globaler Ausnahmehandler

Implementieren Sie einen GlobalExceptionHandler mithilfe der @ControllerAdvice-Annotation von Spring. In dieser Klasse können Sie die ResponseException abfangen und sie basierend auf dem Gebietsschema des Benutzers der entsprechenden lokalisierten Nachricht zuordnen.

@Slf4j
@RestControllerAdvice
@RequiredArgsConstructor
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

  @ExceptionHandler(value = ResponseException.class)
  public ResponseEntity<errorresponse> handleResponseStatusException(
      ResponseException ex
  ) {
    log.error("ResponseException: {}", ex.getMessage());

    String message = ex.getMessage();

    var errorResponse = new ErrorResponse(ex.getStatus().value(), message);

    return new ResponseEntity(errorResponse, ex.getStatus());
  }
}
</errorresponse>

Sprachspezifische Eigenschaftsdateien

Um die lokalisierten Nachrichten zu verwalten, erstellen Sie Eigenschaftsdateien für jede unterstützte Sprache, z. B. „messages_en.properties“ für Englisch, „messages_az.properties“ für Aserbaidschanisch usw. Diese Dateien enthalten die Schlüssel-Wert-Paare für jede Ausnahmemeldung, sodass Spring automatisch die richtige Meldung basierend auf dem Gebietsschema des Benutzers auflösen kann.

Erstellen Sie diese Eigenschaftendateien im Ordner src/main/resources.

err.username_already_exists.msg=User with username: {0} is already exists.

Lokalisierungsteil implementieren

Ich habe das Nötigste für die Behandlung von Ausnahmen in Spring Boot erstellt. Ich gehe davon aus, dass Sie mit dem oben Gesagten bereits vertraut sind. Fügen wir weiterhin den Übersetzungsteil hinzu.

ResponseException-Klasse ändern:

public class ResponseException extends RuntimeException {
  private final String messageTemplate;
  private final transient Object[] params;
  private final Locale locale;

  public static ResponseException notFound(String messageTemplate, Locale locale) {
    return new ResponseException(HttpStatus.NOT_FOUND, messageTemplate, null, locale);
  }

  public static ResponseException notFound(String messageTemplate, Object[] params, Locale locale) {
    return new ResponseException(HttpStatus.NOT_FOUND, messageTemplate, params, locale);
  }

  public static ResponseException forbidden(String messageTemplate, Locale locale) {
    return new ResponseException(HttpStatus.FORBIDDEN, messageTemplate, null, locale);
  }

  public static ResponseException forbidden(String messageTemplate, Object[] params, Locale locale) {
    return new ResponseException(HttpStatus.FORBIDDEN, messageTemplate, params, locale);
  }  
}

Erstellen Sie Hilfsmethoden für häufig verwendete HttpStatus-Codes wie NOT_FOUND, FORBIDDEN.

Sie können diese Hilfsmethoden auf folgende Weise verwenden:

// some code parts omitted ...
userService.findByUsername(username)
  .orElseThrow(() -> ResponseException.notFound("user_not_found", locale))

Erstellen Sie in allen Ihren Immobiliendateien eine Nachrichtenvorlage „user_not_found“.

// file: messages_en.properties
user_not_found=User not found

// file: messages_az.properties
user_not_found=İsdifadəçi tapılmadı

Um diese automatisch zu ersetzen, bevor Sie zum Frontend zurückkehren, aktualisieren Sie die Methode in der GlobalExceptionHandler-Klasse.

@Slf4j
@RestControllerAdvice
@RequiredArgsConstructor
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

  private final MessageSource messageSource;

  @ExceptionHandler(value = ResponseException.class)
  public ResponseEntity<errorresponse> handleResponseStatusException(
      ResponseException ex
  ) {
    log.error("ResponseException: {}", ex.getMessage());

    String message = ex.getMessage();

    String messageTemplate = ex.getMessageTemplate();
    if (StringUtils.isNotBlank(messageTemplate)) {
      message = messageSource.getMessage(messageTemplate, ex.getParams(), ex.getLocale());
    }

    var errorResponse = new ErrorResponse(ex.getStatus().value(), message);

    return new ResponseEntity(errorResponse, ex.getStatus());
  }
}
</errorresponse>

So verwenden Sie dynamische Werte in Ausnahmemeldungen

Diese Art der Ausnahmebehandlung ist nützlich, insbesondere wenn Sie dynamische Werte für Ihre Ausnahmemeldungen festlegen müssen. Zum Beispiel

// file: messages_en.properties
err.invalid_phone_number.msg=The phone: {0} is invalid

Um {0} durch einen dynamischen Wert zu ersetzen.

public static ResponseException badRequest(
      String messageTemplate, 
      Locale locale,
      String... params
) {
  return new ResponseException(
        HttpStatus.BAD_REQUEST, 
        messageTemplate, 
        params, 
        locale
  );
}

Ich habe den Parameter varargs am Ende eingefügt, um mehrere dynamische Parameter zu übergeben, ohne jedes Mal eine neue Methode zu erstellen.

Ich habe einen speziellen Artikel über Nachrichten mit dynamischen Werten.

Wo erhalte ich das Gebietsschema des Benutzers?

Ich habe zwei Ansätze, um Gebietsschemas abzurufen:

1. Gebietsschemata der Benutzer, die basierend auf den Benutzeroberflächeneinstellungen in der Datenbank gespeichert werden.

2. Einige Controller-Methoden akzeptieren optionale lang-Anforderungsparameter. Dies kann zum Testen nützlich sein, wenn Frontend-Entwickler sehen möchten, wie die Benutzeroberfläche in verschiedenen Sprachen aussieht. Weil die Satzlänge in jeder Sprache nicht gleich ist.

Abschluss

Das war's für heute. Ich hoffe, es hat Ihnen gefallen.

Der Quellcode ist im Repository in meinem GitHub-Konto verfügbar.

Wenn Sie Fragen haben, können Sie mich gerne über LinkedIn erreichen.

Das obige ist der detaillierte Inhalt vonBeste Möglichkeit, die Lokalisierung von Ausnahmemeldungen in Spring Boot zu handhaben. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!