使用 ember-simple-auth 实现 Ember.js 应用的权限控制

2016-07-04 09:58:00

很多网站都有登录功能，对于Ember的应用我们怎么实现权限的控制呢？本篇将为你演示一个最常用的权限控制例子：用户登录。

要实现登录最常用的方式是通过判断session值，如果session中存在你所需要的值则可以认为是用户是经过了登录并且把用户信息设置到session了，如果session中没有用户信息则认为用户没有登录，直接跳转到登录或者注册页面。

本篇会引入一个专门用于控制权限的插件ember-simple-auth，文章中大部分代码是直接参考这个插件的文档所写。如果你需要项目的代码请移步github下载。

好了，废话少说，直接放码出来吧。

创建Ember应用

本文会使用Ember CLI名称创建项目和项目所需的文件，更多有关Ember CLI的命令请自行到官网学习。

ember new chapter8_simple_auth
cd chapter8_simple_auth
ember server
如果你的项目搭建成功执行http://localhost:4200，会看到Welcome to Ember，说明项目搭建成功。

升级Ember、Jquery版本

本项目会升级Ember版本，目前(2015-11-18)来说如果是使用Ember CLI命令安装的项目Ember的版本是1.13.7。升级后使用的版本是2.0.0-beta.3。

升级步骤：

修改bower.json
修改后此文件主要的代码如下：

{
"dependencies": {
"ember": "2.0.0-beta.3"
},
"resolutions": {
"ember": "2.0.0-beta.3"
}
}

删除原有的Ember
必须要手动删除原有的版本，否则因为缓存的问题使用命令重新安装的时候可能安装不成功。手动删除如下目录：appName/bower_components/ember
安装新版本Ember
使用命令：bower install，重新安装Ember。
检查是否安装成功。
打开appName/bower_components/ember/ember.js，可以看到Ember是那个版本。如果是2.0.0-beta.3说明升级成功。
同样的方式升级Jquery
如果你升级不成功，你可以参考我的项目的bower.json、package.json升级。修改这两个文件后执行命令bower install升级。
重启项目
可以看到浏览器控制台打印出Ember的版本信息。

2015-11-18 23:54:08.902 ember.debug.js:5202 DEBUG: -------------------------------2015-11-18 23:54:08.916 ember.debug.js:5202 DEBUG: Ember             : 2.0.0-beta.32015-11-18 23:54:08.916 ember.debug.js:5202 DEBUG: jQuery            : 2.1.42015-11-18 23:54:08.917 ember.debug.js:5202 DEBUG: -------------------------------

到此项目的升级工作完成。

安装插件ember-simple-auth

直接使用npm命令安装，安装的方法可以参考官方教程，直接在项目目录下运行ember install ember-simple-auth即可完成安装。可以在appName/bower_components看到安装的插件。

项目主要代码文件

首页模板文件

This is my first auth proj

    Logout

    Login

{{outlet}}
session.isAuthenticated是插件ember-simple-auth封装好的属性，如果没有登录isAuthenticated为false，sessionRequiresAuthentication也是插件ember-simple-auth提供的方法。此方法会自动根据用户实现的authenticate方法校验用户是否已经登录（isAuthenticated为true）。

定义登录、登录成功组件

使用Ember CLI创建两个组件：login-form和get-quotes。

ember g component login-form
ember g component get-quotes
分别编写这两个组件和组件对应的模板文件。

// app/components/login-form.js

import Ember from 'ember';

export default Ember.Component.extend({
// authenticator: 'authenticator: custom',

actions: {    authenticate: function() {        var user = this.getProperties('identification', 'password');        this.get('session').authenticate('authenticator:custom', user).catch((msg) => {            this.set('errorMessage', msg);        });    }}

});
其中authenticator属性执行了一个自定义的身份验证器custom。identification和password是页面输入的用户名和密码。

getProperties方法会自动获取属性值并自动组装成hash形式（{key: value}形式）。msg是方法authenticate验证不通过的提示信息。

