SensitiveDataUtil (sofa-common-tools 1.0.17 API)

java.lang.Object
- com.alipay.sofa.common.security.SensitiveDataUtil

```
public class SensitiveDataUtil
extends Object
```
SensitiveDataUtil 示例：银行卡号： SensitiveDataUtil.bankCardNohide("612526198319131434") = "612526********1434"
身份证号： SensitiveDataUtil.idCardNohide("362397201201012384") = "3****************4"
邮箱： SensitiveDataUtil.emailHide("yaaachaa@163.com") = "yaa***@163.com" SensitiveDataUtil.emailHideSMS("yaaachaa@163.com") = "yaa*@163.com" SensitiveDataUtil.emailHideSMS("yaaachaa@netvigator.com") = "yaa*@netviga*"
电话号码（手机或固定电话）--网站以及客户端 SensitiveDataUtil.phoneOrTelNoHide("15087653459") = "150******59" SensitiveDataUtil.phoneOrTelNoHide("0796-1234567") = "0796-***4567" SensitiveDataUtil.phoneOrTelNoHide("01036852045") = "0103***2045" 手机号码通用隐藏规则（包括港澳台地区），隐藏中间四位--网站以及客户端 SensitiveDataUtil.cellphoneHide("13071835358") = 130******58 SensitiveDataUtil.cellphoneHide("3071835358") = 307****358 SensitiveDataUtil.cellphoneHide("071835358") = 071****58 SensitiveDataUtil.cellphoneHide("835358") = 8****8 适用于短信中 SensitiveDataUtil.cellphoneHideSMS("13071835358") = 130*58 SensitiveDataUtil.cellphoneHideSMS("3071835358") = 307*358 SensitiveDataUtil.cellphoneHideSMS("071835358") = 071*58 SensitiveDataUtil.cellphoneHideSMS("835358") = 8*8
支付宝登录名： SensitiveDataUtil.alipayLogonIdHide("15087653459") = "150******59" SensitiveDataUtil.alipayLogonIdHide("yaaachaa@163.com") = "yaa***@163.com"
非上述固定格式敏感信息的屏蔽方法： SensitiveDataUtil.defualtHide("ttt") = "t*t"
自定义屏蔽规则展示： SensitiveDataUtil.customizeHide("13568794561",3,4,4) = "135****4561"
对起始标签和结尾标签中间的内容按指定的敏感数据类型进行部分隐藏: SensitiveDataUtil.filterHide(final String sourceStr,final String tagBegin, final String tagEnd,final int sensitiveDataType ) sourceStr为：
```
  <Party id="part_2">
   <FullName>yimin.jiang</FullName>
   <GovtIDTC tc="802"></GovtIDTC>
   <GovtID>432926198110191188</GovtID>
   <GovtTermDate>2011-06-07</GovtTermDate>
  </Party>
  

 tagBegin: <GovtID>
 tagEnd: </GovtID>
 sensitiveInfoType: SensitiveDataUtil.IDCARDNO_DATA
 
```
方法返回值:
```
  <Party id="part_2">
   <FullName>yimin.jiang</FullName>
   <GovtIDTC tc="802"></GovtIDTC>
   <GovtID>432926********1188</GovtID>
   <GovtTermDate>2011-06-07</GovtTermDate>
  </Party>
 
```
从以下版本开始:

2017/08/11

作者:

yangguanchao

字段概要

字段
限定符和类型	字段和说明
`static int`	`BANKCARDNO_DATA` 银行卡号数据类型标识，可用于SensitiveDataUtil.filterHide方法的sensitiveDataType参数。
`static int`	`EMAIL_DATA` EMAIL数据类型标识，可用于SensitiveDataUtil.filterHide方法的sensitiveDataType参数。
`static int`	`IDCARDNO_DATA` 身份证号数据类型标识，可用于SensitiveDataUtil.filterHide方法的sensitiveDataType参数。
`static int`	`PHONENO_DATA` 电话号码数据类型标识，可用于SensitiveDataUtil.filterHide方法的sensitiveDataType参数。

