id-validator/README.md

121 lines
4.7 KiB
Markdown
Raw Normal View History

2021-01-08 17:28:15 +08:00
# id-validator
2021-01-12 16:09:37 +08:00
> 中国身份证号验证、获取身份证号信息、升级 15 位身份证号为 18 位、伪造符合校验的身份证号。
2021-01-08 17:28:15 +08:00
![Tests](https://github.com/guanguans/id-validator/workflows/Tests/badge.svg)
2021-01-12 16:09:37 +08:00
[![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/release/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)
2021-01-08 17:28:15 +08:00
## Requirement
2021-01-12 14:18:17 +08:00
* Go >= 1.11
2021-01-08 17:28:15 +08:00
## Installation
``` shell script
2021-01-12 14:18:17 +08:00
$ go get -u github.com/guanguans/id-validator
2021-01-08 17:28:15 +08:00
```
## Usage
2021-01-12 16:09:37 +08:00
This is just a quick introduction, view the [GoDoc](https://godoc.org/github.com/guanguans/id-validator) for details.
Let's start with a trivial example:
2021-01-12 14:18:17 +08:00
``` go
package main
import (
"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> // 错误信息
// ]
}
```
2021-01-08 17:28:15 +08:00
## Testing
``` bash
2021-01-12 15:02:21 +08:00
$ go test
2021-01-08 17:28:15 +08:00
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
* [guanguans](https://github.com/guanguans)
* [All Contributors](../../contributors)
2021-01-12 14:18:17 +08:00
## 相关项目
* [PHP 版本](https://github.com/jxlwqq/id-validator)
* [Python 版本](https://github.com/jxlwqq/id-validator.py)
* [Ruby 版本](https://github.com/renyijiu/id_validator)
* [JavaScript 版本](https://github.com/mc-zone/IDValidator)
## 参考资料
* [中华人民共和国公民身份号码](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/港澳台居民居住证)
2021-01-08 17:28:15 +08:00
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.