优雅脱敏—利用注解进行数据脱敏（电话号、人名等使用****代替）

甜甜掉在星星上

已于 2022-04-14 13:18:11 修改

阅读量2.9k

点赞数 2

分类专栏：优雅永不过时文章标签： java

于 2021-06-04 15:48:44 首次发布

本文链接：https://blog.csdn.net/weixin_45528650/article/details/117551552

版权

优雅永不过时专栏收录该内容

7 篇文章 1 订阅

订阅专栏

一、引入

在项目中经常有联系人的信息，如电话、身份证等敏感信息，我们肯定不能直接显示在前端，也不能直接存储153* * 7574，这样会造成数据缺失，正确的做法应该是对这部分敏感数据进行脱敏，相当于进行简单的加密。
eg：手机号：15354568768，应该脱敏成 153 * *8768这样返回

二、创建数据脱敏相关工具类

1、新建maven项目，引入需要的依赖

 <properties>
        <hutool.version>5.5.1</hutool.version>
    </properties>

    <dependencies>
        <!--工具包-->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>${hutool.version}</version>
        </dependency>

        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!--该依赖已经包含mybatis及mybatis-spring依赖，勿重复加入以免引起冲突-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.3.2</version>
        </dependency>
    </dependencies>

2、创建脱敏工具类

/**
 * 脱敏工具类
 *
 * @author wuying
 * @version v1.0
 **/
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, 0, 1, "*");
    }

    /**
     * 【身份证号】显示前六位, 四位，其他隐藏。共计18位或者15位，比如：340304*******1234
     *
     * @param id 身份证号码
     * @return 结果
     */
    public static String idCardNum(String id) {
        return desValue(id, 6, 4, "*");
    }

    /**
     * 【固定电话】后四位，其他隐藏，比如 ****1234
     *
     * @param num 固定电话
     * @return 结果
     */
    public static String fixedPhone(String num) {
        return desValue(num, 0, 4, "*");
    }

    /**
     * 【手机号码】前三位，后四位，其他隐藏，比如135****6810
     *
     * @param num 手机号码
     * @return 结果
     */
    public static String mobilePhone(String num) {
        return desValue(num, 3, 4, "*");
    }

    /**
     * 【地址】只显示到地区，不显示详细地址，比如：北京市海淀区****
     *
     * @param address 地址
     * @return 结果
     */
    public static String address(String address) {
        return desValue(address, 6, 0, "*");
    }

    /**
     * 【电子邮箱 邮箱前缀仅显示第一个字母，前缀其他隐藏，用星号代替，@及后面的地址显示，比如：d**@126.com
     *
     * @param email 电子邮箱
     * @return 结果
     */
    public static String email(String email) {
        if (email == null) {
            return null;
        }
        int index = StrUtil.indexOf(email, '@');
        if (index <= 1) {
            return email;
        }
        String preEmail = desValue(email.substring(0, index), 1, 0, "*");
        return preEmail + email.substring(index);

    }

    /**
     * 【银行卡号】前六位，后四位，其他用星号隐藏每位1个星号，比如：622260**********1234
     *
     * @param cardNum 银行卡号
     * @return 结果
     */
    public static String bankCard(String cardNum) {
        return desValue(cardNum, 6, 4, "*");
    }

    /**
     * 【密码】密码的全部字符都用*代替，比如：******
     *
     * @param password 密码
     * @return 结果
     */
    public static String password(String password) {
        if (password == null) {
            return null;
        }
        return "******";
    }

    /**
     * 【密钥】密钥除了最后三位，全部都用*代替，比如：***xdS 脱敏后长度为6，如果明文长度不足三位，则按实际长度显示，剩余位置补*
     *
     * @param key 密钥
     * @return 结果
     */
    public static String key(String key) {
        if (key == null) {
            return null;
        }
        int viewLength = 6;
        StringBuilder tmpKey = new StringBuilder(desValue(key, 0, 3, "*"));
        if (tmpKey.length() > viewLength) {
            return tmpKey.substring(tmpKey.length() - viewLength);
        } else if (tmpKey.length() < viewLength) {
            int buffLength = viewLength - tmpKey.length();
            for (int i = 0; i < buffLength; i++) {
                tmpKey.insert(0, "*");
            }
            return tmpKey.toString();
        } else {
            return tmpKey.toString();
        }
    }

}

3、创建敏感信息枚举类

/**
 * @author wuying
 * @version 1.0
 * @date 2021/3/31 
 * @description 敏感信息枚举类
 */
public enum SensitiveTypeEnum {

	/**
	 * 自定义
	 */
	CUSTOMER,
	/**
	 * 用户名, 刘*华, 徐*
	 */
	CHINESE_NAME,
	/**
	 * 身份证号, 110110********1234
	 */
	ID_CARD,
	/**
	 * 座机号, ****1234
	 */
	FIXED_PHONE,
	/**
	 * 手机号, 176****1234
	 */
	MOBILE_PHONE,
	/**
	 * 地址, 北京********
	 */
	ADDRESS,
	/**
	 * 电子邮件, s*****o@xx.com
	 */
	EMAIL,
	/**
	 * 银行卡, 622202************1234
	 */
	BANK_CARD,
	/**
	 * 密码, 永远是 ******, 与长度无关
	 */
	PASSWORD,
	/**
	 * 密钥, 永远是 ******, 与长度无关
	 */
	KEY

}

