SpringBoot 自定義註解之脫敏註解詳解
自定義註解之脫敏註解
數據脫敏是指對某些敏感信息通過脫敏規則進行數據的變形，實現敏感隱私數據的可靠保護。需求是把返回到前端的數據進行脫敏，以免造成隱私信息的泄露。
一、脫敏後的效果
這樣顯示很不好吧，所有信息都泄露瞭
這樣就很好瞭吧
二、代碼
1.脫敏註解
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = SensitiveSerialize.class)
public @interface Sensitive {
/**
* 脫敏數據類型
*/
SensitiveTypeEnum type() default SensitiveTypeEnum.CUSTOMER;
/**
* 前置不需要打碼的長度
*/
int prefixNoMaskLen() default 0;
/**
* 後置不需要打碼的長度
*/
int suffixNoMaskLen() default 0;
/**
* 用什麼打碼
*/
String symbol() default "*";
}
2.定義脫敏類型
public enum SensitiveTypeEnum {
/**
* 自定義
*/
CUSTOMER,
/**
* 姓名
*/
NAME,
/**
* 身份證
*/
ID_NUM,
/**
* 手機號碼
*/
PHONE_NUM
}
3.敏感工具類
public class DesensitizedUtils {
/**
* 對字符串進行脫敏操作
*
* @param origin 原始字符串
* @param prefixNoMaskLen 左側需要保留幾位明文字段
* @param suffixNoMaskLen 右側需要保留幾位明文字段
* @param maskStr 用於遮罩的字符串, 如'*'
* @return 脫敏後結果
*/
public static String desValue(String origin, int prefixNoMaskLen, int suffixNoMaskLen, String maskStr) {
if (origin == null) {
return null;
}
StringBuilder sb = new StringBuilder();
for (int i = 0, n = origin.length(); i < n; i++) {
if (i < prefixNoMaskLen) {
sb.append(origin.charAt(i));
continue;
}
if (i > (n - suffixNoMaskLen - 1)) {
sb.append(origin.charAt(i));
continue;
}
sb.append(maskStr);
}
return sb.toString();
}
/**
* 【中文姓名】隻顯示最後一個漢字，其他隱藏為星號，比如：**夢
*
* @param fullName 姓名
* @return 結果
*/
public static String chineseName(String fullName) {
if (fullName == null) {
return null;
}
return desValue(fullName, 1, 0, "*");
}
/**
* 【身份證號】顯示前4位, 後2位，其他隱藏。
*
* @param id 身份證號碼
* @return 結果
*/
public static String idCardNum(String id) {
return desValue(id, 4, 2, "*");
}
/**
* 【手機號碼】前三位，後四位，其他隱藏。
*
* @param num 手機號碼
* @return 結果
*/
public static String mobilePhone(String num) {
return desValue(num, 3, 4, "*");
}
}
4.脫敏序列化信息
@NoArgsConstructor
@AllArgsConstructor
public class SensitiveSerialize extends JsonSerializer<String> implements ContextualSerializer {
/**
* 脫敏類型
*/
private SensitiveTypeEnum sensitiveTypeEnum;
/**
* 前幾位不脫敏
*/
private Integer prefixNoMaskLen;
/**
* 最後幾位不脫敏
*/
private Integer suffixNoMaskLen;
/**
* 用什麼打碼
*/
private String symbol;
@Override
public void serialize(final String origin, final JsonGenerator jsonGenerator,
final SerializerProvider serializerProvider) throws IOException {
switch (sensitiveTypeEnum) {
case CUSTOMER:
jsonGenerator.writeString(DesensitizedUtils.desValue(origin, prefixNoMaskLen, suffixNoMaskLen, symbol));
break;
case NAME:
jsonGenerator.writeString(DesensitizedUtils.chineseName(origin));
break;
case ID_NUM:
jsonGenerator.writeString(DesensitizedUtils.idCardNum(origin));
break;
case PHONE_NUM:
jsonGenerator.writeString(DesensitizedUtils.mobilePhone(origin));
break;
default:
throw new IllegalArgumentException("unknown sensitive type enum " + sensitiveTypeEnum);
}
}
@Override
public JsonSerializer<?> createContextual(final SerializerProvider serializerProvider,
final BeanProperty beanProperty) throws JsonMappingException {
if (beanProperty != null) {
if (Objects.equals(beanProperty.getType().getRawClass(), String.class)) {
Sensitive sensitive = beanProperty.getAnnotation(Sensitive.class);
if (sensitive == null) {
sensitive = beanProperty.getContextAnnotation(Sensitive.class);
}
if (sensitive != null) {
return new SensitiveSerialize(sensitive.type(), sensitive.prefixNoMaskLen(),
sensitive.suffixNoMaskLen(), sensitive.symbol());
}
}
return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
}
return serializerProvider.findNullValueSerializer(null);
}
}
小結一下
該註解用於隱私數據的脫敏，隻作用於類的屬性上。該註解有四個屬性，type表示脫敏數據類型（默認為CUSTOMER自定義，後面三個屬性才有效），prefixNoMaskLen表示前置不需要打碼的長度（默認為0），suffixNoMaskLen表示後置不需要打碼的長度（默認為0），symbol表示用什麼打碼（默認為*）。
一般用於返回對象給前端對象中包含隱私數據例如身份證、詳細地址需要進行脫敏的情況。
示例：
public class UserInfo {
@Sensitive(type = SensitiveTypeEnum.NAME)
private String name;
@Sensitive(type = SensitiveTypeEnum.ID_NUM)
private String idNum;
@Sensitive(type = SensitiveTypeEnum.PHONE_NUM)
private String phone;
@Sensitive(type = SensitiveTypeEnum.CUSTOMER, prefixNoMaskLen = 3, suffixNoMaskLen = 2, symbol = "#")
private String address;
@Sensitive(prefixNoMaskLen = 1, suffixNoMaskLen = 2, symbol = "*")
private String password;
}
如果還有疑問我寫瞭個demo，可以下載下來運行看看
鏈接： 脫敏註解demo.
自己手寫的一個高效自定義字符串脫敏註解
經理要求寫一個自定義脫敏註解，百度查瞭一堆。都是效率比較低的
自己寫瞭個 僅供參考
/**
* description: 數據脫敏
* 1、默認不傳部位、不傳顯示*號數量時字段全部脫敏
*
* 原始字符串 adminis 總長度從0計算 總數6
* index=(0,2) size = 1 下標即從0到2以內的字符標註“ * ”，size=1 則隻填充一個* size 不能超過截取字符
* index=(2,3) size =2 下標即從2到3以內的字符標註“ * ”，size=2 則隻填充二個* size 不能超過截取字符
*
* date: 2020/3/13 15:56
*
* @author oakdog
* @version 1.0
*/
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonSerialize(using = Desensitization.ConvertDesensitization.class)
public @interface Desensitization {
/**
* 傳入的下標索引
* 規則 第一位起始下標 第二位是結束下標 默認值6位下標
**/
int[] index() default {0,6};
/**
* 需要脫敏的字符長度
* 規則 輸入 3 ：則根據index下標索引對應脫敏3個字符 默認6個長度脫敏
**/
int size() default 6;
class ConvertDesensitization extends StdSerializer<Object> implements ContextualSerializer {
private int[] index;
private int size;
public ConvertDesensitization() {
super(Object.class);
}
private ConvertDesensitization(int[] index,int size) {
super(Object.class);
this.size = size;
this.index = index;
}
@Override
public void serialize(Object value, JsonGenerator jgen,
SerializerProvider provider) throws IOException {
char[] str = value.toString().toCharArray();
StringBuilder builder = new StringBuilder();
String char1 = (String) value;
if(str.length > 0) {
//字符長度超長處理
if(index[0] < str.length && index[1] < str.length) {
//使用默認初始值的脫敏處理
if(index[0] == 0) {
//如果輸入脫敏大小長度小於0或大於原始脫敏字符長度，則全脫敏字符
if (size < 0 || size < str.length) {
char[] charStr = char1.substring(index[1], str.length).toCharArray();
char[] charStr1 = char1.substring(index[0], index[1]).toCharArray();
builder.append(charStr1);
for (int i = 0; i < charStr.length; i++) {
if(size > i) {
builder.append("*");
}else {
builder.append(charStr[i]);
}
}
}else {
builder.append(getDefaultChar((String) value,"left"));
}
}else {
//從中間位置截取脫敏處理
//如果輸入脫敏大小長度小於0或大於原始脫敏字符長度，則全脫敏字符
if (size < 0 || size < str.length) {
char[] charStr = char1.substring(index[0], str.length - index[1] + 1).toCharArray(); //2 6-4 2 //中間截取部分
List<Integer> prefix = getPrefix(index[0], (String) value);
//List<Integer> suffix = getSuffix(index[0],index[1], (String) value);
for (Integer integer : prefix) {
builder.append(str[integer]);
}
for (int i = 0; i < charStr.length; i++) {
if (size > i) {
builder.append("*");
} else {
builder.append(charStr[i]);
}
}
char[] chars = Arrays.copyOfRange(str, index[1], str.length);
builder.append(String.valueOf(chars));
}else {
builder.append(getDefaultChar((String) value,"right"));
}
}
}else {
//默認處理
builder.append(getDefaultChar((String) value,""));
}
}
jgen.writeString(builder.toString());
}
/**
* 默認的填充方式
* @param str 原始字符串
* @param position 位置
* @return
*/
String getDefaultChar(String str,String position){
char[] desensitizationStr = str.toCharArray();
for(int i=0;i<desensitizationStr.length;i++){
if("left".equals(position)){
if(i != 0){
desensitizationStr[i] = '*';
}
}else if("right".equals(position)){
if(i != desensitizationStr.length-1){
desensitizationStr[i] = '*';
}
}else {
if(i != 0 && i != desensitizationStr.length-1){
desensitizationStr[i] = '*';
}
}
}
return String.valueOf(desensitizationStr);
}
/**
* 獲取字符前綴下標
* @param index 下標
* @param val 原始字符串
* @return
*/
List<Integer> getPrefix(int index,String val){
//int[] chars = {};
List<Integer> listIndex = new ArrayList<>();
for(int i=0;i<val.length();i++){
if(i != index){ //0 1 != 2
listIndex.add(i);
continue;
}
break;
}
return listIndex;
}
@Override
public JsonSerializer<?> createContextual(SerializerProvider prov, BeanProperty property) {
int[] index = {0,6}; //初始值
int size = 6; //初始值
Desensitization ann = null;
if (property != null) {
ann = property.getAnnotation(Desensitization.class);
}
if (ann != null) {
index = ann.index();
size = ann.size();
}
return new Desensitization.ConvertDesensitization(index,size);
}
}
}
以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。