next.js app目錄 i18n國際化簡單實現

来源:https://www.cnblogs.com/tandk-blog/p/18149028/how-nextjs-app-simply-make-i18n
-Advertisement-
Play Games

XQuery 是 XML 數據的查詢語言，類似於 SQL 是資料庫的查詢語言。它被設計用於查詢 XML 數據。 XQuery 示例 for $x in doc("books.xml")/bookstore/book where $x/price > 30 order by $x/title retu ...


最近在用next寫一個多語言的項目，找了好久沒找到簡單實現的教程，實踐起來感覺都比較複雜，最後終於是在官方文檔找到了，結合網上找到的代碼demo，終於實現了，在這裡簡單總結一下。

此教程適用於比較簡單的項目實現，如果你是剛入門next，並且不想用太複雜的方式去實現一個多語言項目，那麼這個教程就挺適合你的。

此教程適用於app目錄的next項目。

先貼一下參閱的連接：

官方教程： next i18n 文檔

可參閱的代碼demo

實現思路

結合文件結構解說一下大致邏輯：

image

  • i18n-config.ts只是一個全局管理多語言簡寫的枚舉文件，其他文件可以引用這個文件，這樣就不會出現不同文件對不上的情況。
  • middleware.ts做了一層攔截，在用戶訪問localhost:3000的時候能通過請求頭判斷用戶常用的語言，配合app目錄多出來的[lang]目錄，從而實現跳轉到localhost:3000/zh這樣。
  • dictionaries文件夾下放各語言的json欄位，通過欄位的引用使頁面呈現不同的語種。
    事實上每個頁面的layout.tsx和page.tsx都會將語言作為參數傳入，在對應的文件里，再調用get-dictionaries.ts文件里的方法就能讀取到對應的json文件里的內容了。

大致思路是這樣，下麵貼對應的代碼。

/i18n-config.ts

export const i18n = {
    defaultLocale: "en",
    // locales: ["en", "zh", "es", "hu", "pl"],
    locales: ["en", "zh"],
} as const;

export type Locale = (typeof i18n)["locales"][number];

/middleware.ts，需要先安裝兩個依賴，這兩個依賴用於判斷用戶常用的語言：

npm install @formatjs/intl-localematcher
npm install negotiator

然後才是/middleware.ts的代碼：

import { NextResponse } from "next/server";
import type { NextRequest } from "next/server";

import { i18n } from "./i18n-config";

import { match as matchLocale } from "@formatjs/intl-localematcher";
import Negotiator from "negotiator";

function getLocale(request: NextRequest): string | undefined {
  // Negotiator expects plain object so we need to transform headers
  const negotiatorHeaders: Record<string, string> = {};
  request.headers.forEach((value, key) => (negotiatorHeaders[key] = value));

  // @ts-ignore locales are readonly
  const locales: string[] = i18n.locales;

  // Use negotiator and intl-localematcher to get best locale
  let languages = new Negotiator({ headers: negotiatorHeaders }).languages(
    locales,
  );

  const locale = matchLocale(languages, locales, i18n.defaultLocale);

  return locale;
}

export function middleware(request: NextRequest) {
  const pathname = request.nextUrl.pathname;

  // // `/_next/` and `/api/` are ignored by the watcher, but we need to ignore files in `public` manually.
  // // If you have one
  // if (
  //   [
  //     '/manifest.json',
  //     '/favicon.ico',
  //     // Your other files in `public`
  //   ].includes(pathname)
  // )
  //   return

  // Check if there is any supported locale in the pathname
  const pathnameIsMissingLocale = i18n.locales.every(
    (locale) =>
      !pathname.startsWith(`/${locale}/`) && pathname !== `/${locale}`,
  );

  // Redirect if there is no locale
  if (pathnameIsMissingLocale) {
    const locale = getLocale(request);

    // e.g. incoming request is /products
    // The new URL is now /en-US/products
    return NextResponse.redirect(
      new URL(
        `/${locale}${pathname.startsWith("/") ? "" : "/"}${pathname}`,
        request.url,
      ),
    );
  }
}