构造器概要

构造器
构造器和说明

SensitiveDataUtil()
构造函数，默认开启屏蔽开关

SensitiveDataUtil(boolean hideFlag)
构造函数

构造器
构造器和说明
`SensitiveDataUtil()` 构造函数，默认开启屏蔽开关
`SensitiveDataUtil(boolean hideFlag)` 构造函数

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static String`	`alipayLogonIdHide(String logonId)` 对支付宝登陆帐号进行部分隐藏处理：如果是手机号，显示前3和后2位；如果是email，只显示用户名的前3位+*+@域名；如果都不是，隐藏中间四位。
`static String`	`alipayLogonIdHideSMS(String logonId)` 对支付宝登陆帐号进行部分隐藏处理，适用于短信。
`static String`	`bankCardNoHide(String bankCardNo)` 对银行卡号进行部分隐藏处理的简便方法，默认不做验证，由使用者自己保障。
`static String`	`bankCardNoHide(String bankCardNo, boolean doValidate)` 对银行卡号进行部分隐藏处理，如果银行卡位数大于等于16位只显示前6位和后4位，其他用*代替。
`static String`	`cellphoneHide(String cellphone)` 手机号码通用隐藏规则（包括港澳台地区），隐藏中间四位适用于网站以及客户端 SensitiveDataUtil.cellphoneHide("13071835358") = 130****58 SensitiveDataUtil.cellphoneHide("3071835358") = 30358 SensitiveDataUtil.cellphoneHide("071835358") = 0758 SensitiveDataUtil.cellphoneHide("835358") = 8**8
`static String`	`cellphoneHideSMS(String cellphone)` 手机号码通用隐藏规则（包括港澳台地区），适用于短信。
`static String`	`customizeHide(String sensitiveData, int frontCharNum, int tailCharNum, int hiddenCharNum)` 自定义屏蔽位数和屏蔽位置 SensitiveDataUtil.customizeHide("13568794561",3,4,4) = "135**4561" SensitiveDataUtil.customizeHide("13568794561",0,4,4) = "4561" SensitiveDataUtil.customizeHide("13568794561",3,0,4) = "135" SensitiveDataUtil.customizeHide("13568794561",3,0,8) = "135******"
`static String`	`defaultHide(String sensitiveData)` 敏感信息缺省隐藏方式处理：显示前1/3和后1/3，其他*号代替。
`static String`	`emailHide(String email)` 对Email进行部分隐藏处理的简便方法，默认不做验证，由使用者自己保障。
`static String`	`emailHide(String email, boolean doValidate)` 对Email进行部分隐藏处理，只显示用户名的前3位+***+@域名。
`static String`	`emailHideSMS(String email)` 对短信中的Email进行部分隐藏处理的简便方法，默认不做验证，由使用者自己保障。
`static String`	`emailHideSMS(String email, boolean doValidate)` 对短信中的Email进行部分隐藏处理，只显示用户名的前3位+*+@域名。
`static String`	`filterHide(String sourceStr, String tagBegin, String tagEnd, int sensitiveDataType)` 过滤字符串中的敏感信息：对起始标签`tagBegin`和结尾标签`tagEnd` 中间的内容按指定的敏感数据类型`sensitiveInfoType`进行部分隐藏。
`static String`	`idCardNoHide(String idCardNo)` 对大陆身份证号进行部分隐藏处理的简便方法，默认不做验证，由使用者自己保障。
`static String`	`idCardNoHide(String idCardNo, boolean doValidate)` 对大陆身份证号进行部分隐藏处理，只显示前1位和后1位，其他用*代替。
`static String`	`nameHide(String name)` 只适用于中文姓名
`static boolean`	`needHide()` hideFlag getter
`static String`	`phoneOrTelNoHide(String phoneOrTelNo)` 对电话号码（手机号或座机号码）进行部分隐藏处理的简便方法，默认不做验证，由使用者自己保障。
`static String`	`phoneOrTelNoHide(String phoneOrTelNo, boolean doValidate)` 对电话号码（手机号或座机号码）进行部分隐藏处理，手机号只显示前3位和后4位，固定电话号码只显示区号和后4位，其他用*代替。
`static void`	`setHideFlag(boolean hideFlag)` hideFlag setter
`static String`	`taobaoNickHide(String sensitiveData)` 显示首/尾各1位，中间加 SensitiveDataUtil.taobaoNickHide("中华") = 中华 SensitiveDataUtil.taobaoNickHide("中华人") = 中人 SensitiveDataUtil.taobaoNickHide("中华人民") = 中民 SensitiveDataUtil.taobaoNickHide("china") = c**a

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

- 字段详细资料
  - BANKCARDNO_DATA
```
public static final int BANKCARDNO_DATA
```
    银行卡号数据类型标识，可用于SensitiveDataUtil.filterHide方法的sensitiveDataType参数。
    
    另请参阅:
    
    常量字段值
  - IDCARDNO_DATA
```
public static final int IDCARDNO_DATA
```
    身份证号数据类型标识，可用于SensitiveDataUtil.filterHide方法的sensitiveDataType参数。
    
    另请参阅:
    
    常量字段值
  - PHONENO_DATA
```
public static final int PHONENO_DATA
```
    电话号码数据类型标识，可用于SensitiveDataUtil.filterHide方法的sensitiveDataType参数。
    
    另请参阅:
    
    常量字段值
  - EMAIL_DATA
```
public static final int EMAIL_DATA
```
    EMAIL数据类型标识，可用于SensitiveDataUtil.filterHide方法的sensitiveDataType参数。
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - SensitiveDataUtil
```
public SensitiveDataUtil(boolean hideFlag)
```
    构造函数
    
    参数:
    
    hideFlag - 是否需要进行屏蔽的开关；ture表示打开。
  - SensitiveDataUtil
```
public SensitiveDataUtil()
```
    构造函数，默认开启屏蔽开关
- 方法详细资料
  - alipayLogonIdHide
```
public static String alipayLogonIdHide(String logonId)
```
    对支付宝登陆帐号进行部分隐藏处理：如果是手机号，显示前3和后2位；如果是email，只显示用户名的前3位+*+@域名；如果都不是，隐藏中间四位。
    
    参数:
    
    logonId - 待部分隐藏处理的支付宝登陆帐号，可能是手机号或email。
    
    返回:
    
    如果hideFlag为true，返回按规范进行部分隐藏后的登录号。
  - alipayLogonIdHideSMS
```
public static String alipayLogonIdHideSMS(String logonId)
```
    对支付宝登陆帐号进行部分隐藏处理，适用于短信。
    
    参数:
    
    logonId - 待部分隐藏处理的支付宝登陆帐号，可能是手机号或email。
    
    返回:
    
    如果hideFlag为true，返回按规范进行部分隐藏后的登录号。
  - nameHide
```
public static String nameHide(String name)
```
    只适用于中文姓名
    
    参数:
    
    name - 姓名
    
    返回:
    
    如果hideFlag为true，返回按规范进行部分隐藏后的姓名
  - idCardNoHide
```
public static String idCardNoHide(String idCardNo,
                                  boolean doValidate)
