SpringBoot自定义注解之脱敏注解的示例分析

这篇文章将为大家详细讲解有关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 {        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();    }        public static String chineseName(String fullName) {        if (fullName == null) {            return null;        }        return desValue(fullName, 1, 0, "*");    }        public static String idCardNum(String id) {        return desValue(id, 4, 2, "*");    }        public static String mobilePhone(String num) {        return desValue(num, 3, 4, "*");    }}

4.脱敏序列化信息

@NoArgsConstructor@AllArgsConstructorpublic 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.

自己手写的一个高效自定义字符串脱敏注解

经理要求写一个自定义脱敏注解，百度查了一堆。都是效率比较低的

自己写了个 仅供参考

@Target({ElementType.FIELD})@Retention(RetentionPolicy.RUNTIME)@JacksonAnnotationsInside@JsonSerialize(using = Desensitization.ConvertDesensitization.class)public @interface Desensitization {        int[] index() default {0,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());        }                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);        }                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);        }    }}

关于“springBoot自定义注解之脱敏注解的示例分析”这篇文章就分享到这里了，希望以上内容可以对大家有一定的帮助，使各位可以学到更多知识，如果觉得文章不错，请把它分享出去让更多的人看到。