npm 包 @ngx-i18n-router/core 使用教程

阅读时长 9 分钟读完

随着全球化的发展,网站国际化的需求越来越高。在前端开发中,解决多语言路由的问题一直是一个较为棘手的难题。本文将介绍一款解决多语言路由问题的 npm 包 @ngx-i18n-router/core,包括使用方法、示例代码等。

什么是 @ngx-i18n-router/core

@ngx-i18n-router/core 是一个 Angular 框架下的多语言路由解决方案,它能帮助你轻松实现网站的多语言支持,并解决了路由跳转、SEO 等相关问题。

该 npm 包提供了以下主要功能:

  • 支持通过 URL 地址中的前缀来区分不同语言版本的页面,如 /en/home/zh/home
  • 通过路由拦截器自动切换语言,并保留原 URL 中的其它参数。
  • 支持 SEO 友好的页面 URL。
  • 可以根据用户在浏览器中设置的语言环境自动选择对应语言的页面。

如何使用 @ngx-i18n-router/core

安装

在安装 @ngx-i18n-router/core 之前,需要确认你已经安装好 Angular 环境。然后,在终端中运行以下命令进行安装:

设定语言环境

接下来,需要在 app.module.ts 文件中添加两个模块:I18nRouterModuleTranslateHttpLoader。其中,I18nRouterModule 是核心模块,TranslateHttpLoader 则是一个用于将语言数据加载到内存中的模块。

请参考以下代码示例:

-- -------------------- ---- -------
------ - -------- - ---- ----------------
------ - ------------- - ---- ----------------------------
------ - ---------------- - ---- -----------------------
------ - ------------ - ---- ------------------
------ - ----------------- ---------- - ---- -----------------------
------ - ------------------- - ---- -----------------------------
------ - ---------------- --------------- - ---- ----------------------
------ - ---------------- - ---- ------------------------

------ -------- ----------------------- ----------- -
  ------ --- ------------------------- ----------------- ---------
-

-----------
  ------------- -
    ------------
  --
  -------- -
    --------------
    --------------------------- -- -- ----------------
    -----------------
    -----------------
    -------------------------
      ------- -
        -------- ----------------
        ----------- ------------------
        ----- ------------
      -
    --
  --
  ---------- ---
  ---------- --------------
--
------ ----- --------- - -

在上述代码中,我们通过 I18nRouterModule.forRoot() 导入了 @ngx-i18n-router/core 核心模块,通过 TranslateHttpLoader 将语言数据加载到内存中。

配置路由

需要在 app-routing.module.ts 文件中添加路由,同时定义语言前缀。请参考以下代码示例:

-- -------------------- ---- -------
------ - -------- - ---- ----------------
------ - ------------- ------ - ---- ------------------
------ - ------------- - ---- ------------------------
------ - -------------- - ---- --------------------------

----- ------- ------ - -
  -
    ----- ---
    ---------- -------
    ----------- --------- -- -------- ---- --
  --
  -
    ----- -------- -- ----
    ---------- --------------
  --
  -
    ----- -------------- -- ---- - ----
    ---------- ---------------
  -
--

-----------
  -------- -------------------------------
  -------- --------------
--
------ ----- ---------------- - -

通过以上配置,我们可以看到,路由配置中的 path: ':lang' 指定了语言前缀,而 path: ':lang/about' 指定了语言前缀和页面路由。

使用路由拦截器

app.module.ts 文件中添加以下路由拦截器代码:

-- -------------------- ---- -------
------ - -------- - ---- ----------------
------ - ------------- - ---- ----------------------------
------ - ---------------- - ---- -----------------------
------ - ------------ - ---- ------------------
------ - ----------------- ---------- - ---- -----------------------
------ - ------------------- - ---- -----------------------------
------ - ---------------- --------------- - ---- ----------------------
------ - ---------------- - ---- ------------------------
------ - ----------------- - ---- --------------------------------- -- ------

---
 - ---------------
 --
-------- -------------------------------- ------------------ -
  ------ -- -- --------------------------
-

-----------
  ------------- -
    ------------
  --
  -------- -
    --------------
    --------------------------
      -------------------- ----- -- -------
      ------------------ ----- -- --------
    ---
    -----------------
    -----------------
    -------------------------
      ------- -
        -------- ----------------
        ----------- ------------------
        ----- ------------
      -
    --
  --
  ---------- -
    -
      -------- -------------------
      --------- ----------------- -- -------
    --
    -
      -------- ------------------
      ----------- ------------------------  -- -------
      ----- --------------------
    --
  --
  ---------- --------------
--
------ ----- --------- - -

在上述代码中,我们通过 I18nRouterModule.forRoot() 启用了多语言路由,并通过 translationLoader 禁止自动加载翻译文件。接着,我们通过 MyLanguageService 自定义了一个语言服务,并在 providers 中进行了注册。

最后,我们可使用 ROUTE_RESOLVERS 为路由添加语言拦截器,用于根据用户设置的浏览器语言自动切换到对应语言的页面,同时保留原有 URL 中的其它参数。

定义语言服务

最后一步,我们需要自定义一个语言服务,用于获取用户或系统选择的语言,从而对页面进行切换。请参考以下代码示例:

-- -------------------- ---- -------
------ - ---------- - ---- ----------------
------ - ------ - ---- ------------------
------ - ----------------- - ---- ------------------------

-------------
  ----------- ------
--
------ ----- ----------------- -

  ------------
    ------- -------- ------------------ ------------------
    ------- -------- ------- ------
  - -
  -

  ------------------ ------ -
    ----- ------------ - ---------------------------- ---
    ----- ---- - ------------------------------------------------- -- -----
    --------------------------- --------------------
    ------ -----
  -

  ------------- ------ -
    ------ ---------------------------------------
  -
-

在上述代码中,我们通过 navigator.language.substr(0, 2) 获取用户浏览器中设置的语言。基于语言服务中所定义的 I18nRouterService,我们再调用 findLanguage(userLanguage) 方法来查找对应的多语言标识。最后,通过路由跳转实现对页面的切换。

结束语

通过使用 @ngx-i18n-router/core,我们可以轻松地实现 Angular 网站的多语言版本。同时,由于该 npm 包是基于 Angular 框架开发,提供了丰富的 API 接口,方便进行二次开发和扩展。希望本文可以帮助你更好地了解和使用该 npm 包。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056ed681e8991b448e7801

纠错
反馈