Skip to content

Commit 95c008b

Browse files
committed
增加README
1 parent 7a92648 commit 95c008b

File tree

1 file changed

+109
-0
lines changed

1 file changed

+109
-0
lines changed

README.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# hejunjie/address-parser
2+
3+
一个简单实用的 PHP 地址解析工具,可以从混杂的字符串中提取出 **姓名、手机号、身份证、邮编、以及完整的省市区地址信息**
4+
5+
> 🚀 适用于快递地址、用户信息录入等场景,自动识别结构化信息。
6+
7+
---
8+
9+
## ✨ 特性
10+
11+
- 自动识别:支持姓名、手机号、身份证、邮编提取
12+
- 地址解析:基于省市区行政区划数据,智能匹配行政区域
13+
- 结构化返回:统一结构输出,便于前后端对接
14+
- 零依赖:纯 PHP 编写,无需额外扩展
15+
- 支持 PHP 8+
16+
17+
---
18+
19+
## 📦 安装
20+
21+
使用 Composer 安装:
22+
23+
```bash
24+
composer require hejunjie/address-parser
25+
```
26+
27+
## 🧠 使用示例
28+
29+
```php
30+
use Hejunjie\AddressParser\AddressParser;
31+
32+
$raw = '张三,13512345678,410123199001011234 重庆攀枝花市东区机场路88号 邮编100000';
33+
34+
$parsed = AddressParser::parse($raw);
35+
36+
print_r($parsed);
37+
38+
```
39+
40+
输出结果
41+
42+
```php
43+
[
44+
'name' => '张三',
45+
'mobile' => '13512345678',
46+
'idn' => '410123199001011234',
47+
'postcode' => '100000',
48+
'province' => '四川省',
49+
'city' => '攀枝花市',
50+
'region' => '东区',
51+
'street' => '机场路88号'
52+
]
53+
```
54+
55+
## 🧩 返回字段说明
56+
57+
| 字段名 | 说明 |
58+
|:-------|:-----|
59+
| name | 姓名 |
60+
| mobile | 手机号 |
61+
| idn | 身份证号 |
62+
| postcode | 邮政编码 |
63+
| province | 省份名称 |
64+
| city | 城市名称 |
65+
| region | 区/县名称 |
66+
| street | 详细地址(去除省市区后的部分) |
67+
68+
## 🧰 用途 & 背景
69+
70+
在实际业务中,用户填写的地址往往是非结构化的,例如:
71+
72+
> 张三 13512345678 北京市朝阳区建国路88号 邮编100000
73+
74+
将这些信息手动拆分不仅低效,而且容易出错。`hejunjie/address-parser` 就是为了解决这种 **非结构化地址的自动解析** 而设计的,广泛适用于:
75+
76+
- 🛒 电商系统中的订单地址处理
77+
- 📦 快递物流系统地址识别
78+
- 🧾 后台管理系统用户信息补全
79+
- 📱 小程序/APP 用户地址录入校验
80+
81+
无论是个人项目还是企业系统,它都能快速提升地址处理的自动化与准确率。
82+
83+
有啥问题或者建议都欢迎提 issue 或 PR,我会尽量回复。
84+
85+
# 🔧 更多工具包(可独立使用,也可统一安装)
86+
87+
本项目最初是从 [hejunjie/tools](https://github.com/zxc7563598/php-tools) 拆分而来,如果你想一次性安装所有功能组件,也可以使用统一包:
88+
89+
```bash
90+
composer require hejunjie/tools
91+
```
92+
93+
当然你也可以按需选择安装以下功能模块:
94+
95+
[hejunjie/cache](https://github.com/zxc7563598/php-cache) - 多层缓存系统,基于装饰器模式。
96+
97+
[hejunjie/china-division](https://github.com/zxc7563598/php-china-division) - 中国省市区划分数据包。
98+
99+
[hejunjie/error-log](https://github.com/zxc7563598/php-error-log) - 责任链日志上报系统。
100+
101+
[hejunjie/mobile-locator](https://github.com/zxc7563598/php-mobile-locator) - 国内手机号归属地 & 运营商识别。
102+
103+
[hejunjie/utils](https://github.com/zxc7563598/php-utils) - 常用工具方法集合。
104+
105+
👀 所有包都遵循「轻量实用、解放双手」的原则,能单独用,也能组合用,自由度高,欢迎 star 🌟 或提 issue。
106+
107+
---
108+
109+
该库后续将持续更新,添加更多实用功能。欢迎大家提供建议和反馈,我会根据大家的意见实现新的功能,共同提升开发效率。

0 commit comments

Comments
 (0)