首页演练场案例展示应用文档博客
    • English英语
      EN
    • русский俄语
      RU
    • 日本語日语
      JA
    • français法语
      FR
    • 한국어韩语
      KO
    • 中文中文
      ZH
    • español西班牙语
      ES
    • Deutsch德语
      DE
    • العربية阿拉伯语
      AR
    • italiano意大利语
      IT
    • British English英国英语
      EN-GB
    • português葡萄牙语
      PT
    • हिन्दी印地语
      HI
    • Türkçe土耳其语
      TR
    • polski波兰语
      PL
    • Indonesia印度尼西亚语
      ID
    • Tiếng Việt越南语
      VI
    • українська乌克兰语
      UK
    /
    按框架筛选文档
    Alt+←
    为什么Intlayer?
    开始
    概念
    • Intlayer如何工作
    • 配置
    • TestFillBuildWatchExtractLoginPushPullConfigurationListVersionEditorLiveDebugDoc ReviewDoc TranslateSDK
    • 可视化编辑器
    • CMS
    • CI/CD集成
    • 翻译复数枚举条件性别插入文件嵌套MarkdownHTML函数获取
    • 每个语言环境的文件
    • 编译器
    • 自动填充
    • 测试
    • 打包优化
    环境
    • Next.js 14和应用路由器
      Next.js 15
      Next.js 无 locale URL
      Next.js和页面路由器
      编译器
    • Tanstack Start Solid
    • Astro和React
      Astro和Svelte
      Astro和Vue
      Astro和Solid
      Astro和Preact
      Astro和Lit
      Astro和Vanilla JS
    • React Router v7
      React Router v7 (fs-routes)
      Compiler
    • Nuxt和Vue
    • Vite和Solid
    • SvelteKit
    • Vite和Preact
    • Vite和Vanilla JS
    • Vite和Lit
    • Angular 19 (Webpack)
      Analog
    • React CRA
    • React Native和Expo
    • Express.js
      NestJS
      Fastify
      Hono
      Adonis
    • Lynx和React
    Plugins
    • JSON
    • gettext (.po)
    VS Code扩展
    代理
    • MCP服务器
    • 代理技能
    发布
    • v8
    • v7
    • v6
    基准测试
    • Next.js
    • TanStack
    • Vue
    • Solid
    • Svelte
    博客
    问问题
    1. Documentation
    2. Packages
    3. Intlayer
    4. GetLocalizedUrl
    Creation:2024-08-11Last update:2025-06-29
    将此文档参考到您的 AI 助手
    ChatGPT
    Claude
    DeepSeek
    Google AI mode
    Gemini
    Perplexity
    Mistral
    Grok

    使用您最喜欢的AI助手总结文档,并引用此页面和AI提供商

    此文档已过期,基础版本已在以下日期更新 2025年11月16日.

    前往英文文档

    版本历史

    1. "初始化历史"
      v5.5.102025/6/29
    2. "初始化历史记录"
      v5.5.102025/6/29

    此页面的内容已使用 AI 翻译。

    查看英文原文的最新版本
    编辑此文档

    如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。

    文档的 GitHub 链接
    Copy

    复制文档 Markdown 到剪贴板

    文档:intlayer 中的 getLocalizedUrl 函数

    描述

    getLocalizedUrl 函数通过在给定的 URL 前添加指定的语言环境前缀来生成本地化的 URL。它可以处理绝对 URL 和相对 URL,确保根据配置应用正确的语言环境前缀。


    参数

    • url: string

      • 描述:需要添加语言环境前缀的原始 URL 字符串。
      • 类型:string
    • currentLocale: Locales

      • 描述:当前正在本地化的语言环境。
      • 类型:Locales
    • locales: Locales[]

      • 描述:可选的支持语言环境数组。默认情况下,提供项目中配置的语言环境。
      • 类型:Locales[]
      • 默认值:项目配置
    • defaultLocale: Locales

      • 描述:应用程序的默认语言环境。默认情况下,提供项目中配置的默认语言环境。
      • 类型:Locales
      • 默认值:项目配置
    • prefixDefault: boolean

      • 描述:是否为默认语言环境的 URL 添加前缀。默认情况下,提供项目中配置的值。
      • 类型:boolean
      • 默认值:项目配置

    返回值

    • 类型: string
    • 描述: 指定语言环境的本地化 URL。

    示例用法

    相对 URL

    typescript
    复制代码

    复制代码到剪贴板

    import { getLocalizedUrl, Locales } from "intlayer";
    
    getLocalizedUrl(
      "/about",
      Locales.FRENCH,
      [Locales.ENGLISH, Locales.FRENCH],
      Locales.ENGLISH,
      false
    );
    
    // 输出: 对于法语环境为 "/fr/about"
    // 输出: 对于默认(英语)环境为 "/about"

    绝对 URL

    typescript
    复制代码

    复制代码到剪贴板

    getLocalizedUrl(  "https://example.com/about",  Locales.FRENCH, // 当前区域  [Locales.ENGLISH, Locales.FRENCH], // 支持的区域  Locales.ENGLISH, // 默认区域  false // 是否为默认语言添加前缀); // 输出: "https://example.com/fr/about" (法语)getLocalizedUrl(  "https://example.com/about",  Locales.ENGLISH, // 当前语言  [Locales.ENGLISH, Locales.FRENCH], // 支持的语言  Locales.ENGLISH, // 默认语言  false // 是否为默认语言添加前缀); // 输出: "https://example.com/about" (英语)getLocalizedUrl(  "https://example.com/about",  Locales.ENGLISH, // 当前语言  [Locales.ENGLISH, Locales.FRENCH], // 支持的语言  Locales.ENGLISH, // 默认语言  true // 是否为默认语言添加前缀); // 输出: "https://example.com/en/about" (英语)

    不支持的语言

    typescript
    复制代码

    复制代码到剪贴板

    getLocalizedUrl(  "/about",  Locales.ITALIAN, // 当前语言  [Locales.ENGLISH, Locales.FRENCH], // 支持的语言环境  Locales.ENGLISH // 默认语言环境); // 输出: "/about"(对于不支持的语言环境不添加前缀)

    边缘情况

    • 无语言环境段:

      • 如果 URL 中不包含任何语言环境段,函数会安全地添加适当的语言环境前缀。
    • 默认语言环境:

      • 当 prefixDefault 为 false 时,函数不会为默认语言环境添加前缀。
    • 不支持的语言环境:

      • 对于未列在 locales 中的语言环境,函数不会添加任何前缀。

    在应用中的使用

    在多语言应用程序中,使用 locales 和 defaultLocale 配置国际化设置对于确保显示正确的语言至关重要。以下是如何在应用程序设置中使用 getLocalizedUrl 的示例:

    tsx
    复制代码

    复制代码到剪贴板

    import { Locales, type IntlayerConfig } from "intlayer";
    
    // 支持的语言和默认语言配置
    export default {
      internationalization: {
        locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
        defaultLocale: Locales.ENGLISH,
      },
    } satisfies IntlayerConfig;
    
    export default config;

    上述配置确保应用程序识别 ENGLISH、FRENCH 和 SPANISH 作为支持的语言,并使用 ENGLISH 作为回退语言。

    使用此配置,getLocalizedUrl 函数可以根据用户的语言偏好动态生成本地化 URL:

    typescript
    复制代码

    复制代码到剪贴板

    getLocalizedUrl("/about", Locales.FRENCH); // 输出: "/fr/about"getLocalizedUrl("/about", Locales.SPANISH); // 输出: "/es/about"getLocalizedUrl("/about", Locales.ENGLISH); // 输出: "/about"

    通过集成 getLocalizedUrl,开发者可以在多语言环境中保持一致的 URL 结构,提升用户体验和 SEO 效果。

    为什么Intlayer?
    Alt+→

    在此页面

      讨论是匿名的,并会定期审查以解决常见问题。欢迎分享功能想法、对文档的反馈或任何与 Intlayer 相关的内容, 我们会利用这些意见来制定路线图并改进产品。

      getLocalizedUrl(  "https://example.com/about",  Locales.FRENCH, // 当前区域  [Locales.ENGLISH, Locales.FRENCH], // 支持的区域  Locales.ENGLISH, // 默认区域  false // 是否为默认语言添加前缀); // 输出: "https://example.com/fr/about" (法语)getLocalizedUrl(  "https://example.com/about",  Locales.ENGLISH, // 当前语言  [Locales.ENGLISH, Locales.FRENCH], // 支持的语言  Locales.ENGLISH, // 默认语言  false // 是否为默认语言添加前缀); // 输出: "https://example.com/about" (英语)getLocalizedUrl(  "https://example.com/about",  Locales.ENGLISH, // 当前语言  [Locales.ENGLISH, Locales.FRENCH], // 支持的语言  Locales.ENGLISH, // 默认语言  true // 是否为默认语言添加前缀); // 输出: "https://example.com/en/about" (英语)
      getLocalizedUrl(  "/about",  Locales.ITALIAN, // 当前语言  [Locales.ENGLISH, Locales.FRENCH], // 支持的语言环境  Locales.ENGLISH // 默认语言环境); // 输出: "/about"(对于不支持的语言环境不添加前缀)
      getLocalizedUrl("/about", Locales.FRENCH); // 输出: "/fr/about"getLocalizedUrl("/about", Locales.SPANISH); // 输出: "/es/about"getLocalizedUrl("/about", Locales.ENGLISH); // 输出: "/about"