Vue Element前端应用开发之整合ABP框架的前端登录

Qoqa ·

更新时间:2024-09-20

· 920 次阅读

概述

1、ABP开发框架的回顾

2、Vue+Element整合ABP框架的前端登录处理

概述

ABP框架作为后端，是一个非常不错的技术方向，但是前端再使用Asp.NET 进行开发的话，虽然会快捷一点，不过可能显得有点累赘了，因此BS的前端选项采用Vue+Element来做管理（后续可能会视情况加入Vue+AntDesign），CS前端我已经完成了使用Winform+ABP的模式了。本篇随笔主要介绍Vue+Element+ABP的整合方式，先从登录开始介绍。

1、ABP开发框架的回顾

ABP是ASP.NET Boilerplate的简称，ABP是一个开源且文档友好的应用程序框架。ABP不仅仅是一个框架，它还提供了一个最徍实践的基于领域驱动设计(DDD)的体系结构模型。

启动Host的项目，我们可以看到Swagger的管理界面如下所示。

我们登录获得用户访问令牌token后，测试字典类型或者字典数据的接口，才能返回响应的数据。

我根据ABP后端项目之间的关系，整理了一个架构的图形。

应用服务层是整个ABP框架的灵魂所在，对内协同仓储对象实现数据的处理，对外配合Web.Core、Web.Host项目提供Web API的服务，而Web.Core、Web.Host项目几乎不需要进行修改，因此应用服务层就是一个非常关键的部分，需要考虑对用户登录的验证、接口权限的认证、以及对审计日志的记录处理，以及异常的跟踪和传递，基本上应用服务层就是一个大内总管的角色，重要性不言而喻。

对于通过Winform方式展示界面，以Web API方式和后端的ABP的Web API服务进行数据交互，是我们之前已经完成的项目，项目界面如下所示。

主体框架界面采用的是基于菜单的动态生成，以及多文档的界面布局，具有非常好的美观性和易用性。

左侧的功能树列表和顶部的菜单模块，可以根据角色拥有的权限进行动态构建，不同的角色具有不同的菜单功能点，如下是测试用户登录后具有的界面。

2、Vue+Element整合ABP框架的前端登录处理

之前我们开发完成的Vue+Element的前端项目，默认已经具有登录系统的功能，不过登录是采用mock方式进行验证并处理的，本篇随笔介绍是基于实际的ABP项目进行用户身份的登录处理，这个也是开发其他接口展示数据的开始步骤，必须通过真实的用户身份登录后台，获得对应的token令牌，才能进行下一步接口的开发工作。

例如对应登录界面上，界面效果如下所示。

在用户登录界面中，我们处理用户登录逻辑代码如下所示。


// 处理登录事件
    handleLogin() {
      this.$refs.loginForm.validate(valid => {
        if (valid) {
          this.loading = true
          this.$store
            .dispatch('user/login', this.loginForm)
            .then(() => {
              this.$router.push({ path: this.redirect || '/' })
              this.loading = false
            })
            .catch(() => {
              this.loading = false
            })
        } else {
          console.log('error submit!!')
          return false
        }
      })
    }

这里主要就是调用Store模块里面的用户Action处理操作。

例如对于用户store模块里面的登录Action函数如下所示。


const actions = {
  // user login
  login({ commit }, userInfo) {
    const { username, password } = userInfo
    return new Promise((resolve, reject) => {
      login({ username: username.trim(), password: password }).then(response => {
        const { result } = response // 获取返回对象的 result
        var token = result.accessToken
        var userId = result.userId
        // 记录令牌和用户Id
        commit('SET_TOKEN', token)
        commit('SET_USERID', userId)
        // 存储cookie
        setToken(token)
        setUserId(userId)
        resolve()
      }).catch(error => {
        reject(error)
      })
    })
  },

而其中login({ username: username.trim(), password: password }) 操作，是通过API封装处理的调用，使用前在Store模块中先引入API模块，如下所示。


import { login, logout, getInfo } from '@/api/user'

而其中 API模块代码如下所示。


export function login(data) {
  return request({
    url: '/abp/TokenAuth/Authenticate',
    method: 'post',
    data: {
      UsernameOrEmailAddress: data.username,
      password: data.password
    }
  })
}

这里我们用了一个/abp的前缀，用来给WebProxy的处理，实现地址的转义，从而可以实现跨站的处理，让前端调用外部地址就和调用本地地址一样，无缝对接。

我们来看看vue.config.js里面对于这个代理的转义操作代码。

而http://localhost:21021/api 地址指向的项目，是我们本地使用ABP开发的一个后端Web API项目，我们可以通过地址http://localhost:21021/swagger/index.html进行接口的查看。

我们打开获取授权令牌的Authenticate接口，查看它的接口定义内容

通过标注的1,2，我们可以看到这个接口的输入参数和输出JSON信息，从而为我们封装Web API的调用提供很好的参考。

ABP框架统一返回的结果是result，这个result里面才是返回对应的接口内容，如上面的输出JSON信息里面的定义。

所以在登陆返回结果后，我们要返回它的result对象，然后在进行数据的处理。


const { result } = response // 获取返回对象的 result

然后通过result来访问其他属性即可。


var token = result.accessToken // 用户令牌
var userId = result.userId // 用户id

用户登录成功后，并获取到对应的数据，我们就可以把必要的数据，如token和userid存储在State和Cookie里面了。


// 修改State对象，记录令牌和用户Id
commit('SET_TOKEN', token)
commit('SET_USERID', userId)
// 存储cookie
setToken(token)
setUserId(userId)

有了这些信息，我们就可以进一步获取用户的相关信息，如用户名称、介绍，包含角色列表和权限列表等内容了。

例如对应用户信息获取接口的ABP后端地址是 http://localhost:21021//api/services/app/User/Get

那么我们前端就需要在API模块里面构建它的访问地址（/abp/services/app/User/Get）和接口处理了。


export function getInfo(id) {
  return request({
    url: '/abp/services/app/User/Get',
    method: 'get',
    params: {
      id
    }
  })
}

如上所示，在Store模块里引入API模块，如下所示。


import { login, logout, getInfo } from '@/api/user'

然后在Store模块中封装一个Action用来处理用户信息的获取的。


// 获取用户信息
  getInfo({ commit, state }) {
    return new Promise((resolve, reject) => {
      getInfo(state.userid).then(response => {
        const { result } = response
        console.log(result) // 输出测试
        if (!result) {
          reject('Verification failed, please Login again.')
        }
        const { roles, roleNames, name, fullName } = result
        // 角色非空提醒处理
        if (!roles || roles.length <= 0) {
          reject('getInfo: roles must be a non-null array!')
        }
        commit('SET_ROLES', { roles, roleNames })
        commit('SET_NAME', name)
        // commit('SET_AVATAR', avatar) //可以动态设置头像
        commit('SET_INTRODUCTION', fullName)
        resolve(result)
      }).catch(error => {
        reject(error)
      })
    })
  },