springboot 利用fastjson脫敏數據庫數據（自定義註解）

1. 自定義脫敏註解

package com.hanhuide.hhde.annotation;

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.定義脫敏類型

package com.hanhuide.hhde.enums;

public enum SensitiveTypeEnum {
    /**
     * 中文名
     */
    CHINESE_NAME,
    /**
     * 身份證號
     */
    ID_CARD,
    /**
     * 座機號
     */
    FIXED_PHONE,
    /**
     * 手機號
     */
    MOBILE_PHONE,
    /**
     * 地址
     */
    ADDRESS,
    /**
     * 電子郵件
     */
    EMAIL,
    /**
     * 銀行卡
     */
    BANK_CARD,
    /**
     * 密碼
     */
    PASSWORD,
    /**
     * 車牌號
     */
    CARNUMBER;
}

3. 編輯脫敏工具類

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), "*"), "**"));

    }
}

4. 實現ValueFilter  接口 在process添加自己的處理步驟

package com.hanhuide.hhde.filter;

import com.alibaba.fastjson.serializer.ValueFilter;

import java.lang.reflect.Field;

import com.hanhuide.hhde.annotation.Desensitized;
import com.hanhuide.hhde.enums.SensitiveTypeEnum;
import com.hanhuide.hhde.utils.DesensitizedUtils;
import lombok.extern.slf4j.Slf4j;

/**
 * 在fastjson中使用此過濾器進行脫敏操作
 */
@Slf4j
public class ValueDesensitizeFilter implements ValueFilter {


    @Override
    public Object process(Object object, String name, Object value) {
        if (null == value || !(value instanceof String) || ((String) value).length() == 0) {
            return value;
        }
        try {
            Field field = object.getClass().getDeclaredField(name);
            Desensitized desensitization;
            if (String.class != field.getType() || (desensitization = field.getAnnotation(Desensitized.class)) == null) {
                return value;
            }
            String valueStr = (String) value;
            SensitiveTypeEnum type = desensitization.type();
            switch (type) {
                case CHINESE_NAME:
                    return DesensitizedUtils.chineseName(valueStr);
                case ID_CARD:
                    return DesensitizedUtils.idCardNum(valueStr);
                case FIXED_PHONE:
                    return DesensitizedUtils.fixedPhone(valueStr);
                case MOBILE_PHONE:
                    return DesensitizedUtils.mobilePhone(valueStr);
                case ADDRESS:
                    return DesensitizedUtils.address(valueStr, 8);
                case EMAIL:
                    return DesensitizedUtils.email(valueStr);
                case BANK_CARD:
                    return DesensitizedUtils.bankCard(valueStr);
                case PASSWORD:
                    return DesensitizedUtils.password(valueStr);
                case CARNUMBER:
                    return DesensitizedUtils.carNumber(valueStr);
                default:
            }
        } catch (NoSuchFieldException e) {
            log.error("當前數據類型爲{},值爲{}", object.getClass(), value);
            return value;
        }
        return value;
    }
}

5. 配置fastjson爲默認JSON轉換

package com.hanhuide.hhde.config;

import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import com.hanhuide.hhde.factory.DesensitizedAnnotationFormatterFactory;
import com.hanhuide.hhde.filter.ValueDesensitizeFilter;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.http.HttpMessageConverters;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.format.FormatterRegistry;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.ArrayList;
import java.util.List;

@Configuration
@Slf4j
public class WebConfigurer implements WebMvcConfigurer {

    @Override
    public void addFormatters(FormatterRegistry registry) {
        log.info("啓用自定義註解！！！");
        registry.addFormatterForFieldAnnotation(new DesensitizedAnnotationFormatterFactory());
    }
    /**
     * 配置fastjson爲默認JSON轉換
     *
     * @return
     */
    @Bean
    public HttpMessageConverters fastJsonHttpMessageConverters() {
        // 1.定義一個converters轉換消息的對象
        FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter();
        // 2.添加fastjson的配置信息，比如: 是否需要格式化返回的json數據
        FastJsonConfig fastJsonConfig = new FastJsonConfig();
        fastJsonConfig.setSerializerFeatures(SerializerFeature.PrettyFormat);
        fastJsonConfig.setSerializeFilters(new ValueDesensitizeFilter());//添加自己寫的攔截器
        // 3.在converter中添加配置信息
        fastConverter.setFastJsonConfig(fastJsonConfig);
        // 4.將converter賦值給HttpMessageConverter
        HttpMessageConverter<?> converter = fastConverter;
        // 5.返回HttpMessageConverters對象
        return new HttpMessageConverters(converter);
    }
}

6.實體類

/**
 * 客戶姓名
 */
@Desensitized(type = SensitiveTypeEnum.CHINESE_NAME)
private String carowner;

/**
 * 車牌號
 */
@Desensitized(type = SensitiveTypeEnum.CARNUMBER)
private String licenseno;

/**
 * 手機號碼
 */
@Desensitized(type = SensitiveTypeEnum.MOBILE_PHONE)
private String callNumber;

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;
    }

}

此爲獲取數據庫信息通過fastjson攔截器實現數據的脫敏，自定義註解，數據格式化可以參考（https://blog.csdn.net/qq_27081015/article/details/103295983）