# NamePinyinChecker

**Repository Path**: LanceChen/NamePinyinChecker

## Basic Information

- **Project Name**: NamePinyinChecker
- **Description**: 利用java的pinyin库进行汉语姓名检查的工具类。
拼写规则遵循根据《中国人名汉语拼音字母拼写规则》（国家标准编号：GB/T 28039-2011）和国家移民管理局《关于内地居民拼音姓名中字母“Ü”在出入境证件中打印规则的公告》（2021年9月29日）。
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-08-19
- **Last Updated**: 2024-08-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NamePinyinChecker

#### 介绍

利用java的pinyin库（https://github.com/houbb/pinyin ）进行汉语姓名检查的工具类。

拼写规则遵循根据《中国人名汉语拼音字母拼写规则》（国家标准编号：GB/T 28039-2011）和国家移民管理局《关于内地居民拼音姓名中字母“Ü”在出入境证件中打印规则的公告》（2021年9月29日）。

#### 使用

调用cn.edu.tsinghua.card.NamePinyinChecker#check方法，两个参数分别为汉字姓名和对应的拼音字母拼写（英文姓名），返回错误代码及对应的消息。

汉字姓名的格式要求为：连续汉字字符（可以以点“·”分隔）；拼音拼写的要求为：仅含英文字母、以单空格分隔且仅首字母大写。

| 错误代码 | 错误代码值 | 含义 |
|---|---|---|
| NORMAL | 0 | 比对正确 |
| INVALID_CHINESE_NAME | 1 | 汉字姓名格式不正确 |
| INVALID_ENGLISH_NAME | 2 | 拼音拼写格式不正确 |
| UNMATCHED_PINYIN | 3 | 汉字姓名和拼音拼写不匹配 |