一个纯 Dart 库,通过尝试连接到可配置地址列表中的套接字来检测互联网连接状态,每个地址均可自定义端口和超时时间。它提供了默认设置以实现快速配置,同时允许精细控制。非常适合需要可靠网络状态检测但不依赖平台特定 API 的应用。该库采用异步操作,轻量级,适用于 Flutter 应用程序中的实时连接监控。
适合场景
在 API 调用前检查互联网可用性
在后台任务中监控网络状态
在数据同步之前验证连接
实现离线模式逻辑
提供连接状态的用户反馈
主要特点
基于套接字的连接检查
可配置的主机地址和端口
可自定义的超时设置
默认配置,便于使用
异步操作与回调
适合对象
Flutter 应用需要强大的网络检测
频繁发起网络请求的应用
寻求跨平台一致性的开发者
需要对连接测试进行精确控制的应用程序
项目避免使用平台特定代码
使用建议
需要互联网连接才能正确运行
可能在瞬时网络问题期间引发误报
不验证套接字连接之外的实际互联网可达性
仅限TCP连接检查
无内置重试机制
原始 README
以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。
data_connection_checker
A pure Dart utility library that checks for an internet connection by opening a socket to a list of specified addresses, each with individual port and timeout. Defaults are provided for convenience.
Note that this plugin is in beta and may still have
a few issues. Feedback is welcome.
Checks for an internet (data) connection, by opening a socket to a list of addresses.
The defaults of the plugin should be sufficient to reliably determine if
the device is currently connected to the global network, e.i. has access to the Internet.
Note that you should not be using the current network status for deciding whether you can reliably make a network connection. Always guard your app code against timeouts and errors that might come from the network layer.
Quick start
DataConnectionChecker() is actually a Singleton. Calling DataConnectionChecker()
is guaranteed to always return the same instance.
You can supply a new list to DataConnectionChecker().addresses if you
need to check different destinations, ports and timeouts.
Also, each address can have its own port and timeout.
See InternetAddressCheckOptions in the docs for more info.
First you need to install it (this is the preferred way)
Then you can start using the library:
bool result = awaitDataConnectionChecker().hasConnection;
if(result == true) {
print('YAY! Free cute dog pics!');
} else {
print('No internet :( Reason:');
print(DataConnectionChecker().lastTryResults);
}
Purpose
The reason this package exists is that connectivity package cannot reliably determine if a data connection is actually available. More info on its page here: https://pub.dev/packages/connectivity
You can use this package in combination with connectivity in the following way:
var isDeviceConnected = false;
var subscription = Connectivity().onConnectivityChanged.listen((ConnectivityResult result) async {
if(result != ConnectivityResult.none) {
isDeviceConnected = awaitDataConnectionChecker().hasConnection;
}
});
Note: remember to properly cancel the subscription when it's no longer needed. See connectivity package docs for more info.
How it works
All addresses are pinged simultaneously. On successful result (socket connection to address/port succeeds) a true boolean is pushed to a list, on failure (usually on timeout, default 10 sec) a false boolean is pushed to the same list.
When all the requests complete with either success or failure, a check is made to see if the list contains at least one true boolean. If it does, then an external address is available, so we have data connection. If all the values in this list are false, then we have no connection to the outside world of cute cat and dog pictures, so hasConnection also returns false too.
This all happens at the same time for all addresses, so the maximum waiting time is the address with the highest specified timeout, in case it's unreachable.
I believe this is a reliable and fast method to check if a data connection is available to a device, but I may be wrong. I suggest you open an issue on the Github repository page if you have a better way of.
... is 10 seconds. Interval is the time between automatic checks. Automatic
checks start if there's a listener attached to onStatusChange, thus remember
to cancel unneeded subscriptions.
checkInterval (which controls how often a check is made) defaults
to this value. You can change it if you need to perform checks more often
or otherwise.
import'package:data_connection_checker/data_connection_checker.dart';
main() async {
// Simple check to see if we have internetprint("The statement 'this machine is connected to the Internet' is: ");
print(awaitDataConnectionChecker().hasConnection);
// returns a bool// We can also get an enum value instead of a boolprint("Current status: ${await DataConnectionChecker().connectionStatus}");
// prints either DataConnectionStatus.connected// or DataConnectionStatus.disconnected// This returns the last results from the last call// to either hasConnection or connectionStatusprint("Last results: ${DataConnectionChecker().lastTryResults}");
// actively listen for status updates// this will cause DataConnectionChecker to check periodically// with the interval specified in DataConnectionChecker().checkInterval// until listener.cancel() is calledvar listener = DataConnectionChecker().onStatusChange.listen((status) {
switch (status) {
caseDataConnectionStatus.connected:
print('Data connection is available.');
break;
caseDataConnectionStatus.disconnected:
print('You are disconnected from the internet.');
break;
}
});
// close listener after 30 seconds, so the program doesn't run foreverawaitFuture.delayed(Duration(seconds: 30));
await listener.cancel();
}
Note: Remember to dispose of any listeners,
when they're not needed to prevent memory leaks,
e.g. in aStatefulWidget's dispose() method:
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Features and bugs
Please file feature requests and bugs at the issue tracker.