Angular中的字符串资源

时间:2017-09-15 14:49:04

标签: html string angular pipe

我正在开发一个Angular应用程序,我正在寻找与Android开发中可用的Android资源类似的东西。

以下是在Android中获取字符串的方法:

String mystring = getResources().getString(R.string.mystring);

我想在Angular中拥有相同的内容。

例如,如果我有几个HTML模板,其中有关于提供的错误电子邮件的相同消息...

<div class="alert alert-danger">
      <strong>Error!</strong>Invalid e-mail
</div>

我想要以下内容:

<div class="alert alert-danger">
      <strong>Error!</strong>{{myStrings.INVALID_EMAIL}}
</div>

...或类似的东西......

<div class="alert alert-danger">
      <strong>Error!</strong>{{'INVALID_EMAIL' | stringGenerator}}
</div>

你知道我可以安装的方法或插件吗?

2 个答案:

答案 0 :(得分:14)

将配置,翻译和资源与应用程序的逻辑分离是非常有用的。配置在其他环境中也非常有用,例如,让api_url对任何休息呼叫都有用。

您可以使用@angular/cli设置此类内容。具有以下应用程序结构:

|- app
|- assets
         |- i18n
                - en.json
                - it.json
         |- json-config
                - development.json
                - env.json
                - production.json
         |- resources
                - en.json
                - it.json
|- environment
         - environment.prod.ts
         - environment.ts

|- config
         - app.config.ts    

其中:

  • app :包含所有应用程序逻辑
  • assets / i18n / * .json :包含可在任何组件中使用的文本资源。我们想要涵盖的每种语言都有其中一种。

E.G。 en.json

