前言
在Web应用中,图形验证码(CAPTCHA)是防止自动化攻击的重要防线。推荐一个基于 .NET 的图形验证码模块,该模块不仅易于集成,还利用了 SkiaSharp 提供的强大性能优势。
项目介绍
项目最初发布的 v1 版本基于 ImageSharp,是一个纯托管的图像处理库,无需额外的本地依赖,非常适合快速部署到各种平台。
但是随着项目的发展和对更高性能的需求,推出了 v2 版本,该版本基于 SkiaSharp 开发。但发布到Linux时需要安装对应 NativeAssets(ImageSharp则不需要)。
项目特点
高性能:借助 SkiaSharp 的图像处理能力,验证码生成速度更快,资源消耗更低。
易集成:模块设计简洁,API 易于使用,能够快速集成到现有的 .NET 项目中。
跨平台支持:虽然在 Linux 环境下需要安装对应的 NativeAssets,但 SkiaSharp 依然提供了出色的跨平台兼容性。
项目使用
1、注册服务
cs
// 默认使用内存存储(AddDistributedMemoryCache)
builder.Services.AddCaptcha(builder.Configuration);
// 如果使用redis分布式缓存
//builder.Services.AddStackExchangeRedisCache(options =>
//{
// options.Configuration = builder.Configuration.GetConnectionString("RedisCache");
// options.InstanceName = "captcha:";
//});
2、配置
appsettings.json (不提供配置时,使用默认配置)
json
{
"ConnectionStrings": {
// 使用Redis缓存时,需要配置此项
// 使用格式参考 Microsoft.Extensions.Caching.StackExchangeRedis
"RedisCache": "localhost,password=Aa123456."
},
"CaptchaOptions": {
"CaptchaType": 5, // 验证码类型
"CodeLength": 4, // 验证码长度, 要放在CaptchaType设置后 当类型为算术表达式时,长度代表操作的个数, 例如2
"ExpirySeconds": 60, // 验证码过期秒数
"IgnoreCase": true, // 比较时是否忽略大小写
"StoreageKeyPrefix": "", // 存储键前缀
"ImageOption": {
"Animation": false, // 是否启用动画
"FontSize": 32, // 字体大小
"Width": 100, // 验证码宽度
"Height": 40, // 验证码高度
"BubbleMinRadius": 5, // 气泡最小半径
"BubbleMaxRadius": 10, // 气泡最大半径
"BubbleCount": 3, // 气泡数量
"BubbleThickness": 1.0, // 气泡边沿厚度
"InterferenceLineCount": 3, // 干扰线数量
"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, // 图片质量(质量越高图片越大,gif调整无效可能会更大)
"TextBold": false // 粗体,该配置2.0.3新增
}
}
}
配置可以通过运行Sample.Winfrom生成或直接下载Release运行。
代码配置
cs
// 全部配置
builder.Services.AddCaptcha(builder.Configuration, option =>
{
option.CaptchaType = CaptchaType.WORD; // 验证码类型
option.CodeLength = 6; // 验证码长度, 要放在CaptchaType设置后. 当类型为算术表达式时,长度代表操作的个数
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; // 气泡数量
option.ImageOption.BubbleMinRadius = 5; // 气泡最小半径
option.ImageOption.BubbleMaxRadius = 15; // 气泡最大半径
option.ImageOption.BubbleThickness = 1; // 气泡边沿厚度
option.ImageOption.InterferenceLineCount = 2; // 干扰线数量
option.ImageOption.FontSize = 36; // 字体大小
option.ImageOption.FontFamily = DefaultFontFamilys.Instance.Actionj; // 字体
/*
* 中文使用kaiti,其他字符可根据喜好设置(可能部分转字符会出现绘制不出的情况)。
* 当验证码类型为"ARITHMETIC"时,不要使用"Ransom"字体。(运算符和等号绘制不出来)
*/
option.ImageOption.TextBold = true;// 粗体,该配置2.0.3新增
});
3、Controller
cs
[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);
// 有多处验证码且过期时间不一样,可传第二个参数覆盖默认配置。
//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);
}
}
自定义随机验证码
动图和静态图随机出现, CaptchaType随机。
自定义字体
1、寻找字体
你可以通过fontspace找到自己喜爱的字体。
2、将字体放入项目,并设置为嵌入资源。
当然也可以不作为嵌入资源,放到特定目录也是可以的,只要对下边ResourceFontFamilysFinder稍作修改即可。
.NET Framework下使用
新建MVC项目.NET Framework 选择 4.6.2。
Nuget安装,先安装SkiaSharp, 再安装Lazy.Captcha.Core。
项目效果
项目地址
Gitee:gitee.com/pojianbing/...
总结
以上仅展示了LazyCaptcha v2图形验证码模块的部分功能。更多实用特性和详细信息,请大家访问项目地址。
希望通过本文能为 .NET 各种图形验证码开发方面提供有价值的参考。欢迎在评论区留言交流,分享您的宝贵经验和建议。
最后
如果你觉得这篇文章对你有帮助,不妨点个赞支持一下!你的支持是我继续分享知识的动力。如果有任何疑问或需要进一步的帮助,欢迎随时留言。
也可以加入微信公众号 [DotNet技术匠] 社区,与其他热爱技术的同行一起交流心得,共同成长!
优秀是一种习惯,欢迎大家留言学习!