模板版本:v0.4.0
react-native-print
本项目基于 react-native-print 开发。
该第三方库的仓库已迁移至 Gitcode,且支持直接从 npm 下载,新的包名为:@react-native-ohos/react-native-print 版本所属关系如下:
| 三方库名称 | 三方库版本 | 发布信息 | 支持RN版本 | Autolink | 编译API版本 | 社区基线版本 | npm地址 |
|---|---|---|---|---|---|---|---|
| @react-native-ohos/react-native-print | ~0.13.0 | Gitcode Releases | 0.82.* | 是 | API12+ | 0.11.0 | Npm Address |
| @react-native-ohos/react-native-print | ~0.12.0 | Gitcode Releases | 0.77.* | 否 | API12+ | 0.11.0 | Npm Address |
| @react-native-ohos/react-native-print | ~0.11.1 | Gitcode Releases | 0.72.* | 是 | API12+ | 0.11.0 | Npm Address |
| @react-native-oh-tpl/react-native-print | <= 0.11.0-0.0.3@deprecated | Github Releases(deprecated) | 0.72.* | 否 | API12+ | 0.11.0 | Npm Address |
1. 安装与使用
进入到工程目录并输入以下命令:
npm
npm install @react-native-ohos/react-native-print
yarn
yarn add @react-native-ohos/react-native-print
下面的代码展示了这个库的基本使用场景:
使用时 import 的库名不变。
本示例依赖 react-native-document-picker 库,参照[@react-native-ohos/react-native-document-picker 文档](./react-native-document-picker.md)进行引入。
import React, {useState} from 'react';
import {
ScrollView,
Button,
} from 'react-native';
import {
pick,
DocumentPickerOptions,
isCancel,
} from 'react-native-document-picker';
import RNPrint from 'react-native-print';
type DirType = 'documentDirectory' | 'cachesDirectory';
interface DirOpt {
label: DirType;
selected: boolean;
}
export default function RNPrintDemo(): JSX.Element {
const [pickResult, setPickResult] = useState('');
const [allowMultiSelection, setAllowMultiSelection] = useState(true);
const [fileTypes, setFileTypes] = useState<string[]>([]);
const [dirUi, setDirui] = useState<Array<DirOpt>>([
{label: 'documentDirectory', selected: false},
{label: 'cachesDirectory', selected: false},
]);
const copyTo = dirUi.find(d => d.selected)?.label;
const pickOpt: DocumentPickerOptions<'harmony'> = {
allowMultiSelection,
presentationStyle: 'overFullScreen',
};
if (copyTo) {
pickOpt.copyTo = copyTo;
}
if (fileTypes.length) {
pickOpt.type = fileTypes;
}
const pickFile = async () => {
try {
const res = await pick(pickOpt);
setPickResult(JSON.stringify(res));
return res;
} catch (err) {
console.log(err);
console.log('isCancel: ' + isCancel(err));
}
};
return (
<Button
title="本地url打印"
onPress={async () => {
const res = await pickFile();
RNPrint.print({
filePath: res[0].uri,
jobName: 'huawei',
});
}}
/>
);
}
2. Link
| 是否支持autolink | RN框架版本 | |
|---|---|---|
| ~0.13.0 | Yes | 0.82 |
| ~0.12.0 | No | 0.77 |
| ~0.11.1 | Yes | 0.72 |
| <= 0.11.0-0.0.3@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" : "./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-print": "file:../../node_modules/@react-native-ohos/react-native-print/harmony/print.har"
}
点击右上角的 sync 按钮
或者在命令行终端执行:
cd entry
ohpm install
方法二:直接链接源码
如需使用直接链接源码,请参考[直接链接源码说明](./link-source-code.md)
2.3. 配置 CMakeLists 和引入 PrintPackage
若使用的是 <= 0.11.0-0.0.3 版本,请跳过本章。
打开 entry/src/main/cpp/CMakeLists.txt,添加:
project(rnapp)
cmake_minimum_required(VERSION 3.4.1)
set(CMAKE_SKIP_BUILD_RPATH TRUE)
set(RNOH_APP_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
set(NODE_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../node_modules")
+ set(OH_MODULES "${CMAKE_CURRENT_SOURCE_DIR}/../../../oh_modules")
set(RNOH_CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../../../../../react-native-harmony/harmony/cpp")
set(LOG_VERBOSITY_LEVEL 1)
set(CMAKE_ASM_FLAGS "-Wno-error=unused-command-line-argument -Qunused-arguments")
set(CMAKE_CXX_FLAGS "-fstack-protector-strong -Wl,-z,relro,-z,now,-z,noexecstack -s -fPIE -pie")
set(WITH_HITRACE_SYSTRACE 1) # for other CMakeLists.txt files to use
add_compile_definitions(WITH_HITRACE_SYSTRACE)
add_subdirectory("${RNOH_CPP_DIR}" ./rn)
# RNOH_BEGIN: manual_package_linking_1
add_subdirectory("../../../../sample_package/src/main/cpp" ./sample-package)
+ add_subdirectory("${OH_MODULES}/@react-native-ohos/react-native-print/src/main/cpp" ./print)
# RNOH_END: manual_package_linking_1
file(GLOB GENERATED_CPP_FILES "./generated/*.cpp")
add_library(rnoh_app SHARED
${GENERATED_CPP_FILES}
"./PackageProvider.cpp"
"${RNOH_CPP_DIR}/RNOHAppNapiBridge.cpp"
)
target_link_libraries(rnoh_app PUBLIC rnoh)
# RNOH_BEGIN: manual_package_linking_2
target_link_libraries(rnoh_app PUBLIC rnoh_sample_package)
+ target_link_libraries(rnoh_app PUBLIC rnoh_print)
# RNOH_END: manual_package_linking_2
打开 entry/src/main/cpp/PackageProvider.cpp,添加:
#include "RNOH/PackageProvider.h"
#include "generated/RNOHGeneratedPackage.h"
#include "SamplePackage.h"
+ #include "PrintPackage.h"
using namespace rnoh;
std::vector<std::shared_ptr<Package>> PackageProvider::getPackages(Package::Context ctx) {
return {
std::make_shared<RNOHGeneratedPackage>(ctx),
std::make_shared<SamplePackage>(ctx),
+ std::make_shared<PrintPackage>(ctx)
};
}
2.4. 在 ArkTs 侧引入 RNPrintPackage
打开 entry/src/main/ets/RNPackagesFactory.ts,添加:
...
+ import {RNPrintPackage} from '@react-native-ohos/react-native-print/ts';
export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
return [
new SamplePackage(ctx),
+ new RNPrintPackage(ctx)
];
}
2.5. 运行
点击右上角的 sync 按钮
或者在命令行终端执行:
cd entry
ohpm install
然后编译、运行即可。
3. 约束与限制
3.1. 兼容性
要使用此库,需要使用正确的 React-Native 和 RNOH 版本。另外,还需要使用配套的 DevEco Studio 和 手机 ROM。
本文档内容基于以下版本验证通过:
- 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;
3.2. 权限要求
在 entry 目录下的 module.json5 中添加权限
打开 entry/src/main/module.json5,添加:
...
"requestPermissions": [
+ {
+ "name": "ohos.permission.PRINT",
+ "reason": "$string:print_reason",
+ "usedScene": {
+ "abilities": [
+ "EntryAbility"
+ ],
+ "when":"always"
+ }
+ },
+ {
+ "name": "ohos.permission.INTERNET",
+ "reason": "$string:internet_reason",
+ "usedScene": {
+ "abilities": [
+ "EntryAbility"
+ ],
+ "when":"always"
+ }
+ }
]
在 entry 目录下添加申请以上权限的原因
打开 entry/src/main/resources/base/element/string.json,添加:
...
{
"string": [
+ {
+ "name": "print_reason",
+ "value": "使用打印机"
+ },
+ {
+ "name": "internet_reason",
+ "value": "网络请求数据"
+ },
]
}
4. API / 静态方法
"Platform"列表示该属性在原三方库上支持的平台。
"HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性;no 则表示不支持;partially 表示部分支持。使用方法跨平台一致,效果对标 iOS 或 Android 的效果。
4.1. print(options: Object)
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
html |
用于打印的 HTML 字符串(该值必须为 html 或 filepath。) | string | no | Android、iOS | no |
filePath |
本地或远程文件 url(该值必须为 html 或 filepath。) | string | no | Android、iOS | yes |
printerURL |
仅 iOS: 由 selectPrinterMethod() 返回的 URL |
string | no | iOS | no |
isLandscape |
横向打印;默认值为 false | boolean | no | Android、iOS | no |
jobName |
打印任务名称;默认值为 "Document" | string | no | Android、iOS | yes |
baseUrl |
用于解析 HTML 中的相对链接 | string | no | Android | no |
4.2. selectPrinter(options: Object)
| Name | Description | Type | Required | Platform | HarmonyOS Support |
|---|---|---|---|---|---|
x |
弹出对话框的 x 坐标 | number | yes | iOS | no |
y |
弹出对话框的 y 坐标 | number | yes | iOS | no |
5. 遗留问题
6. 其他
7. 开源协议
本项目基于 The MIT License (MIT) ,请自由地享受和参与开源。