java(注解+自定义参数校验) 实现敏感词汇过滤

人生之路坎坎坷坷,跌跌撞撞在所难免。但是,不论跌了多少次,你都必须坚强勇敢地站起来。任何时候,无论你面临着生命的何等困惑抑或经受着多少挫折,无论道路多艰难,希望变得如何渺茫,请你不要绝望,再试一次,坚持到底,成功终将属于勇不言败的你。

导读:本篇文章讲解 java(注解+自定义参数校验) 实现敏感词汇过滤,希望对大家有帮助,欢迎收藏,转发!站点地址:www.bmabk.com,来源:原文

敏感词汇代码来自: https://github.com/elulis/sensitive-words.

导入依赖

<!-- hibernate校验依赖包-->
<dependency>
 	<groupId>org.hibernate</groupId>
 	<artifactId>hibernate-validator</artifactId>
	<version>6.1.0.Final</version>
</dependency>

敏感词汇代码如下

StringPointer

import java.io.Serializable;
import java.util.HashMap;
import java.util.TreeMap;

/**
 * 没有注释的方法与{@link String}类似<br/>
 * <b>注意:</b>没有(数组越界等的)安全检查<br/>
 * 可以作为{@link HashMap}和{@link TreeMap}的key
 * 
 * @author ZhangXiaoye
 * @date 2017年1月5日 下午2:11:56
 */
public class StringPointer implements Serializable, CharSequence, Comparable<StringPointer>{
	
	private static final long serialVersionUID = 1L;

	protected final char[] value;
	
	protected final int offset;
	
	protected final int length;
	
	private int hash = 0;
	
	public StringPointer(String str){
		value = str.toCharArray();
		offset = 0;
		length = value.length;
	}
	
	public StringPointer(char[] value, int offset, int length){
		this.value = value;
		this.offset = offset;
		this.length = length;
	}
	
	/**
	 * 计算该位置后(包含)2个字符的hash值
	 * 
	 * @param i 从 0 到 length - 2
	 * @return hash值
	 * @author ZhangXiaoye
	 * @date 2017年1月5日 下午2:23:02
	 */
	public int nextTwoCharHash(int i){
		return 31 * value[offset + i] + value[offset + i + 1];
	}
	
	/**
	 * 计算该位置后(包含)2个字符和为1个int型的值<br/>
	 * int值相同表示2个字符相同
	 * 
	 * @param i 从 0 到 length - 2
	 * @return int值
	 * @author ZhangXiaoye
	 * @date 2017年1月5日 下午2:46:58
	 */
	public int nextTwoCharMix(int i){
		return (value[offset + i] << 16) | value[offset + i + 1];
	}
	
	/**
	 * 该位置后(包含)的字符串,是否以某个词(word)开头
	 * 
	 * @param i 从 0 到 length - 2
	 * @param word 词
	 * @return 是否?
	 * @author ZhangXiaoye
	 * @date 2017年1月5日 下午3:13:49
	 */
	public boolean nextStartsWith(int i, StringPointer word){
		// 是否长度超出
		if(word.length > length - i){
			return false;
		}
		// 从尾开始判断
		for(int c =  word.length - 1; c >= 0; c --){
			if(value[offset + i + c] != word.value[word.offset + c]){
				return false;
			}
		}
		return true;
	}
	
	/**
	 * 填充(替换)
	 * 
	 * @param begin 从此位置开始(含)
	 * @param end 到此位置结束(不含)
	 * @param fillWith 以此字符填充(替换)
	 * @author ZhangXiaoye
	 * @date 2017年1月5日 下午3:29:21
	 */
	public void fill(int begin, int end, char fillWith){
		for(int i = begin; i < end; i ++){
			value[offset + i] = fillWith;
		}
	}
	
	public int length(){
		return length;
	}
	
	public char charAt(int i){
		return value[offset + i];
	}
	
	public StringPointer substring(int begin){
		return new StringPointer(value, offset + begin, length - begin);
	}
	
	public StringPointer substring(int begin, int end){
		return new StringPointer(value, offset + begin, end - begin);
	}

	@Override
	public CharSequence subSequence(int start, int end) {
		return substring(start, end);
	}
	
	public String toString(){
		return new String(value, offset, length);
	}
	
	public int hashCode() {
		int h = hash;
		if (h == 0 && length > 0) {
			for (int i = 0; i < length; i++) {
				h = 31 * h + value[offset + i];
			}
			hash = h;
		}
		return h;
	}
	
	public boolean equals(Object anObject) {
        if (this == anObject) {
            return true;
        }
        if (anObject instanceof StringPointer) {
        	StringPointer that = (StringPointer)anObject;
            if (length == that.length) {
                char v1[] = this.value;
                char v2[] = that.value;
                for(int i = 0; i < this.length; i ++){
                	if(v1[this.offset + i] != v2[that.offset + i]){
                		return false;
                	}
                }
                return true;
            }
        }
        return false;
    }

