每一个开发者都可能遇到过这样的场景:在构建一个电商网站、用户注册系统或是任何需要地理位置信息的应用时,你都需要提供一个让用户选择国家和地区的下拉菜单。起初,你可能会想,这不就是几个数组嘛,手动写进去就好了。但随着业务的扩展,你需要支持更多国家,甚至要精确到州、省、市,手动维护这些列表简直是一场噩梦:
- 数据量庞大且易错: 全球有近200个国家,每个国家又有几十个甚至上百个州/省,手动录入这些数据不仅耗时耗力,还极易引入拼写错误或遗漏。
- 更新维护困难: 国家名称、行政区划有时会发生变化,手动更新意味着你需要不断地关注这些信息,并修改代码。
- 国际化与标准化: 如何确保国家和地区名称的英文拼写准确无误?如何统一使用 ISO 编码作为后台标识?这些都是手动维护难以解决的挑战。
- 代码冗余与耦合: 如果在多个地方都需要这些数据,你可能会复制粘贴相同的数组,导致代码冗余,难以管理。
幸好,Laravel 强大的生态系统总能为我们提供优雅的解决方案。今天,我就要向大家介绍一个能彻底解决这个痛点的 Composer 包——dougsisk/laravel-country-state。
引入 dougsisk/laravel-country-state:告别手动维护的时代
dougsisk/laravel-country-state 是一个专为 Laravel 11.0+ 设计的实用工具,它提供了一个简洁的 API 来获取国家和地区(州/省)的英文名称列表,并支持 ISO 编码。得益于 Composer 强大的包管理能力,安装这个库简直是小菜一碟:
首先,通过 Composer 将其添加到你的 Laravel 项目中:
composer require dougsisk/laravel-country-state
安装完成后,如果你使用的是 Laravel 11.0+ 并且开启了包自动发现功能,那么你无需进行任何额外配置。否则,你可能需要在 config/app.php 文件的 providers 数组中手动添加服务提供者:
// config/app.php
'providers' => [
// ...
DougSisk\CountryState\CountryStateServiceProvider::class,
],为了更好地控制和定制国家地区数据,你可以发布其配置文件到你的项目中:
php artisan vendor:publish --provider="DougSisk\CountryState\CountryStateServiceProvider" --tag="config"
这会在 config 目录下生成一个 country-state.php 文件,你可以在其中进行一些配置,例如:
// config/country-state.php
return [
// 预加载指定国家的州/省数据,提高性能
'preloadCountryStates' => ['CA', 'MX', 'US'],
// 限制只返回指定国家的列表
'limitCountries' => ['CA', 'MX', 'US']
];通过 preloadCountryStates,你可以预先加载常用国家的州/省数据,避免每次请求时都去加载所有数据。而 limitCountries 则允许你根据业务需求,只显示部分国家,这对于只服务特定区域的应用来说非常实用。
轻松使用:获取国家与地区列表
dougsisk/laravel-country-state 提供了一个方便的 Facade 接口 CountryState,让你可以轻松访问国家和地区数据。别忘了在你的文件中导入这个 Facade:
use CountryState;
获取所有国家列表:
$countries = CountryState::getCountries();
/*
$countries 的示例输出(部分):
[
"AD" => "Andorra",
"AE" => "United Arab Emirates",
"AF" => "Afghanistan",
// ...
"US" => "United States",
// ...
]
*/getCountries() 方法返回一个关联数组,键是国家的两字母 ISO 编码,值是国家的英文名称。这对于构建 标签的 value 和 text 都非常方便。
获取指定国家的州/省列表:
如果你需要获取某个国家的所有州或省份列表,只需传入该国家的两字母 ISO 编码即可:
$states = CountryState::getStates('US'); // 获取美国的所有州
/*
$states 的示例输出(部分):
[
"AL" => "Alabama",
"AK" => "Alaska",
"AZ" => "Arizona",
// ...
"WY" => "Wyoming"
]
*/同样,返回的也是一个关联数组,键是州/省的两字母 ISO 编码,值是其英文名称。这使得在表单中实现国家-地区级联选择变得异常简单。
总结与实际应用效果
有了 dougsisk/laravel-country-state,我们再也不用为国家地区的下拉列表而烦恼了。它的优势显而易见:
- 节省开发时间: 无需手动创建和维护庞大的数据数组,一行代码即可获取所需数据。
- 保证数据准确性: 依赖标准化的 ISO 编码和预定义的英文名称,减少了人为错误。
- 提高代码可维护性: 将国家地区数据管理封装到库中,使你的业务逻辑代码更清晰、更专注于核心功能。
- 无缝集成 Laravel: 作为 Laravel 包,它与框架完美结合,使用 Facade 接口,简单直观。
尽管该库的维护者提到其底层国家/地区数据包可能更新不频繁,但在绝大多数场景下,它依然能提供稳定且足够准确的数据,并且其易用性远超手动维护。对于需要快速构建带有国家地区选择功能的 Laravel 应用来说,dougsisk/laravel-country-state 绝对是一个值得推荐的利器。
下次当你需要处理国家或地区选择器时,不妨尝试一下 dougsisk/laravel-country-state,你会发现开发效率和代码质量都能得到显著提升!










