React项目国际化多语言开发详解

react-intl 是用来支持react框架实现国语言的有效工具,但是一般在具体的项目中,需要翻译的内容可能还包括各种组件比如antd和boostrap等组件内容的国际化,所以需要结合这些组件内置的国际化工具一起来实现整个项目的多语言。

下面是在具体开发过程中用到的一些API,以及具体开发代码等,以供日后继续学习:

react组件

  • IntlProvider
    该组件用于在程序的根组件中设置整个项目的语言环境,配置属性如下:
type IntlConfig = {
    locale?: string,
    formats?: object,
    messages?: {[id: string]: string},

    defaultLocale?: string = 'en',
    defaultFormats?: object = {},

    textComponent? node = 'span',
};

项目中常用的配置有:locale值为表示浏览器的语言环境,messages为键值对,即需要格式化的字符串对应的key、value键值对;formates接受对象,通常设置时间格式和货币等表示方式;

  • addLocaleData
    该函数由react-intl包导出,只是babel-plugin-react-intl包的一个钩子,用于提取JavaScript源文件中定义的默认消息。此函数只返回传入的Message Descriptor映射对象。一般不建议这样写,有点累赘。
import {defineMessages} from 'react-intl';
const messages = defineMessages({
    greeting: {
        id: 'app.home.greeting',
        description: 'Message to greet the user.',
        defaultMessage: 'Hello, {name}!',
    },
});
  • injectIntl
    该函数由react-intl包导出,是一个高阶组件(它接受一个ReactComponent,并返回一个新的ReactComponent,这一点颇有函数式编程的味道。由于是一个抽象和公用代码的方案,这个新的ReactComponent主要包含一些共用代码的逻辑或者是状态)。它将传入的React组件与另一个React组件包装在一起,该组件通过它为包装组件提供命令式格式化API props。默认情况下,格式化API将通过提供给包装组件props.intl。
import React, {PropTypes} from 'react';
import {injectIntl, intlShape, FormattedRelative} from 'react-intl';

const Component = ({date, intl}) => (
    <span title={intl.formatDate(date)}>
        <FormattedRelative value={date}/>
    </span>
);

Component.propTypes = {
    date: PropTypes.any.isRequired,
    intl: intlShape.isRequired,
};

export default injectIntl(Component);

prop的值是intlShap类型:

    locale: string,
    formats: object,
    messages: {[id: string]: string},

    defaultLocale: string = 'en',
    defaultFormats: object = {},
};

type IntlFormat = {
    formatDate: (value: any, options?: object) => string,
    formatTime: (value: any, options?: object) => string,
    formatRelative: (value: any, options?: object) => string,
    formatNumber: (value: any, options?: object) => string,
    formatPlural: (value: any, options?: object) => string,
    formatMessage: (messageDescriptor: MessageDescriptor, values?: object) => string,
    formatHTMLMessage: (messageDescriptor: MessageDescriptor, values?: object) => string,
};

const intlShape: IntlConfig & IntlFormat & {now: () => number};

IntlConfig:该设置下的key被当做props的值传给父组件,可以通过const {locale,messages} = this.props.intl;来获取;