export const config = {
  // Matcher ignoring `/_next/` and `/api/`
  matcher: ["/((?!api|_next/static|_next/image|favicon.ico).*)"],
};

/dictionaries下的因項目而異，可以看個參考：
image

文件以語言簡寫命名，/i18n-config.ts里的locales有什麼語言，這裡就有多少個對應的文件就行了。

/get-dictionaries.ts

import "server-only";
import type { Locale } from "./i18n-config";

// We enumerate all dictionaries here for better linting and typescript support
// We also get the default import for cleaner types
const dictionaries = {
  en: () => import("./dictionaries/en.json").then((module) => module.default),
  zh: () => import("./dictionaries/zh.json").then((module) => module.default),
};

export const getDictionary = async (locale: Locale) => dictionaries[locale]?.() ?? dictionaries.en();

實際使用可以做個參考：
image

到這裡其實就實現了，但是下麵的事情需要註意：

如果你的項目有集成了第三方需要配知道middleware的地方，比如clerk，需要調試一下是否衝突。

如果你不知道clerk是什麼，那麼下麵可以不用看，下麵將以clerk為例，描述一下可能遇到的問題和解決方案。

Clerk適配

clerk是一個可以快速登錄的第三方庫，用這個庫可以快速實現用戶登錄的邏輯，包括Google、GitHub、郵箱等的登錄。

clerk允許你配置哪些頁面是公開的，哪些頁面是需要登錄之後才能看的，如果用戶沒登錄，但是卻訪問了需要登錄的頁面，就會返回401，跳轉到登錄頁面。

就是這裡衝突了，因為我們實現多語言的邏輯是，用戶訪問localhost:3000的時候判斷用戶常用的語言，從而實現跳轉到localhost:3000/zh這樣。

這兩者實現都在middleware.ts文件中，上面這種配置會有衝突，這兩者只有一個能正常跑通，而我們想要的效果是兩者都能跑通，既能自動跳轉到登錄頁面，也能自動跳轉到常用語言頁面。

技術問題定位：這是因為你重寫了middleware方法，導致不會執行Clerk的authMiddleware方法，視覺效果上，就是多語言導致了Clerk不會自動跳轉登錄。

所以要把上面的middleware方法寫到authMiddleware方法里的beforeAuth里去，Clerk官方有說明： Clerk authMiddleware說明

image

所以現在/middleware.ts文件內的內容變成了：

import { NextResponse } from "next/server";
import type { NextRequest } from "next/server";
import { authMiddleware } from "@clerk/nextjs";
import { i18n } from "./i18n-config";
import { match as matchLocale } from "@formatjs/intl-localematcher";
import Negotiator from "negotiator";

function getLocale(request: NextRequest): string | undefined {
  // Negotiator expects plain object so we need to transform headers
  const negotiatorHeaders: Record<string, string> = {};
  request.headers.forEach((value, key) => (negotiatorHeaders[key] = value));

  // @ts-ignore locales are readonly
  const locales: string[] = i18n.locales;

  // Use negotiator and intl-localematcher to get best locale
  let languages = new Negotiator({ headers: negotiatorHeaders }).languages(
    locales,
  );

  const locale = matchLocale(languages, locales, i18n.defaultLocale);

  return locale;
}

export const config = {
  // Matcher ignoring `/_next/` and `/api/`
  matcher: ["/((?!api|_next/static|_next/image|favicon.ico).*)"],
  // matcher: ["/((?!.+\\.[\\w]+$|_next).*)", "/", "/(api|trpc)(.*)"],
};