```
    对大陆身份证号进行部分隐藏处理，只显示前1位和后1位，其他用*代替。
    如果doValidate为true且传入的数据不是合法的大陆身份证号，将按敏感信息缺省隐藏方式处理，显示前1/3和后1/3，其他用*代替。
    
    参数:
    
    idCardNo - 待部分隐藏处理的身份证号。
    
    doValidate - 是否做身份证号合法性校验。警告：做校验会进行正则匹配，性能上比不做校验的方法略有损耗。
    
    返回:
    
    如果hideFlag为true，返回符合《支付宝会员信息展示规范》的身份证号部分展示字符串；否则返回原数据。
  - idCardNoHide
```
public static String idCardNoHide(String idCardNo)
```
    对大陆身份证号进行部分隐藏处理的简便方法，默认不做验证，由使用者自己保障。
    
    参数:
    
    idCardNo - 待部分隐藏处理的身份证号。
    
    返回:
    
    如果hideFlag为true，返回符合《支付宝会员信息展示规范》的身份证号部分展示字符串；否则返回原数据。
  - bankCardNoHide
```
public static String bankCardNoHide(String bankCardNo,
                                    boolean doValidate)
```
    对银行卡号进行部分隐藏处理，如果银行卡位数大于等于16位只显示前6位和后4位，其他用*代替。
    如果银行卡位数小于16位，则使用缺省脱敏方式。
    如果doValidate为true且传入的数据不是合法的银行号，将按敏感信息缺省隐藏方式处理，显示前1/3和后1/3，其他用*代替。
    
    参数:
    
    bankCardNo - 待部分隐藏处理的银行卡号。
    
    doValidate - 是否做银行卡号合法性校验。警告：做校验会进行正则匹配，性能上比不做校验的方法略有损耗。
    
    返回:
    
    如果hideFlag为true，返回符合《支付宝会员信息展示规范》的银行卡号部分展示字符串；否则返回原数据。
  - bankCardNoHide
```
public static String bankCardNoHide(String bankCardNo)
```
    对银行卡号进行部分隐藏处理的简便方法，默认不做验证，由使用者自己保障。
    
    参数:
    
    bankCardNo - 待部分隐藏处理的银行卡号。
    
    返回:
    
    如果hideFlag为true，返回符合《支付宝会员信息展示规范》的银行卡号部分展示字符串；否则返回原数据。
  - phoneOrTelNoHide
```
public static String phoneOrTelNoHide(String phoneOrTelNo,
                                      boolean doValidate)
