IDCardUtils (MustardTools 0.2.5 API)

java.lang.Object
- cn.buli_home.utils.common.IDCardUtils

```
public class IDCardUtils
extends Object
```

嵌套类概要

嵌套类
限定符和类型类和说明

static class IDCardUtils.IDCard
身份证信息，包括身份、城市代码、生日、性别等

嵌套类
限定符和类型	类和说明
`static class`	`IDCardUtils.IDCard` 身份证信息，包括身份、城市代码、生日、性别等

字段概要

字段
限定符和类型	字段和说明
`private static int`	`CHINA_ID_MAX_LENGTH` 中国公民身份证号码最大长度。
`private static int`	`CHINA_ID_MIN_LENGTH` 中国公民身份证号码最小长度。
`private static Map<String,String>`	`CITY_CODES` 省市代码表
`private static int[]`	`POWER` 每位加权因子
`private static Map<Character,Integer>`	`TW_FIRST_CODE` 台湾身份首字母对应数字

构造器概要

构造器
构造器和说明

IDCardUtils()

构造器
构造器和说明
`IDCardUtils()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static String`	`convert15To18(String idCard)` 将15位身份证号码转换为18位
`static String`	`convert18To15(String idCard)` 将18位身份证号码转换为15位
`static int`	`getAgeByIdCard(String idCard)` 根据身份编号获取年龄，只支持15或18位身份证号码
`static int`	`getAgeByIdCard(String idCard, Date dateToCompare)` 根据身份编号获取指定日期当时的年龄年龄，只支持15或18位身份证号码
`static String`	`getBirth(String idCard)` 根据身份编号获取生日，只支持15或18位身份证号码
`static String`	`getBirthByIdCard(String idCard)` 根据身份编号获取生日，只支持15或18位身份证号码
`static Date`	`getBirthDate(String idCard)` 从身份证号码中获取生日日期，只支持15或18位身份证号码
`static DateUtils.DateNode`	`getBirthDateNode(String idCard)` 从身份证号码中获取生日日期，只支持15或18位身份证号码
`static String`	`getCityCodeByIdCard(String idCard)` 根据身份编号获取地市级编码，只支持15或18位身份证号码获取编码为4位
`static Short`	`getDayByIdCard(String idCard)` 根据身份编号获取生日天，只支持15或18位身份证号码
`static String`	`getDistrictCodeByIdCard(String idCard)` 根据身份编号获取区县级编码，只支持15或18位身份证号码获取编码为6位
`static int`	`getGenderByIdCard(String idCard)` 根据身份编号获取性别，只支持15或18位身份证号码
`static IDCardUtils.IDCard`	`getIDCardInfo(String idCard)` 获取身份证信息，包括身份、城市代码、生日、性别等
`static Short`	`getMonthByIdCard(String idCard)` 根据身份编号获取生日月，只支持15或18位身份证号码
`static String`	`getProvinceByIdCard(String idCard)` 根据身份编号获取户籍省份，只支持15或18位身份证号码
`static String`	`getProvinceCodeByIdCard(String idCard)` 根据身份编号获取户籍省份编码，只支持15或18位身份证号码
`static Short`	`getYearByIdCard(String idCard)` 根据身份编号获取生日年，只支持15或18位身份证号码
`static String`	`hide(String idCard, int startInclude, int endExclude)` 隐藏指定位置的几个身份证号数字为“*”
`static boolean`	`isValidCard(String idCard)` 是否有效身份证号，忽略X的大小写如果身份证号码中含有空格始终返回`false`
`static String[]`	`isValidCard10(String idCard)` 验证10位身份编码是否合法
`static boolean`	`isValidCard15(String idCard)` 验证15位身份编码是否合法
`static boolean`	`isValidCard18(String idCard)` 判断18位身份证的合法性根据〖中华人民共和国国家标准GB11643-1999〗中有关公民身份号码的规定，公民身份号码是特征组合码，由十七位数字本体码和一位数字校验码组成。
`static boolean`	`isValidCard18(String idCard, boolean ignoreCase)` 判断18位身份证的合法性根据〖中华人民共和国国家标准GB11643-1999〗中有关公民身份号码的规定，公民身份号码是特征组合码，由十七位数字本体码和一位数字校验码组成。
`static boolean`	`isValidHKCard(String idCard)` 验证香港身份证号码(存在Bug，部份特殊身份证无法检查) 身份证前2位为英文字符，如果只出现一个英文字符则表示第一位是空格，对应数字58 前2位英文字符A-Z分别对应数字10-35 最后一位校验码为0-9的数字加上字符"A"，"A"代表10 将身份证号码全部转换为数字，分别对应乘9-1相加的总和，整除11则证件号码有效
`static boolean`	`isValidTWCard(String idCard)` 验证台湾身份证号码
`private static char`	`p_getCheckCode18(int iSum)` 将power和值与11取模获得余数进行校验码判断
`private static char`	`p_getCheckCode18(String code17)` 获得18位身份证校验码
`private static int`	`p_getPowerSum(char[] iArr)` 将身份证的每位和对应位的加权因子相乘之后，再得到和值

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - CHINA_ID_MIN_LENGTH
```
private static final int CHINA_ID_MIN_LENGTH
```
    中国公民身份证号码最小长度。
    
    另请参阅:
    
    常量字段值
  - CHINA_ID_MAX_LENGTH