{
  "TEST": {
    "WELCOME"  : "Welcome"
}

E.G it.json

{
  "TEST": {
    "WELCOME"  : "Benvenuto"
}
  • assets / json-config :包含要在开发模式和生产模式下使用的配置文件。还包含env.json,它是一个json,表示当前的开发模式:

E.G。 env.json

{
   "env" : "development"
}

E.G。 development.json

{
    "API_URL"   : "someurl",
    "MYTOKEN" : "sometoken",
    "DEBUGGING" : true
}
  • assets / resources :包含我们想要涵盖的每种语言的jsons资源文件。例如,它可能包含应用程序模型的jsons初始化。例如,如果您想要根据环境和/或语言填充要传递给*ngFor个性化的模型数组,这将非常有用。此类初始化应在每个组件内完成,这些组件希望通过AppConfig.getResourceByKey访问精确资源,稍后将会显示。

  • app.config.ts :基于开发模式加载资源的配置服务。我将在下面显示一个片段。

基本配置

为了在应用程序启动时加载基本配置文件,我们需要做一些事情。

<强> app.module.ts

import { NgModule, APP_INITIALIZER } from '@angular/core';
/** App Services **/
import { AppConfig } from '../config/app.config';
import { TranslationConfigModule } from './shared/modules/translation.config.module';

// Calling load to get configuration + translation
export function initResources(config: AppConfig, translate: TranslationConfigModule) {
        return () => config.load(translate);
}

// Initializing Resources and Translation as soon as possible
@NgModule({
     . . .
     imports: [
         . . .
         TranslationConfigModule
     ],
     providers: [
         AppConfig, {
           provide: APP_INITIALIZER,
           useFactory: initResources,
           deps: [AppConfig, TranslationConfigModule],
           multi: true
         }
     ],
     bootstrap: [AppComponent]
})
export class AppModule { }

<强> app.config.ts

如上所述,该服务基于开发模式加载配置文件,在本例中为浏览器语言。如果要自定义应用程序,则基于语言加载资源非常有用。例如,您的意大利语发行版会有不同的路线,不同的行为或简单的不同文本。

每个资源,配置和环境条目均可通过AppConfiggetEnvByKeygetEntryByKeygetResourceByKey服务方式提供。

import { Inject, Injectable } from '@angular/core';
import { Http } from '@angular/http';
import { Observable } from 'rxjs/Observable';
import { get } from 'lodash';
import 'rxjs/add/operator/catch';

import { TranslationConfigModule } from '../app/shared/modules/translation.config.module';

@Injectable()
export class AppConfig {

  private _configurations: any = new Object();
  private _config_path = './assets/json-config/';
  private _resources_path = './assets/resources/';

  constructor( private http: Http) { }

  // Get an Environment Entry by Key
  public getEnvByKey(key: any): any {
    return this._configurations.env[key];
  }

  // Get a Configuration Entryby Key
  public getEntryByKey(key: any): any {
    return this._configurations.config[key];
  }

  // Get a Resource Entry by Key
  public getResourceByKey(key: any): any {
    return get(this._configurations.resource, key);
  }

  // Should be self-explanatory 
  public load(translate: TranslationConfigModule){
    return new Promise((resolve, reject) => {
      // Given env.json
      this.loadFile(this._config_path + 'env.json').then((envData: any) => {
        this._configurations.env = envData;
        // Load production or development configuration file based on before
        this.loadFile(this._config_path + envData.env  + '.json').then((conf: any) => {
          this._configurations.config = conf;
          // Load resources files based on browser language
          this.loadFile(this._resources_path + translate.getBrowserLang() +'.json').then((resource: any) => {
            this._configurations.resource = resource;
            return resolve(true);
          });
        });
      });
    });
  }

  private loadFile(path: string){
    return new Promise((resolve, reject) => {
      this.http.get(path)
        .map(res => res.json())
        .catch((error: any) => {
          console.error(error);
          return Observable.throw(error.json().error || 'Server error');
        })
        .subscribe((res_data) => {
          return resolve(res_data);
        })
    });
  }

}

<强> translation.config.module.ts

此模块设置使用ngx-translate构建的翻译。根据浏览器语言设置翻译。

import { HttpModule, Http } from '@angular/http';
import { NgModule, ModuleWithProviders } from '@angular/core';
import { TranslateModule, TranslateLoader, TranslateService } from '@ngx-translate/core';
import { TranslateHttpLoader } from '@ngx-translate/http-loader';
import { isNull, isUndefined } from 'lodash';


export function HttpLoaderFactory(http: Http) {
    return new TranslateHttpLoader(http, '../../../assets/i18n/', '.json');
}

const translationOptions = {
    loader: {
        provide: TranslateLoader,
        useFactory: HttpLoaderFactory,
        deps: [Http]
    }
};

@NgModule({
    imports: [TranslateModule.forRoot(translationOptions)],
    exports: [TranslateModule],
    providers: [TranslateService]
})
export class TranslationConfigModule {

    private browserLang;

    /**
     * @param translate {TranslateService}
     */
    constructor(private translate: TranslateService) {
        // Setting up Translations
        translate.addLangs(['en', 'it']);
        translate.setDefaultLang('en');
        this.browserLang = translate.getBrowserLang();
        translate.use(this.browserLang.match(/en|it/) ? this.browserLang : 'en');
    }

    public getBrowserLang(){
        if(isUndefined(this.browserLang) || isNull(this.browserLang)){
            this.browserLang = 'en';
        }
        return this.browserLang;
    }
}

好的,现在?我该如何使用这样的配置?

导入app.module.ts的任何模块/组件或其中任何导入到另一个导入translation.config.module的自定义模块的模块/组件现在都可以根据浏览器语言自动翻译任何插值条目。例如,使用以下剪切将根据解释的行为生成欢迎 Benvenuto

{{ 'TEST.WELCOME' | translate }}

如果我想获取资源来初始化将传递给*ngFor的某个数组?

在任何组件中,只需在构造函数中执行此操作:

. . .

// Just some model
public navigationLinks: NavigationLinkModel[];

constructor(private _config: AppConfig) {
    // PAGES.HOMEPAGE.SIDENAV.NAVIGATION contains such model data
    this.navigationLinks = 
    this._config.getResourceByKey('PAGES.HOMEPAGE.SIDENAV.NAVIGATION');
 }

当然,您也可以组合资源和配置。

答案 1 :(得分:1)

AndreaM16的答案肯定是彻底的,但是您还可以考虑为此使用现有的软件包,而不是编写自己需要维护的自定义代码。为此,我建议您检出ngx-translate(在答案中有些用法),transloco和Angular的内置i18n capabilities

大多数方法都基于magic strings,在这些方法中,HTML模板和打字稿代码需要包含(希望)与JSON或XML文件中的键匹配的字符串。这带来了一个严重的代码维护问题,该问题仅在运行时才会在编译时显示。我也主张提倡一些有关创建类型安全的翻译系统的指南: