ngx-翻译-路由器(折旧)
实施Angular线路本地化.
[叹息] 我不得不以沉重的心情宣布(尽管你可能已经注意到),由于个人原因,我无法在闲暇时间维持这个图书馆. 它完全开源 拥有麻省理工学院的执照, 所以我会很高兴看到别人接管它。 感谢所有用户 这些奇妙的岁月. 为下一个人提供建议:不要单干.
- ngx- 翻译- 路由器
- ngx-翻译-路由-http-loader
- ngx- 翻译- 路由- scully- 插件
(单位:千美元)这里的文档(中文(简体) )
叉子为 本地化路由器。 。 。 .
根据和延长 ngx-翻译。 。 。 .
要选择的版本 :
| 角化版本 | 翻译路由器 | 装入器 | 类型 | 备注 |
|---|---|---|---|---|
| 6 - 7岁 | 1.0.2 联合国 | 1.0.1 (中文(简体) ) | 遗产 | |
| 第7条 | 1.7.3 联合国 | 1.1.0 国家 | 遗产 | |
| 第8条 | 2.2.3 国家 | 1.1.0 国家 | 遗产 | |
| 第8至12条 | 3.1.9 国家 | 1.1.2 国家 | 遗产 | |
| 第13条 | 4.0.1 (中文(简体) ) | 2.0.0 (韩语) | 遗产 | |
| 页:1 | 5.1.1 国家 | 2.0.0 (韩语) | 遗产 | 需要 rxjs 7 或 以上 |
| 15个 | 6.0.0 (单位:千美元) | 2.0.0 (韩语) | 遗产 | 最小角数 15.0.3 |
| 第15.1条 | 6.1.0 (中文(简体) ) | 2.0.0 (韩语) | 遗产 | 最小角为 15.1.0 |
| 16个 | 7.0.0 (单位:千美元) | 2.0.0 (韩语) | 遗产 | 最小角数 16 |
| 页:1 | 7.1.0 (中文(简体) ) | 2.0.0 (韩语) | 遗产 | 可选独立 API |
| 第 18 条 | 7.2.1 国家 | 2.0.0 (韩语) | 遗产 | |
| 第 18 条 | 8.0.0 (单位:千美元) | 2.0.0 (韩语) | 活动 | @ngx- translate/core v17+ (英语) |
Demo 项目可见于子文件夹 src。 。 。 .
此文档用于1.x.x版本,需要Angular 6+. 如果你从旧版本迁移到这里 移徙指南 升级到最新版本.
目录 :
安装
npm install --save @gilsdav/ngx-translate-router
使用量
为了使用 @gilsdav/ngx-translate-router 您必须在初始化时提供以下信息:
- 可用语文/地点
- 路由段翻译的前缀
- 待翻译路线
初始化“ 模块”
模块模式
import {LocalizeRouterModule} from '@gilsdav/ngx-translate-router';
模块可以使用静态文件或手动通过传递必要的值来初始化.
注意在标准路由器Module和TranslateModule后导入此模块. 应为主要路由器以及懒惰的加载器这样做.
imports: [
TranslateModule.forRoot(),
RouterModule.forRoot(routes),
LocalizeRouterModule.forRoot(routes) // <--
]
独立模式
独立模式是新的Angular API,它允许您在没有ng模块的情况下管理您的应用程序.
这个库提供了一个额外的"路透算法",叫做 withLocalizeRouter 你可以提供 provideRouter 角内置功能.
此函数的参数与 LocalizeRouterModule.forRoot()。 。 。 .
以下是在 SSR 应用程序中配置它的例子:
providers: [
provideHttpClient(withFetch()),
importProvidersFrom(TranslateModule.forRoot()),
provideRouter(
routes,
withDisabledInitialNavigation(),
withLocalizeRouter(routes, { // <--
parser: {
provide: LocalizeParser,
useFactory: (createTranslateRouteLoader),
deps: [TranslateService, Location, LocalizeRouterSettings]
},
initialNavigation: true
})
),
provideClientHydration()
]
您也可以导入 LocalizeRouterPipe 输入您的独立组件.
Http 加载器
要使用 Http 加载器来配置文件, 您必须包含 @gilsdav/ngx-translate-router-http-loader 软件包并使用其 LocalizeRouterHttpLoader。 。 。 .
import {BrowserModule} from "@angular/platform-browser";
import {NgModule} from '@angular/core';
import {Location} from '@angular/common';
import {HttpClientModule, HttpClient} from '@angular/common/http';
import {TranslateModule} from '@ngx-translate/core';
import {LocalizeRouterModule} from '@gilsdav/ngx-translate-router';
import {LocalizeRouterHttpLoader} from '@gilsdav/ngx-translate-router-http-loader';
import {RouterModule} from '@angular/router';
import {routes} from './app.routes';
@NgModule({
imports: [
BrowserModule,
HttpClientModule,
TranslateModule.forRoot(),
RouterModule.forRoot(routes),
LocalizeRouterModule.forRoot(routes, {
parser: {
provide: LocalizeParser,
useFactory: (translate, location, settings, http) =>
new LocalizeRouterHttpLoader(translate, location, settings, http),
deps: [TranslateService, Location, LocalizeRouterSettings, HttpClient]
}
})
],
bootstrap: [AppComponent]
})
export class AppModule { }
详情请查阅: 本地化- 路由- http- 载入器。 。 。 .
如果您正在使用儿童模块或路径, 您需要初始化它们 forChild 命令 :
@NgModule({
imports: [
TranslateModule,
RouterModule.forChild(routes),
LocalizeRouterModule.forChild(routes)
],
declarations: [ChildComponent]
})
export class ChildModule { }
手动初始化
手动初始化后,您需要直接提供信息:
LocalizeRouterModule.forRoot(routes, {
parser: {
provide: LocalizeParser,
useFactory: (translate, location, settings) =>
new ManualParserLoader(translate, location, settings, ['en','de',...], 'YOUR_PREFIX'),
deps: [TranslateService, Location, LocalizeRouterSettings]
}
})
初始化配置
除了提供必修的路由和剖析器外,您还可以提供更多颗粒设置的额外配置 @gilsdav/ngx-translate-router。在 本地化 Router 连接。 。 。 .
服务器侧
为了使用 @gilsdav/ngx-translate-router 在角普遍应用(SSR)中,您需要:
-
如果您选择使用 Http 加载器初始化, 您需要注意静态文件位置 .
@gilsdav/ngx-translate-router-http-loader默认情况下, 将尝试装入配置文件assets/locales.json这是一个相对的路径,不会与SSR合作。 你可以使用以下方法之一,- 创建工厂功能以绝对 URL 覆盖默认位置
export function localizeLoaderFactory(translate: TranslateService, location: Location, settings: LocalizeRouterSettings, http: HttpClient) { return new LocalizeRouterHttpLoader(translate, location, settings, http, 'http://example.com/assets/locales.json'); } LocalizeRouterModule.forRoot(routes, { parser: { provide: LocalizeParser, useFactory: localizeLoaderFactory, deps: [TranslateService, Location, LocalizeRouterSettings, HttpClient] } }) - 使用您的 HTTP 截取器
server.module将相对路径转换为绝对上,例如:intercept(request: HttpRequest<any>, next: HttpHandler) { if (request.url.startsWith('assets') && isPlatformServer(this.platformId)) { const req = this.injector.get(REQUEST); const url = req.protocol + '://' + req.get('host') + '/' + request.url; request = request.clone({ url: url }); } return next.handle(request); }
- 创建工厂功能以绝对 URL 覆盖默认位置
-
让节点服务器知道新路线 :
let fs = require('fs'); let data: any = JSON.parse(fs.readFileSync(`src/assets/locales.json`, 'utf8')); app.get('/', ngApp); data.locales.forEach(route => { app.get(`/${route}`, ngApp); app.get(`/${route}/*`, ngApp); }); -
如果你想用的话
cacheMechanism = CacheMechanism.Cookie您需要处理您节点服务器上的饼干 。 有点像,app.use(cookieParser()); app.get('/', (req, res) => { const defaultLang = 'de'; const lang = req.acceptsLanguages('de', 'en'); const cookieLang = req.cookies.LOCALIZE_DEFAULT_LANGUAGE; // This is the default name of cookie const definedLang = cookieLang || lang || defaultLang; res.redirect(301, `/${definedLang}/`); });
抓到他们了
-
以防你用过 多米诺 在您的工程中, 您将面临以下错误
ERROR TypeError: Cannot read property 'indexOf' of undefined at TranslateService.getBrowserLang为克服这种情况,请使用下列方法:
// language is readonly so normally you can't assign a value to it. // The following comments remove the compile time error and the IDE warning // @ts-ignore // noinspection JSAnnotator window.navigator.language = 'en';
处理初始导航
当你在应用中加入环球,你会有 initialNavigation 设置为 "enabled"这是为了避免懒惰者的闪烁.
令人不快的是,这对这个图书馆没有帮助,而且会引起问题.
所以,你需要设置它 "disabled" 并添加 ngx- translate-roter 选项 initialNavigation: true 要有这种渴望的行为.
imports: [
RouterModule.forRoot(routes, { initialNavigation: 'disabled' }),
LocalizeRouterModule.forRoot(routes, {
...
initialNavigation: true
})
]
如何运作
@gilsdav/ngx-translate-router 截取路由器初始化并逐一翻译 path 财务报告和审定财务报表 redirectTo 路径.
翻译过程已经完成 ngx-翻译。为了分离
我们使用的普通应用程序翻译的路由器翻译 prefix前缀的默认值为 ROUTES.最后,为了避免意外翻译一个不应翻译的 URL 部分,您可以选择使用 escapePrefix 因此前缀被剥去而片段不被翻译出. 默认 escapePrefix 未设定.
'home' -> 'ROUTES.home'
跳过段的翻译示例 escapePrefix: '!'
'!segment' -> 'segment'
{ path: '!home/first' ... } -> '/fr/home/premier'
每次改变路线时 @gilsdav/ngx-translate-router 踢入检查语言是否有变化 。 被翻译的路由预留了两个字母语言代码:
http://yourpath/home -> http://yourpath/en/home
如果没有在url路径中提供语言,应用程序使用:
- 在本地Storage/SessionStorage/Cookie中缓存的语言(仅浏览器)或
- 浏览器当前语言( 只浏览器) 或
- 配置中的第一个区域
因此请确定您将最常见的语言( 如 “ en ” ) 作为第一个字符串 .
请注意:
ngx-translate-router不重定向像my/route用于翻译,例如:.en/my/route。所有路由都由目前选中的语言进行预设,因此没有语言的路由对于路由器来说是未知的.
不包括路线
有时可能需要将某些路径排除在本地化进程之外,例如登录页面,注册页面等. 这可以通过设置旗帜来实现 skipRouteLocalization 在路由的数据对象.
如果您想要在启动跳过Route Localization时重定向到url, 您也可以提供配置选项 localizeRedirectTo 以跳过路由本地化,而将方向调整为本地化。 否则, 路由和重定向将不被翻译 .
let routes = [
// this route gets localized
{ path: 'home', component: HomeComponent },
// this route will not be localized
{ path: 'login', component: LoginComponent, data: { skipRouteLocalization: true } }
// this route will not be localized, but redirect to will do
{ path: 'logout', redirectTo: 'login', data: { skipRouteLocalization: { localizeRedirectTo: true } } }
];
注意此旗帜只应设置于根道上. 通过排除根路由,其所有子路由被自动排除. 在子路由上设置此旗帜没有效果, 因为父路由已经拥有或没有语言前缀 .
ngx- 翻译集成
LocalizeRouter 取决于 ngx-translate 核心服务并自动以所选的地块初始化.
执行以下代码 LocalizeParser 输入 :
this.translate.setFallbackLang(cachedLanguage || languageOfBrowser || firstLanguageFromConfig);
// ...
this.translate.use(languageFromUrl || cachedLanguage || languageOfBrowser || firstLanguageFromConfig);
两者 languageOfBrowser 财务报告和审定财务报表 languageFromUrl 与配置的本地人进行交叉检查.
道路歧视
您是否使用同样的路径来装入多个懒惰的模块而您有错误的组件树 ?
discriminantPathKey 将帮助 ngx- translate-router 生成良好的组件树.
{
path: '',
loadChildren: () => import('app/home/home.module').then(m => m.HomeModule),
data: {
discriminantPathKey: 'HOMEPATH'
}
},
{
path: '',
loadChildren: () => import('app/information/information.module').then(m => m.InformationModule),
data: {
discriminantPathKey: 'INFOPATH'
}
}
狂野卡路径
喜欢的方式
使用 WildCard 的偏好方式( '**' 路径)是使用 redirectTo。它将让用户翻译“未找到”的页面信息.
{
path: '404',
component: NotFoundComponent
},
{
path: '**',
redirectTo: '/404'
}
备选案文
如果您需要保留错误的url, 您将面临限制 : 您无法翻译当前页面 . 这种限制是因为我们不能从错误的url中确定语言.
{
path: '**',
component: NotFoundComponent
}
匹配参数翻译
配置路径
如果你想翻译一些配对者, localizeMatcher 为您提供了通过每个参数的函数来完成它的方法。 确保密钥与导航路径中使用的密钥相同(例如:如果函数返回"地图",则必须包含在非本地化路径中: [routerLink]="['/matcher', 'aaa', 'map'] | localize"否则你将无法使用 routerLinkActiveOptions。 。 。 .
示例
{
path: 'matcher',
children: [
{
matcher: detailMatcher,
loadChildren: () => import('./matcher/matcher-detail/matcher-detail.module').then(mod => mod.MatcherDetailModule)
},
{
matcher: baseMatcher,
loadChildren: () => import('./matcher/matcher.module').then(mod => mod.MatcherModule),
data: {
localizeMatcher: {
params: {
mapPage: shouldTranslateMap
}
}
}
}
]
}
...
export function shouldTranslateMap(param: string): string {
if (isNaN(+param)) {
return 'map';
}
return null;
}
该职能的产出应为: falsy 如果参数不能翻译或应当返回 key (没有前缀)如果要翻译参数,则在翻译时要使用.
注意您使用的任何函数 localizeMatcher 必须导出与AOT兼容.
匹配器的小改动
我们一起工作 UrlSegment 在基本中将 URL 拆分为“ params ” UrlMatchResult 但没有足够的信息来应用翻译.
你必须使用 LocalizedMatcherUrlSegment 键,以更强烈地将一段与参数联系起来。 它只包含 localizedParamName 属性,除了基本的 UrlSegment。 在将线段添加到 consumed 财务报告和审定财务报表 posParams。 。 。 .
const result: UrlMatchResult = {
consumed: [],
posParams: { }
};
...
(segment as LocalizedMatcherUrlSegment).localizedParamName = name;
result.consumed.push(segment);
result.posParams[name] = segment;
未本地化Matcher 问题而翻译的匹配参数
如果 URL 被不慎从一种语言翻译到另一种语言, 从而造成不一致的状态, 您必须启用 escapePrefix 机制。 (例: escapePrefix: '!'(中文(简体) )
随函数重定向
从Angular 18开始,除了字符串之外,还引入了重定向To作为函数. 如果您使用此特性, 您可以使用 redirectTo 函数来翻译路径。 然而,库在应用程序启动时静态翻译整个路由器,这意味着翻译功能此时还没有用户的导航背景,因为一旦用户浏览到这种路由,就应该动态地评价. 如果您想要使用此特性, 您可以使用 LocalizeRouterService 翻译此示例中注入服务的道路.
{
path: 'conditionalRedirectTo', redirectTo: ({ queryParams }) => {
const localizeRouterService = inject(LocalizeRouterService);
if (queryParams['redirect']) {
return localizeRouterService.translateRoute('/test') as string;
}
return localizeRouterService.translateRoute('/home') as string;
}
}
管道
LocalizeRouterPipe 用于翻译 routerLink 指令的内容。 管道可以被附加到路由器Link定义中的部分字符串或整个数组元素上:
<a [routerLink]="['user', userId, 'profile'] | localize">{{'USER_PROFILE' | translate}}</a>
<a [routerLink]="['about' | localize]">{{'ABOUT' | translate}}</a>
Root路由工作方式与附加方式相同,如果是root链接,则由语言来准备链接. 德语语言和链接“ 大约” 示例:
'/about' | localize -> '/de/über'
服务
路由可以使用手动翻译 LocalizeRouterService。如果您想要使用,这很重要 router.navigate 用于动态路径.
class MyComponent {
constructor(private localize: LocalizeRouterService) { }
myMethod() {
let translatedPath: any = this.localize.translateRoute('about/me');
// do something with translated path
// e.g. this.router.navigate([translatedPath]);
}
}
阿奥特
要使用Ahead-On-Time编译,任何自定义装入器都必须导出为函数 . 这就是目前的解决办法:
export function localizeLoaderFactory(translate: TranslateService, location: Location, http: Http) {
return new StaticParserLoader(translate, location, http);
}
API 密码
本地化路特模块
方法:
forRoot(routes: Routes, config: LocalizeRouterConfig = {}): ModuleWithProviders: @gilsdav/ngx-translate-router的主要初始化器. 可以为更多的颗粒设置提供自定义配置 .forChild(routes: Routes): ModuleWithProviders: 提供儿童路线的儿童模块初始化器.
本地化 Router 连接
属性
parser: 装入本地化Parser的提供者。 默认值是StaticParserLoader。 。 。 .useCachedLang:布尔. 标记默认语言是否应当被缓存 。 默认值是true。 。 。 .alwaysSetPrefix:布尔. 标出语言是否总是在url前缀 。 默认值是true。 。 。 .
当值是false,前缀将不会用于默认语言(这包括只有一个语言的情况).cacheMechanism: CacheMechanic. LocalStorage QQ CacheMechanic. SesseStorage QQ CacheMechanic. (中文(简体) ). 饼干。 默认值是CacheMechanism.LocalStorage。 。 。 .cacheName: 弦乐. 饼干/本地商店的名称。 默认值是LOCALIZE_DEFAULT_LANGUAGE。 。 。 .defaultLangFunction: (语言:字符串 [],缓存Lang?:字符串,浏览器Lang?:字符串)QQ字符串. 当没有通过url提供语言时,为选择默认语言的自定义逻辑所覆盖的方法. 默认值是undefined。 。 。 .cookieFormat: 弦乐. 要存储的饼干格式 。 默认值是'{{value}};{{expires}}'。(延长格式,例如:'{{value}};{{expires}};path=/'(中文(简体) ){{value}}将替换为要保存的值( e)CACHE_NAME=language) (中文(简体) ). 必须是格式化的.{{expires}}将替换为expires=currentDate+30days选择,如果你想要的会话饼干.- 您可以通过使用此合成来配置过期天数 :
{{expires:365}}。结果将是expires=currentDate+365days。 。 。 .
- 您可以通过使用此合成来配置过期天数 :
- 结果是:
LOCALIZE_DEFAULT_LANGUAGE=en;expires=Wed, 11 Sep 2019 21:19:23 GMT。 。 。 .
将路透社服务本地化
属性 :
routerEvents: 用于聆听语言变化事件的事件编辑器
localizeService.routerEvents.subscribe((language: string) => {
// do something with language
});
parser: 本地化程序
let selectedLanguage = localizeService.parser.currentLang;
方法:
translateRoute(path: string | any[]): string | any[]:翻译给定路径. 若为path以回击开头,然后路径会以当前设定的语言进行预设.
localizeService.translateRoute('/'); // -> e.g. '/en'
localizeService.translateRoute('/about'); // -> '/de/ueber-uns' (e.g. for German language)
localizeService.translateRoute('about'); // -> 'ueber-uns' (e.g. for German language)
changeLanguage(lang: string, extras?: NavigationExtras, useNavigateMethod?: boolean):将当前url翻译为给定语言并更改应用程序的语言.extras将传递给角路由器导航方法.userNavigateMethod告诉本地化路由器使用navigate而不是说navigateByUrl方法.
对德国语言和路线的定义::lang/users/:user_name/profile
yoursite.com/en/users/John%20Doe/profile -> yoursite.com/de/benutzer/John%20Doe/profil
钩子:
现在只有一个钩子,只有用它才有趣 initialNavigation 旗帜(更具体地说,如果您正在制作 AppInitializer 使用角质 Router 或者说 ngx-translate-router) (中文(简体) ).
hooks.initialized: 执行初始Navigation时发送的事件可观察到.
用法示例:
export const appInitializerFactory = (injector: Injector) => {
return () => {
const localize = injector.get(LocalizeRouterService);
return firstValueFrom(
localize.hooks.initialized
.pipe(
tap(() => {
const router = injector.get(Router);
router.events.pipe(
filter(url => url instanceof NavigationEnd),
first()
).subscribe((route: NavigationEnd) => {
console.log(router.url, route.url);
router.navigate(['/fr/accueil']);
});
})
)
)
}
};
本地化Parser 软件
属性 :
locales: 旧语言代码阵列currentLang: 当前选择的语言routes: 主动翻译路线urlPrefix: 当前语言的语言前缀. 空字符串,如果alwaysSetPrefix=false财务报告和审定财务报表currentLang与默认语言相同.
方法:
translateRoutes(language: string): Observable<any>: 翻译所有路线并设置语言和当前 整个应用程序的语言.translateRoute(path: string): string: 翻译单一路径getLocationLang(url?: string): string: 如果匹配定义的地块, 从当前 URL 中提取语言
许可证
根据麻省理工学院颁发的许可证
谢谢
以及最初项目的所有捐助者
制造的 贡献者-img。 。 。 .