```
private static final int CHINA_ID_MAX_LENGTH
```
    中国公民身份证号码最大长度。
    
    另请参阅:
    
    常量字段值
  - POWER
```
private static final int[] POWER
```
    每位加权因子
  - CITY_CODES
```
private static final Map<String,String> CITY_CODES
```
    省市代码表
  - TW_FIRST_CODE
```
private static final Map<Character,Integer> TW_FIRST_CODE
```
    台湾身份首字母对应数字
- 构造器详细资料
  - IDCardUtils
```
public IDCardUtils()
```
- 方法详细资料
  - convert15To18
```
public static String convert15To18(String idCard)
```
    将15位身份证号码转换为18位
    
    参数:
    
    idCard - 15位身份编码
    
    返回:
    
    18位身份编码
  - convert18To15
```
public static String convert18To15(String idCard)
```
    将18位身份证号码转换为15位
    
    参数:
    
    idCard - 18位身份编码
    
    返回:
    
    15位身份编码
  - isValidCard
```
public static boolean isValidCard(String idCard)
```
    是否有效身份证号，忽略X的大小写
    如果身份证号码中含有空格始终返回false
    
    参数:
    
    idCard - 身份证号，支持18位、15位和港澳台的10位
    
    返回:
    
    是否有效
  - isValidCard18
```
public static boolean isValidCard18(String idCard)
```
    判断18位身份证的合法性
    根据〖中华人民共和国国家标准GB11643-1999〗中有关公民身份号码的规定，公民身份号码是特征组合码，由十七位数字本体码和一位数字校验码组成。
    排列顺序从左至右依次为：六位数字地址码，八位数字出生日期码，三位数字顺序码和一位数字校验码。
    顺序码: 表示在同一地址码所标识的区域范围内，对同年、同月、同日出生的人编定的顺序号，顺序码的奇数分配给男性，偶数分配给女性。
    1. 第1、2位数字表示：所在省份的代码
    2. 第3、4位数字表示：所在城市的代码
    3. 第5、6位数字表示：所在区县的代码
    4. 第7~14位数字表示：出生年、月、日
    5. 第15、16位数字表示：所在地的派出所的代码
    6. 第17位数字表示性别：奇数表示男性，偶数表示女性
    7. 第18位数字是校检码，用来检验身份证的正确性。校检码可以是0~9的数字，有时也用x表示
    第十八位数字(校验码)的计算方法为：
    1. 将前面的身份证号码17位数分别乘以不同的系数。从第一位到第十七位的系数分别为：7 9 10 5 8 4 2 1 6 3 7 9 10 5 8 4 2
    2. 将这17位数字和系数相乘的结果相加
    3. 用加出来和除以11，看余数是多少
    4. 余数只可能有0 1 2 3 4 5 6 7 8 9 10这11个数字。其分别对应的最后一位身份证的号码为1 0 X 9 8 7 6 5 4 3 2
    5. 通过上面得知如果余数是2，就会在身份证的第18位数字上出现罗马数字的Ⅹ。如果余数是10，身份证的最后一位号码就是2
    1. 香港人在大陆的身份证，【810000】开头；同样可以直接获取到性别、出生日期
    2. 81000019980902013X: 文绎循男 1998-09-02
    3. 810000201011210153: 辛烨男 2010-11-21
    1. 澳门人在大陆的身份证，【820000】开头；同样可以直接获取到性别、出生日期
    2. 820000200009100032: 黄敬杰男 2000-09-10
    1. 台湾人在大陆的身份证，【830000】开头；同样可以直接获取到性别、出生日期
    2. 830000200209060065: 王宜妃女 2002-09-06
    3. 830000194609150010: 苏建文男 1946-09-14
    4. 83000019810715006X: 刁婉琇女 1981-07-15
    参数:
    
    idCard - 待验证的身份证
    
    返回:
    
    是否有效的18位身份证，忽略x的大小写
  - isValidCard18
