Flutter IP地址获取插件ipapi的使用

ipapi 是一个用于Flutter应用的地理位置插件，它通过调用 IP-API.com 的 IP 地理位置 API 来获取IP信息。

功能

• 支持所有平台。
• 同时支持免费版和专业版访问 IP-API.com。
• 免费版无需API密钥。

使用方法

要使用此插件，在 pubspec.yaml 文件中添加依赖：

dependencies:
  ipapi: ^版本号

然后运行 flutter pub get 命令以安装该插件。

示例

以下是几个示例，展示如何使用该插件。

示例 1：获取当前IP的所有信息（使用免费API）

// 获取当前IP的所有信息
final GeoData? geoData = await IpApi.getData("172.217.0.0");
print(geoData?.toJson());
/*
打印结果：
{
    "query": "172.217.0.0",
    "status": "success",
    "continent": null, // 可选字段，未包含在请求中
    "continentCode": null, // 可选字段，未包含在请求中
    "country": "United States",
    "countryCode": "US",
    "region": "IL",
    "regionName": "Illinois",
    "city": "Chicago",
    "district": null, // 可选字段，未包含在请求中
    "zip": "60666",
    "lat": 41.8781,
    "lon": -87.6298,
    "timezone": "America/Chicago",
    "offset": null, // 可选字段，未包含在请求中
    "currency": null, // 可选字段，未包含在请求中
    "isp": "Google LLC",
    "org": "Google LLC",
    "as": "AS15169 Google LLC",
    "reverse": null, // 可选字段，未包含在请求中
    "asname": null, // 可选字段，未包含在请求中
    "mobile": null, // 可选字段，未包含在请求中
    "proxy": null, // 可选字段，未包含在请求中
    "hosting": null // 可选字段，未包含在请求中
}
*/

示例 2：获取不同IP的所有信息（使用免费API），并指定语言和查询字段

// 获取不同IP的所有信息，并指定语言和查询字段
final GeoData? geoData = await IpApi.getData({
    "ip": '172.217.0.0',
    "lang": 'de',
    "fields": ['country'],
});
print(geoData?.country); // 打印 'Vereinigte Staaten'
print(geoData?.city); // 打印 'null'，因为该字段不在查询中

示例 3：使用API密钥自动查询专业API端点

// 使用API密钥自动查询专业API端点
final GeoData? geoData = await IpApi.getData({
    "apiKey": 'xxxxxxxxxxxxxxx'
});

字段列表

额外信息

请注意以下重要信息

• 我们与 IP-API.com 没有任何关联。此插件只是 IP-API.com 提供的 API 的封装。我们不对使用此插件或 IP-API.com 可能引起的任何责任负责。
• 请注意，IP-API.com 的免费版 IP 地理位置 API 每个IP每分钟限制为45次请求，并且仅使用HTTP（不是HTTPS），并且不能用于商业用途。商业用途需要购买专业版许可。
• 请务必阅读 IP-API.com 上的完整使用条款和最新的API规范。

完整示例代码

import 'dart:convert';

import 'package:flutter/material.dart';
import 'package:ipapi/ipapi.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String? text;
  GeoData? geoData;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: Column(
          crossAxisAlignment: CrossAxisAlignment.center,
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text(text ?? ''),
            TextButton(
              onPressed: () async {
                geoData = await IpApi.getData();
                if (geoData != null) {
                  setState(() {
                    text = jsonEncode(geoData?.toJson());
                  });
                }
              },
              child: const Text("Get Data"),
            )
          ],
        ),
      ),
    );
  }
}