4、创建脱敏序列化类


/**
 * @author wuying
 * @version 1.0
 * @date 2021/3/31 
 * @description 脱敏序列化类
 */
@NoArgsConstructor
@AllArgsConstructor
public class SensitiveSerialize extends JsonSerializer<String> implements ContextualSerializer {

	private cn.wyj.sensitive.SensitiveTypeEnum type;

	private Integer prefixNoMaskLen;

	private Integer suffixNoMaskLen;

	private String maskStr;

	@Override
	public void serialize(final String origin, final JsonGenerator jsonGenerator,
			final SerializerProvider serializerProvider) throws IOException {
		switch (type) {
		case CHINESE_NAME:
			jsonGenerator.writeString(cn.wyj.sensitive.DesensitizedUtils.chineseName(origin));
			break;
		case ID_CARD:
			jsonGenerator.writeString(cn.wyj.sensitive.DesensitizedUtils.idCardNum(origin));
			break;
		case FIXED_PHONE:
			jsonGenerator.writeString(cn.wyj.sensitive.DesensitizedUtils.fixedPhone(origin));
			break;
		case MOBILE_PHONE:
			jsonGenerator.writeString(cn.wyj.sensitive.DesensitizedUtils.mobilePhone(origin));
			break;
		case ADDRESS:
			jsonGenerator.writeString(cn.wyj.sensitive.DesensitizedUtils.address(origin));
			break;
		case EMAIL:
			jsonGenerator.writeString(cn.wyj.sensitive.DesensitizedUtils.email(origin));
			break;
		case BANK_CARD:
			jsonGenerator.writeString(cn.wyj.sensitive.DesensitizedUtils.bankCard(origin));
			break;
		case PASSWORD:
			jsonGenerator.writeString(cn.wyj.sensitive.DesensitizedUtils.password(origin));
			break;
		case KEY:
			jsonGenerator.writeString(cn.wyj.sensitive.DesensitizedUtils.key(origin));
			break;
		case CUSTOMER:
			jsonGenerator.writeString(cn.wyj.sensitive.DesensitizedUtils.desValue(origin, prefixNoMaskLen, suffixNoMaskLen, maskStr));
			break;
		default:
			throw new IllegalArgumentException("Unknow sensitive type enum " + type);
		}
	}

	@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.maskStr());
				}
			}
			return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
		}
		return serializerProvider.findNullValueSerializer(null);
	}

}

5、创建对象脱敏注解类


/**
 * @author wuying
 * @version 1.0
 * @date 2021/3/31 
 * @description 对象脱敏注解类
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = cn.wyj.sensitive.SensitiveSerialize .class)
public @interface Sensitive {

	/**
	 * 脱敏数据类型, 非Customer时, 将忽略 refixNoMaskLen 和 suffixNoMaskLen 和 maskStr
	 */
	cn.wyj.sensitive.SensitiveTypeEnum type() default cn.wyj.sensitive.SensitiveTypeEnum.CUSTOMER;

	/**
	 * 前置不需要打码的长度
	 */
	int prefixNoMaskLen() default 0;

	/**
	 * 后置不需要打码的长度
	 */
	int suffixNoMaskLen() default 0;

	/**
	 * 用什么打码
	 */
	String maskStr() default "*";

}

三、使用注解对数据脱敏

1、创建一个实体类进行脱敏


/**
 * @author wuying
 * @version 1.0
 * @date 2021/3/31 
 * @description
 */
@Data
@AllArgsConstructor
public class User {
    
    private Long id;
    /**按照名字数据进行脱敏*/
    @Sensitive(type = SensitiveTypeEnum.CHINESE_NAME)
    private String name;
    
    private String description;
    
    /**按照手机号数据进行脱敏  type指明脱敏类别*/
    @Sensitive(type = SensitiveTypeEnum.MOBILE_PHONE)
    private String phone;
}

2、创建控制器类测试一下

/**
 * <p>
 *  前端控制器
 * </p>
 *
 * @author wuying
 * @since 2021-04-16
 */
@RestController
@RequestMapping("/user")
public class UserController {

    @Resource
    private UserService userService;

    @GetMapping
    public List<User> findUserList(){
        return userService.list();
    }


}

3、访问控制器数据脱敏成功

在这里插入图片描述

四、写在最后

我是无影，相信再小的帆也能远航，感谢各位大佬的点赞、收藏和评论，我们下期见！

甜甜掉在星星上

关注

2
点赞
踩
22

收藏

觉得还不错? 一键收藏
打赏
13
评论
优雅脱敏—利用注解进行数据脱敏（电话号、人名等使用****代替）

一、背景引入在项目中经常有联系人的信息，如电话、身份证等敏感信息，我们肯定不能直接显示在前端，正确的做法应该是对这部分敏感数据进行脱敏，相当于进行简单的加密。eg：手机号：15354568768，应该脱敏成 153****8768这样返回...
复制链接

扫一扫