1. 新建注解
import com.hanhuide.hhde.enums.SensitiveTypeEnum;
import java.lang.annotation.*;
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Desensitized {
// 脱敏类型(规则)
SensitiveTypeEnum type();
}
2. 脱敏类型(定义脱敏类型)
public enum SensitiveTypeEnum {
/**
* 中文名
*/
CHINESE_NAME,
/**
* 身份证号
*/
ID_CARD,
/**
* 座机号
*/
FIXED_PHONE,
/**
* 手机号
*/
MOBILE_PHONE,
/**
* 地址
*/
ADDRESS,
/**
* 电子邮件
*/
EMAIL,
/**
* 银行卡
*/
BANK_CARD,
/**
* 密码
*/
PASSWORD,
/**
* 车牌号
*/
CARNUMBER;
}
3.实现AnnotationFormatterFactory接口
import com.hanhuide.hhde.annotation.Desensitized;
import org.springframework.format.AnnotationFormatterFactory;
import org.springframework.format.Parser;
import org.springframework.format.Printer;
import java.util.HashSet;
import java.util.Set;
/**
* Deprecated为注解的名称
*
* @author 韩惠德
*/
public class DesensitizedAnnotationFormatterFactory implements AnnotationFormatterFactory<Desensitized> {
/**
* 返回为处理的变量的类型
*
* @return
*/
@Override
public Set<Class<?>> getFieldTypes() {
Set<Class<?>> hashSet = new HashSet<>();
hashSet.add(String.class);
return hashSet;
}
@Override
public Printer<?> getPrinter(Desensitized desensitized, Class<?> aClass) {
return getFormatter(desensitized);
}
@Override
public Parser<?> getParser(Desensitized desensitized, Class<?> aClass) {
return getFormatter(desensitized);
}
private DesensitizedFormatter getFormatter(Desensitized desensitized) {
DesensitizedFormatter formatter = new DesensitizedFormatter();
formatter.setTypeEnum(desensitized.type());
return formatter;
}
}
4创建DesensitizedFormatter 格式化类实现Formatter
import com.hanhuide.hhde.enums.SensitiveTypeEnum;
import com.hanhuide.hhde.utils.DesensitizedUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.format.Formatter;
import java.text.ParseException;
import java.util.Locale;
public class DesensitizedFormatter implements Formatter<String> {
private SensitiveTypeEnum typeEnum;
public SensitiveTypeEnum getTypeEnum() {
return typeEnum;
}
public void setTypeEnum(SensitiveTypeEnum typeEnum) {
this.typeEnum = typeEnum;
}
@Override
public String parse(String valueStr, Locale locale) throws ParseException {
if (StringUtils.isNotBlank(valueStr)) {
switch (typeEnum) {
case CHINESE_NAME:
valueStr = DesensitizedUtils.chineseName(valueStr);
break;
case ID_CARD:
valueStr = DesensitizedUtils.idCardNum(valueStr);
break;
case FIXED_PHONE:
valueStr = DesensitizedUtils.fixedPhone(valueStr);
break;
case MOBILE_PHONE:
valueStr = DesensitizedUtils.mobilePhone(valueStr);
break;
case ADDRESS:
valueStr = DesensitizedUtils.address(valueStr, 8);
break;
case EMAIL:
valueStr = DesensitizedUtils.email(valueStr);
break;
case BANK_CARD:
valueStr = DesensitizedUtils.bankCard(valueStr);
break;
case PASSWORD:
valueStr = DesensitizedUtils.password(valueStr);
break;
case CARNUMBER:
valueStr = DesensitizedUtils.carNumber(valueStr);
break;
default:
}
}
return valueStr;
}
@Override
public String print(String s, Locale locale) {
return s;
}
}
5.创建格式化工具类DesensitizedUtils
package com.hanhuide.hhde.utils;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.hanhuide.hhde.annotation.Desensitized;
import org.apache.commons.lang3.StringUtils;
import java.lang.reflect.*;
import java.util.*;
/**
* @Title: DesensitizedUtils
*/
public class DesensitizedUtils {
/**
* 【中文姓名】只显示第一个汉字,其他隐藏为2个星号,比如:李**
*
* @param fullName
* @return
*/
public static String chineseName(String fullName) {
if (StringUtils.isBlank(fullName)) {
return "";
}
String name = StringUtils.left(fullName, 1);
return StringUtils.rightPad(name, StringUtils.length(fullName), "*");
}
/**
* 【身份证号】显示最后四位,其他隐藏。共计18位或者15位,比如:*************1234
*
* @param id
* @return
*/
public static String idCardNum(String id) {
if (StringUtils.isBlank(id)) {
return "";
}
String num = StringUtils.right(id, 4);
return StringUtils.leftPad(num, StringUtils.length(id), "*");
}
/**
* 【固定电话 后四位,其他隐藏,比如1234
*
* @param num
* @return
*/
public static String fixedPhone(String num) {
if (StringUtils.isBlank(num)) {
return "";
}
return StringUtils.leftPad(StringUtils.right(num, 4), StringUtils.length(num), "*");
}
/**
* 【手机号码】前三位,后四位,其他隐藏,比如135******10
*
* @param num
* @return
*/
public static String mobilePhone(String num) {
if (StringUtils.isBlank(num)) {
return "";
}
return StringUtils.left(num, 3).concat(StringUtils.removeStart(StringUtils.leftPad(StringUtils.right(num, 2), StringUtils.length(num), "*"), "***"));
}
/**
* 【地址】只显示到地区,不显示详细地址,比如:北京市海淀区****
*
* @param address
* @param sensitiveSize 敏感信息长度
* @return
*/
public static String address(String address, int sensitiveSize) {
if (StringUtils.isBlank(address)) {
return "";
}
int length = StringUtils.length(address);
return StringUtils.rightPad(StringUtils.left(address, length - sensitiveSize), length, "*");
}
/**
* 【电子邮箱 邮箱前缀仅显示第一个字母,前缀其他隐藏,用星号代替,@及后面的地址显示,比如:d**@126.com>
*
* @param email
* @return
*/
public static String email(String email) {
if (StringUtils.isBlank(email)) {
return "";
}
int index = StringUtils.indexOf(email, "@");
if (index <= 1) {
return email;
} else {
return StringUtils.rightPad(StringUtils.left(email, 1), index, "*").concat(StringUtils.mid(email, index, StringUtils.length(email)));
}
}
/**
* 【银行卡号】前六位,后四位,其他用星号隐藏每位1个星号,比如:6222600**********1234>
*
* @param cardNum
* @return
*/
public static String bankCard(String cardNum) {
if (StringUtils.isBlank(cardNum)) {
return "";
}
return StringUtils.left(cardNum, 6).concat(StringUtils.removeStart(StringUtils.leftPad(StringUtils.right(cardNum, 4), StringUtils.length(cardNum), "*"), "******"));
}
/**
* 【密码】密码的全部字符都用*代替,比如:******
*
* @param password
* @return
*/
public static String password(String password) {
if (StringUtils.isBlank(password)) {
return "";
}
String pwd = StringUtils.left(password, 0);
return StringUtils.rightPad(pwd, StringUtils.length(password), "*");
}
/**
* 【车牌号】前两位后一位,比如:苏M****5
*
* @param carNumber
* @return
*/
public static String carNumber(String carNumber) {
if (StringUtils.isBlank(carNumber)) {
return "";
}
return StringUtils.left(carNumber, 2).
concat(StringUtils.removeStart(StringUtils.leftPad(StringUtils.right(carNumber, 1), StringUtils.length(carNumber), "*"), "**"));
}
}
6.将DesensitizedAnnotationFormatterFactory添加到spring配置文件中
package com.hanhuide.hhde.config;
import com.hanhuide.hhde.factory.DesensitizedAnnotationFormatterFactory;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
@Slf4j
public class WebConfigurer implements WebMvcConfigurer {
@Override
public void addFormatters(FormatterRegistry registry) {
log.info("启用自定义注解!!!");
registry.addFormatterForFieldAnnotation(new DesensitizedAnnotationFormatterFactory());
}
}
6.创建实体类student测试效果
package com.hanhuide.hhde.dao;
import com.hanhuide.hhde.annotation.BooleanFormat;
import com.hanhuide.hhde.annotation.Desensitized;
import com.hanhuide.hhde.annotation.Label;
import com.hanhuide.hhde.annotation.TimestampFormat;
import com.hanhuide.hhde.enums.SensitiveTypeEnum;
import lombok.Data;
import org.springframework.format.annotation.DateTimeFormat;
import java.sql.Timestamp;
import java.util.Date;
@Data
public class Student {
@Label("姓名")
String name;
@Label("出生日期")
@DateTimeFormat
Date born;
@Label("分数")
double score;
@BooleanFormat(trueTag = {"YES", "OK", "是", "不是"})
private boolean exists;
@TimestampFormat
private Timestamp startTime;
@Desensitized(type = SensitiveTypeEnum.CHINESE_NAME)
private String chinaName;
@Desensitized(type = SensitiveTypeEnum.MOBILE_PHONE)
private String moble_phone;
@Desensitized(type = SensitiveTypeEnum.CARNUMBER)
private String carNumber;
}
7创建controller测试
package com.hanhuide.hhde.controller;
import com.hanhuide.hhde.dao.CallRecordQuery;
import com.hanhuide.hhde.dao.CallRecordReport;
import com.hanhuide.hhde.dao.Student;
import com.hanhuide.hhde.service.CallRecordService;
import com.hanhuide.hhde.service.impl.CallRecordServiceImpl;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
@RequestMapping("hello")
@Slf4j
public class HelloController {
@Autowired
private CallRecordService callRecordService;
@ApiOperation(value = "测试自定义注解")
@PostMapping(value = {"index"})
public Student ceshi(Student student) {
log.info("这个月的学生 student:[{}]", student);
return student;
}
@ApiOperation(value = "测试自定义注解数据库返回信息")
@PostMapping(value = {"ceshi"})
public List<CallRecordReport> ceshi(CallRecordQuery callRecordQuery) {
List<CallRecordReport> callRecordReportList = callRecordService.searchExportDetails(callRecordQuery);
return callRecordReportList;
}
}
实现效果
测试发现在前端传回去的参数可以脱敏但是 直接获取mybatis 结果无法脱敏所以 需要创建拦截器 使用阿里fastjson实现数据库数据脱敏,请查看(https://blog.csdn.net/qq_27081015/article/details/103297316)