开始
复制一个带有安装步骤和完整Markdown指南的设置提示。
Set up this Capacitor plugin in the project.
Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-network-diagnostics`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/network-diagnostics/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.
安装
安装您可以使用我们的AI辅助设置来安装插件。将Capgo技能添加到您的AI工具中,使用以下命令:
npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins然后使用以下提示:
Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-network-diagnostics` plugin in my project.如果您更喜欢手动设置,请运行以下命令并按照以下平台特定说明进行安装:
bun add @capgo/capacitor-network-diagnosticsbunx cap sync导入
导入import { NetworkDiagnostics } from '@capgo/capacitor-network-diagnostics';运行完整诊断报告
导入runDiagnostics 运行完整诊断报告
const report = await NetworkDiagnostics.runDiagnostics({ urls: [{ url: 'https://api.example.com/health', method: 'HEAD' }], ports: [{ host: 'api.example.com', port: 443 }], websockets: [{ url: 'wss://ws.example.com/socket' }], download: { url: 'https://speed.example.com/5mb.bin', maxBytes: 5 * 1024 * 1024, }, packetLoss: { mode: 'tcp', host: 'api.example.com', port: 443, count: 10, },});
console.log(report.status.connectionType);console.log(report.issues);检查当前网络状态
检查当前网络状态const status = await NetworkDiagnostics.getNetworkStatus();
console.log(status.connected);console.log(status.connectionType);console.log(status.internetReachable);console.log(status.captivePortal);具体的标志取决于平台。 Android 可以报告验证的互联网和被捕获的门户状态。 iOS 报告路径状态、接口类型、昂贵路径和受限路径通过 Network.framework.
测试API可达性
检查API可达性const result = await NetworkDiagnostics.testUrl({ url: 'https://api.example.com/health', method: 'HEAD', timeoutMs: 5000, followRedirects: true,});
if (!result.reachable) { console.warn(result.errorCode, result.errorMessage);}使用您的后端的真实健康端点。 浏览器的检查可以被 WebView、CORS、代理或被捕获的门户行为隐藏,而这个插件使用原生网络
测试一个 TCP 端口
测试一个 TCP 端口const port = await NetworkDiagnostics.testPort({ host: 'api.example.com', port: 443, timeoutMs: 3000,});
console.log(port.open, port.durationMs);当Wi-Fi访问点阻止非标准端口、MQTT、自定义网关或私有后端时,这很有用,仍允许正常浏览。
测试WebSocket连接
测试WebSocket连接const socket = await NetworkDiagnostics.testWebSocket({ url: 'wss://ws.example.com/socket', timeoutMs: 5000,});
console.log(socket.open, socket.statusCode);当代理或捕获门户允许HTTPS页面但阻止WebSocket升级请求时使用。
测量下载速度
测量下载速度const speed = await NetworkDiagnostics.testDownloadSpeed({ url: 'https://speed.example.com/5mb.bin', maxBytes: 5 * 1024 * 1024, timeoutMs: 30000,});
console.log(speed.mbps);使用您自己的静态文件端点,以便结果反映您的应用程序所需的网络路径。
估计丢包率
估计丢包率const loss = await NetworkDiagnostics.testPacketLoss({ mode: 'tcp', host: 'api.example.com', port: 443, count: 10, timeoutMs: 3000, intervalMs: 250,});
console.log(loss.lossPercent);App Store 和 Play Store 应用程序中 ICMP ping 不是可移植的。这项方法通过重复 TCP 或 HTTP 探测来测量应用程序级别的数据包丢失。
网络fallback
Web fallbackWeb 实现是为开发而设计的。浏览器无法打开原始 TCP sockets,URL 检查可能受 CORS 限制。请使用 iOS 或 Android 构建来获得真实的支持诊断。