.Net集成敏感詞組件的步驟

Posted on by

ToolGood.Words

首先我們要使用的開源組件是 ToolGood.Words

通過簡單的瞭解，我們可以知道它可以針對敏感詞及其拼音、跳詞等變形進行檢測，在實際的應用場景中能滿足大部分的需求。
具體的用法在這裡不做過多的介紹，接下來我們需要做的事情是如何在現有代碼中快速且方便的情況下接入敏感詞組件。很顯然，如果我們按照組件寫的示例去操作，會發現需要在現有的代碼中進行大量重構的操作，這顯然會累垮 VS 。熟悉水弟的朋友首先就會想到使用 AOP 的方式去優化處理。

ValidationAttribute

我們先定義兩個簡單的模型來綁定輸入參數，一個是隻要輸入含有敏感詞就會報錯，一個是隻要輸入含有敏感詞就會把相關的字符串替換為 * ，代碼如下：

    public class MinganCheckInput
    {
        [MinGanCheck]
        public string Text { get; set; }
    }
    
    public class MinganReplaceInput
    {
        [MinGanReplace]
        public string Text { get; set; }
    }

其中 [MinGanCheck] 和 [MinGanReplace] 是我們定義的特性標記，將其繼承 ValidationAttribute，就和我們常用的 [Required] 一樣方便，哪裡敏感點哪裡。

  /// <summary>
    /// 敏感詞檢查的特性，一匹配就拋異常
    /// </summary>
    [AttributeUsage(AttributeTargets.Property)]
    public class MinGanCheck : ValidationAttribute
    {
        protected override ValidationResult IsValid(object value, ValidationContext validationContext)
        {
            throw  new NotImplementedException();
        }
    }

    /// <summary>
    /// 敏感詞替換
    /// </summary>
    [AttributeUsage(AttributeTargets.Property)]
    public class MinGanReplace : ValidationAttribute
    {
        protected override ValidationResult IsValid(object value, ValidationContext validationContext)
        {
            return ValidationResult.Success;
        }
    }

接下來就是實現 ValidationAttribute 的功能，如果看過水弟寫過的 aop 文章，這時候就不會直接在校驗的方法中直接引入 ToolGood.Words ，這樣會帶來很大的耦合，也不便於我們替換為其他的敏感詞組件或服務。所以我們隻要再多一層抽象就可以瞭。

       // 檢查
        protected override ValidationResult IsValid(object value, ValidationContext validationContext)
        {
            return validationContext.GetService<IMinGanCheckValidator>().IsValid(value, validationContext);
        }
        // 替換
        protected override ValidationResult IsValid(object value, ValidationContext validationContext)
        {
            validationContext.GetService<IMinGanReplaceValidator>().IsValid(value, validationContext);
            return ValidationResult.Success;
        }

接著我們分別實現 IMinGanCheckValidator 和 IMinGanReplaceValidator 的功能，也即檢查和替換功能。

// 檢查
   public class MinGanCheckValidator : IMinGanCheckValidator
    {
        public ValidationResult IsValid(object value, ValidationContext validationContext)
        {
            if (value is string v)
            {
                if (!String.IsNullOrEmpty(v))
                {
                   // 文字檢查
                    if (MinGanProvider.Instance.IllegalWordsSearch.ContainsAny(v))
                    {
                        return new ValidationResult("存在敏感詞", new[] { validationContext.MemberName });
                    }
                    // 檢查拼音
                    if (MinGanProvider.Instance.IllegalWordsSearch.ContainsAny(WordsHelper.GetPinyin(v)))
                    {
                        return new ValidationResult("存在敏感詞",new []{ validationContext.MemberName });
                    }
                    // todo:其他變種
                }
            }
            return ValidationResult.Success;
        }
    }

//替換
 public class MinGanReplaceValidator : IMinGanReplaceValidator
    {
        public void Replace(object value, ValidationContext validationContext)
        {
            if (value is string v)
            {
                if (!String.IsNullOrEmpty(v))
                {
                    v = MinGanProvider.Instance.IllegalWordsSearch.Replace(v);
                    SetPropertyByName(validationContext.ObjectInstance,validationContext.MemberName, v);
                }
            }
        }
        
        static bool SetPropertyByName(Object obj, string name, Object value)
        {
            var type = obj.GetType();
            var prop = type.GetProperty(name, BindingFlags.Public | BindingFlags.Instance);
            if (null == prop || !prop.CanWrite) return false;
            prop.SetValue(obj, value, null);
            return true;
        }
    }

其中 MinGanProvider.Instance.IllegalWordsSearch 是 ToolGood.Words 中的檢測類單例，這裡不詳細展開。這樣我們就有一個大概能用的敏感詞檢測組件瞭，然而在實際過程中，我們還需要對敏感詞進行管理，特別是需要實時更新敏感詞。

敏感詞熱重載

以 json 配置文件存放敏感詞為例，隻需要配置熱重載就行瞭。
首先是 Program.cs 文件中讓 json 配置文件熱重載。

          public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureAppConfiguration((builderContext, config) =>
                {
                    config.AddJsonFile("IllegalKeywords.json", optional: false, reloadOnChange: true);// 配置可熱重載
                })
                .ConfigureWebHostDefaults(webBuilder => { webBuilder.UseStartup<Startup>(); });

最後是在 Startup.cs 中文件處理重載事件。

           ChangeToken.OnChange(() => Configuration.GetReloadToken(), () =>
            {
                // 敏感詞重載
            var keys= Configuration.GetSection("IllegalKeywords").Get<List<string>>();
            if (keys!=null&&keys.Any())
            {
                var allKeys = new List<string>();
                foreach (var k in keys)
                {
                    allKeys.Add(k); // 增加詞匯
                    allKeys.Add(WordsHelper.ToTraditionalChinese(k)); // 增加繁體
                    allKeys.Add(WordsHelper.GetPinyin(k)); // 增加拼音
                }
                IllegalWordsSearch.SetKeywords(allKeys);
            }
            });

效果

結語

看到這裡，可能有些人已經罵罵咧咧退出網站，說好的兩分鐘，光是看文章和復制代碼都需要十幾分鐘。所以為瞭滿足伸手黨的需求，我寫瞭一個簡單的示例，隻要把對應文件和代碼復制到代碼就可以使用瞭，真的不超過2分鐘就能實現敏感詞檢測。
項目地址：https://github.com/jonechenug/ToolGood.Words.Sample

以上就是.Net集成敏感詞組件的步驟的詳細內容，更多關於.Net集成敏感詞組件的資料請關註WalkonNet其它相關文章！

推薦閱讀：