	@Override
	public int compareTo(StringPointer that) {
		int len1 = this.length;
        int len2 = that.length;
        int lim = Math.min(len1, len2);
        char v1[] = this.value;
        char v2[] = that.value;

        int k = 0;
        while (k < lim) {
            char c1 = v1[this.offset + k];
            char c2 = v2[that.offset + k];
            if (c1 != c2) {
                return c1 - c2;
            }
            k++;
        }
        return len1 - len2;
	}

}

SensitiveNode

import java.io.Serializable;
import java.util.TreeSet;
/**
 * 敏感词节点,每个节点包含了以相同的2个字符开头的所有词
 * 
 * @author ZhangXiaoye
 * @date 2017年1月5日 下午5:06:26
 */
public class SensitiveNode implements Serializable{
	
	private static final long serialVersionUID = 1L;

	/**
	 * 头两个字符的mix,mix相同,两个字符相同
	 */
	protected final int headTwoCharMix;
	
	/**
	 * 所有以这两个字符开头的词表
	 */
	protected final TreeSet<StringPointer> words = new TreeSet<StringPointer>();
	
	/**
	 * 下一个节点
	 */
	protected SensitiveNode next;
	
	public SensitiveNode(int headTwoCharMix){
		this.headTwoCharMix = headTwoCharMix;
	}
	
	public SensitiveNode(int headTwoCharMix, SensitiveNode parent){
		this.headTwoCharMix = headTwoCharMix;
		parent.next = this;
	}
}

SensitiveFilter

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.Serializable;
import java.nio.charset.StandardCharsets;
import java.util.NavigableSet;

/**
 * 敏感词过滤器,以过滤速度优化为主。<br/>
 * * 增加一个敏感词:{@link #put(String)} <br/>
 * * 过滤一个句子:{@link #filter(String, char)} <br/>
 * * 获取默认的单例
 *
 * @author ZhangXiaoye
 * @date 2017年1月5日 下午4:18:38
 */
public class SensitiveFilter implements Serializable {

    private static final long serialVersionUID = 1L;


    /**
     * 构建一个空的filter
     *
     * @author ZhangXiaoye
     * @date 2017年1月5日 下午4:18:07
     */
    private SensitiveFilter() {

    }

	/**
	 * 默认的单例,使用自带的敏感词库
	 */
	public static final SensitiveFilter DEFAULT = new SensitiveFilter(
			new BufferedReader(new InputStreamReader(
					ClassLoader.getSystemResourceAsStream("sensi_words.txt")
					, StandardCharsets.UTF_8)));

    /**
     * 为2的n次方,考虑到敏感词大概在10k左右,
     * 这个数量应为词数的数倍,使得桶很稀疏
     * 提高不命中时hash指向null的概率,
     * 加快访问速度。
     */
    static final int DEFAULT_INITIAL_CAPACITY = 131072;

    /**
     * 类似HashMap的桶,比较稀疏。
     * 使用2个字符的hash定位。
     */
    protected SensitiveNode[] nodes = new SensitiveNode[DEFAULT_INITIAL_CAPACITY];