```
public static boolean isValidCard18(String idCard,
                                    boolean ignoreCase)
```
    判断18位身份证的合法性
    根据〖中华人民共和国国家标准GB11643-1999〗中有关公民身份号码的规定，公民身份号码是特征组合码，由十七位数字本体码和一位数字校验码组成。
    排列顺序从左至右依次为：六位数字地址码，八位数字出生日期码，三位数字顺序码和一位数字校验码。
    顺序码: 表示在同一地址码所标识的区域范围内，对同年、同月、同日出生的人编定的顺序号，顺序码的奇数分配给男性，偶数分配给女性。
    1. 第1、2位数字表示：所在省份的代码
    2. 第3、4位数字表示：所在城市的代码
    3. 第5、6位数字表示：所在区县的代码
    4. 第7~14位数字表示：出生年、月、日
    5. 第15、16位数字表示：所在地的派出所的代码
    6. 第17位数字表示性别：奇数表示男性，偶数表示女性
    7. 第18位数字是校检码，用来检验身份证的正确性。校检码可以是0~9的数字，有时也用x表示
    第十八位数字(校验码)的计算方法为：
    1. 将前面的身份证号码17位数分别乘以不同的系数。从第一位到第十七位的系数分别为：7 9 10 5 8 4 2 1 6 3 7 9 10 5 8 4 2
    2. 将这17位数字和系数相乘的结果相加
    3. 用加出来和除以11，看余数是多少
    4. 余数只可能有0 1 2 3 4 5 6 7 8 9 10这11个数字。其分别对应的最后一位身份证的号码为1 0 X 9 8 7 6 5 4 3 2
    5. 通过上面得知如果余数是2，就会在身份证的第18位数字上出现罗马数字的Ⅹ。如果余数是10，身份证的最后一位号码就是2
    参数:
    
    idCard - 待验证的身份证
    
    ignoreCase - 是否忽略大小写。true则忽略X大小写，否则严格匹配大写。
    
    返回:
    
    是否有效的18位身份证
  - isValidCard15
```
public static boolean isValidCard15(String idCard)
```
    验证15位身份编码是否合法
    
    参数:
    
    idCard - 身份编码
    
    返回:
    
    是否合法
  - isValidCard10
```
public static String[] isValidCard10(String idCard)
```
    验证10位身份编码是否合法
    
    参数:
    
    idCard - 身份编码
    
    返回:
    
    身份证信息数组
    [0] - 台湾、澳门、香港 [1] - 性别(男M,女F,未知N) [2] - 是否合法(合法true,不合法false) 若不是身份证件号码则返回null
  - isValidTWCard
```
public static boolean isValidTWCard(String idCard)
```
    验证台湾身份证号码
    
    参数:
    
    idCard - 身份证号码
    
    返回:
    
    验证码是否符合
  - isValidHKCard
```
public static boolean isValidHKCard(String idCard)
```
    验证香港身份证号码(存在Bug，部份特殊身份证无法检查)
    身份证前2位为英文字符，如果只出现一个英文字符则表示第一位是空格，对应数字58 前2位英文字符A-Z分别对应数字10-35 最后一位校验码为0-9的数字加上字符"A"，"A"代表10
    
    将身份证号码全部转换为数字，分别对应乘9-1相加的总和，整除11则证件号码有效
    
    参数:
    
    idCard - 身份证号码
    
    返回:
    
    验证码是否符合
  - getBirthByIdCard
```
public static String getBirthByIdCard(String idCard)
```
    根据身份编号获取生日，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份编号
    
    返回:
    
    生日(yyyyMMdd)
    
    另请参阅:
    
    getBirth(String)
  - getBirth
```
public static String getBirth(String idCard)
```
    根据身份编号获取生日，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份编号
    
    返回:
    
    生日(yyyyMMdd)
  - getBirthDate
```
public static Date getBirthDate(String idCard)
```
    从身份证号码中获取生日日期，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份证号码
    
    返回:
    
    日期
  - getBirthDateNode
```
public static DateUtils.DateNode getBirthDateNode(String idCard)
```
    从身份证号码中获取生日日期，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份证号码
    
    返回:
    
    日期
  - getAgeByIdCard
