使用.Net Core實現的一個圖形驗證碼

1992w發表於2020-07-05

SimpleCaptcha是一個使用簡單，基於.Net Standard 2.0的圖形驗證碼模組。它的靈感來源於Edi.Wang的這篇文章https://edi.wang/post/2018/10/13/generate-captcha-code-aspnet-core，我將其中生成驗證碼的程式碼抽取出來進行封裝得到了這個模組。下面介紹一下使用方式。

基本使用方式

安裝SimpleCaptcha

在Nuget中搜尋安裝SimpleCaptcha
image.png

安裝快取模組

SimpleCaptcha依賴Microsoft.Extensions.Caching.Abstractions模組用來儲存驗證碼，所以你需要在專案中根據自己的需要安裝相應的實現包，例如這裡我使用Microsoft.Extensions.Caching.Memory

Startup

修改Startup.cs檔案注入相應的服務：

services.AddMemoryCache()
    .AddSimpleCaptcha(builder =>
    {
        builder.UseMemoryStore();
    });

注入ICaptcha介面

在Controller中注入核心介面ICaptcha

private readonly ICaptcha _captcha;

public HomeController(ICaptcha captcha)
{
    _captcha = captcha;
}

生成驗證碼

使用ICaptcha介面的Generate方法生成驗證碼

public IActionResult Captcha(string id)
{
    var info = _captcha.Generate(id);
    var stream = new MemoryStream(info.CaptchaByteData);
    return File(stream, "image/png");
}

驗證

使用ICaptcha介面的Validate方法對使用者的提交進行驗證

public IActionResult Validate(string id, string code)
{
    var result = _captcha.Validate(id, code);
    return Json(new { success = result });
}

完整的例子可以在這裡找到：https://github.com/1992w/SimpleCaptcha/tree/master/src/SimpleCaptcha.Demo

配置

SimpleCaptcha預留了一些預設的配置項，你可以根據需要自行修改。

設定驗證碼長度

services.AddSimpleCaptcha(builder =>
{
    builder.AddConfiguration(options =>
    {
        options.CodeLength = 6;
    });
});

設定圖片大小

services.AddSimpleCaptcha(builder =>
{
    builder.AddConfiguration(options =>
    {
        options.ImageWidth = 100;
        options.ImageHeight = 36;
    });
});

設定區分大小寫

預設情況下驗證不區分大小寫

services.AddSimpleCaptcha(builder =>
{
    builder.AddConfiguration(options =>
    {
        options.IgnoreCase = false;
    });
});

設定驗證碼有效期

驗證碼預設的有效期為5分鐘

services.AddSimpleCaptcha(builder =>
{
    builder.AddConfiguration(options =>
    {
        options.ExpiryTime =TimeSpan.FromMinutes(10);
    });
});

設定字符集

SimpleCaptcha提供了ICaptchaCodeGenerator介面用來生成字元，預設的實現是從字符集012346789ABCDEFGHIJKLMNOPQRSTUVWXYZ中隨機生成，你可以繼承ICaptchaCodeGenerator介面實現自己的需求。

public class MyCaptchaCodeGenerator : ICaptchaCodeGenerator
{
    public string Generate(int length)
    {
        throw new NotImplementedException();
    }
}

配置自己的生成器

services.AddSimpleCaptcha(builder =>
{
    builder.AddConfiguration(options =>
    {
        options.CodeGenerator = new MyCaptchaCodeGenerator();
    });
});

設定個性化的圖片

如果預設生成的圖片你覺得不符合你的要求，你可以實現ICaptchaImageGenerator介面進行修改

public class CaptchaImageGenerator : ICaptchaImageGenerator
{
    public byte[] Generate(int width, int height, string captchaCode)
    {
        throw new NotImplementedException();
    }
}


services.AddSimpleCaptcha(builder =>
{
    builder.AddConfiguration(options =>
    {
        options.ImageGenerator = new CaptchaImageGenerator();
    });
});

原始碼

所有原始碼可以在這裡獲取：https://github.com/1992w/SimpleCaptcha

感謝

在這裡感謝Edi.Wang分享。

最後

歡迎你對這個模組提出任何的建議和想法。

相關文章