MaskingUtil (hutool-core 6.0.0-M13 API)

java.lang.Object
- org.dromara.hutool.core.data.MaskingUtil

```
public class MaskingUtil
extends Object
```
数据脱敏（Data Masking）工具类，对某些敏感信息（比如，身份证号、手机号、卡号、姓名、地址、邮箱等）屏蔽敏感数据。
原名称：DesensitizedUtil

支持以下类型信息的脱敏自动处理：
- 用户ID
- 中文名
- 身份证
- 座机号
- 手机号
- 地址
- 电子邮件
- 密码
- 车牌
- 银行卡号
- IPv4
- IPv6
作者:

dazer and neusoft and qiaomu

从以下版本开始:

5.6.2

嵌套类概要

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

static class MaskingUtil.MaskingType
支持的脱敏类型枚举

嵌套类
限定符和类型	类和说明
`static class`	`MaskingUtil.MaskingType` 支持的脱敏类型枚举

构造器概要

构造器
构造器和说明

MaskingUtil()

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

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static String`	`address(String address, int sensitiveSize)` 【地址】只显示到地区，不显示详细地址，比如：北京市海淀区****
`static String`	`bankCard(String bankCardNo)` 银行卡号脱敏 eg: 1101 ** ** 3256
`static String`	`carLicense(String carLicense)` 【中国车牌】车牌中间用代替 eg1：null -》 "" eg1："" -》 "" eg3：苏D40000 -》苏D40 eg4：陕A12345D -》陕A1**D eg5：京A123 -》京A123 如果是错误的车牌，不处理
`static String`	`chineseName(String fullName)` 【中文姓名】只显示第一个汉字，其他隐藏为2个星号，比如：李**
`static String`	`clear()` 清空为空字符串
`static String`	`clearToNull()` 清空为`null`
`static String`	`email(String email)` 【电子邮箱】邮箱前缀仅显示第一个字母，前缀其他隐藏，用星号代替，@及后面的地址显示，比如：d**@126.com
`static String`	`firstMask(String str)` 定义了一个first_mask的规则，只显示第一个字符。
`static String`	`fixedPhone(String num)` 【固定电话前四位，后两位
`static String`	`idCardNum(String idCardNum, int front, int end)` 【身份证号】前1位和后2位
`static String`	`ipv4(String ipv4)` IPv4脱敏，如：脱敏前：192.0.2.1；脱敏后：192...*。
`static String`	`ipv6(String ipv6)` IPv6脱敏，如：脱敏前：2001:0db8:86a3:08d3:1319:8a2e:0370:7344；脱敏后：2001:::::::*
`static String`	`masking(CharSequence str, MaskingUtil.MaskingType maskingType)` 脱敏，使用默认的脱敏策略 MaskingUtil.masking("100", MaskingUtil.DesensitizedType.USER_ID)) = "0" MaskingUtil.masking("段正淳", MaskingUtil.DesensitizedType.CHINESE_NAME)) = "段" MaskingUtil.masking("51343620000320711X", MaskingUtil.DesensitizedType.ID_CARD)) = "5***********1X" MaskingUtil.masking("09157518479", MaskingUtil.DesensitizedType.FIXED_PHONE)) = "0915*79" MaskingUtil.masking("18049531999", MaskingUtil.DesensitizedType.MOBILE_PHONE)) = "1801999" MaskingUtil.masking("北京市海淀区马连洼街道289号", MaskingUtil.DesensitizedType.ADDRESS)) = "北京市海淀区马****" MaskingUtil.masking("duandazhi-jack@gmail.com.cn", MaskingUtil.DesensitizedType.EMAIL)) = "d*********@gmail.com.cn" MaskingUtil.masking("1234567890", MaskingUtil.DesensitizedType.PASSWORD)) = "******" MaskingUtil.masking("苏D40000", MaskingUtil.DesensitizedType.CAR_LICENSE)) = "苏D40" MaskingUtil.masking("11011111222233333256", MaskingUtil.DesensitizedType.BANK_CARD)) = "1101 * ** 3256" MaskingUtil.masking("192.168.1.1", MaskingUtil.DesensitizedType.IPV4)) = "192...*"
`static String`	`mobilePhone(String num)` 【手机号码】前三位，后4位，其他隐藏，比如135****2210
`static String`	`password(String password)` 【密码】密码的全部字符都用代替，比如：*****
`static Long`	`userId()` 【用户id】不对外提供userId

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

- 构造器详细资料
  - MaskingUtil
```
public MaskingUtil()
```
- 方法详细资料
  - masking
```
public static String masking(CharSequence str,
                             MaskingUtil.MaskingType maskingType)
