com.emily.infrastructure.sensitive.annotation.JsonFlexField Maven / Gradle / Ivy

Go to download
package com.emily.infrastructure.sensitive.annotation;

import com.emily.infrastructure.sensitive.SensitiveType;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义jackson注解，标注在属性上，实例如下：
 * {@code
 * @JsonSensitive
 * public class JsonRequest extends Animal {
 *     @JsonFlexField(keys = {"email", "phone"}, value = "fieldValue", types = {SensitiveType.EMAIL, SensitiveType.PHONE})
 *     private String fieldKey;
 *     private String fieldValue;
 *     @JsonFlexField(keys = {"email", "phone"}, value = "fieldValue1")
 *     private String fieldKey1;
 *     private String fieldValue1;
 *     }
 * }
 *
 * @author Emily
 * @since :  Created in 2022/7/19 5:22 下午
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface JsonFlexField {
    /**
     * 要隐藏的参数key名称
     *
     * @return 复杂类型字段名
     */
    String[] keys() default {};

    /**
     * 要隐藏的参数值的key名称
     *
     * @return 值字段名
     */
    String value();

    /**
     * 脱敏类型，见枚举类型{@link SensitiveType}
     *
     * @return 脱敏类型
     */
    SensitiveType[] types() default {};
}