Vue.js使用$.ajax和vue-resource实现OAuth的注册、登录、注销和A
概述上一篇我们介绍了如何使用vue resource处理HTTP请求,结合服务端的REST API,就能够很容易地构建一个增删查改应用。 这个应用始终遗留了一个问题,Web App在访问REST API时,没有经过任何认证,这使得服务端的REST API是不安全的,只要有人知道api地址,就可以调用API对服务端的资源进行修改和删除。 今天我们就来探讨一下如何结合Web API来限制资源的访问。 本文的主要内容如下:
本文的最终示例是结合上一篇的CURD,本文的登录、注册、注销和API调用功能实现的。 本文9个示例的源码已放到GitHub:https://github.com/keepfool/vue-tutorials/tree/master/04.OAuth OAuth介绍传统的Web应用在传统的Web应用程序中,前后端是放在一个站点下的,我们可以通过会话(Session)来保存用户的信息。 例如:一个简单的ASP.NET MVC应用程序,用户登录成功后,我们将用户的ID记录在Session中,假设为Session["UserID"]。 前端发送ajax请求时,如果这个请求要求已登录的用户才能访问,我们只需在后台Controller中验证Session["UserID"]是否为空,就可以判断用户是否已经登录了。 这也是传统的Web应用能够逃避HTTP面向无连接的方法。 基于REST服务的Web应用当今很多应用,客户端和服务端是分离的,服务端是基于REST风格构建的一套Service,客户端是第三方的Web应用,客户端通过跨域的ajax请求获取REST服务的资源。 然而REST Service通常是被设计为无状态的(Stateless),这意味着我们不能依赖于Session来保存用户信息,也不能使用Session["UserID"]这种方式确定用户身份。 解决这个问题的方法是什么呢?常规的方法是使用OAuth 2.0。 对于用户相关的OpenAPI,为了保护用户数据的安全和隐私,第三方Web应用访问用户数据前都需要显式的向用户征求授权。 相比于OAuth 1.0,OAuth 2.0的认证流程更加简单。 专用名词介绍在了解OAuth 2.0之前,我们先了解几个名词:
Token的类型请参考:https://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-7.1 有时候认证服务器和资源服务器可以是一台服务器,本文中的Web API示例正是这种运用场景。 OAuth认证流程在知道这几个词以后,我们用这几个名词来编个故事。 简化版本这个故事的简化版本是:用户(Resource Owner)访问资源(Resource)。 具体版本 简化版的故事只有一个结果,下面是这个故事的具体版本:
以上几个步骤,(B)是较为关键的一个,即用户怎么样才能给客户端授权。有了这个授权以后,客户端就可以获取令牌,进而通过临牌获取资源。这也是OAuth 2.0的运行流程,详情请参考:https://tools.ietf.org/html/draft-ietf-oauth-v2-15#section-1.2 客户端的授权模式客户端必须得到用户的授权(authorization grant),才能获得令牌(access token)。 OAuth 2.0定义了四种授权方式:
本文的示例是基于密码模式的,我就只简单介绍这种模式,其他3我就不介绍了。 密码模式密码模式(Resource Owner Password Credentials Grant)中,用户向客户端提供自己的用户名和密码。客户端使用这些信息,向服务端申请授权。 在这种模式中,用户必须把自己的密码给客户端,但是客户端不得储存密码。这通常用在用户对客户端高度信任的情况下,比如客户端是操作系统的一部分,或者由一个著名公司出品。 密码嘛事的执行步骤如下: (A)用户向客户端提供用户名和密码。 (B)客户端将用户名和密码发给认证服务器,向后者请求令牌。 (C)认证服务器确认无误后,向客户端提供访问令牌。 (B)步骤中,客户端发出的HTTP请求,包含以下参数:
注意:在后面的客户端示例中,除了提供username和password,grant_type也是必须指定为"password",否则无法获取服务端的授权。 服务端环境准备如果您是前端开发人员,并且未接触过ASP.Net Web API,可以跳过此段落。 Authentication选择Individual User Accounts 创建这个Web API工程时,VS会自动引入Owin和AspNet.Identity相关的库。 修改ValuesController,除了IEnumerable Get()
{
return new string[] { "value1","value2" };
}
}
添加Model,Controller 初始化数据库 执行以下3个命令 CustomersController类有5个Action,除了2个GET请求外,其他3个请求分别是POST,PUT和DELETE。 为这3个请求添加[Authorize]特性,这3个请求必须通过身份验证才能访问。 // GET: api/Customers
public IQueryable { return db.Customers; } // GET: api/Customers/5
} // PUT: api/Customers/5 // POST: api/Customers // DELETE: api/Customers/5 让Web API以CamelCase输出JSON在Global.asax文件中添加以下几行代码: 启用CORS在Nuget Package Manager Console输入以下命令: 在WebApiConfig中启用CORS: // ...
} 类说明 在执行上述步骤时,VS已经帮我们生成好了一些类 IdentityModels.cs:包含ApplicationDbContext类和ApplicationUser类,无需再创建DbContext类 public class ApplicationDbContext : IdentityDbContext
{ // ... } Startup.Auth.cs:用于配置OAuth的一些属性。 public static string PublicClientId { get; private set; }
// For more information on configuring authentication,please visit http://go.microsoft.com/fwlink/?LinkId=301864
} 这些OAuth配置项,我们只用关注其中的两项:
ApplicationOAuthProvider.cs:默认的OAuthProvider实现,GrantResourceOwnerCredentials方法用于验证用户身份信息,并返回access_token(访问令牌)。 通俗地讲,客户端输入用户名、密码,点击登录后,会发起请求到www.example.com/token。 token这个请求在服务端执行的验证方法是什么呢?正是GrantResourceOwnerCredentials方法。 客户端发起验证请求时,必然是跨域的,token这个请求不属于任何ApiController的Action,而在WebApiConfig.cs中启用全局的CORS,只对ApiController有效,对token请求是不起作用的。 所以还需要在GrantResourceOwnerCredentials方法中添加一行代码: IdentityConfig.cs:配置用户名和密码的复杂度,主要用于用户注册时。例如:不允许用户名为纯字母和数字的组合,密码长度至少为6位…。 使用Postman测试GET和POST请求测试GET请求 GET请求测试成功,可以获取到JSON数据。 测试POST请求 POST请求测试不通过,提示:验证不通过,请求被拒绝。 基于$.ajax实现注册、登录、注销和API调用服务端的环境已经准备好了,现在我们就逐个实现用户注册、登录,以及API调用功能吧。 注册 页面的HTML代码如下: 电子邮箱
密码
创建Vue实例,然后基于$.ajax发送用户注册请求: $.ajax({
url: vm.registerUrl,type: 'POST',dataType: 'json',data: vm.registerModel,success: function() {
vm.msg = '注册成功!'
},error: vm.requestError
})
},requestError: function(xhr,errorType,error) {
this.msg = xhr.responseText
}
} 登录和注销登录的HTML代码: 电子邮箱
密码
创建Vue实例,然后基于$.ajax发送用户登录请求: $.ajax({
url: vm.loginUrl,data: vm.loginModel,success: function(data) {
vm.msg = '登录成功!'
vm.userName = data.userName
sessionStorage.setItem('accessToken',data.access_token)
sessionStorage.setItem('userName',vm.userName)
},logout: function() {
var vm = this
vm.msg = ''
$.ajax({
url: vm.logoutUrl,success: function(data) {
vm.msg = '注销成功!'
vm.userName = ''
vm.loginModel.userName = ''
vm.loginModel.password = ''
sessionStorage.removeItem('userName')
sessionStorage.removeItem('accessToken')
},error) {
this.msg = xhr.responseText
}
} 在试验这个示例时,把Fiddler也打开,我们一共进行了3次操作:
注意第2次操作,在Fiddler中查看服务端返回的内容: 服务端返回了access_token,expires_in,token_type,userName等信息,在客户端可以用sessionStorage或localStorage保存access_token。 调用API取到了access_token后,我们就可以基于access_token去访问服务端受保护的资源了。 这里我们要访问的资源是/api/Values,它来源于ValuesController的Get操作。 基于注册画面,添加一段HTML代码: 在Vue实例中添加一个callApi方法: headers = {}
headers.Authorization = 'Bearer ' + sessionStorage.getItem('accessToken');
$.ajax({ 在调用callApi方法时,设置了请求头的Authorization属性,其格式为:"Bearer access_token"。 由于服务端指定使用了Bearer类型的access token,所以客户端必须使用这种格式将access token传给资源服务器。 在试验这个示例时,我们一共进行了5次操作:
有人可能会注意到,为什么每次点击[调用API]按钮,都发起了两次请求? 这是因为当浏览器发送跨域请求时,浏览器都会先发送一个OPTIONS预请求(preflight request)给目标站点,用于确认目标站点是否接受跨域请求,如果目标站点不支持跨域请求,浏览器会提示错误:
如果是POST请求,且数据类型(Content-Type)是 zepto会自动将非GET请求的Content-Type设置为 我们还是通过Fidder看一下第1次/api/Values请求和响应的Headers信息 请求的Headers信息,它是一次OPTIONS请求。 响应的Headers信息,Access-Control-Allow-Origin: *表示允许所有外部站点对目标站点发送跨域请求。 更多CORS的知识,请参考MDN上的说明: https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Access_control_CORS 基于vue-resource实现注册、登录和API调用基于vue-resource实现这3项功能时,沿用上面的HTML代码。 注册更为简洁的register方法: {
this.msg = '注册成功!'
}).catch((response) => {
this.msg = response.json()
})
}
注意:当使用vue-resource发送注册的POST请求时,Fiddler捕获到了2次请求,第1次是由浏览器发送的OPTIONS预请求,第2次才是实际的POST请求。这和使用$.ajax时是不一样的,因为$.ajax会将非GET请求的Content-Type设置为application/x-www-form-urlencoded,而vue-resource发送POST请求的Content-Type为application/json;charset=UTF-8。 启用emulateJSON选项,可以让浏览器不发送OPTIONS预请求,有两种启用方式。 1.全局启用 2.局部启用 {
this.msg = '注册成功!'
})
启用了emulateJSON选项后,使得POST请求的Content-Type变为application/x-www-form-urlencoded 登录和注销登录和注销的方法: this.$http.post(this.loginUrl,this.loginModel)
.then((response) => { var body = response.json() this.msg = '登录成功!' this.userName = body.userName
},logout: function() { this.$http.post(this.logoutUrl)
},requestError: function(response) { API调用调用API的方法也更为简洁: var headers = {}
headers.Authorization = 'Bearer ' + sessionStorage.getItem('accessToken') this.$http.get(this.apiUrl,{ 同样的,在发送请求前,需要将access token添加到请求头。 综合示例本文在准备服务端环境的时候,提供了一个CustomersController,除了GET操作,其他操作的访问都是受保护的,需要用户登录以后才能操作。 现在我们来实现这个示例, 该示例结合了上一篇的CURD示例,以及本文的注册、登录、注销功能。 具体代码我就不再贴出来了,大家结合源代码试一试吧。 以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持编程之家。 (编辑:李大同) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |