DesensitizedUtil (hutool 5.8.33 API)

java.lang.Object
- cn.hutool.core.util.DesensitizedUtil

```
public class DesensitizedUtil
extends Object
```
脱敏工具类，支持以下类型信息的脱敏自动处理：
- 用户ID
- 中文名
- 身份证
- 座机号
- 手机号
- 地址
- 电子邮件
- 密码
- 车牌
- 银行卡号
Since:

5.6.2

Author:

dazer and neusoft and qiaomu

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DesensitizedUtil.DesensitizedType
支持的脱敏类型枚举

Nested Classes
Modifier and Type	Class and Description
`static class`	`DesensitizedUtil.DesensitizedType` 支持的脱敏类型枚举

Constructor Summary

Constructors
Constructor and Description

DesensitizedUtil()

Constructors
Constructor and Description
`DesensitizedUtil()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`address(String address, int sensitiveSize)` 【地址】只显示到地区，不显示详细地址，比如：北京市海淀区****
`static String`	`bankCard(String bankCardNo)` 【银行卡号脱敏】由于银行卡号长度不定，所以只展示前4位，后面的位数根据卡号决定展示1-4位例如： `1. "1234 2222 3333 4444 6789 9" -> "1234 ** 9" 2. "1234 2222 3333 4444 6789 91" -> "1234 91" 3. "1234 2222 3333 4444 678" -> "1234 678" 4. "1234 2222 3333 4444 6789" -> "1234 ** 6789"`
`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`	`desensitized(CharSequence str, DesensitizedUtil.DesensitizedType desensitizedType)` 脱敏，使用默认的脱敏策略 DesensitizedUtil.desensitized("100", DesensitizedUtil.DesensitizedType.USER_ID)) = "0" DesensitizedUtil.desensitized("段正淳", DesensitizedUtil.DesensitizedType.CHINESE_NAME)) = "段" DesensitizedUtil.desensitized("51343620000320711X", DesensitizedUtil.DesensitizedType.ID_CARD)) = "5***********1X" DesensitizedUtil.desensitized("09157518479", DesensitizedUtil.DesensitizedType.FIXED_PHONE)) = "0915*79" DesensitizedUtil.desensitized("18049531999", DesensitizedUtil.DesensitizedType.MOBILE_PHONE)) = "1801999" DesensitizedUtil.desensitized("北京市海淀区马连洼街道289号", DesensitizedUtil.DesensitizedType.ADDRESS)) = "北京市海淀区马****" DesensitizedUtil.desensitized("duandazhi-jack@gmail.com.cn", DesensitizedUtil.DesensitizedType.EMAIL)) = "d*********@gmail.com.cn" DesensitizedUtil.desensitized("1234567890", DesensitizedUtil.DesensitizedType.PASSWORD)) = "******" DesensitizedUtil.desensitized("苏D40000", DesensitizedUtil.DesensitizedType.CAR_LICENSE)) = "苏D40" DesensitizedUtil.desensitized("11011111222233333256", DesensitizedUtil.DesensitizedType.BANK_CARD)) = "1101 * ** 3256" DesensitizedUtil.desensitized("192.168.1.1", DesensitizedUtil.DesensitizedType.IPV4)) = "192...*"
`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`	`mobilePhone(String num)` 【手机号码】前三位，后4位，其他隐藏，比如135****2210
`static String`	`password(String password)` 【密码】密码的全部字符都用代替，比如：*****
`static Long`	`userId()` 【用户id】不对外提供userId

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- DesensitizedUtil
```
public DesensitizedUtil()
```

Method Detail

desensitized

public static String desensitized(CharSequence str,
                                  DesensitizedUtil.DesensitizedType desensitizedType)

脱敏，使用默认的脱敏策略

 DesensitizedUtil.desensitized("100", DesensitizedUtil.DesensitizedType.USER_ID)) =  "0"
 DesensitizedUtil.desensitized("段正淳", DesensitizedUtil.DesensitizedType.CHINESE_NAME)) = "段**"
 DesensitizedUtil.desensitized("51343620000320711X", DesensitizedUtil.DesensitizedType.ID_CARD)) = "5***************1X"
 DesensitizedUtil.desensitized("09157518479", DesensitizedUtil.DesensitizedType.FIXED_PHONE)) = "0915*****79"
 DesensitizedUtil.desensitized("18049531999", DesensitizedUtil.DesensitizedType.MOBILE_PHONE)) = "180****1999"
 DesensitizedUtil.desensitized("北京市海淀区马连洼街道289号", DesensitizedUtil.DesensitizedType.ADDRESS)) = "北京市海淀区马********"
 DesensitizedUtil.desensitized("duandazhi-jack@gmail.com.cn", DesensitizedUtil.DesensitizedType.EMAIL)) = "d*************@gmail.com.cn"
 DesensitizedUtil.desensitized("1234567890", DesensitizedUtil.DesensitizedType.PASSWORD)) = "**********"
 DesensitizedUtil.desensitized("苏D40000", DesensitizedUtil.DesensitizedType.CAR_LICENSE)) = "苏D4***0"
 DesensitizedUtil.desensitized("11011111222233333256", DesensitizedUtil.DesensitizedType.BANK_CARD)) = "1101 **** **** **** 3256"
 DesensitizedUtil.desensitized("192.168.1.1", DesensitizedUtil.DesensitizedType.IPV4)) = "192.*.*.*"

Parameters:: str - 字符串; desensitizedType - 脱敏类型;可以脱敏：用户id、中文名、身份证号、座机号、手机号、地址、电子邮件、密码
Returns:: 脱敏之后的字符串
Since:: 5.6.2

clear
```
public static String clear()
```
清空为空字符串

Returns:

清空后的值

Since:

5.8.22

clearToNull
```
public static String clearToNull()
```
清空为null

Returns:

清空后的值(null)

Since:

5.8.22

userId
```
public static Long userId()
```
【用户id】不对外提供userId

Returns:

脱敏后的主键

firstMask
```
public static String firstMask(String str)
```
定义了一个first_mask的规则，只显示第一个字符。
脱敏前：123456789；脱敏后：1********。

Parameters:

str - 字符串

Returns:

脱敏后的字符串

chineseName
```
public static String chineseName(String fullName)
```
【中文姓名】只显示第一个汉字，其他隐藏为2个星号，比如：李**

Parameters:

fullName - 姓名

Returns:

脱敏后的姓名

idCardNum
```
public static String idCardNum(String idCardNum,
                               int front,
                               int end)
```
【身份证号】前1位和后2位

Parameters:

idCardNum - 身份证

front - 保留：前面的front位数；从1开始

end - 保留：后面的end位数；从1开始

Returns:

脱敏后的身份证

fixedPhone
```
public static String fixedPhone(String num)
```
【固定电话前四位，后两位

Parameters:

num - 固定电话

Returns:

脱敏后的固定电话；

mobilePhone
```
public static String mobilePhone(String num)
```
【手机号码】前三位，后4位，其他隐藏，比如135****2210

Parameters:

num - 移动电话；

Returns:

脱敏后的移动电话；

address
```
public static String address(String address,
                             int sensitiveSize)
```
【地址】只显示到地区，不显示详细地址，比如：北京市海淀区****

Parameters:

address - 家庭住址

sensitiveSize - 敏感信息长度

Returns:

脱敏后的家庭地址

email
```
public static String email(String email)
```
【电子邮箱】邮箱前缀仅显示第一个字母，前缀其他隐藏，用星号代替，@及后面的地址显示，比如：d**@126.com

Parameters:

email - 邮箱

Returns:

脱敏后的邮箱

password
```
public static String password(String password)
```
【密码】密码的全部字符都用*代替，比如：******

Parameters:

password - 密码

Returns:

脱敏后的密码

carLicense
```
public static String carLicense(String carLicense)
```
【中国车牌】车牌中间用*代替 eg1：null -》 "" eg1："" -》 "" eg3：苏D40000 -》苏D4***0 eg4：陕A12345D -》陕A1****D eg5：京A123 -》京A123 如果是错误的车牌，不处理

Parameters:

carLicense - 完整的车牌号

Returns:

脱敏后的车牌

bankCard

public static String bankCard(String bankCardNo)

【银行卡号脱敏】由于银行卡号长度不定，所以只展示前4位，后面的位数根据卡号决定展示1-4位例如：


      1. "1234 2222 3333 4444 6789 9"    ->   "1234 **** **** **** **** 9"
      2. "1234 2222 3333 4444 6789 91"   ->   "1234 **** **** **** **** 91"
      3. "1234 2222 3333 4444 678"       ->    "1234 **** **** **** 678"
      4. "1234 2222 3333 4444 6789"      ->    "1234 **** **** **** 6789"

Parameters:: bankCardNo - 银行卡号
Returns:: 脱敏之后的银行卡号

ipv4
```
public static String ipv4(String ipv4)
```
IPv4脱敏，如：脱敏前：192.0.2.1；脱敏后：192.*.*.*。

Parameters:

ipv4 - IPv4地址

Returns:

脱敏后的地址

ipv6
```
public static String ipv6(String ipv6)
```
IPv6脱敏，如：脱敏前：2001:0db8:86a3:08d3:1319:8a2e:0370:7344；脱敏后：2001:*:*:*:*:*:*:*

Parameters:

ipv6 - IPv6地址

Returns:

脱敏后的地址

Class DesensitizedUtil

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DesensitizedUtil

Method Detail

desensitized

clear

clearToNull

userId

firstMask

chineseName

idCardNum

fixedPhone

mobilePhone

address

email

password

carLicense

bankCard

ipv4

ipv6