&

.NET 驗證碼生成神器基于 SkiaSharp 的高性能方案

當(dāng)前位置：點晴教程→知識管理交流 →『技術(shù)文檔交流』

freeflydom

2025年4月3日 15:30 本文熱度 601

前言

在Web應(yīng)用中，圖形驗證碼（CAPTCHA）是防止自動化攻擊的重要防線。推薦一個基于 .NET 的圖形驗證碼模塊，該模塊不僅易于集成，還利用了 SkiaSharp 提供的強大性能優(yōu)勢。

項目介紹

項目最初發(fā)布的 v1 版本基于 ImageSharp，是一個純托管的圖像處理庫，無需額外的本地依賴，非常適合快速部署到各種平臺。

但是隨著項目的發(fā)展和對更高性能的需求，推出了 v2 版本，該版本基于 SkiaSharp 開發(fā)。但發(fā)布到Linux時需要安裝對應(yīng) NativeAssets（ImageSharp則不需要）。

項目特點

高性能：借助 SkiaSharp 的圖像處理能力，驗證碼生成速度更快，資源消耗更低。

易集成：模塊設(shè)計簡潔，API 易于使用，能夠快速集成到現(xiàn)有的 .NET 項目中。

跨平臺支持：雖然在 Linux 環(huán)境下需要安裝對應(yīng)的 NativeAssets，但 SkiaSharp 依然提供了出色的跨平臺兼容性。

項目使用

1、注冊服務(wù)

// 默認使用內(nèi)存存儲（AddDistributedMemoryCache）
builder.Services.AddCaptcha(builder.Configuration);
// 如果使用redis分布式緩存
//builder.Services.AddStackExchangeRedisCache(options =>
//{
//    options.Configuration = builder.Configuration.GetConnectionString("RedisCache");
//    options.InstanceName = "captcha:";
//});

2、配置

appsettings.json （不提供配置時，使用默認配置）

{
  "ConnectionStrings": {
    // 使用Redis緩存時，需要配置此項
    // 使用格式參考 Microsoft.Extensions.Caching.StackExchangeRedis
    "RedisCache": "localhost,password=Aa123456."
  },
  "CaptchaOptions": {
    "CaptchaType": 5, // 驗證碼類型
    "CodeLength": 4, // 驗證碼長度, 要放在CaptchaType設(shè)置后  當(dāng)類型為算術(shù)表達式時，長度代表操作的個數(shù), 例如2
    "ExpirySeconds": 60, // 驗證碼過期秒數(shù)
    "IgnoreCase": true, // 比較時是否忽略大小寫
    "StoreageKeyPrefix": "", // 存儲鍵前綴
    "ImageOption": {
      "Animation": false, // 是否啟用動畫
      "FontSize": 32, // 字體大小
      "Width": 100, // 驗證碼寬度
      "Height": 40, // 驗證碼高度
      "BubbleMinRadius": 5, // 氣泡最小半徑
      "BubbleMaxRadius": 10, // 氣泡最大半徑
      "BubbleCount": 3, // 氣泡數(shù)量
      "BubbleThickness": 1.0, // 氣泡邊沿厚度
      "InterferenceLineCount": 3, // 干擾線數(shù)量
      "FontFamily": "kaiti", // 包含actionj,epilog,fresnel,headache,lexo,prefix,progbot,ransom,robot,scandal,kaiti
      "FrameDelay": 15, // 每幀延遲,Animation=true時有效, 默認30
      "BackgroundColor": "#ffffff", //  格式: rgb, rgba, rrggbb, or rrggbbaa format to match web syntax, 默認#fff
      "ForegroundColors": "", //  顏色格式同BackgroundColor,多個顏色逗號分割，隨機選取。不填，空值，則使用默認顏色集
      "Quality": 100, // 圖片質(zhì)量（質(zhì)量越高圖片越大，gif調(diào)整無效可能會更大）
      "TextBold": false // 粗體，該配置2.0.3新增
    }
  }
}

配置可以通過運行Sample.Winfrom生成或直接下載Release運行。

代碼配置

// 全部配置
builder.Services.AddCaptcha(builder.Configuration, option =>
{
    option.CaptchaType = CaptchaType.WORD; // 驗證碼類型
    option.CodeLength = 6; // 驗證碼長度, 要放在CaptchaType設(shè)置后.  當(dāng)類型為算術(shù)表達式時，長度代表操作的個數(shù)
    option.ExpirySeconds = 30; // 驗證碼過期時間
    option.IgnoreCase = true; // 比較時是否忽略大小寫
    option.StoreageKeyPrefix = ""; // 存儲鍵前綴
    option.ImageOption.Animation = true; // 是否啟用動畫
    option.ImageOption.FrameDelay = 30; // 每幀延遲,Animation=true時有效, 默認30
    option.ImageOption.Width = 150; // 驗證碼寬度
    option.ImageOption.Height = 50; // 驗證碼高度
    option.ImageOption.BackgroundColor = SkiaSharp.SKColors.White; // 驗證碼背景色
    option.ImageOption.BubbleCount = 2; // 氣泡數(shù)量
    option.ImageOption.BubbleMinRadius = 5; // 氣泡最小半徑
    option.ImageOption.BubbleMaxRadius = 15; // 氣泡最大半徑
    option.ImageOption.BubbleThickness = 1; // 氣泡邊沿厚度
    option.ImageOption.InterferenceLineCount = 2; // 干擾線數(shù)量
    option.ImageOption.FontSize = 36; // 字體大小
    option.ImageOption.FontFamily = DefaultFontFamilys.Instance.Actionj; // 字體
    
    /* 
     * 中文使用kaiti，其他字符可根據(jù)喜好設(shè)置（可能部分轉(zhuǎn)字符會出現(xiàn)繪制不出的情況）。
     * 當(dāng)驗證碼類型為“ARITHMETIC”時，不要使用“Ransom”字體。（運算符和等號繪制不出來）
     */
     option.ImageOption.TextBold = true;// 粗體，該配置2.0.3新增
});

3、Controller

[Route("captcha")]
[ApiController]
public class CaptchaController : Controller
{
    private readonly ICaptcha _captcha;
    public CaptchaController(ICaptcha captcha)
    {
        _captcha = captcha;
    }
    [HttpGet]
    public IActionResult Captcha(string id)
    {
        var info = _captcha.Generate(id);
        // 有多處驗證碼且過期時間不一樣，可傳第二個參數(shù)覆蓋默認配置。
        //var info = _captcha.Generate(id,120);
        var stream = new MemoryStream(info.Bytes);
        return File(stream, "image/gif");
    }
    /// <summary>
    /// 演示時使用HttpGet傳參方便，這里僅做返回處理
    /// </summary>
    [HttpGet("validate")]
    public bool Validate(string id, string code)
    {
        return _captcha.Validate(id, code);
    }
    /// <summary>
    /// 多次校驗（https://gitee.com/pojianbing/lazy-captcha/issues/I4XHGM）
    /// 演示時使用HttpGet傳參方便，這里僅做返回處理
    /// </summary>
    [HttpGet("validate2")]
    public bool Validate2(string id, string code)
    {
        return _captcha.Validate(id, code, false);
    }
}