|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126 |
- # id-validator
-
- [简体中文](README.md) | [ENGLISH](README-EN.md)
-
- > 中国身份证号验证。
-
- [![Tests](https://github.com/guanguans/id-validator/workflows/Tests/badge.svg)](https://github.com/guanguans/id-validator/actions)
- [![gocover.io](https://gocover.io/_badge/github.com/guanguans/id-validator)](https://gocover.io/github.com/guanguans/id-validator)
- [![Go Report Card](https://goreportcard.com/badge/github.com/guanguans/id-validator)](https://goreportcard.com/report/github.com/guanguans/id-validator)
- [![GoDoc](https://godoc.org/github.com/guanguans/id-validator?status.svg)](https://godoc.org/github.com/guanguans/id-validator)
- [![GitHub release](https://img.shields.io/github/tag/guanguans/id-validator.svg)](https://github.com/guanguans/id-validator/releases)
- [![GitHub license](https://img.shields.io/github/license/guanguans/id-validator.svg)](https://github.com/guanguans/id-validator/blob/master/LICENSE)
-
- ## 功能
-
- * 中国身份证号验证
- * 获取身份证号信息
- * 升级 15 位身份证号为 18 位
- * 伪造符合校验的身份证号
-
- ## 环境要求
-
- * Go >= 1.11
-
- ## 安装
-
- ``` shell script
- $ go get -u github.com/guanguans/id-validator
- ```
-
- ## 使用
-
- 这只是一个快速介绍, 请查看 [GoDoc](https://godoc.org/github.com/guanguans/id-validator) 获得详细信息。
-
- ``` go
- package main
-
- import (
- idvalidator "github.com/guanguans/id-validator"
- "gopkg.in/ffmt.v1"
- )
-
- func main() {
-
- // 验证身份证号合法性
- ffmt.P(idvalidator.IsValid("440308199901101512")) // 大陆居民身份证18位
- ffmt.P(idvalidator.IsValid("610104620927690")) // 大陆居民身份证15位
- ffmt.P(idvalidator.IsValid("810000199408230021")) // 港澳居民居住证18位
- ffmt.P(idvalidator.IsValid("830000199201300022")) // 台湾居民居住证18位
-
- // 获取身份证号信息
- ffmt.P(idvalidator.GetInfo("440308199901101512"))
- // []interface {}[
- // github.com/guanguans/id-validator.IdInfo{ // 身份证号信息
- // AddressCode: int(440308) // 地址码
- // Abandoned: int(0) // 地址码是否废弃:1为废弃的,0为正在使用的
- // Address: string("广东省深圳市盐田区") // 地址
- // AddressTree: []string[ // 省市区三级列表
- // string("广东省") // 省
- // string("深圳市") // 市
- // string("盐田区") // 区
- // ]
- // Birthday: <1999-01-10 00:00:00 +0000 UTC> // 出生日期
- // Constellation: string("摩羯座") // 星座
- // ChineseZodiac: string("卯兔") // 生肖
- // Sex: int(1) // 性别:1为男性,0为女性
- // Length: int(18) // 号码长度
- // CheckBit: string("2") // 校验码
- // }
- // <nil> // 错误信息
- // ]
-
- // 生成可通过校验的假身份证号
- ffmt.P(idvalidator.FakeId()) // 随机生成
- ffmt.P(idvalidator.FakeRequireId(true, "江苏省", "200001", 1)) // 生成出生于2000年1月江苏省的男性居民身份证
-
- // 15位号码升级为18位
- ffmt.P(idvalidator.UpgradeId("610104620927690"))
- // []interface {}[
- // string("610104196209276908") // 升级后号码
- // <nil> // 错误信息
- // ]
- }
- ```
-
- ## 测试
-
- ``` bash
- $ make test
- ```
-
- ## 变更日志
-
- 请参阅 [CHANGELOG](CHANGELOG.md) 获取最近有关更改的更多信息。
-
- ## 贡献指南
-
- 请参阅 [CONTRIBUTING](.github/CONTRIBUTING.md) 有关详细信息。
-
- ## 安全漏洞
-
- 请查看[我们的安全政策](../../security/policy)了解如何报告安全漏洞。
-
- ## 贡献者
-
- * [guanguans](https://github.com/guanguans)
- * [所有贡献者](../../contributors)
-
- ## 相关项目
-
- * [jxlwqq/id-validator](https://github.com/jxlwqq/id-validator),jxlwqq
- * [jxlwqq/id-validator.py](https://github.com/jxlwqq/id-validator.py),jxlwqq
- * [mc-zone/IDValidator](https://github.com/mc-zone/IDValidator),mc-zone
- * [renyijiu/id_validator](https://github.com/renyijiu/id_validator),renyijiu
-
- ## 参考资料
-
- * [中华人民共和国公民身份号码](https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码)
- * [中华人民共和国民政部:行政区划代码](http://www.mca.gov.cn/article/sj/xzqh/)
- * [中华人民共和国行政区划代码历史数据集](https://github.com/jxlwqq/address-code-of-china)
- * [国务院办公厅关于印发《港澳台居民居住证申领发放办法》的通知](http://www.gov.cn/zhengce/content/2018-08/19/content_5314865.htm)
- * [港澳台居民居住证](https://zh.wikipedia.org/wiki/港澳台居民居住证)
-
- ## 协议
-
- MIT 许可证(MIT)。有关更多信息,请参见[协议文件](LICENSE)。
|