IntlFormat: 是必须的格式化API,具体介绍如下:

  • 日期格式化API
    包括(formaDate,formatTime,formatRelative三个)
    这些API可以通过对应的 <FormattedDate>, <FormattedTime>, and [<FormattedRelative>](https://github.com/yahoo/react-intl/wiki/Components#formattedrelative)组件通过props注入到你的组件中,
    其中<FormattedDate> <FormattedTime>可以使用下面的格式化选项:
type DateTimeFormatOptions = {
    localeMatcher: 'best fit' | 'lookup' = 'best fit',
    formatMatcher: 'basic' | 'best fit' = 'best fit',

    timeZone: string,
    hour12  : boolean,

    weekday     : 'narrow' | 'short' | 'long',
    era         : 'narrow' | 'short' | 'long',
    year        : 'numeric' | '2-digit',
    month       : 'numeric' | '2-digit' | 'narrow' | 'short' | 'long',
    day         : 'numeric' | '2-digit',
    hour        : 'numeric' | '2-digit',
    minute      : 'numeric' | '2-digit',
    second      : 'numeric' | '2-digit',
    timeZoneName: 'short' | 'long',
};

<FormattedDate> 该组件需要必须传入value键值作为要解析的内容,然后以<span>形式对结果进行渲染,如果需要其他形式,可以在外面再包裹一层,具体用法如下:

<FormattedDate
  value={new Date(1459832991883)}
  year='numeric'
  month='long'
  day='2-digit'
/>
生成:<span>April 05, 2016</span>

<FormattedTime>该组件与上面组件的区别是,本组件是对时分秒的格式化。其他都相同,具体使用如下:

<FormattedTime value={new Date(1459832991883)}/>
生成:<span>1:09 AM</span>

<FormattedRelative>该组件用来格式化相对时间,具体使用方式如下:

<FormattedRelative value={Date.now()}/>
// <span>now</span>
<FormattedRelative value={10 seconds later}/>
// <span>10 seconds ago</span>
<FormattedRelative value={60 seconds later}/>
// <span>1 minute ago</span>
  • 数字格式化API
    包括:formatNumber和formatPlural两个API,都是通过对应的<FormattedNumber>和<FormattedPlural>组件注入;具体用法:
<FormattedNumber value={1000}/>
//<span>1,000</span>
<FormattedPlural
    value={10}
    one='message'
    other='messages'
/>
//<span>messages</span>
  • 字符串格式化API
    包括formatMessage和formatHTMLMessage两个;并通过相应的<FormattedMessage><FormattedHTMLMessage>组件使用,可以通过它们注入组件props
    用于定义应用程序的默认消息/字符串。<FormattedMessage><FormattedHTMLMessage>拥有对应于消息描述符的道具。消息描述符非常适用于提供翻译字符串/消息所需的数据,并且它们包含以下属性:
    id:消息的唯一,稳定标识符
    description:翻译者关于如何在UI中使用它的上下文
    defaultMessage:默认消息(可能是英文)
type MessageDescriptor = {
    id: string,
    defaultMessage?: string,
    description?: string | object,
};

<FormattedMessage>该组件使用formatMessageAPI并且具有props消息描述符相对应的API 。具体使用方法:

<FormattedMessage
    id='app.greeting'
    description='Greeting to welcome the user to the app'
    defaultMessage='Hello, {name}!'
    values={{
        name: 'Eric'
    }}
/>
//<span>Hello, Eric!</span>
<FormattedMessage id="title">
    {(txt) => (
        <H1>
            {txt}
        </H1>
    )}
</FormattedMessage>
//<h1>Hello, Eric!</h1>
<FormattedMessage
    id='app.greeting'
    description='Greeting to welcome the user to the app'
    defaultMessage='Hello, {name}!'
    values={{
        name: <b>Eric</b>
    }}
/>
//<span>Hello, <b>Eric</b>!</span>

antD组件国际化

在antd中提供了一个LocaleProvider的组件,该组件接受locale属性,该属性的值为当前语言的文案,antd通过react的context将该语言信息以共享的方式传递给被LocaleProvider组件包裹的子组件中,从而实现国际化,下面我们按照实际项目中的代码进行演示:
我们可以新建连个js文件,用来设置对应的语言环境:

import appLocaleData from 'react-intl/locale-data/en';
import antEn from 'antd/lib/locale-provider/en_US'
import messages from './en_US';

window.appLocale = {
  messages: messages,
  locale: 'en-US',
  data: appLocaleData,
  antd:antEn,
};
export default window.appLocale;

其他环境类似,导入对应的语言包,接下来我们需要在入口文件中进行设置,即在应用外层包裹LocaleProvider组件:

import React, {Component} from 'react';
import { Radio, LocaleProvider} from 'antd';
import Entry from './routes/router.jsx';
import ReactDOM from 'react-dom';
import './less/main.less';
import { IntlProvider, addLocaleData } from 'react-intl';

function getLocale(lang){
  let result={};
  switch(lang){
    case 'zh_CN':
    result = require('./locale/zh-CN.config');
    break;
    case 'en_US':
    result = require('./locale/en-US.config');
    break;
    default: result = require('./locale/zh-CN.config');
  }
  return result.default || result;
}//导入对应的语言配置文件

class Lang extends React.Component{
  constructor(props){
      super(props);
      this.state={
          lan:" "
      }
      this.changeLang=this.changeLang.bind(this);
  }
  changeLang(p){
    if(p==="zh-CN"|| p==="default"){
      this.setState(
        {lan:"zh_CN"}
        )
    }
    else {
      this.setState({
        lan:"en_US"
      })
    }
    
  }
  render(){
    const {lan} = this.state;
    const appLocale = getLocale(lan);
    addLocaleData(...appLocale.data);
      return (
      <IntlProvider 
          locale={appLocale.locale} 
          messages={appLocale.messages}
          >
           <LocaleProvider locale={appLocale.antd}>
          <Index />
          </LocaleProvider>
      </IntlProvider>
     )
  }
}

ReactDOM.render(<Lang/>,document.getElementById('best-react-root'));

注:上述代码中,LocaleProvider组件是从antd中导入的,对应locale属性的值也是从antd/lib/locale-provider/...导入的语言包;react-intl实现多语言需要上述组件进行内容格式化外,在项目的主入口导入IntlProvider组件以及addLocaleData方法

写在最后

内容到此结束,欢迎斧正,一起学起!!!

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,417评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,921评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,850评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,945评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,069评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,188评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,239评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,994评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,409评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,735评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,898评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,578评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,205评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,916评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,156评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,722评论 2 363
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,781评论 2 351

推荐阅读更多精彩内容