Skip to content

Commit b3fd282

Browse files
jiawen-afkJiawen
jiawen-afk
and
Jiawen
authored
feat: add address.Smart and Decompose for parse CN address (#346)
* feat: add address.Smart and Decompose for parse CN address * feat: add Xinjiang directly-administered county-level cities support - Add '自治区直辖县级市' as a city-level unit (ID: 4043) in A2Data for Xinjiang - Add 12 directly-administered county-level cities in A3Data (IDs: 4044-4055): * 石河子市 (Shihezi, 1976, 8th Division) - ID: 4044 * 阿拉尔市 (Aral, 2002, 1st Division) - ID: 4045 * 图木舒克市 (Tumxuk, 2002, 3rd Division) - ID: 4046 * 五家渠市 (Wujiaqu, 2002, 6th Division) - ID: 4047 * 北屯市 (Beitun, 2011, 10th Division) - ID: 4048 * 铁门关市 (Tiemenguan, 2012, 2nd Division) - ID: 4049 * 双河市 (Shuanghe, 2014, 5th Division) - ID: 4050 * 可克达拉市 (Kokdala, 2015, 4th Division) - ID: 4051 * 昆玉市 (Kunyu, 2016, 14th Division) - ID: 4052 * 胡杨河市 (Huyanghe, 2019, 7th Division) - ID: 4053 * 新星市 (Xinxing, 2021, 13th Division) - ID: 4054 * 白杨市 (Baiyang, 2023, 9th Division) - ID: 4055 - All county-level cities are under PID 4043 (自治区直辖县级市) - Add test case for Xinjiang Shihezi city address parsing - Now supports parsing addresses like: 新疆石河子市北三路25小区 * docs: formated address data * fix: parse repeat address error * feat: update readme file --------- Co-authored-by: Jiawen <im@linjiawen.com>
1 parent a1cebec commit b3fd282

File tree

8 files changed

+5679
-0
lines changed

8 files changed

+5679
-0
lines changed

‎README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -986,6 +986,12 @@ import "github.com/duke-git/lancet/v2/formatter"
986986
- **<big>ParseBinaryBytes</big>** : return the human readable bytes size string into the amount it represents(base 1024).
987987
[[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/formatter.md#ParseBinaryBytes)]
988988
[[play](https://go.dev/play/p/69v1tTT62x8)]
989+
- **<big>ParseCNAddress</big>** : parses a Chinese address string intelligently and extracts structured information (province, city, district, street, name, phone, etc.). Supports various address formats including county-level cities.
990+
[[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/formatter.md#ParseCNAddress)]
991+
[[play](https://go.dev/play/p/o5l09hQopEV)]
992+
- **<big>ParsePersonInfo</big>** : extracts user information (name, phone, ID card, postal code) from an address string and separates it from the location address.
993+
[[doc](https://github.com/duke-git/lancet/blob/main/docs/en/api/packages/formatter.md#ParsePersonInfo)]
994+
[[play](https://go.dev/play/p/JO-uTlJlTy7)]
989995

990996
<h3 id="function"> 13. Function package can control the flow of function execution and support part of functional programming.&nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">index</a></h3>
991997

‎README_zh-CN.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -996,6 +996,12 @@ import "github.com/duke-git/lancet/v2/formatter"
996996
- **<big>ParseBinaryBytes</big>** : 将字节单位字符串转换成其所表示的字节数（以 1024 为基数）。
997997
[[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/formatter.md#ParseBinaryBytes)]
998998
[[play](https://go.dev/play/p/69v1tTT62x8)]
999+
- **<big>ParseCNAddress</big>** : 智能解析中国地址字符串并提取结构化信息（省、市、区、街道、姓名、电话等）。支持多种地址格式，包括县级市。
1000+
[[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/formatter.md#ParseCNAddress)]
1001+
[[play](https://go.dev/play/p/o5l09hQopEV)]
1002+
- **<big>ParsePersonInfo</big>** : 从地址字符串中提取用户信息（姓名、电话、身份证、邮编）并将其与位置地址分离。
1003+
[[doc](https://github.com/duke-git/lancet/blob/main/docs/api/packages/formatter.md#ParsePersonInfo)]
1004+
[[play](https://go.dev/play/p/JO-uTlJlTy7)]
9991005

10001006
<h3 id="function"> 13. function 函数包控制函数执行流程，包含部分函数式编程。&nbsp; &nbsp; &nbsp; &nbsp;<a href="#index">回到目录</a></h3>
10011007

‎docs/api/packages/formatter.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ formatter 格式化器包含一些数据格式化处理方法。
88

99
- [https://github.com/duke-git/lancet/blob/main/formatter/formatter.go](https://github.com/duke-git/lancet/blob/main/formatter/formatter.go)
1010
- [https://github.com/duke-git/lancet/blob/main/formatter/byte.go](https://github.com/duke-git/lancet/blob/main/formatter/byte.go)
11+
- [https://github.com/duke-git/lancet/blob/main/formatter/address.go](https://github.com/duke-git/lancet/blob/main/formatter/address.go)
1112

1213
<div STYLE="page-break-after: always;"></div>
1314

@@ -30,6 +31,8 @@ import (
3031
- [BinaryBytes](#BinaryBytes)
3132
- [ParseDecimalBytes](#ParseDecimalBytes)
3233
- [ParseBinaryBytes](#ParseBinaryBytes)
34+
- [ParseCNAddress](#ParseCNAddress)
35+
- [ParsePersonInfo](#ParsePersonInfo)
3336

3437
<div STYLE="page-break-after: always;"></div>
3538

@@ -308,3 +311,134 @@ func main() {
308311
// 12492
309312
}
310313
```
314+
315+
### <span id="ParseCNAddress">ParseCNAddress</span>
316+
317+
<p>智能解析中国地址字符串并提取结构化信息。可以解析带或不带用户信息（姓名、电话、身份证等）的地址。当 withUser 为 true 时，从地址字符串中提取用户信息。当 withUser 为 false 时，仅解析位置信息。支持多种地址格式：标准格式、紧凑格式、带关键词格式、县级市格式等。</p>
318+
319+
<b>函数签名:</b>
320+
321+
```go
322+
func ParseCNAddress(str string, withUser bool) *AddressInfo
323+
```
324+
325+
<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/o5l09hQopEV)</span></b>
326+
327+
```go
328+
package main
329+
330+
import (
331+
"encoding/json"
332+
"fmt"
333+
"github.com/duke-git/lancet/v2/formatter"
334+
)
335+
336+
func main() {
337+
// 解析包含用户信息的完整地址
338+
result1 := formatter.ParseCNAddress("张三 13800138000 北京市朝阳区建国路1号", true)
339+
jsonData1, _ := json.MarshalIndent(result1, "", " ")
340+
fmt.Println("示例 1 - 带用户信息:")
341+
fmt.Println(string(jsonData1))
342+
343+
// 仅解析地址，不提取用户信息
344+
result2 := formatter.ParseCNAddress("北京市海淀区中关村大街1号", false)
345+
fmt.Printf("\n示例 2 - 仅地址:\n")
346+
fmt.Printf("省: %s, 市: %s, 区: %s, 街道: %s\n",
347+
result2.Province, result2.City, result2.Region, result2.Street)
348+
349+
// 解析县级市地址
350+
result3 := formatter.ParseCNAddress("河北省石家庄市新乐市经济开发区兴工街10号", false)
351+
fmt.Printf("\n示例 3 - 县级市:\n")
352+
fmt.Printf("省: %s, 市: %s, 区/县: %s, 街道: %s\n",
353+
result3.Province, result3.City, result3.Region, result3.Street)
354+
355+
// 紧凑格式
356+
result4 := formatter.ParseCNAddress("马云13593464918陕西省西安市雁塔区丈八沟街道", true)
357+
fmt.Printf("\n示例 4 - 紧凑格式:\n")
358+
fmt.Printf("姓名: %s, 电话: %s, 地址: %s%s%s%s\n",
359+
result4.Name, result4.Mobile, result4.Province, result4.City, result4.Region, result4.Street)
360+
361+
// Output:
362+
// 示例 1 - 带用户信息:
363+
// {
364+
// "name": "张三",
365+
// "mobile": "13800138000",
366+
// "idn": "",
367+
// "postcode": "",
368+
// "province": "北京",
369+
// "city": "北京市",
370+
// "region": "朝阳区",
371+
// "street": "建国路1号",
372+
// "addr": "北京市朝阳区建国路1号"
373+
// }
374+
//
375+
// 示例 2 - 仅地址:
376+
// 省: 北京, 市: 北京市, 区: 海淀区, 街道: 中关村大街1号
377+
//
378+
// 示例 3 - 县级市:
379+
// 省: 河北省, 市: 石家庄市, 区/县: 新乐市, 街道: 经济开发区兴工街10号
380+
//
381+
// 示例 4 - 紧凑格式:
382+
// 姓名: 马云, 电话: 13593464918, 地址: 陕西省西安市雁塔区丈八沟街道
383+
}
384+
```
385+
386+
### <span id="ParsePersonInfo">ParsePersonInfo</span>
387+
388+
<p>从地址字符串中提取用户信息（姓名、电话、身份证、邮编）。将个人信息与地址分离，支持带标签格式、紧凑格式、带分隔符格式。返回包含提取的用户信息和清理后地址字符串的 AddressInfo。</p>
389+
390+
<b>函数签名:</b>
391+
392+
```go
393+
func ParsePersonInfo(str string) *AddressInfo
394+
```
395+
396+
<b>示例:<span style="float:right;display:inline-block;">[运行](https://go.dev/play/p/JO-uTlJlTy7)</span></b>
397+
398+
```go
399+
package main
400+
401+
import (
402+
"encoding/json"
403+
"fmt"
404+
"github.com/duke-git/lancet/v2/formatter"
405+
)
406+
407+
func main() {
408+
// 提取姓名和手机号
409+
result1 := formatter.ParsePersonInfo("张三 13800138000 北京市朝阳区")
410+
fmt.Println("示例 1 - 姓名和手机号:")
411+
fmt.Printf("姓名: %s, 手机: %s, 地址: %s\n", result1.Name, result1.Mobile, result1.Addr)
412+
413+
// 提取身份证号
414+
result2 := formatter.ParsePersonInfo("李四 110101199001011234 上海市")
415+
fmt.Println("\n示例 2 - 身份证号:")
416+
fmt.Printf("姓名: %s, 身份证: %s, 地址: %s\n", result2.Name, result2.IDN, result2.Addr)
417+
418+
// 带标签格式
419+
result3 := formatter.ParsePersonInfo("收货人：王五 电话：13900139000 收货地址：天津市河西区友谊路20号")
420+
jsonData3, _ := json.MarshalIndent(result3, "", " ")
421+
fmt.Println("\n示例 3 - 带标签格式:")
422+
fmt.Println(string(jsonData3))
423+
424+
// Output:
425+
// 示例 1 - 姓名和手机号:
426+
// 姓名: 张三, 手机: 13800138000, 地址: 北京市朝阳区
427+
//
428+
// 示例 2 - 身份证号:
429+
// 姓名: 李四, 身份证: 110101199001011234, 地址: 上海市
430+
//
431+
// 示例 3 - 带标签格式:
432+
// {
433+
// "name": "王五",
434+
// "mobile": "13900139000",
435+
// "idn": "",
436+
// "postcode": "",
437+
// "province": "",
438+
// "city": "",
439+
// "region": "",
440+
// "street": "",
441+
// "addr": "天津市河西区友谊路20号"
442+
// }
443+
}
444+
```

‎docs/en/api/packages/formatter.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ formatter contains some functions for data formatting.
88

99
- [https://github.com/duke-git/lancet/blob/main/formatter/formatter.go](https://github.com/duke-git/lancet/blob/main/formatter/formatter.go)
1010
- [https://github.com/duke-git/lancet/blob/main/formatter/byte.go](https://github.com/duke-git/lancet/blob/main/formatter/byte.go)
11+
- [https://github.com/duke-git/lancet/blob/main/formatter/address.go](https://github.com/duke-git/lancet/blob/main/formatter/address.go)
1112

1213
<div STYLE="page-break-after: always;"></div>
1314

@@ -30,6 +31,8 @@ import (
3031
- [BinaryBytes](#BinaryBytes)
3132
- [ParseDecimalBytes](#ParseDecimalBytes)
3233
- [ParseBinaryBytes](#ParseBinaryBytes)
34+
- [ParseCNAddress](#ParseCNAddress)
35+
- [ParsePersonInfo](#ParsePersonInfo)
3336

3437
<div STYLE="page-break-after: always;"></div>
3538

@@ -308,3 +311,134 @@ func main() {
308311
// 12492
309312
}
310313
```
314+
315+
### <span id="ParseCNAddress">ParseCNAddress</span>
316+
317+
<p>Parses a Chinese address string intelligently and extracts structured information. It can parse addresses with or without user information (name, phone, ID card, etc.). When withUser is true, it extracts user information from the address string. When withUser is false, it only parses the location information. Supports various address formats: standard format, compact format, labeled format, county-level cities format, etc.</p>
318+
319+
<b>Signature:</b>
320+
321+
```go
322+
func ParseCNAddress(str string, withUser bool) *AddressInfo
323+
```
324+
325+
<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/o5l09hQopEV)</span></b>
326+
327+
```go
328+
package main
329+
330+
import (
331+
"encoding/json"
332+
"fmt"
333+
"github.com/duke-git/lancet/v2/formatter"
334+
)
335+
336+
func main() {
337+
// Parse complete address with user information
338+
result1 := formatter.ParseCNAddress("张三 13800138000 北京市朝阳区建国路1号", true)
339+
jsonData1, _ := json.MarshalIndent(result1, "", " ")
340+
fmt.Println("Example 1 - With user info:")
341+
fmt.Println(string(jsonData1))
342+
343+
// Parse address only, without extracting user information
344+
result2 := formatter.ParseCNAddress("北京市海淀区中关村大街1号", false)
345+
fmt.Printf("\nExample 2 - Address only:\n")
346+
fmt.Printf("Province: %s, City: %s, Region: %s, Street: %s\n",
347+
result2.Province, result2.City, result2.Region, result2.Street)
348+
349+
// Parse county-level city address
350+
result3 := formatter.ParseCNAddress("河北省石家庄市新乐市经济开发区兴工街10号", false)
351+
fmt.Printf("\nExample 3 - County-level city:\n")
352+
fmt.Printf("Province: %s, City: %s, Region: %s, Street: %s\n",
353+
result3.Province, result3.City, result3.Region, result3.Street)
354+
355+
// Compact format
356+
result4 := formatter.ParseCNAddress("马云13593464918陕西省西安市雁塔区丈八沟街道", true)
357+
fmt.Printf("\nExample 4 - Compact format:\n")
358+
fmt.Printf("Name: %s, Phone: %s, Address: %s%s%s%s\n",
359+
result4.Name, result4.Mobile, result4.Province, result4.City, result4.Region, result4.Street)
360+
361+
// Output:
362+
// Example 1 - With user info:
363+
// {
364+
// "name": "张三",
365+
// "mobile": "13800138000",
366+
// "idn": "",
367+
// "postcode": "",
368+
// "province": "北京",
369+
// "city": "北京市",
370+
// "region": "朝阳区",
371+
// "street": "建国路1号",
372+
// "addr": "北京市朝阳区建国路1号"
373+
// }
374+
//
375+
// Example 2 - Address only:
376+
// Province: 北京, City: 北京市, Region: 海淀区, Street: 中关村大街1号
377+
//
378+
// Example 3 - County-level city:
379+
// Province: 河北省, City: 石家庄市, Region: 新乐市, Street: 经济开发区兴工街10号
380+
//
381+
// Example 4 - Compact format:
382+
// Name: 马云, Phone: 13593464918, Address: 陕西省西安市雁塔区丈八沟街道
383+
}
384+
```
385+
386+
### <span id="ParsePersonInfo">ParsePersonInfo</span>
387+
388+
<p>Extracts user information (name, phone, ID card, postal code) from an address string. It separates personal information from the address, supporting labeled format, compact format, and formats with separators. Returns an AddressInfo with extracted user information and cleaned address string.</p>
389+
390+
<b>Signature:</b>
391+
392+
```go
393+
func ParsePersonInfo(str string) *AddressInfo
394+
```
395+
396+
<b>Example:<span style="float:right;display:inline-block;">[Run](https://go.dev/play/p/JO-uTlJlTy7)</span></b>
397+
398+
```go
399+
package main
400+
401+
import (
402+
"encoding/json"
403+
"fmt"
404+
"github.com/duke-git/lancet/v2/formatter"
405+
)
406+
407+
func main() {
408+
// Extract name and phone
409+
result1 := formatter.ParsePersonInfo("张三 13800138000 北京市朝阳区")
410+
fmt.Println("Example 1 - Name and phone:")
411+
fmt.Printf("Name: %s, Phone: %s, Address: %s\n", result1.Name, result1.Mobile, result1.Addr)
412+
413+
// Extract ID card number
414+
result2 := formatter.ParsePersonInfo("李四 110101199001011234 上海市")
415+
fmt.Println("\nExample 2 - ID card number:")
416+
fmt.Printf("Name: %s, ID Card: %s, Address: %s\n", result2.Name, result2.IDN, result2.Addr)
417+
418+
// Labeled format
419+
result3 := formatter.ParsePersonInfo("收货人：王五 电话：13900139000 收货地址：天津市河西区友谊路20号")
420+
jsonData3, _ := json.MarshalIndent(result3, "", " ")
421+
fmt.Println("\nExample 3 - Labeled format:")
422+
fmt.Println(string(jsonData3))
423+
424+
// Output:
425+
// Example 1 - Name and phone:
426+
// Name: 张三, Phone: 13800138000, Address: 北京市朝阳区
427+
//
428+
// Example 2 - ID card number:
429+
// Name: 李四, ID Card: 110101199001011234, Address: 上海市
430+
//
431+
// Example 3 - Labeled format:
432+
// {
433+
// "name": "王五",
434+
// "mobile": "13900139000",
435+
// "idn": "",
436+
// "postcode": "",
437+
// "province": "",
438+
// "city": "",
439+
// "region": "",
440+
// "street": "",
441+
// "addr": "天津市河西区友谊路20号"
442+
// }
443+
}
444+
```

0 commit comments

Comments
 (0)