export default authMiddleware({
  publicRoutes: ['/anyone-can-visit-this-route'],
  ignoredRoutes: ['/no-auth-in-this-route'],
  beforeAuth: (request) => {
    const pathname = request.nextUrl.pathname;

    // // `/_next/` and `/api/` are ignored by the watcher, but we need to ignore files in `public` manually.
    // // If you have one
    if (
      [
        '/manifest.json',
        '/favicon.ico',
        '/serviceWorker.js',
        '/en/sign-in'
        // Your other files in `public`
      ].includes(pathname)
    )
      return

    // Check if there is any supported locale in the pathname
    const pathnameIsMissingLocale = i18n.locales.every(
      (locale) =>
        !pathname.startsWith(`/${locale}/`) && pathname !== `/${locale}`,
    );

    // Redirect if there is no locale
    if (pathnameIsMissingLocale) {
      const locale = getLocale(request);

      // e.g. incoming request is /products
      // The new URL is now /en-US/products
      return NextResponse.redirect(
        new URL(
          `/${locale}${pathname.startsWith("/") ? "" : "/"}${pathname}`,
          request.url,
        ),
      );
    }
  }
});

這樣就OK了，大功告成。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 鴻蒙HarmonyOS實戰-ArkUI組件（Canvas）
    一、Canvas Canvas組件是一種圖形渲染組件，它提供了一個畫布（canvas），開發者可以在上面繪製各種圖形、文本等。Canvas組件通常用於創建游戲、數據可視化等需要動態繪製圖形的應用程式。 Canvas組件提供了多個API，開發者可以使用這些API進行繪製操作。常用的API包括繪製矩 ...
  • 鴻蒙開發TypeScript語言：【函數】
    函數是一組一起執行一個任務的語句。 您可以把代碼劃分到不同的函數中。如何劃分代碼到不同的函數中是由您來決定的，但在邏輯上，劃分通常是根據每個函數執行一個特定的任務來進行的。 函數聲明告訴編譯器函數的名稱、返回類型和參數。函數定義提供了函數的實際主體。 函數定義 函數就是包裹在花括弧中的代碼塊，前面使 ...
  • HarmonyOS NEXT應用開發之Tab組件實現增刪Tab標簽
    介紹 本示例介紹使用了Tab組件實現自定義增刪Tab頁簽的功能。該場景多用於瀏覽器等場景。 效果圖預覽 使用說明： 點擊新增按鈕，新增Tab頁面。 點擊刪除按鈕，刪除Tab頁面。 實現思路 設置Tab組件的barHeight為0，隱藏組件自帶的TabBar。 Tabs() { ... } .barH ...
  • 主題搗鼓日記
    主題搗鼓日記 sakura版本（YYDS） 主要框架都沒怎麼動，功能挺完整的。但是如果要DIY還是得自己把代碼捋一遍，不然從哪改起都不知道，註釋不能說完全沒用。。。 搗鼓了兩天兩夜，還是有很多細節沒改好，main.js翻了四五遍，看評論區發現諸多細節還要改CSS文件，太難了。。前端都忘得差不多了，趕 ...
  • 結對編碼-軟體開發與創新課程設計
    一、題目及運行環境 1.小組成員 2252331 與 2252336 2.題目 小學老師要每周給同學出300道四則運算練習題。 這個程式有很多種實現方式： C/C++ C#/VB.net/Java Excel Unix Shell Emacs/Powershell/Vbscript Perl Pyt ...
  • 前端如何防止介面重覆提交
    什麼是介面重覆提交？ 介面重覆提交指的是在網路通信中，同一個請求被客戶端多次發送到伺服器端的情況。這種情況可能由於多種原因導致，例如用戶在等待期間多次點擊提交按鈕、網路超時後客戶端重新發送請求、客戶端發送的請求在網路傳輸過程中出現重覆等。 介面重覆提交可能會導致多種問題，當伺服器收到重覆請求時，可能 ...
  • vue3 快速入門系列 —— 其他API
    其他章節請看： vue3 快速入門 系列 他API 前面我們已經學習了 vue3 的一些基礎知識，本篇將繼續講解一些常用的其他api，以及較完整的分析vue2 和 vue3 的改變。 淺層響應式數據 shallowRef shallow 中文：“淺層的” shallowRef：淺的 ref()。 先 ...
  • 怎麼樣零代碼零成本搭建個人網站？
    零代碼指的是藉助VuePress 通過簡單配置，幫助我們生成靜態網站。 零成本指的是藉助GitHub Pages 或者Gitee Pages部署網站，讓互聯網上的小伙伴能訪問到它 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類