在此简单处理，直接放回到界面显示。

    Login    {{input value=identification placeholder="enter your name" class="form-control"}}    Login    {{input value=password placeholder="enter password" class="form-control" type="password"}}Login

    **Login failed: **{{errorMessage}}

{{/if}}
这个文件比较简单没什么好说，errorMessage就是组件类中返回的提示信息。

get-quotes.js

// app/components/get-quotes.js

import Ember from 'ember';

export default Ember.Component.extend({
gotQuote: false,
quote: "",

actions: {    getQuote: function() {        var that = this;        //  返回一个随机的字符串        Ember.$.ajax({            type: 'GET',            // url: 'http://localhost:3001/api/protected/random-quote',            url: 'http://localhost:3001/api/random-quote',            success: function(response) {                that.setProperties({ quote: response, gotQuote: true });            },            error: function(error) {                alert("An error occurred while processing the response.");                console.log(error);            }        });    }}

});
此组件模拟登陆之后才能访问的资源，通过Ajax获取一个随机的字符串。
请求的服务代码你也可以从github上下载，下载之后按照文档安装，直接运行node server.js既可，服务器端是一个nodejs程序，如果你的电脑没有安装nodejs，请自行下载安装。

登陆、信息显示页面

这两个页面比较简单，直接调用组件。为什么我没有直接把组件代码放在这两个页面呢？？我们知道Ember2.0之后官方不推荐使用控制器，控制器的作用在弱化，组件变得越来越重要。

既然我们项目使用的是Ember2.0版本那就必须要用组件去替代控制器实现某些逻辑的判断。

登陆前的提示信息

我们直接把登陆使用的用户名和密码提示出来，为了测试方便嘛，再者项目还没有注册功能。

    You can {{# link-to 'login' className="alert-link"}}log in {{/link-to}} with login ember and password 123.

{{/unless}}
但是用户名和密码为什么是ember和123呢？？你看到服务器代码里的user-routes.js就明白了，github上用的是gonto，我下载之后做了点小修改。你可以修改成你喜欢的字符串。

到此常规的文件就创建完成了，下面的内容才是重头戏。到目前为止我们还没使用过任何有关插件ember-simple-auth的内容。

路由配置

ember g route login
ember g route protected
ember g route application
执行命令的时候要注意别把之前的模板覆盖了！！！下面是这几个文件的内容。

application.js

// app/routes/application.js

import Ember from 'ember';

import ApplicationRouteMixin from 'simple-auth/mixins/application-route-mixin';

export default Ember.Route.extend(ApplicationRouteMixin, {
actions: {
invalidateSession: function() {
this.get('session').invalidate();
}
}
});
这个类首先混合了ApplicationRouteMixin类的特性，然后再加上自定义的特性。注意第二行代码，引入了插件ember-simple-auth的类ApplicationRouteMixin。更多有关这个类的介绍请点击链接查看。session是插件内置的属性。方法invalidate设置session为无效或者说是当前认证无效，更多详细信息请看方法的API介绍。

protected.js

// app/routes/protected.js

import Ember from 'ember';

import AuthenticatedRouteMixin from 'simple-auth/mixins/authenticated-route-mixin';

// 实现AuthenticatedRouteMixin的类会自动根据权限过滤，如果经过登录页面直接进入这个route会自动跳转到登录页面
export default Ember.Route.extend(AuthenticatedRouteMixin, {
});
此类也是引入插件ember-simple-auth封装好的类AuthenticatedRouteMixin。混合了此类的类会自动根据权限过滤，如果没有通过认证而直接访问这个route会被强制跳转到登录页面。

// app/routes/login.js

import Ember from 'ember';

export default Ember.Route.extend({
// 清空提示信息
setupController: function(controller, model) {
console.log("route:login model = " + model);
controller.set('errorMessage', null);
}
});
这个route的作用是清空页面的提示信息，如果不清空你再次进入的时候还是会看到提示信息。

控制器配置

路由protected之所以能实现无权限重定向到登录页面是因为在controller:login中指定了登录处理类。

// app/controllers/login.js

import Ember from 'ember';

import LoginControllerMixin from 'simple-auth/mixins/login-controller-mixin';

export default Ember.Controller.extend(LoginControllerMixin, {
});
此类引入插件封装好的登录处理类LoginControllerMixin，遗憾的是在插件目录下并没有发现这个类，看不到里面的实现！

核心处理类

最后的这两个类是整个项目最核心的东西——自定义校验器、授权者。

授权者类 authorizer/custom.js

// app/authenrizers/custom.js

import Ember from 'ember';
import Base from 'simple-auth/authorizers/base';

export default Base.extend({
authorize: function(jqXHR, requestOptions) {
var accessToken = this.get('session.content.secure.token');
if (this.get('session.isAuthenticated') && !Ember.isEmpty(accessToken)) {
// setRequestHeader方法自定义请求头信息：键为Authorization，值为Ember+accessToken
// 有关这个方法的介绍请看API介绍
jqXHR.setRequestHeader('Authorization', 'Ember' + accessToken);
}
}
});
直接继承Base类，重新实现authorize方法。或者你亦可以像github上的教程使用插件已经定义好的类。
authorize方法第一个参数是需要设置的session数据，第二个参数是一个回调函数，更多详情情况接口API。

验证器类 authenticators/custom.js

// app/authenticators/custom.js

import Ember from 'ember';
import Base from 'simple-auth/authenticators/base';

export default Base.extend({
tokenEndpoint: 'http://localhost:3001/sessions/create',
restore: function(data) {
return new Ember.RSVP.Promise(function(resolve, reject) {
if (!Ember.isEmpty(data.token)) {
resolve(data);
} else {
reject();
}
});
},
authenticate: function(options) {
return new Ember.RSVP.Promise((resolve, reject) => {
Ember.$.ajax({
url: this.tokenEndpoint,
type: 'POST',
data: JSON.stringify({
username: options.identification,
password: options.password
}),
contentType: 'application/json;charset=utf-8',
dataType: 'json'
}).then(function(response) {
Ember.run(function() {
resolve({
token: response.id_token
});
});
}, function(xhr, status, error) {
var response = xhr.responseText;
Ember.run(function() {
reject(response);
});
});
});
},
invalidate: function() {
console.log('invalidate...');
return Ember.RSVP.resolve();
}
});
这个类代码比较多，也比较复杂。目前官方提供了三种常用的验证器。

但是本项目使用的自定义的验证器。需要注意的是自定义的验证器需要实现restore、authenticate、invalidate这个三个方法，最后一个方法不强制要求重写，但是前面两个方法必须重写。从代码实现可以看到这几个方法都返回了Promise对象。

代码首先是执行了Ajax请求http://localhost:3001/sessions/create，如果执行成功则返回token，否则返回出错信息，返回的错误信息可以在user-routes.js上看到，下载代码后你可以修改成自己喜欢的提示信息。

修改项目配置

到此项目的主要代码都已实现了，下面为了项目能正常运行还需要修改项目的配置文件config/environment.js。

/ jshint node: true /

module.exports = function(environment) {
var ENV = {
// ……与原文件一样
APP: {
// Here you can pass flags/options to your application instance
// when it is created
},
contentSecurityPolicy: {
'default-src': "'none'",
'script-src': "'self'",
'font-src': "'self' ",
'connect-src': "'self' ", // Allow data (ajax/websocket) from http://localhost:3001
'img-src': "'self'",
'style-src': "'self' 'unsafe-inline' *", // Allow inline styles
'media-src': "'self'"
}
};
ENV['simple-auth'] = {
store: 'simple-auth-session-store:local-storage',
authorizer: 'authorizer:custom',
crossOriginWhitelist: ['http://localhost:3001/'], // Ajax跨域设置
// routeAfterAuthentication: '/', //登录成功后跳转到的页面
authenticationRoute: 'login' // 登录不成功转回登录页面
};
// ……与原文件一样