```
    对电话号码（手机号或座机号码）进行部分隐藏处理，手机号只显示前3位和后4位，固定电话号码只显示区号和后4位，其他用*代替。
    不支持带分机的电话号码，并限于大陆地区手机号
    如果doValidate为true且传入的数据不是合法的电话号码，将按敏感信息缺省隐藏方式处理，显示前1/3和后1/3，其他用*代替。
    
    参数:
    
    phoneOrTelNo - 待隐藏处理的电话号码
    
    doValidate - 是否做电话号码合法性校验。警告：做校验会进行正则匹配，性能上比不做校验的方法略有损耗。
    
    返回:
    
    如果hideFlag为true，返回《支付宝会员信息展示规范》中推荐的电话号码部分展示字符串；否则返回原数据。
  - phoneOrTelNoHide
```
public static String phoneOrTelNoHide(String phoneOrTelNo)
```
    对电话号码（手机号或座机号码）进行部分隐藏处理的简便方法，默认不做验证，由使用者自己保障。
    
    参数:
    
    phoneOrTelNo - 待隐藏处理的电话号码
    
    返回:
    
    如果hideFlag为true，返回《支付宝会员信息展示规范》中推荐的电话号码部分展示字符串；否则返回原数据。
  - cellphoneHide
```
public static String cellphoneHide(String cellphone)
```
    手机号码通用隐藏规则（包括港澳台地区），隐藏中间四位适用于网站以及客户端
    - SensitiveDataUtil.cellphoneHide("13071835358") = 130******58
    - SensitiveDataUtil.cellphoneHide("3071835358") = 30****358
    - SensitiveDataUtil.cellphoneHide("071835358") = 07****58
    - SensitiveDataUtil.cellphoneHide("835358") = 8****8
    参数:
    
    cellphone -
    
    返回:
    
    隐藏后的手机号码
  - cellphoneHideSMS
```
public static String cellphoneHideSMS(String cellphone)
```
    手机号码通用隐藏规则（包括港澳台地区），适用于短信。 SensitiveDataUtil.cellphoneHideSMS("13071835358") = 130*58 SensitiveDataUtil.cellphoneHideSMS("3071835358") = 307*358 SensitiveDataUtil.cellphoneHideSMS("071835358") = 071*58 SensitiveDataUtil.cellphoneHideSMS("835358") = 8*8
    
    参数:
    
    cellphone -
    
    返回:
    
    隐藏后的手机号码
  - emailHide
```
public static String emailHide(String email,
                               boolean doValidate)
