IdentityServer4之持久化很顺手的事

时间:2024-01-28 15:31:57

前言

原计划打算在春节期间多分享几篇技术文章的,但到最后一篇也没出,偷懒了吗?算是吧,过程是这样的:每次拿出电脑,在孩姥姥家的院子总有阳光沐浴,看不清屏幕,回屋又有点冷(在强行找理由),于是又带着娃遛弯去啦。哪有那么多理由,就是想偷个懒;不过后面几天把计算机组成原理简单过了过,后面整理整理再单独给小伙伴分享吧。

这次接着IdentityServer4说,之前一直用内存数据进行测试演示,在正式项目中肯定是要存数据库的(除非数据固定,用内存方式实现);接下来就用Demo实操的过程说说IdentityServer4的持久化。

正文

IdentityServer4已经对EF Core有很好的支持与封装,用很少的代码就能实现数据持久化,重点还是需要对EF Core有所了解,如果还有不了解的小伙伴,请先花几分钟看看之前分享的关于EF Core的文章(跟我一起学.NetCore之EF Core 实战入门,一看就会)。

主要需要nuget包如下:

  • IdentityServer4:这个包是IdentityServer4的核心包,项目中只要使用IdentityServer4,就必须引入此包;
  • IdentityServer4.EntityFramework:这个包是IdentityServer4针对EF进行封装的包,支持使用EF进行数据的持久化;
  • Microsoft.EntityFrameworkCore.SqlServer:针对不同的数据库引入不同的EF包,这里使用的是微软提供的本地数据库,所以引入的SqlServer;
  • Microsoft.EntityFrameworkCore.Tools:如果需要在程序的包管理控制台进行迁移操作,就需要在指定程序集中安装此包;
  • Microsoft.EntityFrameworkCore.Design:如果需要在命令行中进行迁移操作,就需要在指定程序集中安装此包;

注:Demo演示采用的是包管理控制台的方式进行迁移操作;命令行的方式思路是一样的,只是使用的命令稍微有点不同;

Demo走起来

  1. 项目准备

    这里就不从头到尾敲代码啦,把上一节Authorization Code的代码拷贝过来,重点还是关注持久化的过程(这个理由棒棒哒)。

    源码地址:https://github.com/zyq025/IDS4Demo/tree/main/AuthorizationCode。

  2. 开始撸码

    先把包都引入到程序中,如下图:

    然后在Startup.cs文件中,将原来的内存模式改为从数据库中读取即可;其实最关键的就是IdentityServer4封装好的两个上下文:

    • ConfigurationDbContext:这个上下文主要是针对配置数据,比如客户端(Client)、资源(Resources)等;
    • PersistedGrantDbContext:这个上下文主要是针对用户授权操作时的数据和临时数据,比如同意授权的数据、Token等;

    在代码中只需要针对这这两个上下文指定数据库就行啦,如果没有什么自定义需求,不用其他配置,如下:

  3. 迁移就完事啦

    代码撸完啦,剩下的就是EF迁移的几步走就完事啦(这里演示用的包管理控制台):

    注: 如果程序中有多个上下文,如果不指定上下文,迁移会报错,因为程序不知要到迁移哪个。

    • 新增迁移

      指定ConfigurationDbContext

      指定PersistedGrantDbContext

      参数简要说明:

      -Context : 指定上下文进行迁移;

      -OutputDir:迁移生成的文件存放路径;

      最后迁移的文件结果如下:

    • 根据迁移文件,同步到数据库中

      先同步ConfigurationDbContext

      这时候对应的数据库就生成了,而且对应配置相关的表已经在数据库创建:

      再同步PersistedGrantDbContext

      这个表少,就两张:

    其实这样就已经可以啦,只要在数据库对应的表中添加对应的数据,就能进行操作啦; 那新手小伙伴肯定得苦恼啦,这么多表,咋知道哪个表存啥数据啊;不急,咱们把原来内存中的数据存进去,然后再看看每个表存了啥,这不就更加明了啦,比一个一个表说的还直接,这种方式还能促使小伙伴动手,不然都不知道里面存了啥(哈哈哈,高招)。那就多出来第四步,如下......

  4. 加个种子数据美美哒

    这里说的种子数据就是指原来在内存中数据,把它们读出来存到数据库中就行;很简单,通过上文对应直接存即可,代码如下:

    方法写好啦,直接在Configure中调用即可,如下:

    这样就完工啦,把授权服务器、资源服务器、客户端都启动,走一遍流程,看看是不是成功啦,不出意外一切顺利,这时再返过来看看每个表中都存啥数据,就真的很清晰啦。这里就不一一截图说,相信小伙伴都能搞得明白。

到这肯定有小伙伴要说话啦,用户那还是用的内存;之所以没放到上面一起说,那是因为用户这块的控制权完全在我们自己手里,可以自己设计(就是用户、菜单、角色那一套),也可以集成微软封装好的Identity(把常用的用户那一套已经封装啦)。

这里演示肯定挑着爽的玩,就集成微软封装好的Identity,来,继续撸码:

  1. 引入相关nuget包

    引入的包简单说明

    IdentityServer4.AspNetIdentity:IdentityServer4对微软封装的Indentity的支持;

    Microsoft.AspNetCore.Identity.EntityFrameworkCore:对Identity提供EF支持;

  2. 撸码就对啦

    因为IdentityDbContext是抽象类,不能直接使用,这里需要针对IdentityDbContext定义一个子类ApplicationDbContext,如下:

    然后在Startup.cs中注册相关服务即可:

  3. 迁移及同步:这里没有指定输出路径,小伙伴根据自己的需要进行指定。

    数据库中生成相关的表,如下:

  4. 更改登录和登出逻辑

    登出的时调用 _signInManager.SignOutAsync();即可

  5. 加点种子数据,即程序启动时加入用户数据

    方法写好,同样在Configure中调用即可,种子数据准备好之后,就可以用Zoe用户进行登录啦,密码就是Zoe123456&

这里就不专门针对微软封装的Identity说的那么细啦,小伙伴可以参考文档:https://docs.microsoft.com/zh-cn/aspnet/identity/overview/getting-started/introduction-to-aspnet-identity。

总结

IdentityServer4的入门暂时先到这篇吧,后续会在实战项目中进行使用分享。下一节先来说说服务发现。

一个被程序搞丑的帅小伙,关注"Code综艺圈",跟我一起学~