初识ABP vNext(3):vue对接ABP基本思路
Tips:本篇已加入系列文章阅读目录,可点击查看更多相关文章。
前言
上一篇介绍了 ABP 的启动模板以及 AbpHelper 工具的基本使用,这一篇将进入项目实战部分。因为目前 ABP 的官方模板只支持 MVC 和 Angular,MVC 的话咱.NET 开发人员来写还可以,专业前端估计很少会用这个。。。Angular 我本人不熟,所以选择 vue 来做 UI。
开始
我使用vue-element-admin来作为模板,这个项目貌似很多人用,选择他的i18n分支,因为我需要国际化功能。在开始编码前,需要先分析几个重要问题:
- 用户登录 /token
- 用户权限控制
- 应用程序本地化 / 语言切换
好在 ABP 模板提供了 Angular 版本,我们可以参考 Angular 版本来做。
登录
因为 ABP 的授权模块是使用 IdentityServer4,所以 IdentityServer4 的一些默认端点在 ABP 里也是同样有效的,可以参考下IdentityServer4 官网。运行 ABP 模板项目,看一下 IdentityServer4 发现文档,uri 是:/.well-known/openid-configuration
可以看到 token 端点是/connect/token
,这是 IdentityServer4 默认的,通过这个端点就可以登录用户获取 token。后面请求接口时,把 token 放到 HTTP Header 的 authorization 字段即可。
权限
进入 ABP 的/swagger
界面:
ABP 内置了一个/api/abp/application-configuration
接口,它用于返回本地化文本,权限和一些系统设置信息。看一下数据格式:
在auth.policies字段中包含了系统的所有权限,auth.grantedPolicies字段则包含了当前用户所拥有的权限,因为我现在没登录所以是空的。通过这两个字段就可以和 vue-element-admin 的菜单权限对应起来,实现权限控制。
currentUser字段表示当前用户信息,没登录时就是空的,isAuthenticated为 false,这个字段也可以作为用户是否登录(token 是否有效)的判断依据。
本地化
本地化对于大部分的小型系统可能都用不上,不过 ABP 作为一个优秀且全面的框架,必然会支持本地化功能。同样的,本地化信息也可以通过/api/abp/application-configuration
接口来获取:
localization.languages字段表示系统所支持的语言类型,前端的语言切换选项就可以使用这个字段。
localization.values字段就是本地化的文本信息了,你在后端配置的本地化文本都可以从这里获取到,通过这个字段结合 vue-element-admin 的国际化功能,就可以让你的系统支持多语言。vue-element-admin 的国际化方案是通过 vue-i18n来实现,你也可以直接在前端部分来做国际化,如果你只有一个前端应用的话,但是在后端做复用性更好一些。
语言切换时只需要把对应的语言名称放到 HTTP Header 的 accept-language 字段就行。
创建项目
在开始编码前,先创建好前后端的模板项目。
ABP
这里直接用 Abp CLI 命令来创建解决方案吧:
abp new "Xhznl.HelloAbp"
-t app
-u none --separate-identity-server
-m none
-d ef -cs "Server=localhost;User Id=sa;Password=Password@2020;Database=HelloAbp;MultipleActiveResultSets=true"
创建一个名为 "Xhznl.HelloAbp" 的解决方案,使用 app 作为模板,不需要 UI,并且将 Identity Server 应用程序与 API host 应用程序分开,使用 Entity Framework Core 作为数据库提供程序,并指定连接字符串。创建完成后会得到一个 aspnet-core 文件夹。
项目结构如下,因为指定了--separate-identity-server
参数,所以多了个 IdentityServer 项目,如果不指定的话它是集成在 HttpApi.Host 中的。
通常小型系统没必要把 Identity Server 应用程序与 API host 应用程序分开,会增加运维成本,这里只是为了演示分布式部署的情况,为后面的微服务做准备。
ABP 还支持为每个模块单独配置数据库(如果你不需要分库,可以忽略以下内容),修改 DbMigrator、IdentityServer 项目的 appsettings.json 配置文件:
在 ConnectionStrings 中添加 AbpIdentityServer 配置,为 Identity Server 配置独立的数据库连接字符串,不配置的话默认使用 Default 配置。AbpIdentityServer 这个 key 是来自 ABP 的 IdentityServer 模块中的一个常量,具体请参考源码。
在开发环境光定义连接字符串还不够,因为 HelloAbpIdsDB 数据库还不存在,需要使用 EF Core Code Frist 迁移系统创建和维护这个数据库。新建一个项目:
步骤比较多,具体流程请参考官网:数据库迁移,这里就不重复介绍了,你也可以选择不分库。
完成以上步骤,最终会生成 2 个数据库,并且包含了一些默认的种子数据。
然后验证一下 HttpApi.Host 和 IdentityServer 项目是否可以正常运行,前提是你电脑需要有 sqlserver,redis。
HttpApi.Host:
IdentityServer:
vue-element-admin
vue-element-admin 的基本使用就不介绍了,相信很多人见过这个,不了解的可以自己去搜索学习一下。
去 GitHub 下载i18n分支的代码,或者直接用 git clone 命令。
在项目根目录下执行指令:
安装依赖:npm install
启动项目:npm run dev
启动正常的话可以看到这个界面:
最后
本篇先做准备工作,下一篇将从登录功能开始编码实现。。。代码已上传至 GitHub:https://github.com/xiajingren/HelloAbp 欢迎 star。