next.js app目录 i18n国际化简单实现

转x33g5p2x  于9个月前 转载在 其他  
字(5.7k)|赞(0)|评价(0)|浏览(109)

最近在用next写一个多语言的项目，找了好久没找到简单实现的教程，实践起来感觉都比较复杂，最后终于是在官方文档找到了，结合网上找到的代码demo，终于实现了，在这里简单总结一下。

此教程适用于比较简单的项目实现，如果你是刚入门next，并且不想用太复杂的方式去实现一个多语言项目，那么这个教程就挺适合你的。

此教程适用于app目录的next项目。

先贴一下参阅的连接：

官方教程： next i18n 文档

可参阅的代码demo

实现思路

结合文件结构解说一下大致逻辑：

  • 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

  1. export const i18n = {
  2.     defaultLocale: "en",
  3.     // locales: ["en", "zh", "es", "hu", "pl"],
  4.     locales: ["en", "zh"],
  5. } as const;
  7. export type Locale = (typeof i18n)["locales"][number];

/middleware.ts ，需要先安装两个依赖，这两个依赖用于判断用户常用的语言：

  1. npm install @formatjs/intl-localematcher
  2. npm install negotiator

然后才是 /middleware.ts 的代码：

  1. import { NextResponse } from "next/server";
  2. import type { NextRequest } from "next/server";
  4. import { i18n } from "./i18n-config";
  6. import { match as matchLocale } from "@formatjs/intl-localematcher";
  7. import Negotiator from "negotiator";
  9. function getLocale(request: NextRequest): string | undefined {
  10.   // Negotiator expects plain object so we need to transform headers
  11.   const negotiatorHeaders: Record<string, string> = {};
  12.   request.headers.forEach((value, key) => (negotiatorHeaders[key] = value));
  14.   // @ts-ignore locales are readonly
  15.   const locales: string[] = i18n.locales;
  17.   // Use negotiator and intl-localematcher to get best locale
  18.   let languages = new Negotiator({ headers: negotiatorHeaders }).languages(
  19.     locales,
  20.   );
  22.   const locale = matchLocale(languages, locales, i18n.defaultLocale);
  24.   return locale;
  25. }
  27. export function middleware(request: NextRequest) {
  28.   const pathname = request.nextUrl.pathname;
  30.   // // `/_next/` and `/api/` are ignored by the watcher, but we need to ignore files in `public` manually.
  31.   // // If you have one
  32.   // if (
  33.   //   [
  34.   //     '/manifest.json',
  35.   //     '/favicon.ico',
  36.   //     // Your other files in `public`
  37.   //   ].includes(pathname)
  38.   // )
  39.   //   return
  41.   // Check if there is any supported locale in the pathname
  42.   const pathnameIsMissingLocale = i18n.locales.every(
  43.     (locale) =>
  44.       !pathname.startsWith(`/${locale}/`) && pathname !== `/${locale}`,
  45.   );
  47.   // Redirect if there is no locale
  48.   if (pathnameIsMissingLocale) {
  49.     const locale = getLocale(request);
  51.     // e.g. incoming request is /products
  52.     // The new URL is now /en-US/products
  53.     return NextResponse.redirect(
  54.       new URL(
  55.         `/${locale}${pathname.startsWith("/") ? "" : "/"}${pathname}`,
  56.         request.url,
  57.       ),
  58.     );
  59.   }
  60. }
  62. export const config = {
  63.   // Matcher ignoring `/_next/` and `/api/`
  64.   matcher: ["/((?!api|_next/static|_next/image|favicon.ico).*)"],
  65. };

/dictionaries 下的因项目而异，可以看个参考：

文件以语言简写命名， /i18n-config.ts 里的 locales 有什么语言，这里就有多少个对应的文件就行了。

/get-dictionaries.ts

  1. import "server-only";
  2. import type { Locale } from "./i18n-config";
  4. // We enumerate all dictionaries here for better linting and typescript support
  5. // We also get the default import for cleaner types
  6. const dictionaries = {
  7.   en: () => import("./dictionaries/en.json").then((module) => module.default),
  8.   zh: () => import("./dictionaries/zh.json").then((module) => module.default),
  9. };
  11. export const getDictionary = async (locale: Locale) => dictionaries[locale]?.() ?? dictionaries.en();

实际使用可以做个参考：

到这里其实就实现了，但是下面的事情需要注意：

如果你的项目有集成了第三方需要配知道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说明

所以现在/middleware.ts文件内的内容变成了：

  1. import { NextResponse } from "next/server";
  2. import type { NextRequest } from "next/server";
  3. import { authMiddleware } from "@clerk/nextjs";
  4. import { i18n } from "./i18n-config";
  5. import { match as matchLocale } from "@formatjs/intl-localematcher";
  6. import Negotiator from "negotiator";
  8. function getLocale(request: NextRequest): string | undefined {
  9.   // Negotiator expects plain object so we need to transform headers
  10.   const negotiatorHeaders: Record<string, string> = {};
  11.   request.headers.forEach((value, key) => (negotiatorHeaders[key] = value));
  13.   // @ts-ignore locales are readonly
  14.   const locales: string[] = i18n.locales;
  16.   // Use negotiator and intl-localematcher to get best locale
  17.   let languages = new Negotiator({ headers: negotiatorHeaders }).languages(
  18.     locales,
  19.   );
  21.   const locale = matchLocale(languages, locales, i18n.defaultLocale);
  23.   return locale;
  24. }
  26. export const config = {
  27.   // Matcher ignoring `/_next/` and `/api/`
  28.   matcher: ["/((?!api|_next/static|_next/image|favicon.ico).*)"],
  29.   // matcher: ["/((?!.+\\.[\\w]+$|_next).*)", "/", "/(api|trpc)(.*)"],
  30. };
  32. export default authMiddleware({
  33.   publicRoutes: ['/anyone-can-visit-this-route'],
  34.   ignoredRoutes: ['/no-auth-in-this-route'],
  35.   beforeAuth: (request) => {
  36.     const pathname = request.nextUrl.pathname;
  38.     // // `/_next/` and `/api/` are ignored by the watcher, but we need to ignore files in `public` manually.
  39.     // // If you have one
  40.     if (
  41.       [
  42.         '/manifest.json',
  43.         '/favicon.ico',
  44.         '/serviceWorker.js',
  45.         '/en/sign-in'
  46.         // Your other files in `public`
  47.       ].includes(pathname)
  48.     )
  49.       return
  51.     // Check if there is any supported locale in the pathname
  52.     const pathnameIsMissingLocale = i18n.locales.every(
  53.       (locale) =>
  54.         !pathname.startsWith(`/${locale}/`) && pathname !== `/${locale}`,
  55.     );
  57.     // Redirect if there is no locale
  58.     if (pathnameIsMissingLocale) {
  59.       const locale = getLocale(request);
  61.       // e.g. incoming request is /products
  62.       // The new URL is now /en-US/products
  63.       return NextResponse.redirect(
  64.         new URL(
  65.           `/${locale}${pathname.startsWith("/") ? "" : "/"}${pathname}`,
  66.           request.url,
  67.         ),
  68.       );
  69.     }
  70.   }
  71. });

这样就OK了，大功告成。

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://www.cnblogs.com/tandk-blog/p/18149028/how-nextjs-app-simply-make-i18n

内容来源于网络，如有侵权，请联系作者删除！

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com