```
public static int getAgeByIdCard(String idCard)
```
    根据身份编号获取年龄，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份编号
    
    返回:
    
    年龄
  - getAgeByIdCard
```
public static int getAgeByIdCard(String idCard,
                                 Date dateToCompare)
```
    根据身份编号获取指定日期当时的年龄年龄，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份编号
    
    dateToCompare - 以此日期为界，计算年龄。
    
    返回:
    
    年龄
  - getYearByIdCard
```
public static Short getYearByIdCard(String idCard)
```
    根据身份编号获取生日年，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份编号
    
    返回:
    
    生日(yyyy)
  - getMonthByIdCard
```
public static Short getMonthByIdCard(String idCard)
```
    根据身份编号获取生日月，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份编号
    
    返回:
    
    生日(MM)
  - getDayByIdCard
```
public static Short getDayByIdCard(String idCard)
```
    根据身份编号获取生日天，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份编号
    
    返回:
    
    生日(dd)
  - getGenderByIdCard
```
public static int getGenderByIdCard(String idCard)
```
    根据身份编号获取性别，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份编号
    
    返回:
    
    性别(0 : 女, 1 : 男, - 1 : 未知)
  - getProvinceCodeByIdCard
```
public static String getProvinceCodeByIdCard(String idCard)
```
    根据身份编号获取户籍省份编码，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份编码
    
    返回:
    
    省份编码
  - getProvinceByIdCard
```
public static String getProvinceByIdCard(String idCard)
```
    根据身份编号获取户籍省份，只支持15或18位身份证号码
    
    参数:
    
    idCard - 身份编码
    
    返回:
    
    省份名称。
  - getCityCodeByIdCard
```
public static String getCityCodeByIdCard(String idCard)
```
    根据身份编号获取地市级编码，只支持15或18位身份证号码
    获取编码为4位
    
    参数:
    
    idCard - 身份编码
    
    返回:
    
    地市级编码
  - getDistrictCodeByIdCard
```
public static String getDistrictCodeByIdCard(String idCard)
```
    根据身份编号获取区县级编码，只支持15或18位身份证号码
    获取编码为6位
    
    参数:
    
    idCard - 身份编码
    
    返回:
    
    地市级编码
  - hide
```
public static String hide(String idCard,
                          int startInclude,
                          int endExclude)
```
    隐藏指定位置的几个身份证号数字为“*”
    
    参数:
    
    idCard - 身份证号
    
    startInclude - 开始位置（包含）
    
    endExclude - 结束位置（不包含）
    
    返回:
    
    隐藏后的身份证号码
    
    另请参阅:
    
    StringUtils.hide(CharSequence, int, int)
  - getIDCardInfo
```
public static IDCardUtils.IDCard getIDCardInfo(String idCard)
```
    获取身份证信息，包括身份、城市代码、生日、性别等
    
    参数:
    
    idCard - 15或18位身份证
    
    返回:
    
    IDCardUtils.IDCard
  - p_getCheckCode18
```
private static char p_getCheckCode18(String code17)
```
    获得18位身份证校验码
    
    参数:
    
    code17 - 18位身份证号中的前17位
    
    返回:
    
    第18位
  - p_getCheckCode18
```
private static char p_getCheckCode18(int iSum)
```
    将power和值与11取模获得余数进行校验码判断
    
    参数:
    
    iSum - 加权和
    
    返回:
    
    校验位
  - p_getPowerSum
```
private static int p_getPowerSum(char[] iArr)
```
    将身份证的每位和对应位的加权因子相乘之后，再得到和值
    
    参数:
    
    iArr - 身份证号码的数组
    
    返回:
    
    身份证编码

类 IDCardUtils

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

CHINA_ID_MIN_LENGTH

CHINA_ID_MAX_LENGTH

POWER

CITY_CODES

TW_FIRST_CODE

构造器详细资料

IDCardUtils

方法详细资料

convert15To18

convert18To15

isValidCard

isValidCard18

isValidCard18

isValidCard15

isValidCard10

isValidTWCard

isValidHKCard

getBirthByIdCard

getBirth

getBirthDate

getBirthDateNode

getAgeByIdCard

getAgeByIdCard

getYearByIdCard

getMonthByIdCard

getDayByIdCard

getGenderByIdCard

getProvinceCodeByIdCard

getProvinceByIdCard

getCityCodeByIdCard

getDistrictCodeByIdCard

hide

getIDCardInfo

p_getCheckCode18

p_getCheckCode18

p_getPowerSum