```
    对Email进行部分隐藏处理，只显示用户名的前3位+***+@域名。如用户名不足3位，将显示用户名全部+***+@域名。
    如果doValidate为true且传入的数据不是email（不含‘@’）,将按敏感信息缺省隐藏方式处理，显示前1/3和后1/3。
    
    参数:
    
    email - 待处理的Email
    
    doValidate - 是否做Email合法性校验。警告：做校验会进行正则匹配，性能上比不做校验的方法略有损耗。
    
    返回:
    
    如果hideFlag为true，返回《支付宝会员信息展示规范》中推荐的Email部分展示字符串；否则返回原数据。
  - emailHide
```
public static String emailHide(String email)
```
    对Email进行部分隐藏处理的简便方法，默认不做验证，由使用者自己保障。
    
    参数:
    
    email - 待处理的Email
    
    返回:
    
    如果hideFlag为true，返回《支付宝会员信息展示规范》中推荐的Email部分展示字符串；否则返回原数据。
  - emailHideSMS
```
public static String emailHideSMS(String email,
                                  boolean doValidate)
```
    对短信中的Email进行部分隐藏处理，只显示用户名的前3位+*+@域名。如用户名不足3位，将显示用户名全部+*+@域名。
    如果doValidate为true且传入的数据不是email（不含‘@’）,将按敏感信息缺省隐藏方式处理，显示前1/3和后1/3。
    
    参数:
    
    email - 待处理的Email
    
    doValidate - 是否做Email合法性校验。警告：做校验会进行正则匹配，性能上比不做校验的方法略有损耗。
    
    返回:
    
    如果hideFlag为true，返回《支付宝会员信息展示规范》中推荐的Email部分展示字符串；否则返回原数据。
  - emailHideSMS
```
public static String emailHideSMS(String email)
```
    对短信中的Email进行部分隐藏处理的简便方法，默认不做验证，由使用者自己保障。
    - SensitiveDataUtil.emailHideSMS("ddddddd@hide.com") = ddd*@hide.*
    - SensitiveDataUtil.emailHideSMS("ddddddd@netvigator.com") = ddd*@netviga*
    - SensitiveDataUtil.emailHideSMS("d@netvigator.com") = d*@netviga*
    - SensitiveDataUtil.emailHideSMS("ddddddd@outlook.com") = ddd*@outlook.*
    参数:
    
    email - 待处理的Email
    
    返回:
    
    如果hideFlag为true，返回《支付宝会员信息展示规范》中推荐的Email部分展示字符串；否则返回原数据。
  - filterHide
```
public static String filterHide(String sourceStr,
                                String tagBegin,
                                String tagEnd,
                                int sensitiveDataType)
```
    过滤字符串中的敏感信息：对起始标签tagBegin和结尾标签tagEnd 中间的内容按指定的敏感数据类型sensitiveInfoType进行部分隐藏。
    
    示例: 过滤证件号
    
    sourceStr为：
```
  <Party id="part_2">
   <FullName>yimin.jiang</FullName>
   <GovtIDTC tc="802"></GovtIDTC>
   <GovtID>432926201110191188</GovtID>
   <GovtTermDate>2011-06-07</GovtTermDate>
  </Party>
 
```
```
 tagBegin:<GovtID>
 tagEnd: </GovtID>
 sensitiveInfoType: SensitiveDataUtil.IDCARDNO_DATA
 
