在 GitHub 上查看

@nativescript/background-http ​

一个允许您进行后台 HTTP 上传的插件。

内容 ​

• 安装
• 使用 @nativescript/background-http
  • 处理上传任务事件
• API
  • init()
  • session()
    • uploadFile()
    • multipartUpload()
  • 上传请求对象
  • 任务对象
    • 任务事件
• 在本地测试插件
• 许可证

安装 ​

npm install @nativescript/background-http

使用 @nativescript/background-http ​

要进行后台 HTTP 调用，请按照以下步骤操作

1. 初始化后台 HTTP 服务

调用 init() 函数以初始化在后台运行的 HTTP 服务。在应用程序的早期，在 main.ts 文件中，应用程序启动之前调用此方法。

import { init } from '@nativescript/background-http'
init()

2. 上传文件

   1. 通过调用 session() 函数并传递会话的唯一标识符字符串（例如 image-upload）来创建上传会话。
   JavaScript

   // file path and url
   var file = '/some/local/file/path/and/file/name.jpg';
   var url = 'https://some.remote.service.com/path';
   var name = file.substr(file.lastIndexOf('/') + 1);
   
   // upload configuration
   var bghttp = require('@nativescript/background-http');
   
   var session = bghttp.session('image-upload');
   var request = {
       url: url,
       method: 'POST',
       headers: {
           'Content-Type': 'application/octet-stream',
       },
       description: 'Uploading ' + name,
   };

   2. 上传文件
   • 要启动简单的上传请求，请调用 session 的 uploadFile() 方法，并传递文件路径和 上传请求对象
   JavaScript

   var task = session.uploadFile(filePath, request);

   • 要启动 multipart/form-data 上传请求或传递其他数据，请调用 multipartUpload() 方法。所有参数值必须为字符串
   JS

   var params = [
     { name: 'test', value: 'value' },
     { name: 'fileToUpload', filename: file, mimeType: 'image/jpeg' },
   ]
   
   var task = session.multipartUpload(params, request)

为了成功上传，您应确保满足以下条件

• 文件必须可从您的应用程序访问。这可能需要其他权限（例如，访问设备上的文档和文件）。
• 操作系统不得阻止 URL。Android Pie 或更高版本的设备默认情况下需要 TLS（HTTPS）连接，并且不会上传到不安全的（HTTP）URL。

处理上传任务事件 ​

uploadFile() 和 multipartUpload() 都会启动并返回一个 Task 实例。

上传任务启动后，您可以使用以下事件监控其进度。

有关事件对象的更多信息，请参阅 任务事件。

task.on("progress", progressHandler);
task.on("error", errorHandler);
task.on("responded", respondedHandler);
task.on("complete", completeHandler);
task.on("cancelled", cancelledHandler); // Android only

每个事件处理程序接收一个包含事件数据的单个参数。

function progressHandler(e: ProgressEventData) {
  alert('uploaded ' + e.currentBytes + ' / ' + e.totalBytes)
}

// event arguments:
// task: Task
// responseCode: number
// error: java.lang.Exception (Android) / NSError (iOS)
// response: net.gotev.uploadservice.ServerResponse (Android) / NSHTTPURLResponse (iOS)
function errorHandler(e: ErrorEventData) {
  alert('received ' + e.responseCode + ' code.')
  var serverResponse = e.response
}

// event arguments:
// task: Task
// responseCode: number
// data: string
function respondedHandler(e: ResultEventData) {
  alert('received ' + e.responseCode + ' code. Server sent: ' + e.data)
}

// event arguments:
// task: Task
// responseCode: number
// response: net.gotev.uploadservice.ServerResponse (Android) / NSHTTPURLResponse (iOS)
function completeHandler(e: CompleteEventData) {
  alert('received ' + e.responseCode + ' code')
  var serverResponse = e.response
}

// event arguments:
// task: Task
function cancelledHandler(e: EventData) {
  alert('upload cancelled')
}

API ​

init() ​

import { init } from '@nativescript/background-http'

init()

初始化 HTTP 后台服务。

session() ​

import { session } from '@nativescript/background-http';
session: Session = session(id: string)

按 ID 获取或创建后台下载/上传会话。

会话对象 ​

会话对象具有以下成员

• uploadFile(fileUri: string, options: Request): Task
• multipartUpload(params: Array<any>, options: Request): Task

这两种方法都启动一个新的后台文件(s)上传任务。uploadFile() 用于单个文件上传，multipartUpload() 用于多个文件上传。fileUri 是要上传的文件的路径。options 参数表示 请求对象。

上传请求对象 ​

请求对象参数具有以下属性

任务对象 ​

任务对象具有以下属性和方法，可用于获取有关上传的信息

EventData ​

所有任务事件都扩展了 EventData 接口。

ProgressEventData ​

ResultEventData ​

CompleteEventData ​

ErrorEventData ​

API ​

init() ​

import { init } from '@nativescript/background-http'

init()

初始化 HTTP 后台服务。

session() ​

import { session } from '@nativescript/background-http'

session: Session = session(id)

按 ID 获取或创建后台下载/上传会话。

uploadFile() ​

session.uploadFile(filePath, requestOptions)

session 对象的一种方法，它启动一个后台 任务 以将指定文件编码为 application/x-www-form-urlencoded 进行上传。

multipartUpload() ​

session.multipartUpload()

session 对象的一种方法，它启动一个后台 任务 以将指定文件编码为 multipart/form-data 进行上传。

上传请求对象 ​

请求对象参数具有以下属性

任务对象 ​

任务对象具有以下属性和方法。

任务事件 ​

以下是为后台任务的不同进度状态发出的事件

• 事件数据

以下所有任务事件都扩展了前面的EventData接口。

• ProgressEventData

• ResultEventData

• CompleteEventData

• ErrorEventData

在本地测试插件 ​

要测试插件，您必须拥有一个服务器实例来接收上传。有一些在线服务可用于小型文件上传 - 例如 http://httpbin.org/post 但是，这些服务不能用于大型文件。插件存储库附带了一个简单的服务器，您可以在本地运行它。以下是启动它的方法

cd demo-server
npm i
node server 8080

以上命令将启动一个在端口 8080 上侦听的服务器。请记住更新应用程序中的 URL 以匹配服务器运行的地址/端口。

许可证 ​

Apache 许可证版本 2.0