这里想补充下上个文章,感觉有点不太行。因为每次设计新的表结构就要去更新一下,所以,干脆随着我要做的功能去展示我的表结构设计,最终再把所有的表结构包括sql语句统计出来,感觉这样更新会方便很多~
这个文章主要是发送邮件的功能。之前提过,我不是一下子把后端全部完成,然后再一下子搞定后端。所以我前后端是要一起做,然后去完善接口功能。
登录注册这个功能,90%网站都需要。可以不用,但是不能没有。本篇文章主要是实现注册的验证码发放功能(邮件or手机号)。
因为发短信得收费,咳咳,所以这里先做的邮件发送验证码。这个在网络冲浪的时候要注册某些网站账号的时候一般都会遇上把?之前看有的朋友是后台返回一张验证码的图片,这个我后面应该也会做一下,但我觉得意义不是特别大。就跟死验证一样,这样我怎么判定你输入的邮箱是否是正确真实可用的呢?我不想给数据库搞一堆脏数据,麻烦
之前微软是自带一个邮箱发送的库的,现在好像弃用了,虽然还可以用。但是微软推荐了一个新的开源的第三方库MailKit。使用起来相对来说,代码减少了不少,感觉挺好用的,官网也有案例,所以不会细说,官网的很详细,我也不想写博客都是搬运官网的。我的代码会加上自己的注释。哪怕你不看官网,跟着我这个流程走就100%没问题。
正文开始~
先展示下,验证码表的数据库结构:注释说明都有应该无需细说了
建表SQL
create table dbo.AutoCode ( Id INT identity(1, 1) not null /*编号*/, Code VARCHAR(20) not null /*验证码*/, Phone VARCHAR(20) null /*手机号*/, Email VARCHAR(100) null /*邮箱*/, ExpDate FLOAT not null /*过期时间*/, CreateDate DATETIME default getdate() null /*创建日期*/, UpdateDate DATETIME default getdate() null /*修改日期*/ ); alter table dbo.AutoCode add constraint PK_AutoCode_Id primary key (Id); EXEC sp_addextendedproperty 'MS_Description', '验证码表', 'user', dbo, 'table', AutoCode, NULL, NULL; EXEC sp_addextendedproperty 'MS_Description', '编号', 'user', dbo, 'table', AutoCode, 'column', Id; EXEC sp_addextendedproperty 'MS_Description', '验证码', 'user', dbo, 'table', AutoCode, 'column', Code; EXEC sp_addextendedproperty 'MS_Description', '手机号', 'user', dbo, 'table', AutoCode, 'column', Phone; EXEC sp_addextendedproperty 'MS_Description', '邮箱', 'user', dbo, 'table', AutoCode, 'column', Email; EXEC sp_addextendedproperty 'MS_Description', '过期时间 (当前时间+过期时间)的时间戳', 'user', dbo, 'table', AutoCode, 'column', ExpDate; EXEC sp_addextendedproperty 'MS_Description', '创建日期 默认为当前时间', 'user', dbo, 'table', AutoCode, 'column', CreateDate; EXEC sp_addextendedproperty 'MS_Description', '修改日期 默认为当前时间', 'user', dbo, 'table', AutoCode, 'column', UpdateDate;View Code
使用SQLsugar生成实体到FastEasy.Model类库中。
这里插一句吧,前面不是用T4模板搞了个生成仓储模式4个类的代码生成吗,我可能目前对于T4还是不是很会,在T4模板使用第三方库的时候会报一个找不到netstand程序集的问题,我目前很疑惑。然后看了下别人的代码生成器,好像通过后台管理系统就可以,那目前可能我弄的这个还不是很好,但是也极大的减少了一些工作量,以后我会再学习下这块儿,也搞个更方便的代码生成器。T4模板确实有一些局限性……
那我是又在base基类添加了一个方法,CreateModels。我这个数据库空空如也,所以选择了全部生成,当然也可以根据条件去筛选生成,甚至重命名,修改字段名,诸如此类的。这是sqlsugar提供的,真的很强大,可以去学习一下。中秋的时候阿妮亚又更新了一个功能,可以把增删改写成一个方法,但我目前还是没看,只是看到了介绍,这个以后再去看一下,nb~
代码只有一句:第一个参数是生成的目录路径,第二个是命名空间public void CreateModels() { db.DbFirst.IsCreateAttribute().CreateClassFile(@"D:\FastEasy\API\FastEasy.Model\Models\", "FastEasy.Model.Models"); }
如何使用呢。因为是要继承base基类,所以得有个实体,所以我就手动创建了一个空的base类。然后用T4代码生成器分别生成了仓储层和服务层的接口和实现类。主要是避免没有泛型传入,注入的时候报错。然后直接调用这个方法就好了,base类在这里没有作用!只是避免注入解析的时候不报错!
其实应该稍微感觉的出来这样好像有点麻烦……无奈现在手里活不够多,经验欠缺,暂时没有想到别的思路,但我们有代码生成器,终归也麻烦不到哪去,一分钟就搞定了
到这里,我们生成了实体,然后通过T4代码生成器,同样根据数据库生成了各自的仓储层和服务层。这里就不得不提一个弊端了。但是这只能说目前的,就是要先生成实体,因为T4模板不需要运行就可以生成,所以没实体的话,依赖注入会找不到实体而报错,这样就没法运行程序生成实体了。除非就是说,咱们搞个控制台程序单独运行下?反正上边也提到了,这个T4我弄的确实不到位,只是最基础的一些功能,还需继续完善呀~~~
言归正传,这篇文章主要说的是发送邮件!
上面简单提到了,我们使用的是微软推荐的一个第三方库:MailKit+MimeKit。NuGet管理器自行下载。
MailKit是用于向邮箱服务端发送消息的。
MimeKit则是创建邮件实例的(包括并不局限:发送人接收人邮件内容等……)。
再简单点理解就是,通过MailKIt把MimeKit创建的邮件实例发送给邮箱服务端,然后根据你的邮件实例解析发送相应的邮件。似乎我这么说有点绕嘴,但我是这么理解的。甚至一开始我都很好奇,为什么要分成两个包安装呀,或者你内置进去呗?不过他这些个库不仅仅支持你发送邮件,好像还能下载邮件,删除邮件,挺多功能的,确实np,但这些我好像也用不上,有兴趣的同学就自行学习吧~
实现注册发送邮件验证码的功能。其实很简单。首先搞清楚,我们需要的情景是如何的:
- 用户填写邮箱
- 发送验证码到邮箱
- 正则匹配输入的是否正确格式
- 生成随机验证码
- 新增到数据库
- 返回结果给前端成功还是失败
正则也没啥可说的,因为你百度邮箱正则就找到了匹配规则拿过来用就好了。随机验证码这个更没什么可说的Random……当然你可以搞更复杂的,但我觉得我这样应该足够了。
我把这两个方法写在了Common类库中。因为他们不涉及业务逻辑,是可公用的。因此做成静态类方法直接调用就好。
/// <summary> /// 检验是否手机号 /// </summary> /// <param name="number">号码</param> /// <returns></returns> public static bool IsPhone(string number) { string phoneRegex = @"^1\d{10}$"; return Regex.IsMatch(number, phoneRegex); } /// <summary> /// 检验是否邮箱 /// </summary> /// <param name="number">号码</param> /// <returns></returns> public static bool IsEmail(string number) { string emailRegex = @"^\S+@\S+\.\S+$"; return Regex.IsMatch(number, emailRegex); }
/// <summary> /// 创建一个4位随机验证码 /// </summary> /// <returns></returns> public static string CreateRandomCode() { int num = 4; const string chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"; // 根据需要修改字符集合 Random random = new(); char[] code = new char[num]; for (int i = 0; i < num; i++) { code[i] = chars[random.Next(chars.Length)]; } return new string(code); }
包括发送邮件的功能,也理所应当的放在Common类库中。目前因为针对发送邮件的功能,可能封装的方法自由度不高,我贴的代码只做参考,可以根据自己需求完善 邮件实例是用MimeKit中的MimeMessage创建的。里面包含了发送人,接收人,邮件内容等。原本我想传递这个类型的参数,但是官方的这个实例中,发送人和接收人是不能直接赋值的,要Add添加进去。这对我们来说还是有点麻烦的 ,主要是传参太麻烦了。所以自己创建了一个新的实体类型Mime,主要用来传递参数。
using MimeKit; namespace FastEasy.Common.Extension.Mail { public class Mime { /// <summary> /// 主题 /// </summary> public string Subject { get; set; } /// <summary> /// 消息内容 /// </summary> public TextPart Body { get; set; } /// <summary> /// 发送人,默认为“官方” /// </summary> public MailboxAddress From { get; set; } = new MailboxAddress("神里凌华", "[email protected]"); /// <summary> /// 邮箱SMTP授权码 /// </summary> public string Code { get; set; } = "XXXXX"; /// <summary> /// 接收人 /// </summary> public MailboxAddress To { get; set; } /// <summary> /// 465加密25不加密 /// </summary> public int Port { get; set; } = 465; } }
发送邮件方法:通过上面的注释应该都可以看懂,所以不过多解释废话了
/// <summary> /// 发送邮件 /// </summary> /// <param name="mime">邮件消息体</param> /// <returns></returns> public static async Task<bool> SendMail(Mime mime) { //邮件实例 MimeMessage message = new() { Subject = mime.Subject, Body = mime.Body, }; message.To.Add(mime.To); message.From.Add(mime.From); try { using var client = new SmtpClient(); client.Connect("smtp.163.com", mime.Port, mime.Port == 465); client.Authenticate(mime.From.Address, mime.Code); await client.SendAsync(message); client.Disconnect(true); } catch { return false; } return true; }
由此看来,该功能并未涉及程序本身的业务逻辑,因此只要在API程序层调用相应的公共方法,然后调用基类的新增方法即可完成。 API程序层代码:
/// <summary> /// 发送验证码 /// </summary> /// <param name="user">邮箱或者手机号</param> /// <returns></returns> [HttpPost] [SwaagerRoute(SwaggerVersion.FastEasy, "CreateCode")] public async Task<ResultDto> CreateCode(string user) { var result = new ResultDto(); var code = RandomCode.CreateRandomCode(); if (RegexMatch.IsPhone(user)) { result.State = false; result.Message = "暂不支持手机号注册"; } else if (RegexMatch.IsEmail(user)) { var mime = new Mime { Body = new MimeKit.TextPart() { Text = code }, Subject = "验证码", To = new MimeKit.MailboxAddress(user, user), }; var autocode = new AutoCode { Code = code, CreateDate = DateTime.Now, Email = user, ExpDate = DateTimeOffset.Now.AddMinutes(10).ToUnixTimeSeconds(), UpdateDate = DateTime.Now }; if (await EmailKit.SendMail(mime) && await service.CreateEntityAsync(autocode)) { result.State = true; result.Message = "发送成功请查收"; } else { result.State = false; result.Message = "发送失败"; } } else { result.State = false; result.Message = "请输入正确的注册号码"; }; return result; }
我承认我废话太多了,我本意想讲的详细点……看效果:
掰掰,中秋国庆快乐……我还没买到票……
标签:功能,AutoCode,验证码,发送,user,public,邮件 From: https://www.cnblogs.com/zhang-3/p/17738032.html