io.github.opensabre.boot.annotations.Desensitization Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opensabre-starter-boot Show documentation

The newest version!

package io.github.opensabre.boot.annotations;

import com.fasterxml.jackson.annotation.JacksonAnnotationsInside;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import io.github.opensabre.boot.sensitive.rest.DesensitizationSerialize;
import io.github.opensabre.boot.sensitive.rule.DefaultSensitiveRule;

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

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
@JacksonAnnotationsInside
@JsonSerialize(using = DesensitizationSerialize.class)
public @interface Desensitization {

    /**
     * 脱敏数据类型，只有在CUSTOM的时候，retainPrefixCount和retainSuffixCount生效
     *
     * @return 脱敏器类型 type
     */
    DefaultSensitiveRule type() default DefaultSensitiveRule.CUSTOM;

    /**
     * @return 保留前缀个数
     */
    int retainPrefixCount() default 0;

    /**
     * @return 保留后缀个数
     */
    int retainSuffixCount() default 0;

    /**
     * @return 掩码符号
     */
    char replaceChar() default '*';
}