```
    方法返回值:
```
  <Party id="part_2">
   <FullName>yimin.jiang</FullName>
   <GovtIDTC tc="802"></GovtIDTC>
   <GovtID>432926********1188</GovtID>
   <GovtTermDate>2011-06-07</GovtTermDate>
  </Party>
 
```
    参数:
    
    sourceStr - 源字符串
    
    tagBegin - 起始标签
    
    tagEnd - 结尾标签
    
    sensitiveDataType - 敏感数据类型，值可为： SensitiveDataUtil.BANKCARDNO_DATA、 SensitiveDataUtil.IDCARDNO_DATA、 SensitiveDataUtil.PHONENO_DATA、 SensitiveDataUtil.EMAIL_DATA或 SensitiveDataUtil.UNKNOWN_DATA。
    
    返回:
    
    如果hideFlag为true，返回过滤掉敏感数据后的字符串；否则返回原数据。
  - taobaoNickHide
```
public static String taobaoNickHide(String sensitiveData)
```
    显示首/尾各1位，中间加**
    - SensitiveDataUtil.taobaoNickHide("中华") = 中**华
    - SensitiveDataUtil.taobaoNickHide("中华人") = 中**人
    - SensitiveDataUtil.taobaoNickHide("中华人民") = 中**民
    - SensitiveDataUtil.taobaoNickHide("china") = c**a
    参数:
    
    sensitiveData - 淘宝昵称
    
    返回:
    
    部分隐藏后的昵称
  - defaultHide
```
public static String defaultHide(String sensitiveData)
```
    敏感信息缺省隐藏方式处理：显示前1/3和后1/3，其他*号代替。内容长度不能被3整除时，显示前ceil[length/3.0]和后floor[ length/3.0]
```
 SensitiveDataUtil.defaultHide("ttt") = "t*t"
 SensitiveDataUtil.defaultHide("tttttttt") = "ttt***tt"
 
```
    参数:
    
    sensitiveData - 待部分隐藏处理的敏感信息。
    
    返回:
    
    屏蔽后的数据; 如果hideFlag为flase，返回原数据。
  - customizeHide
```
public static String customizeHide(String sensitiveData,
                                   int frontCharNum,
                                   int tailCharNum,
                                   int hiddenCharNum)
```
    自定义屏蔽位数和屏蔽位置
```
 SensitiveDataUtil.customizeHide("13568794561",3,4,4) = "135****4561"
 SensitiveDataUtil.customizeHide("13568794561",0,4,4) = "****4561"
 SensitiveDataUtil.customizeHide("13568794561",3,0,4) = "135****"
 SensitiveDataUtil.customizeHide("13568794561",3,0,8) = "135********"
 
```
    参数:
    
    sensitiveData - 原数据
    
    frontCharNum - 展示前几位
    
    tailCharNum - 展示后几位
    
    hiddenCharNum - 展示星号*的个数
    
    返回:
    
    部分隐藏的敏感数据字符串
  - setHideFlag
```
public static void setHideFlag(boolean hideFlag)
```
    hideFlag setter
    
    参数:
    
    hideFlag -
  - needHide
```
public static boolean needHide()
```
    hideFlag getter
    
    返回:
    
    是否需要进行隐藏屏蔽

类 SensitiveDataUtil

字段概要

构造器概要

方法概要

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

字段详细资料

BANKCARDNO_DATA

IDCARDNO_DATA

PHONENO_DATA

EMAIL_DATA

构造器详细资料

SensitiveDataUtil

SensitiveDataUtil

方法详细资料

alipayLogonIdHide

alipayLogonIdHideSMS

nameHide

idCardNoHide

idCardNoHide

bankCardNoHide

bankCardNoHide

phoneOrTelNoHide

phoneOrTelNoHide

cellphoneHide

cellphoneHideSMS

emailHide

emailHide

emailHideSMS

emailHideSMS

filterHide

taobaoNickHide

defaultHide

customizeHide

setHideFlag

needHide