模板版本:v0.4.0
react-native-localization
本项目基于 react-native-localization 开发。
该第三方库的仓库已迁移至 Gitcode,且支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-localization。 版本所属关系如下:
| 三方库名称 | 三方库版本 | 发布信息 | 支持RN版本 | Autolink | 编译API版本 | 社区基线版本 | npm地址 |
|---|---|---|---|---|---|---|---|
| @react-native-ohos/react-native-localization | ~ 2.5.0 | Gitcode Releases | 0.82.* | 是 | API12+ | 2.3.2 | Npm Address |
| @react-native-ohos/react-native-localization | ~ 2.4.0 | Gitcode Releases | 0.77.* | 否 | API12+ | 2.3.2 | Npm Address |
| @react-native-ohos/react-native-localization | ~ 2.3.3 | Gitcode Releases | 0.72.* | 是 | API12+ | 2.3.2 | Npm Address |
| @react-native-oh-tpl/react-native-localization | <=2.3.2-0.0.1@deprecated | Github Releases(deprecated) | 0.72.* | 否 | API12+ | 2.3.2 | Npm Address |
1. 安装与使用
进入到工程目录并输入以下命令:
npm
npm install @react-native-ohos/react-native-localization
yarn
yarn add @react-native-ohos/react-native-localization
下面的代码展示了这个库的基本使用场景:
使用时 import 的库名不变。
import React, { useState } from 'react';
import { View, Text, Button, StyleSheet } from 'react-native';
import Localize from 'react-native-localization';
// 定义本地化内容
const strings = new Localize({
en: {//英语
welcome: 'Welcome',
question: 'I\'d like some {0} and {1}, or just {0}',
bread: 'bread',
butter: 'butter',
greeting: 'Hello, {0}! ',
currentlanguage: 'Current Language',
availableLanguages: 'Available Languages',
interfaceLanguage: 'The System Language'
},
fr: {//法语
welcome: 'Bienvenue',
question: 'Je voudrais un peu de {0} et {1}, ou juste {0}',
bread: 'pain',
butter: 'beurre',
greeting: 'Bonjour, {0}!',
currentlanguage: 'Langue actuelle',
availableLanguages: 'Langues disponibles',
interfaceLanguage: 'Langue du système'
},
bo: {//藏语
welcome: 'བསྐུལ་མཁན།',
question: 'ང་ལུས་འདི་ལས། {0} དང། {1} ཡང་ཡིན། གང་ཡིན་ནི། {0}',
bread: 'བཀྲུངས',
butter: 'བརྡེན',
greeting: 'བཀའ་བདག་ {0}!',
currentlanguage: 'ད་དུས་ལག་འཁྱེར།',
availableLanguages: 'ད་དུས་ལག་འཁྱེར་སྒྲིགས།',
interfaceLanguage: 'རྩམ་གཞི་སྒྲིག་ལེན་དེ་རྒྱལ་སྤོད་'
},
zh: {//中文
welcome: '欢迎',
question: '我想要一些{0}和{1},或者只要{0}',
bread: '面包',
butter: '黄油',
greeting: '你好, {0}!',
currentlanguage: '当前语言',
availableLanguages: '当前可用语言列表',
interfaceLanguage: '当前系统语言'
},
});
export function LocalizationDemo() {
// getLanguage API
const [language, setLanguage] = useState(strings.getLanguage());
const changeLanguage = (lang: string) => {
// setLanguage API
strings.setLanguage(lang);
setLanguage(strings.getLanguage());
};
return (
<View style={styles.screen}>
<View style={{ height: 180, justifyContent: 'space-between', marginBottom: 30 }}>
<Button
color="#144400"
title="切换成中文"
onPress={() => changeLanguage('zh')}
/>
<Button
color="#841584"
title="切换成法语"
onPress={() => changeLanguage('fr')}
/>
<Button
color="#645555"
title="切换成英语"
onPress={() => changeLanguage('en')}
/>
<Button
color="#241595"
title="切换成藏语"
onPress={() => changeLanguage('bo')}
/>
</View>
<Text style={styles.text}>
{strings.welcome}
</Text>
<Text style={styles.text}>
{/* formatString API */}
{strings.formatString(strings.question, strings.bread, strings.butter)}
</Text>
<Text style={styles.text}>
{strings.currentlanguage}: {language}
</Text>
{/* getAvailableLanguages API */}
<Text style={styles.text}>
{strings.availableLanguages}: {strings.getAvailableLanguages().join(', ')}
</Text>
{/* getInterfaceLanguage API */}
<Text style={styles.text}>
{strings.interfaceLanguage}: {strings.getInterfaceLanguage()}
</Text>
</View>
);
}
const styles = StyleSheet.create({
text: {
fontSize: 18,
marginBottom: 10,
color: 'white'
},
screen: {
flex: 1,
padding: 4,
paddingTop: 10,
backgroundColor: 'black',
marginHorizontal: 4,
marginVertical: 8,
paddingHorizontal: 8,
},
});
2. Link
| 是否支持autolink | RN框架版本 | |
|---|---|---|
| ~2.5.0 | Yes | 0.82 |
| ~2.4.0 | No | 0.77 |
| ~2.3.3 | Yes | 0.72 |
| <=2.3.2-0.0.1@deprecated | No | 0.72 |
使用AutoLink的工程需要根据该文档配置,Autolink框架指导文档:https://gitcode.com/openharmony-sig/ohos_react_native/blob/master/docs/zh-cn/Autolinking.md
如您使用的版本支持 Autolink,并且工程已接入 Autolink,可跳过ManualLink配置。
ManualLink: 此步骤为手动配置原生依赖项的指导
首先需要使用 DevEco Studio 打开项目里的 HarmonyOS 工程 harmony。
2.1. Overrides RN SDK
为了让工程依赖同一个版本的 RN SDK,需要在工程根目录的 oh-package.json5 添加 overrides 字段,指向工程需要使用的 RN SDK 版本。替换的版本既可以是一个具体的版本号,也可以是一个模糊版本,还可以是本地存在的 HAR 包或源码目录。
关于该字段的作用请阅读官方说明
{
...
"overrides": {
"@rnoh/react-native-openharmony" : "file:./react_native_openharmony"
}
}
2.2. 引入原生端代码
目前有两种方法:
- 通过 har 包引入;
- 直接链接源码。
方法一:通过 har 包引入(推荐)
har 包位于三方库安装路径的 `harmony` 文件夹下。
打开 entry/oh-package.json5,添加以下依赖
"dependencies": {
"@rnoh/react-native-openharmony": "file:../react_native_openharmony",
"@react-native-ohos/react-native-localization": "file:../../node_modules/@react-native-ohos/react-native-localization/harmony/react_localization.har"
}
点击右上角的 sync 按钮
或者在命令行终端执行:
cd entry
ohpm install
方法二:直接链接源码
如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)
2.3. 配置 CMakeLists 和引入 LocalizationPackage
打开 entry/src/main/cpp/CMakeLists.txt,添加:
+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
# RNOH_BEGIN: manual_package_linking_1
+ add_subdirectory("${OH_MODULES}/@react-native-ohos/react-native-localization/src/main/cpp" ./localization)
# RNOH_END: manual_package_linking_1
# RNOH_BEGIN: manual_package_linking_2
+ target_link_libraries(rnoh_app PUBLIC rnoh_localization)
# RNOH_END: manual_package_linking_2
打开 entry/src/main/cpp/PackageProvider.cpp,添加:
#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
+ #include "LocalizationPackage.h"
using namespace rnoh;
std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
return {
std::make_shared<RNOHGeneratedPackage>(ctx),
+ std::make_shared<LocalizationPackage>(ctx),
};
}
2.4. 在 ArkTs 侧引入 RNReactLocalizationPackage
打开 entry/src/main/ets/RNPackagesFactory.ts,添加:
...
+ import { RNReactLocalizationPackage } from '@react-native-ohos/react-native-localization/ts';
export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
return [
+ new RNReactLocalizationPackage(ctx),
];
}
2.5. 运行
点击右上角的 sync 按钮
或者在命令行终端执行:
cd entry
ohpm install
然后编译、运行即可。
3. 约束与限制
3.1. 兼容性
本文档内容基于以下版本验证通过:
- RNOH: 0.72.96; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
- RNOH: 0.72.33; SDK: HarmonyOS NEXT B1; IDE: DevEco Studio: 5.0.3.900; ROM: Next.0.0.71;
- RNOH: 0.77.18; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
- RNOH: 0.82.1; SDK: HarmonyOS 6.0.0 Release SDK; IDE: DevEco Studio 6.0.0.858; ROM: 6.0.0.112;
4. 静态方法
"Platform"列表示该属性在原三方库上支持的平台。
"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
| setLanguage(languageCode) | 手动强制设置为特定语言 | void | no | iOS/Android | yes |
| getLanguage() | 获取当前显示的语言 | string | no | iOS/Android | yes |
| getInterfaceLanguage() | 获取当前设备的系统界面语言 | string | no | iOS/Android | yes |
| formatString() | 格式化传入的字符串,用其他参数替换字符串中的占位符。 | string | no | iOS/Android | yes |
| getAvailableLanguages() | 获取在构造函数中传入的语言数组 | string[] | no | iOS/Android | yes |
| getString(key: string, language?: string) | 根据键(key)获取对应的字符信息。如果指定了 language,则获取特定语言的字符信息。 |
string | no | iOS/Android | yes |
| setContent(props: any) | 替换 NamedLocalization 对象的内容,而无需重新实例化该对象。 |
void | no | iOS/Android | yes |
5. 遗留问题
6. 其他
7. 开源协议
本项目基于 The MIT License (MIT) ,请自由地享受和参与开源。