com.feilong.taglib.display.sensitive.SensitiveUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
/*
* Copyright (C) 2008 feilong
*
* 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.feilong.taglib.display.sensitive;
import static com.feilong.core.Validator.isNotNullOrEmpty;
import static com.feilong.core.Validator.isNullOrEmpty;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.feilong.json.JsonUtil;
import com.feilong.lib.lang3.StringUtils;
import com.feilong.core.Validate;
/**
* 敏感词工具类.
*
* 关于 type 优先级:
*
*
* - 先判断类型是否在config/sensitive 配置文件中,如果是那么使用
* - 如果不是,那么使用 {@link SensitiveType}
*
*
*
* @author feilong
* @since 1.10.1
*/
public final class SensitiveUtil{
/** The Constant LOGGER. */
private static final Logger LOGGER = LoggerFactory.getLogger(SensitiveUtil.class);
//---------------------------------------------------------------
/** Don't let anyone instantiate this class. */
private SensitiveUtil(){
//AssertionError不是必须的. 但它可以避免不小心在类的内部调用构造器. 保证该类在任何情况下都不会被实例化.
//see 《Effective Java》 2nd
throw new AssertionError("No " + getClass().getName() + " instances for you!");
}
//---------------------------------------------------------------
/**
* 转换.
*
* @param value
* the value
* @param sensitiveConfig
* the sensitive config
* @return 如果 value 是null,直接返回value
* 如果 value 是blank,直接返回value
* 如果 sensitiveConfig 是null,抛出 {@link NullPointerException}
* 如果 sensitiveConfig.getType() 是null,抛出 {@link NullPointerException}
*/
public static String parse(String value,SensitiveConfig sensitiveConfig){
if (isNullOrEmpty(value)){
return value;
}
//---------------------------------------------------------------
Validate.notNull(sensitiveConfig, "sensitiveConfig can't be null!");
//---------------------------------------------------------------
//since 1.14.0
String type = sensitiveConfig.getType();
Validate.notBlank(type, "type can't be blank!");
char maskChar = sensitiveConfig.getMaskChar();
//---------------------------------------------------------------
//配置式
Integer[] leftAndRightNoMaskLengths = SensitivePropertiesConfig.load(type);
if (isNotNullOrEmpty(leftAndRightNoMaskLengths)){
return parse(value, leftAndRightNoMaskLengths, maskChar);
}
//---------------------------------------------------------------
//枚举式
return parseWithEnum(value, sensitiveConfig, type, maskChar);
}
/**
* 枚举式.
*
* @param value
* the value
* @param sensitiveConfig
* the sensitive config
* @param type
* the type
* @param maskChar
* the mask char
* @return the string
* @since 1.14.0
*/
private static String parseWithEnum(String value,SensitiveConfig sensitiveConfig,String type,char maskChar){
SensitiveType sensitiveType = SensitiveType.toSensitiveType(type);
Validate.notNull(sensitiveType, "sensitiveConfig.getSensitiveType() can't be null!");
//---------------------------------------------------------------
if (LOGGER.isTraceEnabled()){
LOGGER.trace("value:[{}],sensitiveConfig:{}", value, JsonUtil.format(sensitiveConfig));
}
//---------------------------------------------------------------
if (sensitiveType.isNoNeedMask(value)){
return value;
}
//---------------------------------------------------------------
return parse(value, sensitiveType.getLeftAndRightNoMaskLengths(value), maskChar);
}
/**
* Parses the.
*
* @param value
* the value
* @param leftAndRightNoMaskLengths
* the left and right no mask lengths
* @param maskChar
* the mask char
* @return the string
* @since 1.14.0
*/
private static String parse(String value,Integer[] leftAndRightNoMaskLengths,char maskChar){
//左边不需要mask的长度
int leftNoMaskLength = leftAndRightNoMaskLengths[0];
//右边不需要mask的长度
int rightNoMaskLength = leftAndRightNoMaskLengths[1];
//---------------------------------------------------------------
return parse(value, maskChar, leftNoMaskLength, rightNoMaskLength);
}
//---------------------------------------------------------------
/**
* Parses the.
*
* @param value
* the value
* @param maskChar
* the mask char
* @param leftNoMaskLength
* the left no mask length
* @param rightNoMaskLength
* the right no mask length
* @return the string
* @since 1.14.0
*/
public static String parse(String value,char maskChar,int leftNoMaskLength,int rightNoMaskLength){
if (LOGGER.isTraceEnabled()){
String format = "will parse:[{}],maskChar:[{}],leftNoMaskLength:[{}],rightNoMaskLength:[{}]";
LOGGER.trace(format, value, maskChar, leftNoMaskLength, rightNoMaskLength);
}
//---------------------------------------------------------------
StringBuilder sb = new StringBuilder();
sb.append(StringUtils.left(value, leftNoMaskLength));
sb.append(StringUtils.repeat(maskChar, value.length() - leftNoMaskLength - rightNoMaskLength));
sb.append(StringUtils.right(value, rightNoMaskLength));
if (LOGGER.isDebugEnabled()){
String format = "parse:[{}],maskChar:[{}],leftNoMaskLength:[{}],rightNoMaskLength:[{}],result:[{}]";
LOGGER.debug(format, value, maskChar, leftNoMaskLength, rightNoMaskLength, sb.toString());
}
return sb.toString();
}
}