com.taotao.boot.sensitive.other1.SensitiveStrategy Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2022 lzhpo
 *
 * 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
 *
 *     http://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.other1;

import com.taotao.boot.common.utils.log.LogUtils;
import com.taotao.boot.sensitive.other1.annocation.SensitiveFilterWords;
import com.taotao.boot.sensitive.other1.annocation.SensitiveHandler;
import com.taotao.boot.sensitive.other1.annocation.SensitiveKeepLength;
import com.taotao.boot.sensitive.other1.util.SensitiveUtils;
import org.dromara.hutool.core.reflect.ConstructorUtil;
import org.dromara.hutool.core.reflect.FieldUtil;
import org.dromara.hutool.core.text.CharSequenceUtil;
import org.springframework.util.Assert;
import org.springframework.util.ObjectUtils;

import java.lang.reflect.Field;

/**
 * Sensitive strategy
 *
 * @author lzhpo
 */
public enum SensitiveStrategy {

    /** Chinese name */
    CHINESE_NAME() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            return SensitiveUtils.chineseName(wrapper.getFieldValue(), wrapper.getReplacer());
        }
    },

    /** ID card */
    ID_CARD() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            return SensitiveUtils.idCardNum(wrapper.getFieldValue(), 1, 2, wrapper.getReplacer());
        }
    },

    /** Fixed phone */
    FIXED_PHONE() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            return SensitiveUtils.fixedPhone(wrapper.getFieldValue(), wrapper.getReplacer());
        }
    },

    /** Mobile phone */
    MOBILE_PHONE() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            return SensitiveUtils.mobilePhone(wrapper.getFieldValue(), wrapper.getReplacer());
        }
    },

    /** Address */
    ADDRESS() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            return SensitiveUtils.address(wrapper.getFieldValue(), 8, wrapper.getReplacer());
        }
    },

    /** Email */
    EMAIL() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            return SensitiveUtils.email(wrapper.getFieldValue(), wrapper.getReplacer());
        }
    },

    /** Password */
    PASSWORD() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            return SensitiveUtils.password(wrapper.getFieldValue(), wrapper.getReplacer());
        }
    },

    /** Chinese mainland license plates, including ordinary vehicles, new energy vehicles */
    CAR_LICENSE() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            return SensitiveUtils.carLicense(wrapper.getFieldValue(), wrapper.getReplacer());
        }
    },

    /** Bank card */
    BANK_CARD() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            return SensitiveUtils.bankCard(wrapper.getFieldValue(), wrapper.getReplacer());
        }
    },

    /** Customize sensitive keep length */
    CUSTOMIZE_FILTER_WORDS() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            String fieldValue = wrapper.getFieldValue();
            String fieldName = wrapper.getFieldName();
            Object object = wrapper.getObject();
            Field field = FieldUtil.getField(object.getClass(), fieldName);
            SensitiveFilterWords filterWords = field.getAnnotation(SensitiveFilterWords.class);
            if (ObjectUtils.isEmpty(filterWords)) {
                LogUtils.warn(
                        "{} is marked CUSTOMIZE_FILTER_WORDS strategy, "
                                + "but not has @SensitiveFilterWords, will ignore sensitive it.",
                        field.getName());
                return fieldValue;
            }

            char replacer = wrapper.getReplacer();
            String[] words = filterWords.value();
            if (!ObjectUtils.isEmpty(words)) {
                for (String filterWord : words) {
                    if (fieldValue.contains(filterWord)) {
                        String replacers = CharSequenceUtil.repeat(replacer, filterWord.length());
                        fieldValue = fieldValue.replace(filterWord, replacers);
                    }
                }
            }

            return fieldValue;
        }
    },

    /** Customize sensitive keep length */
    CUSTOMIZE_KEEP_LENGTH() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            String fieldValue = wrapper.getFieldValue();
            String fieldName = wrapper.getFieldName();
            Object object = wrapper.getObject();
            Field field = FieldUtil.getField(object.getClass(), fieldName);
            SensitiveKeepLength sensitiveKeepLength = field.getAnnotation(SensitiveKeepLength.class);
            int preKeep = sensitiveKeepLength.preKeep();
            int postKeep = sensitiveKeepLength.postKeep();
            Assert.isTrue(preKeep >= SensitiveConstants.NOP_KEEP, "preKeep must greater than -1");
            Assert.isTrue(postKeep >= SensitiveConstants.NOP_KEEP, "postKeep must greater than -1");

            boolean ignorePreKeep = preKeep <= 0;
            boolean ignoreSuffixKeep = postKeep <= 0;
            if (ignorePreKeep && ignoreSuffixKeep) {
                return fieldValue;
            }

            char replacer = wrapper.getReplacer();
            return CharSequenceUtil.replaceByCodePoint(fieldValue, preKeep, fieldValue.length() - postKeep, replacer);
        }
    },

    /** Customize sensitive handler */
    CUSTOMIZE_HANDLER() {
        @Override
        public String apply(SensitiveWrapper wrapper) {
            String fieldName = wrapper.getFieldName();
            Object object = wrapper.getObject();
            Field field = FieldUtil.getField(object.getClass(), fieldName);
            SensitiveHandler customizeHandler = field.getAnnotation(SensitiveHandler.class);
            Class handlerClass = customizeHandler.value();
            CustomizeSensitiveHandler handler = ConstructorUtil.newInstance(handlerClass);
            return handler.customize(wrapper);
        }
    };

    /**
     * Field sensitive strategy method
     *
     * @param wrapper {@link SensitiveWrapper}
     * @return after sensitive value
     */
    public abstract String apply(SensitiveWrapper wrapper);
}