註解實現json序列化的時候自動進行資料脫敏
阿新 • • 發佈：2019-01-10
最近在進行開發的時候遇到一個問題，需要對使用者資訊進行脫敏處理，原有的方式是寫一個util類，在需要脫敏的欄位查出資料後，顯示掉用方法處理後再set回去，覺得這種方式能實現功能，但是不是特別優雅，想找個比較優雅的實現。
思考了一下，覺得資料只有在輸出的時候進行脫敏處理即可，其它都是在記憶體階段，相對來說都是比較安全的，輸出階段我想到了json序列化，因為我們用的restful介面輸出json，於是去查詢了一下相關的資源，jackson可以指定某個欄位的自定義序列化類，那麼還有一個問題，我指定了用某個類進行序列化，但是在序列化的時候如果判斷脫敏的型別呢，翻看網上大神的文章得知，ContextualSerializer
JsonSerializer，只需要實現createContextual方法即可。廢話少說，下面上程式碼：
使用者資訊實體：
@Data public class UserDetailResponse { private Long useId; @ApiModelProperty(value = "使用者編號") private String useNo; @ApiModelProperty(value = "使用者姓名") private String useName; @SensitiveInfo(SensitiveType.MOBILE_PHONE) @ApiModelProperty(value = "使用者手機號") private String mobile; @ApiModelProperty(value = "使用者性別") private String sex; @ApiModelProperty(value = "使用者年齡") private int age; @ApiModelProperty(value = "使用者籍貫") private String nativePlace; @SensitiveInfo(SensitiveType.ID_CARD) @ApiModelProperty(value = "使用者身份證號") private String idCard; @ApiModelProperty(value = "使用者身份證號") private String borrowingLevel; }
脫敏型別列舉類
public enum SensitiveType { /** * 中文名 */ CHINESE_NAME, /** * 身份證號 */ ID_CARD, /** * 座機號 */ FIXED_PHONE, /** * 手機號 */ MOBILE_PHONE, /** * 地址 */ ADDRESS, /** * 電子郵件 */ EMAIL, /** * 銀行卡 */ BANK_CARD, /** * 公司開戶銀行聯號 */ CNAPS_CODE }
脫敏註解類
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonSerialize(using = SensitiveInfoSerialize.class)
public @interface SensitiveInfo {
public SensitiveType value();
}public class SensitiveInfoSerialize extends JsonSerializer<String> implements
ContextualSerializer {
private SensitiveType type;
public SensitiveInfoSerialize() {
}
public SensitiveInfoSerialize(final SensitiveType type) {
this.type = type;
}
@Override
public void serialize(final String s, final JsonGenerator jsonGenerator,
final SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
switch (this.type) {
case CHINESE_NAME: {
jsonGenerator.writeString(SensitiveInfoUtils.chineseName(s));
break;
}
case ID_CARD: {
jsonGenerator.writeString(SensitiveInfoUtils.idCardNum(s));
break;
}
case FIXED_PHONE: {
jsonGenerator.writeString(SensitiveInfoUtils.fixedPhone(s));
break;
}
case MOBILE_PHONE: {
jsonGenerator.writeString(SensitiveInfoUtils.mobilePhone(s));
break;
}
case ADDRESS: {
jsonGenerator.writeString(SensitiveInfoUtils.address(s, 4));
break;
}
case EMAIL: {
jsonGenerator.writeString(SensitiveInfoUtils.email(s));
break;
}
case BANK_CARD: {
jsonGenerator.writeString(SensitiveInfoUtils.bankCard(s));
break;
}
case CNAPS_CODE: {
jsonGenerator.writeString(SensitiveInfoUtils.cnapsCode(s));
break;
}
}
}
@Override
public JsonSerializer<?> createContextual(final SerializerProvider serializerProvider,
final BeanProperty beanProperty) throws JsonMappingException {
if (beanProperty != null) { // 為空直接跳過
if (Objects.equals(beanProperty.getType().getRawClass(), String.class)) { // 非 String 類直接跳過
SensitiveInfo sensitiveInfo = beanProperty.getAnnotation(SensitiveInfo.class);
if (sensitiveInfo == null) {
sensitiveInfo = beanProperty.getContextAnnotation(SensitiveInfo.class);
}
if (sensitiveInfo != null) { // 如果能得到註解，就將註解的 value 傳入 SensitiveInfoSerialize
return new SensitiveInfoSerialize(sensitiveInfo.value());
}
}
return serializerProvider.findValueSerializer(beanProperty.getType(), beanProperty);
}
return serializerProvider.findNullValueSerializer(beanProperty);
}
}脫敏處理util類
public class SensitiveInfoUtils {
/**
* [中文姓名] 只顯示第一個漢字，其他隱藏為2個星號<例子：李**>
*/
public static String chineseName(final String fullName) {
if (StringUtils.isBlank(fullName)) {
return "";
}
final String name = StringUtils.left(fullName, 1);
return StringUtils.rightPad(name, StringUtils.length(fullName), "*");
}
/**
* [中文姓名] 只顯示第一個漢字，其他隱藏為2個星號<例子：李**>
*/
public static String chineseName(final String familyName, final String givenName) {
if (StringUtils.isBlank(familyName) || StringUtils.isBlank(givenName)) {
return "";
}
return chineseName(familyName + givenName);
}
/**
* [身份證號] 顯示最後四位，其他隱藏。共計18位或者15位。<例子：*************5762>
*/
public static String idCardNum(final String id) {
if (StringUtils.isBlank(id)) {
return "";
}
return StringUtils.left(id, 3).concat(StringUtils
.removeStart(StringUtils.leftPad(StringUtils.right(id, 3), StringUtils.length(id), "*"),
"***"));
}
/**
* [固定電話] 後四位，其他隱藏<例子：****1234>
*/
public static String fixedPhone(final String num) {
if (StringUtils.isBlank(num)) {
return "";
}
return StringUtils.leftPad(StringUtils.right(num, 4), StringUtils.length(num), "*");
}
/**
* [手機號碼] 前三位，後四位，其他隱藏<例子:138******1234>
*/
public static String mobilePhone(final String num) {
if (StringUtils.isBlank(num)) {
return "";
}
return StringUtils.left(num, 2).concat(StringUtils
.removeStart(StringUtils.leftPad(StringUtils.right(num, 2), StringUtils.length(num), "*"),
"***"));
}
/**
* [地址] 只顯示到地區，不顯示詳細地址；我們要對個人資訊增強保護<例子：北京市海淀區****>
*
* @param sensitiveSize 敏感資訊長度
*/
public static String address(final String address, final int sensitiveSize) {
if (StringUtils.isBlank(address)) {
return "";
}
final int length = StringUtils.length(address);
return StringUtils.rightPad(StringUtils.left(address, length - sensitiveSize), length, "*");
}
/**
* [電子郵箱] 郵箱字首僅顯示第一個字母，字首其他隱藏，用星號代替，@及後面的地址顯示<例子:g**@163.com>
*/
public static String email(final String email) {
if (StringUtils.isBlank(email)) {
return "";
}
final 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>
*/
public static String bankCard(final String cardNum) {
if (StringUtils.isBlank(cardNum)) {
return "";
}
return StringUtils.left(cardNum, 6).concat(StringUtils.removeStart(
StringUtils.leftPad(StringUtils.right(cardNum, 4), StringUtils.length(cardNum), "*"),
"******"));
}
/**
* [公司開戶銀行聯號] 公司開戶銀行聯行號,顯示前兩位，其他用星號隱藏，每位1個星號<例子:12********>
*/
public static String cnapsCode(final String code) {
if (StringUtils.isBlank(code)) {
return "";
}
return StringUtils.rightPad(StringUtils.left(code, 2), StringUtils.length(code), "*");
}
}效果圖：
此文主要參考了下面幾位大神的文章
http://www.scienjus.com/get-field-annotation-property-by-jackson-contextualserializer/
http://blog.csdn.net/liuc0317/article/details/48787793
http://www.voidcn.com/article/p-ezjgnfeh-bee.html