    /**
     * 加载一个文件中的词典,并构建filter<br/>
     * 文件中,每行一个敏感词条<br/>
     * <b>注意:</b>读取完成后会调用{@link BufferedReader#close()}方法。<br/>
     * <b>注意:</b>读取中的{@link IOException}不会抛出
     *
     * @param reader
     * @author ZhangXiaoye
     * @date 2017年1月5日 下午4:21:06
     */
    public SensitiveFilter(BufferedReader reader) {
        try {
            for (String line = reader.readLine(); line != null; line = reader.readLine()) {
                put(line);
            }
            reader.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 增加一个敏感词,如果词的长度(trim后)小于2,则丢弃<br/>
     * 此方法(构建)并不是主要的性能优化点。
     *
     * @param word
     * @author ZhangXiaoye
     * @date 2017年1月5日 下午2:35:21
     */
    public boolean put(String word) {
        // 长度小于2的不加入
        if (word == null || word.trim().length() < 2) {
            return false;
        }
        // 两个字符的不考虑
        if (word.length() == 2 && word.matches("\\w\\w")) {
            return false;
        }
        StringPointer sp = new StringPointer(word.trim());
        // 计算头两个字符的hash
        int hash = sp.nextTwoCharHash(0);
        // 计算头两个字符的mix表示(mix相同,两个字符相同)
        int mix = sp.nextTwoCharMix(0);
        // 转为在hash桶中的位置
        int index = hash & (nodes.length - 1);

        // 从桶里拿第一个节点
        SensitiveNode node = nodes[index];
        if (node == null) {
            // 如果没有节点,则放进去一个
            node = new SensitiveNode(mix);
            // 并添加词
            node.words.add(sp);
            // 放入桶里
            nodes[index] = node;
        } else {
            // 如果已经有节点(1个或多个),找到正确的节点
            for (; node != null; node = node.next) {
                // 匹配节点
                if (node.headTwoCharMix == mix) {
                    node.words.add(sp);
                    return true;
                }
                // 如果匹配到最后仍然不成功,则追加一个节点
                if (node.next == null) {
                    new SensitiveNode(mix, node).words.add(sp);
                    return true;
                }
            }
        }
        return true;
    }

    /**
     * 对句子进行敏感词过滤<br/>
     * 如果无敏感词返回输入的sentence对象,即可以用下面的方式判断是否有敏感词:<br/><code>
     * String result = filter.filter(sentence, '*');<br/>
     * if(result != sentence){<br/>
     * &nbsp;&nbsp;// 有敏感词<br/>
     * }
     * </code>
     *
     * @param sentence 句子
     * @param replace  敏感词的替换字符
     * @return 过滤后的句子
     * @author ZhangXiaoye
     * @date 2017年1月5日 下午4:16:31
     */
    public String filter(String sentence, char replace) {
        // 先转换为StringPointer
        StringPointer sp = new StringPointer(sentence);

        // 标示是否替换
        boolean replaced = false;

        // 匹配的起始位置
        int i = 0;
        while (i < sp.length - 2) {
            /*
             * 移动到下一个匹配位置的步进:
             * 如果未匹配为1,如果匹配是匹配的词长度
             */
            int step = 1;
            // 计算此位置开始2个字符的hash
            int hash = sp.nextTwoCharHash(i);
            /*
             * 根据hash获取第一个节点,
             * 真正匹配的节点可能不是第一个,
             * 所以有后面的for循环。
             */
            SensitiveNode node = nodes[hash & (nodes.length - 1)];
            /*
             * 如果非敏感词,node基本为null。
             * 这一步大幅提升效率
             */
            if (node != null) {
                /*
                 * 如果能拿到第一个节点,
                 * 才计算mix(mix相同表示2个字符相同)。
                 * mix的意义和HashMap先hash再equals的equals部分类似。
                 */
                int mix = sp.nextTwoCharMix(i);
                /*
                 * 循环所有的节点,如果非敏感词,
                 * mix相同的概率非常低,提高效率
                 */
                outer:
                for (; node != null; node = node.next) {
                    /*
                     * 对于一个节点,先根据头2个字符判断是否属于这个节点。
                     * 如果属于这个节点,看这个节点的词库是否命中。
                     * 此代码块中访问次数已经很少,不是优化重点
                     */
                    if (node.headTwoCharMix == mix) {
                        /*
                         * 查出比剩余sentence小的最大的词。
                         * 例如剩余sentence为"色情电影哪家强?",
                         * 这个节点含三个词从小到大为:"色情"、"色情电影"、"色情信息"。
                         * 则从“色情电影”开始向前匹配
                         */
                        NavigableSet<StringPointer> desSet = node.words.headSet(sp.substring(i), true);
                        if (desSet != null) {
                            for (StringPointer word : desSet.descendingSet()) {
                                /*
                                 * 仍然需要再判断一次,例如"色情信息哪里有?",
                                 * 如果节点只包含"色情电影"一个词,
                                 * 仍然能够取到word为"色情电影",但是不该匹配。
                                 */
                                if (sp.nextStartsWith(i, word)) {
                                    // 匹配成功,将匹配的部分,用replace制定的内容替代
                                    sp.fill(i, i + word.length, replace);
                                    // 跳过已经替代的部分
                                    step = word.length;
                                    // 标示有替换
                                    replaced = true;
                                    // 跳出循环(然后是while循环的下一个位置)
                                    break outer;
                                }
                            }
                        }

                    }
                }
            }
            // 移动到下一个匹配位置
            i += step;
        }
        // 如果没有替换,直接返回入参(节约String的构造copy)
        if (replaced) {
            return sp.toString();
        } else {
            return sentence;
        }
    }

    /**
     * 是否存在敏感词汇
     * @return true 存在
     */
    public boolean isExist(String sentence) {
        // 先转换为StringPointer
        StringPointer sp = new StringPointer(sentence);
        // 匹配的起始位置
        int i = 0;
        while (i < sp.length - 2) {
            /*
             * 移动到下一个匹配位置的步进:
             * 如果未匹配为1,如果匹配是匹配的词长度
             */
            int step = 1;
            // 计算此位置开始2个字符的hash
            int hash = sp.nextTwoCharHash(i);
            /*
             * 根据hash获取第一个节点,
             * 真正匹配的节点可能不是第一个,
             * 所以有后面的for循环。
             */
            SensitiveNode node = nodes[hash & (nodes.length - 1)];
            /*
             * 如果非敏感词,node基本为null。
             * 这一步大幅提升效率
             */
            if (node != null) {
                /*
                 * 如果能拿到第一个节点,
                 * 才计算mix(mix相同表示2个字符相同)。
                 * mix的意义和HashMap先hash再equals的equals部分类似。
                 */
                int mix = sp.nextTwoCharMix(i);
                /*
                 * 循环所有的节点,如果非敏感词,
                 * mix相同的概率非常低,提高效率
                 */
                outer:
                for (; node != null; node = node.next) {
                    /*
                     * 对于一个节点,先根据头2个字符判断是否属于这个节点。
                     * 如果属于这个节点,看这个节点的词库是否命中。
                     * 此代码块中访问次数已经很少,不是优化重点
                     */
                    if (node.headTwoCharMix == mix) {
                        /*
                         * 查出比剩余sentence小的最大的词。
                         * 例如剩余sentence为"色情电影哪家强?",
                         * 这个节点含三个词从小到大为:"色情"、"色情电影"、"色情信息"。
                         * 则从“色情电影”开始向前匹配
                         */
                        NavigableSet<StringPointer> desSet = node.words.headSet(sp.substring(i), true);
                        if (desSet != null) {
                            for (StringPointer word : desSet.descendingSet()) {
                                /*
                                 * 仍然需要再判断一次,例如"色情信息哪里有?",
                                 * 如果节点只包含"色情电影"一个词,
                                 * 仍然能够取到word为"色情电影",但是不该匹配。
                                 */
                                if (sp.nextStartsWith(i, word)) {
                                    // 结束匹配
                                    return true;
                                }
                            }
                        }

                    }
                }
            }
            // 移动到下一个匹配位置
            i += step;
        }
        return false;
    }
}

测试成功但运行失败,原因读取Resources下的文件的坑

参考链接: https://blog.csdn.net/baidu_24352355/article/details/91988282.

之前以为只要在resources下创建好一个json、xml文件后,希望能够通过 ResourceUtils.getFile()来获取到对应的文件,
本地idea运行后是可以读取到文件,所以理所当然的部署了,但是在服务器上运行时,发现根本没有执行这部分代码,
最后发现,springboot构建后,除了配置yml文件,不会将resouces下的文件构建部署到jar包内,所以读取不到,
解决办法:通过类加载形式,加载到该具体文件即可
//最终解决方案:SensitiveFilter.class.getClassLoader().getResourceAsStream("sensi_words.txt")
    /**
     * 构建一个空的filter
     *
     * @author ZhangXiaoye
     * @date 2017年1月5日 下午4:18:07
     */
    private SensitiveFilter() {

    }

    /**
     * 静态内部类单例模式
     * 由于在调用 SingletonHolder.instance 的时候,才会对单例进行初始化,而且通过反射,是不能从外部类获取内部类的属性的。所以这种形式,很好的避免了反射入侵。
     * 优点:线程安全、保证单例对象唯一性,同时也延迟了单例的实例化
     * 缺点:需要两个类去做到这一点,虽然不会创建静态内部类的对象,但是其 Class 对象还是会被创建,而且是属于永久代的对象。(综合来看,私以为这种方式是最好的单例模式)
     */
    private static class SingletonHolder {
        private final static SensitiveFilter DEFAULT = new SensitiveFilter(new BufferedReader(new InputStreamReader(
                SensitiveFilter.class.getClassLoader().getResourceAsStream("sensi_words.txt"), StandardCharsets.UTF_8)
        ));
    }

    public static SensitiveFilter getInstance() {
        return SingletonHolder.DEFAULT;
    }

自定义敏感词注解

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * 自定义注解:敏感词汇检验
 */
@Documented
@Constraint(validatedBy = {SensiCustomValid.class })
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Sensi {

    String message() default "存在敏感词汇";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

}

实现ConstraintValidator接口

import org.apache.commons.lang3.StringUtils;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

/**
 * 存在敏感词汇则校验失败
 */
public class SensiCustomValid implements ConstraintValidator<Sensi,String> {

    @Override
    public void initialize(Sensi constraintAnnotation) {}
    
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        SensitiveFilter filter = SensitiveFilter.getInstance();
        if(StringUtils.isNotBlank(value) && filter.isExist(value)){
            return false;
        }
        return true;
    }
}

如果需要将参数中存在的敏感词汇替换成 * ,则在建立一个注解即可

在vo类里使用

public class AddGoodsVo {
	@Sensi(message = "商品名称存在敏感词汇")
	private String goodsName;
}

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/133958.html

(0)
飞熊的头像飞熊bm

相关推荐

发表回复

登录后才能评论
极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!