com.taotao.boot.sensitive.houbb.annotation.Sensitive Maven / Gradle / Ivy

Go to download

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

taotao-boot-starter-sensitive

The newest version!

/*
 * Copyright (c) 2020-2030, Shuigedeng ([email protected] & https://blog.taotaocloud.top/).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.taotao.boot.sensitive.houbb.annotation;

import com.taotao.boot.sensitive.houbb.api.ICondition;
import com.taotao.boot.sensitive.houbb.api.IStrategy;
import com.taotao.boot.sensitive.houbb.api.impl.ConditionAlwaysTrue;

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

/**
 * 脱敏 1. 所有的注解都要继承这个注解 2. 如果一个字段上面有多个注解，则根据注解的顺序，依次执行。
 *
 * 设计的考虑： 本来想过将生效条件单独抽离为一个注解，这样可以达到条件注解的复用。 但是有一个缺点，当指定多个策略时，条件的注解就会太宽泛，无法保证精细到每一个策略生效的场景。
 *
 * 平衡的方式： 在 condition 注解中，可以指定策略。默认是全部，如果指定，则只针对其中的某个策略生效。
 */
@Inherited
@Documented
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Sensitive {

    /**
     * 注解生效的条件
     *
     * @return 条件对应的实现类
     */
    Class condition() default ConditionAlwaysTrue.class;

    /**
     * 执行的策略
     *
     * @return 策略对应的类型
     */
    Class strategy();
}