Flutter斯里兰卡省份区县城市数据插件sri_lanka_provinces_districts_cities的使用

一个Flutter插件，用于访问斯里兰卡省份、区县和城市的信息。此插件提供了模型和辅助函数，可以处理斯里兰卡地理数据，包括按不同标准（如ID、名称、邮政编码）搜索、过滤和检索省份、区县和城市的详细信息。

特性

• 获取斯里兰卡省份、区县和城市的详细信息。
• 包含City、District和Province模型。
• 辅助函数可按ID、名称（英语、僧伽罗语或泰米尔语）和邮政编码查找项目。
• 提供易于使用的辅助函数以获取相关数据（例如，某个省份的所有区县，某个区县的所有城市）。

安装

在你的pubspec.yaml文件中添加以下依赖：

dependencies:
  sri_lanka_provinces_districts_cities: ^x.x.x

然后运行：

flutter pub get

导入包：

import 'package:sri_lanka_provinces_districts_cities/sri_lanka_provinces_districts_cities.dart';

模型

该插件包含以下模型：

• Province
• District
• City

每个模型都有必要的属性和fromJson/toJson方法用于JSON序列化。

示例用法

1. 按ID获取省份

你可以通过省份ID来获取省份信息：

Province? province = getProvinceById(3); // 获取南方省份
print(province?.nameEn); // 输出: Southern

2. 按省份ID获取区县

获取指定省份的所有区县：

List<District> colomboDistricts = getDistrictsByProvinceId(1); // 获取西方省份的所有区县
for (var district in colomboDistricts) {
  print(district.nameEn); // 输出: Colombo, Gampaha, Kalutara
}

3. 按ID获取城市

通过城市ID查找特定城市：

City? city = getCityById(1);
print(city?.nameEn); // 输出: Akkaraipattu

4. 按区县ID获取城市

获取指定区县的所有城市：

List<City> citiesInDistrict = getCitiesByDistrictId(1); // 获取ID为1的区县的所有城市
for (var city in citiesInDistrict) {
  print(city.nameEn); // 输出: Akkaraipattu, Ampara 等等
}

5. 按名称搜索城市（英语、僧伽罗语或泰米尔语）

根据城市名称（英语、僧伽罗语或泰米尔语）搜索城市：

List<City> searchedCities = searchCitiesByNameEn('Ampara');
print(searchedCities.first.nameEn); // 输出: Ampara

List<City> searchedCitiesSi = searchCitiesByNameSi('අම්පාර');
print(searchedCitiesSi.first.nameSi); // 输出: අම්පාර

List<City> searchedCitiesTa = searchCitiesByNameTa('அம்பாறை');
print(searchedCitiesTa.first.nameTa); // 输出: அம்பாறை

辅助函数

以下是可用的辅助函数：

1. 按ID获取省份

Province? getProvinceById(int id)

通过ID返回一个省份对象。

2. 按省份ID获取区县

List<District> getDistrictsByProvinceId(int provinceId)

返回一个省份内的区县列表。

3. 按ID获取城市

City? getCityById(int id)

通过ID返回一个城市对象。

4. 按区县ID获取城市

List<City> getCitiesByDistrictId(int districtId)

返回一个区县内的城市列表。

5. 按邮政编码获取城市

List<City> getCitiesByPostcode(String postcode)

返回匹配特定邮政编码的城市列表。

6. 按英语名称搜索城市

List<City> searchCitiesByNameEn(String name)

根据英语名称搜索城市。

7. 按僧伽罗语名称搜索城市

List<City> searchCitiesByNameSi(String name)

根据僧伽罗语名称搜索城市。

8. 按泰米尔语名称搜索城市

List<City> searchCitiesByNameTa(String name)

根据泰米尔语名称搜索城市。

示例代码

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

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'Cities Helper Demo',
      home: CitiesHomePage(),
    );
  }
}

class CitiesHomePage extends StatefulWidget {
  const CitiesHomePage({super.key});

  [@override](/user/override)
  _CitiesHomePageState createState() => _CitiesHomePageState();
}

class _CitiesHomePageState extends State<CitiesHomePage> {
  late List<Cities> localCities;
  late List<District> localDistricts;
  late List<Province> localProvinces;

  String result = '';

  [@override](/user/override)
  void initState() {
    super.initState();
    // 加载所有省份、区县和城市
    localProvinces = slProvinces; // 假设 `slProvinces` 包含所有省份
    localDistricts = slDistricts; // 假设 `slDistricts` 包含所有区县
    localCities = slCities;       // 假设 `slCities` 包含所有城市
  }

  void _searchProvince(int id) {
    Province? province = getProvinceById(id);
    setState(() {
      result = province != null
          ? '省份: ${province.nameEn}'
          : '未找到ID为 $id 的省份';
    });
  }

  void _searchDistricts(int provinceId) {
    List<District> foundDistricts = getDistrictsByProvinceId(provinceId);
    setState(() {
      result = foundDistricts.isNotEmpty
          ? '区县: ${foundDistricts.map((d) => d.nameEn).join(', ')}'
          : '未找到省份ID为 $provinceId 的区县';
    });
  }

  void _searchCities(int districtId) {
    List<Cities> foundCities = getCitiesByDistrictId(districtId);
    setState(() {
      result = foundCities.isNotEmpty
          ? '城市: ${foundCities.map((c) => c.nameEn).join(', ')}'
          : '未找到区县ID为 $districtId 的城市';
    });
  }

  void _searchCityByName(String name) {
    List<Cities> foundCities = searchCitiesByNameEn(name);
    setState(() {
      result = foundCities.isNotEmpty
          ? '搜索结果: ${foundCities.map((c) => c.nameEn).join(', ')}'
          : '未找到名为 "$name" 的城市';
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('城市助手演示'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(16.0),
        child: Column(
          children: [
            ElevatedButton(
              onPressed: () => _searchProvince(3),
              child: const Text('按ID查找省份 (例如, 3)'),
            ),
            ElevatedButton(
              onPressed: () => _searchDistricts(1),
              child: const Text('按省份ID查找区县 (例如, 1)'),
            ),
            ElevatedButton(
              onPressed: () => _searchCities(2),
              child: const Text('按区县ID查找城市 (例如, 1)'),
            ),
            ElevatedButton(
              onPressed: () => _searchCityByName('Ampara'),
              child: const Text('按英语名称搜索城市 (例如, Ampara)'),
            ),
            const SizedBox(height: 20),
            Text(
              result,
              style: const TextStyle(fontSize: 16, color: Colors.black),
              textAlign: TextAlign.center,
            ),
          ],
        ),
      ),
    );
  }
}