```
    脱敏，使用默认的脱敏策略
```
 MaskingUtil.masking("100", MaskingUtil.DesensitizedType.USER_ID)) =  "0"
 MaskingUtil.masking("段正淳", MaskingUtil.DesensitizedType.CHINESE_NAME)) = "段**"
 MaskingUtil.masking("51343620000320711X", MaskingUtil.DesensitizedType.ID_CARD)) = "5***************1X"
 MaskingUtil.masking("09157518479", MaskingUtil.DesensitizedType.FIXED_PHONE)) = "0915*****79"
 MaskingUtil.masking("18049531999", MaskingUtil.DesensitizedType.MOBILE_PHONE)) = "180****1999"
 MaskingUtil.masking("北京市海淀区马连洼街道289号", MaskingUtil.DesensitizedType.ADDRESS)) = "北京市海淀区马********"
 MaskingUtil.masking("duandazhi-jack@gmail.com.cn", MaskingUtil.DesensitizedType.EMAIL)) = "d*************@gmail.com.cn"
 MaskingUtil.masking("1234567890", MaskingUtil.DesensitizedType.PASSWORD)) = "**********"
 MaskingUtil.masking("苏D40000", MaskingUtil.DesensitizedType.CAR_LICENSE)) = "苏D4***0"
 MaskingUtil.masking("11011111222233333256", MaskingUtil.DesensitizedType.BANK_CARD)) = "1101 **** **** **** 3256"
 MaskingUtil.masking("192.168.1.1", MaskingUtil.DesensitizedType.IPV4)) = "192.*.*.*"
 
```
    参数:
    
    str - 字符串
    
    maskingType - 脱敏类型;可以脱敏：用户id、中文名、身份证号、座机号、手机号、地址、电子邮件、密码
    
    返回:
    
    脱敏之后的字符串
    
    从以下版本开始:
    
    5.6.2
  - clear
```
public static String clear()
```
    清空为空字符串
    
    返回:
    
    清空后的值
    
    从以下版本开始:
    
    5.8.22
  - clearToNull
```
public static String clearToNull()
```
    清空为null
    
    返回:
    
    清空后的值(null)
    
    从以下版本开始:
    
    5.8.22
  - userId
```
public static Long userId()
```
    【用户id】不对外提供userId
    
    返回:
    
    脱敏后的主键
  - firstMask
```
public static String firstMask(String str)
```
    定义了一个first_mask的规则，只显示第一个字符。
    脱敏前：123456789；脱敏后：1********。
    
    参数:
    
    str - 字符串
    
    返回:
    
    脱敏后的字符串
  - chineseName
```
public static String chineseName(String fullName)
```
    【中文姓名】只显示第一个汉字，其他隐藏为2个星号，比如：李**
    
    参数:
    
    fullName - 姓名
    
    返回:
    
    脱敏后的姓名
  - idCardNum
```
public static String idCardNum(String idCardNum,
                               int front,
                               int end)
```
    【身份证号】前1位和后2位
    
    参数:
    
    idCardNum - 身份证
    
    front - 保留：前面的front位数；从1开始
    
    end - 保留：后面的end位数；从1开始
    
    返回:
    
    脱敏后的身份证
  - fixedPhone
```
public static String fixedPhone(String num)
```
    【固定电话前四位，后两位
    
    参数:
    
    num - 固定电话
    
    返回:
    
    脱敏后的固定电话；
  - mobilePhone
```
public static String mobilePhone(String num)
```
    【手机号码】前三位，后4位，其他隐藏，比如135****2210
    
    参数:
    
    num - 移动电话；
    
    返回:
    
    脱敏后的移动电话；
  - address
```
public static String address(String address,
                             int sensitiveSize)
```
    【地址】只显示到地区，不显示详细地址，比如：北京市海淀区****
    
    参数:
    
    address - 家庭住址
    
    sensitiveSize - 敏感信息长度
    
    返回:
    
    脱敏后的家庭地址
  - email
```
public static String email(String email)
```
    【电子邮箱】邮箱前缀仅显示第一个字母，前缀其他隐藏，用星号代替，@及后面的地址显示，比如：d**@126.com
    
    参数:
    
    email - 邮箱
    
    返回:
    
    脱敏后的邮箱
  - password
```
public static String password(String password)
```
    【密码】密码的全部字符都用*代替，比如：******
    
    参数:
    
    password - 密码
    
    返回:
    
    脱敏后的密码
  - carLicense
```
public static String carLicense(String carLicense)
```
    【中国车牌】车牌中间用*代替 eg1：null -》 "" eg1："" -》 "" eg3：苏D40000 -》苏D4***0 eg4：陕A12345D -》陕A1****D eg5：京A123 -》京A123 如果是错误的车牌，不处理
    
    参数:
    
    carLicense - 完整的车牌号
    
    返回:
    
    脱敏后的车牌
  - bankCard
```
public static String bankCard(String bankCardNo)
```
    银行卡号脱敏 eg: 1101 **** **** **** 3256
    
    参数:
    
    bankCardNo - 银行卡号
    
    返回:
    
    脱敏之后的银行卡号
    
    从以下版本开始:
    
    5.6.3
  - ipv4
```
public static String ipv4(String ipv4)
```
    IPv4脱敏，如：脱敏前：192.0.2.1；脱敏后：192.*.*.*。
    
    参数:
    
    ipv4 - IPv4地址
    
    返回:
    
    脱敏后的地址
  - ipv6
```
public static String ipv6(String ipv6)
```
    IPv6脱敏，如：脱敏前：2001:0db8:86a3:08d3:1319:8a2e:0370:7344；脱敏后：2001:*:*:*:*:*:*:*
    
    参数:
    
    ipv6 - IPv6地址
    
    返回:
    
    脱敏后的地址

类 MaskingUtil

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

MaskingUtil

方法详细资料

masking

clear

clearToNull

userId

firstMask

chineseName

idCardNum

fixedPhone

mobilePhone

address

email

password

carLicense

bankCard

ipv4

ipv6