[关闭]
@pockry 2015-08-20T18:06:07.000000Z 字数 77280 阅读 3536

使用React、Node.js、MongoDB、Socket.IO开发一个角色投票应用

前端

作者: Sahat Yalkabov

Source: sahatyalkabov.com

摘要:在这个教程里,我们将为EVE Online游戏创建一个角色投票应用(受Facemash的启发),EVE是一个大型多人在线游戏。在本教程里你将学习到如何使用Node.js构建一个REST API、使用MongoDB保存和检索数据、使用Socket.IO跟踪在线的访问者,以及使用React + Flux和服务端渲染来构建单页面应用,最后将应用部署到云端。


概述

在这个教程里我们将为EVE Online游戏创建一个角色投票应用(受Facemash的启发),EVE是一个大型多人在线游戏。请点击播放下面美妙的音乐,来进入本教程的学习氛围当中。

【audio:EVE Online - Kronos (2014) Release Theme】

当你听着这首音乐时,想象你正身处宇宙深空的某个小行星带,一边从小行星中挖取稀有矿物,一边警戒着雷达上随时可能出现的宇宙海盗,同时,你还正在研究太空站推进系统的设计图,为你的宇宙舰队制造零件,并在完全由玩家需求和供给控制的交易系统下达买卖指令,另外还从遥远星系赶来的大型宇宙货船上卸货。在你的战舰旁边,是装有微型曲速装置的超高速截击机,和武装到牙齿的战斗飞船,它们也都属于你。在这场自由的游戏中,你可以计算如何从行星最优化的萃取矿物,也可以投身一场有数千玩家参与的大型宇宙会战。——这就是EVE Online。

在EVE Online中每个玩家都有一个3D形象以代表他们的角色,我们要开发的这个应用就是来为这些角色形象投票,以选出它们中最好看的。不管怎样,你的目标是学习Node.js和React,而不是EVE Online。但我想说的是:“在一个教程里,趣味即使不是最重要的,也至少和教程的主要目的同样重要。”我之前创建New Eden Faces的唯一目的是学习Backbone.js,我创建TV Show Tracker的目的是为了学习AngularJS。这些日子以来,貌似大家都开始用一个简单的TODO应用来当做教程项目,但对我来说,上面这些项目的任何一个,都比一个简单的TODO应用要有趣得多。

编写这些教程,我所学到的就是,无论是录屏、书籍还是视频教程,在学习一项新技术时,没有什么比创建一个让你有激情的小项目更高效的了。

Full Demo

项目完整源代码: https://github.com/sahat/newedenfaces-react

基于和我之前教程同样的精神(TV Show TrackerInstagram Clone),本教程将是一篇全栈的JavaScript教程,我们将从零开始构建一个完整的应用。

注意:这个项目是对我之前New Eden Faces项目的重制,那是我使用Backbone.js编写的第一个单页面应用。它已经在OpenShift上基于Node.js 0.8.x稳定的运行两年多了。

对于特定主题,我一般尝试做尽量少的假设(如假设读者拥有Node.js基础之类),这也是为什么我的教程都是如此之长。不过即便如此,你至少也需要有一些客户端JavaScript框架和Node.js的经验,才能从这个教程中得到最大的收获。

在开始之前,你需要下载并安装下列工具:

  1. Node.js,或io.js
  2. Bower
  3. MongoDB
  4. gulp
  5. nodemon

第一步:新建Express项目

创建一个新目录newedenfaces,进入目录并创建两个空文件 package.jsonserver.js

注:我的OS X终端使用了Monokai主题和oh-my-fish框架以提供Fish shell.

打开package.json并粘贴下面的代码:

  1. {
  2. "name": "newedenfaces",
  3. "description": "Character voting app for EVE Online",
  4. "version": "1.0.0",
  5. "repository": {
  6. "type": "git",
  7. "url": "https://github.com/sahat/newedenfaces-react"
  8. },
  9. "main": "server.js",
  10. "scripts": {
  11. "start": "babel-node server.js",
  12. "watch": "nodemon --exec babel-node -- server.js"
  13. },
  14. "dependencies": {
  15. "alt": "^0.17.1",
  16. "async": "^1.4.0",
  17. "babel": "^5.6.23",
  18. "body-parser": "^1.13.2",
  19. "colors": "^1.1.2",
  20. "compression": "^1.5.1",
  21. "express": "^4.13.1",
  22. "mongoose": "^4.0.7",
  23. "morgan": "^1.6.1",
  24. "react": "^0.13.3",
  25. "react-router": "^0.13.3",
  26. "request": "^2.58.0",
  27. "serve-favicon": "^2.3.0",
  28. "socket.io": "^1.3.6",
  29. "swig": "^1.4.2",
  30. "underscore": "^1.8.3",
  31. "xml2js": "^0.4.9"
  32. },
  33. "devDependencies": {
  34. "babelify": "^6.1.3",
  35. "bower": "^1.4.1",
  36. "browserify": "^11.0.0",
  37. "gulp": "^3.9.0",
  38. "gulp-autoprefixer": "^2.3.1",
  39. "gulp-concat": "^2.6.0",
  40. "gulp-cssmin": "^0.1.7",
  41. "gulp-if": "^1.2.5",
  42. "gulp-less": "^3.0.3",
  43. "gulp-plumber": "^1.0.1",
  44. "gulp-streamify": "0.0.5",
  45. "gulp-uglify": "^1.2.0",
  46. "gulp-util": "^3.0.6",
  47. "vinyl-source-stream": "^1.1.0",
  48. "watchify": "^3.3.0"
  49. },
  50. "license": "MIT"
  51. }

这是我们的应用所需要的所有依赖包,简要介绍如下:

包名称 描述
alt React的Flux实现
async 异步流程控制
babel ES6转换为ES5
body-parser 渲染POST请求数据
colors 美化控制台输出结果
compression Gzip压缩
express Node.js Web框架
mongoose MongoDB ODM
morgan HTTP请求日志
react React框架
react-router React路由库
request HTTP请求库
serve-favicon 提供favicon.png
socket.io 显示有多少用户在线
swig 渲染HTML
underscore JS辅助库
xml2js 将XML渲染为JSON

在终端输入npm install安装依赖。

如果你使用Windows,可以使用cmder控制台模拟器,可以达到接近OS X/Linux终端的效果。

打开server.js粘贴下面代码,下面是最基础的Express应用,足够我们开始了。

  1. var express = require('express');
  2. var path = require('path');
  3. var logger = require('morgan');
  4. var bodyParser = require('body-parser');
  5. var app = express();
  6. app.set('port', process.env.PORT || 3000);
  7. app.use(logger('dev'));
  8. app.use(bodyParser.json());
  9. app.use(bodyParser.urlencoded({ extended: false }));
  10. app.use(express.static(path.join(__dirname, 'public')));
  11. app.listen(app.get('port'), function() {
  12. console.log('Express server listening on port ' + app.get('port'));
  13. });

注意:尽管我们将使用ES6编写React app,但在这儿我还是决定使用ES5,因为这段代码从两年前到现在基本没有变过。并且,如果你第一次使用ES6,至少这个Express app对你来说还算熟悉。

然后,新建文件夹public,这里是我们放文件如图片、字体,以及压缩后的CSS和JS文件。

现在你可以在终端输入npm start启动应用,确保Express app没有问题。

注意:你现在可以使用node server.js来直接启动应用,但之后我们将使用Babel来预编译文件,也就是说你需要运行babel-node server.js来启动应用。

现在你应该可以看到终端输出“Express server listening on port 3000.”

第二步 构建系统

如果你经常参与web社区,那么你应该听说过BrowserifyWebpack工具。如果不使用它们,你将面临手动的在HTML输入很多<script>标签,并且需要将JS代码放到合适的地方。

并且,我们还不能直接在浏览器使用ES6,在将代码提供给用户之前,我们需要用Babel将它们转换为ES5代码。

我们将使用Gulp和Browserify而不用Webpack。我并不认为它们两个谁优谁劣,但我想说Gulp+Browserify比等价的Webpack文件要直观多了,我还没有在任何React boilerplate项目中看到一个易于理解的webpack.config.js文件。

创建文件gulpfile.js并粘贴下面的代码:

  1. var gulp = require('gulp');
  2. var gutil = require('gulp-util');
  3. var gulpif = require('gulp-if');
  4. var streamify = require('gulp-streamify');
  5. var autoprefixer = require('gulp-autoprefixer');
  6. var cssmin = require('gulp-cssmin');
  7. var less = require('gulp-less');
  8. var concat = require('gulp-concat');
  9. var plumber = require('gulp-plumber');
  10. var source = require('vinyl-source-stream');
  11. var babelify = require('babelify');
  12. var browserify = require('browserify');
  13. var watchify = require('watchify');
  14. var uglify = require('gulp-uglify');
  15. var production = process.env.NODE_ENV === 'production';
  16. var dependencies = [
  17. 'alt',
  18. 'react',
  19. 'react-router',
  20. 'underscore'
  21. ];
  22. /*
  23. |--------------------------------------------------------------------------
  24. | Combine all JS libraries into a single file for fewer HTTP requests.
  25. |--------------------------------------------------------------------------
  26. */
  27. gulp.task('vendor', function() {
  28. return gulp.src([
  29. 'bower_components/jquery/dist/jquery.js',
  30. 'bower_components/bootstrap/dist/js/bootstrap.js',
  31. 'bower_components/magnific-popup/dist/jquery.magnific-popup.js',
  32. 'bower_components/toastr/toastr.js'
  33. ]).pipe(concat('vendor.js'))
  34. .pipe(gulpif(production, uglify({ mangle: false })))
  35. .pipe(gulp.dest('public/js'));
  36. });
  37. /*
  38. |--------------------------------------------------------------------------
  39. | Compile third-party dependencies separately for faster performance.
  40. |--------------------------------------------------------------------------
  41. */
  42. gulp.task('browserify-vendor', function() {
  43. return browserify()
  44. .require(dependencies)
  45. .bundle()
  46. .pipe(source('vendor.bundle.js'))
  47. .pipe(gulpif(production, streamify(uglify({ mangle: false }))))
  48. .pipe(gulp.dest('public/js'));
  49. });
  50. /*
  51. |--------------------------------------------------------------------------
  52. | Compile only project files, excluding all third-party dependencies.
  53. |--------------------------------------------------------------------------
  54. */
  55. gulp.task('browserify', ['browserify-vendor'], function() {
  56. return browserify('app/main.js')
  57. .external(dependencies)
  58. .transform(babelify)
  59. .bundle()
  60. .pipe(source('bundle.js'))
  61. .pipe(gulpif(production, streamify(uglify({ mangle: false }))))
  62. .pipe(gulp.dest('public/js'));
  63. });
  64. /*
  65. |--------------------------------------------------------------------------
  66. | Same as browserify task, but will also watch for changes and re-compile.
  67. |--------------------------------------------------------------------------
  68. */
  69. gulp.task('browserify-watch', ['browserify-vendor'], function() {
  70. var bundler = watchify(browserify('app/main.js', watchify.args));
  71. bundler.external(dependencies);
  72. bundler.transform(babelify);
  73. bundler.on('update', rebundle);
  74. return rebundle();
  75. function rebundle() {
  76. var start = Date.now();
  77. return bundler.bundle()
  78. .on('error', function(err) {
  79. gutil.log(gutil.colors.red(err.toString()));
  80. })
  81. .on('end', function() {
  82. gutil.log(gutil.colors.green('Finished rebundling in', (Date.now() - start) + 'ms.'));
  83. })
  84. .pipe(source('bundle.js'))
  85. .pipe(gulp.dest('public/js/'));
  86. }
  87. });
  88. /*
  89. |--------------------------------------------------------------------------
  90. | Compile LESS stylesheets.
  91. |--------------------------------------------------------------------------
  92. */
  93. gulp.task('styles', function() {
  94. return gulp.src('app/stylesheets/main.less')
  95. .pipe(plumber())
  96. .pipe(less())
  97. .pipe(autoprefixer())
  98. .pipe(gulpif(production, cssmin()))
  99. .pipe(gulp.dest('public/css'));
  100. });
  101. gulp.task('watch', function() {
  102. gulp.watch('app/stylesheets/**/*.less', ['styles']);
  103. });
  104. gulp.task('default', ['styles', 'vendor', 'browserify-watch', 'watch']);
  105. gulp.task('build', ['styles', 'vendor', 'browserify']);

如果你从未使用过Gulp,这里有一个很棒的教程《An Introduction to Gulp.js

下面简单介绍一下每个Gulp任务是干嘛的。

Gulp Task Description
vendor 将所有第三方JS文件合并到一个文件
browserify-vendor 因为性能原因,我们将NPM模块和前端模块分开编译和打包,因此每次重新编译将会快个几百毫秒
browserify 仅将app文件编译并打包,不包括其它模块和库
browserify-watch 包括上面的功能,并且监听文件改变,然后重新编译打包app文件
watch 当文件改变时重新编译LESS文件
default 运行上面所有任务并开始监听文件改变
build 运行上面所有任务然后退出

下面,我们将注意力转移到项目结构上,我们将创建gulpfile.js需要的文件和文件夹。

第三步:项目结构

public目录下创建四个目录:cssjsfontsimg。然后,下载这个favicon.png,也把它放到这里。

在项目根目录,创建新目录app

然后在app文件夹里新建四个目录:actionscomponentsstoresstylesheets,以及三个空文件alt.jsroutes.jsmain.js

在stylesheets目录下新建文件main.less,我们将在里面填入样式。

回到根目录,创建新文件bower.json并粘贴下面的代码:

  1. {
  2. "name": "newedenfaces",
  3. "dependencies": {
  4. "jquery": "^2.1.4",
  5. "bootstrap": "^3.3.5",
  6. "magnific-popup": "^1.0.0",
  7. "toastr": "^2.1.1"
  8. }
  9. }

注意:Bower是一个让你轻松下载JavaScript库的前端包管理器,通过命令行即可下载上面的库。

在终端运行bower install然后等待包下载并安装到bower_components目录。你能在.bowerrc文件改变该路径,不过本教程我们使用默认设置。

node_modules相似,你可能不想将bower_components提交到Git仓库,但如果你不提交的话,当你部署应用的时候如何下载这些文件?我们将在教程的部署部分来解决这个问题。

复制bower_components/bootstrap/fonts下所有的字体图标(glyphicons fonts)到public/fonts目录。

下载并解压下面的背景图片到public/img目录。

有趣事实:三年前我使用Adobe Photoshop来创建高斯模糊效果,但它们今天能轻松的使用CSS滤镜实现。

打开main.less并粘贴下面的文件中的代码。鉴于代码的长度,我决定不将它放在文中。

如果你以前用过Bootstrap CSS框架,那么你应该对里面的大部分代码都感到熟悉。

注意:我花了很长时间在这个UI上,调整fonts和颜色,添加精细的变换效果,如果你有时间的话,推荐在完成本教程之后继续探索一下样式的细节。

我不知道你是否知道最近的趋势,是将样式直接放入React组件当中,但我不太确定我是否喜欢这项实践,也许当相关的工具完善之后我会喜欢吧,但在那之前我还是会使用附加的样式表文件。不过,如果你对使用模块化的CSS感兴趣,可以看看这个css-modulesify项目。

在我们开始构建React app之前,我决定先花三个章节的时间讲讲ES6、React、Flux基础,否则要想一下子全部学会它们会让人很崩溃。对我个人来说,我曾花了不少时间理解某些用ES6编写的React + Flux示例代码上,因为我相当于同时学习一个新语法、一个新框架,以及一个全新的应用架构。

由于三者的内容众多,显然我不能在一篇文章中全讲清楚,我将会只讲那些本教程中会用到的主题。

第四步: ES6速成教程

最好的学习ES6的方法,是为每一个ES6示例提供一个等价的ES5实现。外面已经有不少介绍ES6的文章,本文将只讲其中一些。

Modules(Import)

  1. // ES6
  2. import React from 'react';
  3. import {Route, DefaultRoute, NotFoundRoute} from 'react-router';
  4. // ES5
  5. var React = require('react');
  6. var Router = require('react-router');
  7. var Route = Router.Route;
  8. var DefaultRoute = Router.DefaultRoute;
  9. var NotFoundRoute = Router.NotFoundRoute;

使用ES6中的解构赋值(destructuring assignment),我们能导入模块的子集,这对于像react-routerunderscore这样不止输出一个函数的模块尤其有用。

需要注意的是ES6 import的优先级很高,所有的依赖模块都会在模块代码执行之前加载,也就是说,你无法像在CommonJS一样有条件的加载模块。之前我尝试在一个if-else条件里import模块,结果失败了。

想了解import的更多细节,可访问它的MDN页面

Modules(Export)

  1. // ES6
  2. function Add(x) {
  3. return x + x;
  4. }
  5. export default Add;
  6. // ES5
  7. function Add(x) {
  8. return x + x;
  9. }
  10. module.exports = Add;

想学习ES6模块的更多细节,这里有两篇文章ECMAScript 6 modulesUnderstanding ES6 Modules

Classes

ES6 class只不过是现有的基于原型继承机制的一层语法糖,了解这个事实之后,class关键字对你来说就不再像一个其它语言的概念了。

  1. // ES6
  2. class Box {
  3. constructor(length, width) {
  4. this.length = length;
  5. this.width = width;
  6. }
  7. calculateArea() {
  8. return this.length * this.width;
  9. }
  10. }
  11. let box = new Box(2, 2);
  12. box.calculateArea(); // 4
  13. // ES5
  14. function Box(length, width) {
  15. this.length = length;
  16. this.width = width;
  17. }
  18. Box.prototype.calculateArea = function() {
  19. return this.length * this.width;
  20. }
  21. var box = new Box(2, 2);
  22. box.calculateArea(); // 4

另外,ES6中还可以用extends关键字来创建子类。

  1. class MyComponent extends React.Component {
  2. // Now MyComponent class contains all React component methods
  3. // such as componentDidMount(), render() and etc.
  4. }

了解ES6 class更多信息可查看Classes in ECMAScript 6这篇博文。

JS varlet

这两个关键字唯一的区别是,var的作用域在最近的函数块中,而let的作用域在最近的块语句中——它可以是一个函数、一个for循环,或者一个if语句块。

这里有个很好的示例,来自MDN:

  1. var a = 5;
  2. var b = 10;
  3. if (a === 5) {
  4. let a = 4; // The scope is inside the if-block
  5. var b = 1; // The scope is inside the function
  6. console.log(a); // 4
  7. console.log(b); // 1
  8. }
  9. console.log(a); // 5
  10. console.log(b); // 1

一般来说,let是块作用域,var是函数作用域。

箭头函数(=> fat arrow)

一个箭头函数表达式与函数表达式相比有更简短的语法,以及从语法上绑定了this值。

  1. // ES6
  2. [1, 2, 3].map(n => n * 2); // [2, 4, 6]
  3. // ES5
  4. [1, 2, 3].map(function(n) { return n * 2; }); // [2, 4, 6]

注意:如果参数只有一个,圆括号是可选的,到底是否强制使用取决于你,不过有些人认为去掉括号是坏的实践,有些人则无所谓。

除了更短的语法,箭头函数还有什么用途呢?

考虑下面这个示例,它来自于我将这个项目转换为使用ES6之前的代码:

  1. $.ajax({ type: 'POST', url: '/api/characters', data: { name: name, gender: gender } })
  2. .done(function(data) {
  3. this.setState({ helpBlock: data.message });
  4. }.bind(this))
  5. .fail(function(jqXhr) {
  6. this.setState({ helpBlock: jqXhr.responseJSON.message });
  7. }.bind(this))
  8. .always(function() {
  9. this.setState({ name: '', gender: '' });
  10. }.bind(this));

上面的每个函数都创建了自己的this作用域,不绑定外层this的话我们是无法在示例中调用this.setState的,因为函数作用域的this一般是undefined

当然,它有绕过的方法,比如将this赋值给一个变量,比如var self = this,然后在闭包里用self.setState代替this.setState即可。

而使用等价的ES6代码的话,我们没有必要如此麻烦:

  1. $.ajax({ type: 'POST', url: '/api/characters', data: { name: name, gender: gender } })
  2. .done((data) => {
  3. this.setState({ helpBlock: data.message });
  4. })
  5. .fail((jqXhr) => {
  6. this.setState({ helpBlock: jqXhr.responseJSON.message });
  7. })
  8. .always(() => {
  9. this.setState({ name: '', gender: '' });
  10. });

ES6的讲解就到此为止了,下面让我们看看React,到底是什么让它如此特殊。

第五步: React速成教程

React是一个用于构建UI的JS库。你可以说它的竞争对手有AngularJS,Ember.js,Backbone和Polymer,尽管React专注的领域要小得多。React仅仅是MVC架构中的V,即视图层。

那么,React有什么特殊的呢?

React的组件使用特定的声明式样式书写,不像jQuery或其它传统JS库,你不与DOM直接交互。当背后的数据改变时,React接管所有的UI更新。

React还非常快,这归功于Virtual DOM和幕后的diff算法。当数据改变时,React计算所需要操作的最少的DOM,然后高效的重新渲染组件。比如,如果页面上有10000个已经渲染的元素,但只有一个元素改变,React将仅仅更新其中一个DOM,这是React为何能高效的重新渲染整个组件的原因。

React其它令人瞩目的特性包括:

我非常喜欢React v0.14 Beta 1发布中的这段话,讲了React到底是什么:

现在我们已经清楚,React的美妙和本质与浏览器或DOM无关,我们认为React的真正基础是关于组件和元素的质朴想法:用声明式的方式来描述任何你想渲染的东西。

在进入下一步之前,推荐你先观看这个了不起的视频React in 7 Minutes,它的作者是John Lindquist,推荐你订阅PRO以获得更多的视频教程。

另外,也可以考虑Udemy上的这个广受好评的教程——Build Web Apps with React JS and Flux,作者是Stephen Grider。它包含超过71个视频和10小时以上的内容,涵盖了React,Flux,React Router,Firebase,Imgur API和其它。

当学习React时,我最大的挑战是使用完全不同的思考方式去构建UI。这也是为什么你必须阅读Thinking in React中文版)这个官方指南的原因。

和Thinking in React中的产品列表风格类似,如果我们将New Eden Faces UI分开为潜在的组件,它将会是这样:

注意:每个组件都应该坚持单一职责原则,如果你发现你的组件做的事情太多,也许最好将它分成子组件。不过话虽如此,我首先还是编写了一个典型的的单块组件,当它能够工作后,然后将它重构为小的子组件。

在我们的项目中,顶级App组件包含Navbar,Homepage和Footer组件,Homepage组件包含两个Character组件。

所以,无论何时你想到一个UI设计,从将它分解为不同的组件开始,并且永远考虑你的数据如何在父-子、子-父以及同胞组件间传递,否则你会遇到这样的时刻:“WTF,这个到底在React里怎么实现的?这个用jQuery实现起来简单多了……”

所以,下次你决定用React构建一个新app时,在写代码之前,先画一个这样的层次大纲图。它帮你视觉化多个组件间的关系,并可以照着它来构建组件。

React中所有的组件都有render()方法,它总是返回一个单一的子元素。因此,下面的返回语句是错误的,因为它返回了3个子元素。

  1. render() {
  2. // Invalid JSX,
  3. return (
  4. <li>Achura</li>
  5. <li>Civire</li>
  6. <li>Deteis</li>
  7. );
  8. }

上面的HTML标记叫做JSX。它的语法和HTML仅有些微的不同,比如用className代替class,在我们开始开发应用的时候你将会学到它的更多内容。

当我第一眼看到这样的语法,我的第一反应就是拒绝,在JavaScript中我习惯返回布尔值、数字、字符串、对象以及函数,但绝不是这种东西。但是,JSX不过是一个语法糖。使用一个<ul>标签包裹上面的返回内容后,下面是不使用JSX时的模样:

  1. render() {
  2. return React.createElement('ul', null,
  3. React.createElement('li', null, 'Achura'),
  4. React.createElement('li', null, 'Civire'),
  5. React.createElement('li', null, 'Deteis')
  6. );
  7. }

我相信你会同意JSX远比普通的JavaScript的可读性更好,另外,Babel对JSX有内建支持,所以我们无需做任何额外的事情即可解析它。如果你用过AngularJS中的指令(directive)那么你将会欣赏React的做法,这样你就不必同时处理两个文件——directive.js(负责逻辑)和template.html(负责展现),你可以在同一个文件里同时处理逻辑和展现了。

React中的componentDidMount方法和jQuery中的$(document).ready非常相似,这个方法仅在组件第一次渲染后运行一次(只在客户端运行),这里经常用于初始化第三方库和jQuery插件,或者连接到Socket.IO。

render方法中,你将经常使用三元运算符:当数据为空时隐藏元素、根据条件注入CSS类名、根据组件的状态切换元素的展示等等。

比如下面的例子展示如果根据props值作为条件将CSS类名设为text-danger或text-success:

  1. render() {
  2. let delta = this.props.delta ? (
  3. <strong className={this.props.delta > 0 ? 'text-success' : 'text-danger'}>
  4. {this.props.delta}
  5. </strong>
  6. ) : null;
  7. return (
  8. <div className='card'>
  9. {delta}
  10. {this.props.title}
  11. </div>
  12. );
  13. }

这里我们仅仅浅尝辄止了React的内容,但这应该已经足以展示React的一般概念和它的优点了。

React本身是非常简单并且容易掌握的,但是,当我们谈起Flux架构时,可能会有些麻烦。

第六步:Flux架构速成教程

Flux是Facebook为可扩展的客户端web应用开发的应用架构。它利用单向数据流补全了React组件的一些不足。Flux更应该看做一种模式而非框架,不过,这里我们将使用一个叫做Alt的Flux实现,来减少我们写脚手架代码的时间。

以前你看过这个图解吗?你能理解它吗?我就不能理解,无论我看它多少遍。

现在我对Flux比较了解了,我只能说,真是服了他们(Flux作者),能将简单的架构用如此复杂的方式展现出来。不过需要说明的是,它们的新Flux图解比以前好多了。

有趣事实:当我刚开始写这个教程时,我决定不在这个项目中使用Flux。我实在掌握不了这个东西,还是让别人去教它吧。不过谢天谢地,在Yahoo我能在上班时间把玩不同的技术并试验它们,所以花点功夫还是学会了。老实说,不用Flux我们也能构建这个app,并且写的代码还少些,因为这个项目并没有什么复杂的内嵌组件。但我相信,做一个全栈的React app,包括服务端渲染和Flux架构,看着不同的部分是如何组合到一起的,这本身有它的价值。

与其重复Flux那抽象的官方教程,不如让我们来看一个真实的用例,来展示Flux是如何工作的:

  1. OverviewActions.getSummary();
  2. OverviewActions.getApps();
  3. OverviewActions.getCompanies();
  1. getSummary() {
  2. request
  3. .get('/api/overview/summary')
  4. .end((err, res) => {
  5. this.actions.getSummarySuccess(res.body);
  6. });
  7. }
  1. class OverviewStore {
  2. constructor() {
  3. this.bindActions(OverviewActions);
  4. this.summary = {};
  5. this.apps = [];
  6. this.companies = [];
  7. }
  8. onGetSummarySuccess(data) {
  9. this.summary = data;
  10. }
  11. onGetAppsSuccess(data) {
  12. this.apps = data;
  13. }
  14. onGetCompaniesSuccess(data) {
  15. this.companies = data;
  16. }
  17. }
  1. class Overview extends React.Component {
  2. constructor(props) {
  3. super(props);
  4. this.state = OverviewStore.getState();
  5. this.onChange = this.onChange.bind(this);
  6. }
  7. componentDidMount() {
  8. OverviewStore.listen(this.onChange);
  9. }
  10. onChange() {
  11. this.setState(OverviewStore.getState())
  12. }
  13. ...
  14. }

注意:Action如何命名并无规定,你可自由按照自己的习惯命名,只要它是描述性并且有意义的。

让我们暂时先忽略Dispatcher一会,从上面的描述你看到了一条单向的数据流吗?如果没有也没什么大不了的,当我们开始构建应用的时候你自然就明白了。

Flux概要

Flux事实上不过是pub/sub架构的一个时髦说法,比如,应用的数据总是单向的,并被一路上的订阅者们接收。

在写这篇教程的时候,外面已经有超过一打的Flux实现,在这些实现当中,我只用过RefluxJSAlt,在这两者之间,我个人比较喜欢Alt,因为它的简洁,以及作者goatslacker的热心、支持服务端渲染、非常棒的文档,以及积极的维护。

我强烈建议你去读一下Alt的Getting Started,不超过10分钟你就能基本入门了。

如果你对于该选择哪个Flux库感到迷茫,可以考虑一下Hacker News上一个叫glenjamin的家伙的评论,他花了大量时间试图弄清到底该用哪个Flux库:

令人郁闷的事实是:它们(Flux库)都很好。你几乎不可能因为一个Flux库而让你的应用出现问题。即使某个Flux库停止维护了也不打紧,你要知道,大多数正常的Flux实现都非常小(大约100行代码),出不了什么致命问题,即使出了我想你也能搞定。总之,redux很灵巧,但不要在试图获得完美的Flux库上浪费时间,瞅着哪个还算顺眼就拿来用,赶紧将关注点转回到你的应用上去。

现在,我们已经过了一遍ES6、React、Flux的一些基础,现在该将注意力集中到我们的应用上来了。

第七步:React路由(客户端)

app/components目录下新建文件App.js,粘贴下面的代码:

  1. import React from 'react';
  2. import {RouteHandler} from 'react-router';
  3. class App extends React.Component {
  4. render() {
  5. return (
  6. <div>
  7. <RouteHandler />
  8. </div>
  9. );
  10. }
  11. }
  12. export default App;

RouteHandler是渲染当前子路由处理器的组件,它将根据URL渲染这些组件中的一个:Home、Top100、Profile,或Add Character。

注意:它和AngularJS中的<div ng-view></div>挺相似,会将当前路由中已渲染的模板包含进主布局中。

然后,打开app目录下的routes.js,粘贴下面的代码:

  1. import React from 'react';
  2. import {Route} from 'react-router';
  3. import App from './components/App';
  4. import Home from './components/Home';
  5. export default (
  6. <Route handler={App}>
  7. <Route path='/' handler={Home} />
  8. </Route>
  9. );

之所以将路由像这样嵌套,是因为我们将在RouteHandler的前后添加Navbar和Footer组件。不像其它组件,路由改变的时候,Navbar和Footer组件会保持不变。

最后,我们需要添加一个URL监听程序,当URL改变时渲染应用。打开App目录下的main.js并添加下列代码:

  1. import React from 'react';
  2. import Router from 'react-router';
  3. import routes from './routes';
  4. Router.run(routes, Router.HistoryLocation, function(Handler) {
  5. React.render(<Handler />, document.getElementById('app'));
  6. });

注意main.js是我们的React应用的入口点,当Browserify将整个依赖树串起来并生成最终的bundle.js时会用到,这里我们填入初始化的内容后我们基本不用再动它了。

React Router引导route.js中的路由,将它们和URL匹配,然后执行相应的callback处理器,在这里即意味着渲染一个React组件到<div id="app"></div>。它是怎么知道要渲染哪个组件呢?举例来说,如果我们在/URL路径,那么<Handler />将渲染Home组件,因为我们之前已经在route.js指定这个组件了。后面我们将添加更多的路由。

另外注意,为了让URL好看点,我们使用了HistoryLocation来启用HMTL History API。比如它的URL看起来会是http://localhost:3000/add而不是http://localhost:3000/#add,因为我们构建的是一个同型React应用(在客户端和服务端都能渲染),所以我们不需要用一些非正统的方式在服务器上重定向以启用这项特性,它直接就能用。

接下来让我们创建这一节最后一个React组件。在app/components目录新建文件Home.js,并添上内容:

  1. import React from 'react';
  2. class Home extends React.Component {
  3. render() {
  4. return (
  5. <div className='alert alert-info'>
  6. Hello from Home Component
  7. </div>
  8. );
  9. }
  10. }
  11. export default Home;

下面应该是我们在目前所创建的所有内容。现在是你检查代码的好时候了。

哦,还有一个,打开app目录下的alt.js并粘贴下面的代码,我将会在第9步真正用到它的时候再解释这些代码的目的。

  1. import Alt from 'alt';
  2. export default new Alt();

现在我们只需要在后端设置一些东西,就终于能将我们的应用运行起来了。

第八步:React路由(服务端)

打开server.js并将下面的代码粘贴到文件最前面,我们需要导入这些模块:

  1. var swig = require('swig');
  2. var React = require('react');
  3. var Router = require('react-router');
  4. var routes = require('./app/routes');

然后,将下面的中间件也加入到server.js中去,放在现有的Express中间件之后。

  1. app.use(function(req, res) {
  2. Router.run(routes, req.path, function(Handler) {
  3. var html = React.renderToString(React.createElement(Handler));
  4. var page = swig.renderFile('views/index.html', { html: html });
  5. res.send(page);
  6. });
  7. });

这个中间件在每次请求时都会执行。这里server.js中的Router.run和main.js中Router.run的主要区别是应用是如何渲染的。

在客户端,渲染完成的HTML标记将被插入到<div id="app"></div>,在服务器端,渲染完成的HTML标记被发到index.html模板,然后被Swig模板引擎插入到<div id="app">{{ html|safe }}</div>中,我选择Swig是因为我想尝试下JadeHandlerbars之外的选择。

但我们真的需要一个独立的模板吗?为什么不直接将内容渲染到App组件呢?是的,你可以这么做,只要你能接受违反W3C规范的HMTL标记,以及不能在组件中直接包含内嵌的script标签,比如Google Analytics。不过即便这么说,好像现在不规范的HMTL标记也不再和SEO相关了,也有一些绕过的办法来包含内嵌script标签,所以要怎么做看你咯,不过为了这个教程的目的,让我们还是使用Swig模板引擎吧。

在项目根目录新建目录views,进入目录并新建文件index.html

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="utf-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
  6. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  7. <title>New Eden Faces</title>
  8. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,900"/>
  9. <link rel="stylesheet" href="/css/main.css"/>
  10. </head>
  11. <body>
  12. <div id="app">{{ html|safe }}</div>
  13. <script src="/js/vendor.js"></script>
  14. <script src="/js/vendor.bundle.js"></script>
  15. <script src="/js/bundle.js"></script>
  16. </body>
  17. </html>

打开两个终端界面并进入根目录,在其中一个运行gulp,连接依赖文件、编译LESS样式并监视你的文件变化:

在另一个界面运行npm run watch来启动Node.js服务器并在文件变动时自动重启服务器:

在浏览器打开http://localhost:3000,现在你应该能看到React应用成功渲染了。

我们坚持到现在,做了大量的工作,结果就给我们显示了一个提示信息!不过还好,最艰难的部分已经结束了,从现在开始我们可以轻松一点,专注到创建React组件并实现REST API端点。

上面的两个命令gulpnpm run watch将为我们完成脏活累活,我们不用在添加React组件后的重新编译和Express服务器重启上费心啦。

第九步:Footer和Navbar组件

Navbar和Footer都是相对简单的组件。Footer组件获取并展示Top5人物角色,Navbar组件获取并展示所有角色数量,然后还初始化一个Socket.IO事件监听器,用以跟踪在线访客的数量。

注意:这一节会比别的小节要稍长些,因为我会在这里谈到一些新概念,而其它小节将基于它们进行开发。

Footer组件

components目录下新建文件Footer.js

  1. import React from 'react';
  2. import {Link} from 'react-router';
  3. import FooterStore from '../stores/FooterStore'
  4. import FooterActions from '../actions/FooterActions';
  5. class Footer extends React.Component {
  6. constructor(props) {
  7. super(props);
  8. this.state = FooterStore.getState();
  9. this.onChange = this.onChange.bind(this);
  10. }
  11. componentDidMount() {
  12. FooterStore.listen(this.onChange);
  13. FooterActions.getTopCharacters();
  14. }
  15. componentWillUnmount() {
  16. FooterStore.unlisten(this.onChange);
  17. }
  18. onChange(state) {
  19. this.setState(state);
  20. }
  21. render() {
  22. let leaderboardCharacters = this.state.characters.map((character) => {
  23. return (
  24. <li key={character.characterId}>
  25. <Link to={'/characters/' + character.characterId}>
  26. <img className='thumb-md' src={'http://image.eveonline.com/Character/' + character.characterId + '_128.jpg'} />
  27. </Link>
  28. </li>
  29. )
  30. });
  31. return (
  32. <footer>
  33. <div className='container'>
  34. <div className='row'>
  35. <div className='col-sm-5'>
  36. <h3 className='lead'><strong>Information</strong> and <strong>Copyright</strong></h3>
  37. <p>Powered by <strong>Node.js</strong>, <strong>MongoDB</strong> and <strong>React</strong> with Flux architecture and server-side rendering.</p>
  38. <p>You may view the <a href='https://github.com/sahat/newedenfaces-react'>Source Code</a> behind this project on GitHub.</p>
  39. <p>© 2015 Sahat Yalkabov.</p>
  40. </div>
  41. <div className='col-sm-7 hidden-xs'>
  42. <h3 className='lead'><strong>Leaderboard</strong> Top 5 Characters</h3>
  43. <ul className='list-inline'>
  44. {leaderboardCharacters}
  45. </ul>
  46. </div>
  47. </div>
  48. </div>
  49. </footer>
  50. );
  51. }
  52. }
  53. export default Footer;

为防止你还未熟悉ES6语法而晕头转向,在这里我将最后一次展示这段代码用ES5是如何写的,另外你也可以参看Using Alt with ES5指南来了解创建action和store时语法的不同。

  1. var React = require('react');
  2. var Link = require('react-router').Link;
  3. var FooterStore = require('../stores/FooterStore');
  4. var FooterActions = require('../actions/FooterActions');
  5. var Footer = React.createClass({
  6. getInitialState: function() {
  7. return FooterStore.getState();
  8. }
  9. componentDidMount: function() {
  10. FooterStore.listen(this.onChange);
  11. FooterActions.getTopCharacters();
  12. }
  13. componentWillUnmount: function() {
  14. FooterStore.unlisten(this.onChange);
  15. }
  16. onChange: function(state) {
  17. this.setState(state);
  18. }
  19. render() {
  20. var leaderboardCharacters = this.state.characters.map(function(character) {
  21. return (
  22. <li key={character.characterId}>
  23. <Link to={'/characters/' + character.characterId}>
  24. <img className='thumb-md' src={'http://image.eveonline.com/Character/' + character.characterId + '_128.jpg'} />
  25. </Link>
  26. </li>
  27. );
  28. });
  29. return (
  30. <footer>
  31. <div className='container'>
  32. <div className='row'>
  33. <div className='col-sm-5'>
  34. <h3 className='lead'><strong>Information</strong> and <strong>Copyright</strong></h3>
  35. <p>Powered by <strong>Node.js</strong>, <strong>MongoDB</strong> and <strong>React</strong> with Flux architecture and server-side rendering.</p>
  36. <p>You may view the <a href='https://github.com/sahat/newedenfaces-react'>Source Code</a> behind this project on GitHub.</p>
  37. <p>© 2015 Sahat Yalkabov.</p>
  38. </div>
  39. <div className='col-sm-7 hidden-xs'>
  40. <h3 className='lead'><strong>Leaderboard</strong> Top 5 Characters</h3>
  41. <ul className='list-inline'>
  42. {leaderboardCharacters}
  43. </ul>
  44. </div>
  45. </div>
  46. </div>
  47. </footer>
  48. );
  49. }
  50. });
  51. module.exports = Footer;

如果你还记得Flux架构那一节的内容,这些代码看上去应该挺熟悉。当组件加载后,将初始组件状态设置为FooterStore中的值,然后初始化store监听器。同样,当组件被卸载(比如导航至另一页面),store监听器也被移除。当store更新,onChange函数被调用,然后反过来又更新Footer的状态。

如果你之前用过React,在这里你需要注意的是,当使用ES6 class创建React组件,组件方法不再自动绑定this。也就是说,当你调用组件内部方法时,你需要手动绑定this,在之前,React.createClass()会帮我们自动绑定:

自动绑定:当在JavaScript中创建回调时,你经常需要手动绑定方法到它的实例以保证this的值正确,使用React,所有方法都自动绑定到组件实例。

以上出自于官方文档。不过在ES6中我们要这么做:

  1. this.onChange = this.onChange.bind(this);

下面是关于这个问题更详细的例子:

  1. class App extends React.Component {
  2. constructor(props) {
  3. super(props);
  4. this.state = AppStore.getState();
  5. this.onChange = this.onChange; // Need to add `.bind(this)`.
  6. }
  7. onChange(state) {
  8. // Object `this` will be undefined without binding it explicitly.
  9. this.setState(state);
  10. }
  11. render() {
  12. return null;
  13. }
  14. }

现在你需要了解JavaScript中的map()方法,即使你之前用过,也还是可能搞不清楚它在JSX中是怎么用的(React官方教程并没有很好的解释它)。

它基本上是一个for-each循环,和Jade和Handlebars中的类似,但在这里你可以将结果分配给一个变量,然后你就可以在JSX里使用它了,就和用其它变量一样。它在React中很常见,你会经常用到。

注意:当渲染动态子组件时,如上面的leaderboardCharacters,React会要求你使用key属性来指定每一个子组件。

Link组件当指定合适的href属性时会渲染一个链接标签,它还知道链接的目标是否可用,从而给链接加上active的类。如果你使用React Router,你需要使用Link模块在应用内部进行导航。

Actions

下面,我们将为Footer组件创建action和store,在app/actions目录新建FooterActions.js并添加:

  1. import alt from '../alt';
  2. class FooterActions {
  3. constructor() {
  4. this.generateActions(
  5. 'getTopCharactersSuccess',
  6. 'getTopCharactersFail'
  7. );
  8. }
  9. getTopCharacters() {
  10. $.ajax({ url: '/api/characters/top' })
  11. .done((data) => {
  12. this.actions.getTopCharactersSuccess(data)
  13. })
  14. .fail((jqXhr) => {
  15. this.actions.getTopCharactersFail(jqXhr)
  16. });
  17. }
  18. }
  19. export default alt.createActions(FooterActions);

首先,注意我们从第七步创建的alt.js中导入了一个Alt的实例,而不是从我们安装的Alt模块中。它是一个Alt的实例,实现了Flux dispatcher并提供创建Alt action和store的方法。你可以把它想象为我们的store和action之间的胶水。

这里我们有3个action,一个使用ajax获取数据,另外两个用来通知store获取数据是成功还是失败。在这个例子里,知道getTopCharacters何时被触发并没有什么用,我们真正想知道的是action执行成功(更新store然后重新渲染组件)还是失败(显示一个错误通知)。

Action可以很复杂,也可以很简单。有些action我们不关心它们做了什么,我们只关心它们是否被触发,比如这里的ajaxInProgressajaxComplete被用来通知store,AJAX请求是正在进行还是已经完成。

注意:Alt的action能通过generateActions方法创建,只要它们直接通向dispatch。具体可参看官方文档

下面的两种创建action方式是等价的,可依据你的喜好进行选择:

  1. getTopCharactersSuccess(payload) {
  2. this.dispatch(payload);
  3. }
  4. getTopCharactersFail(payload) {
  5. this.dispatch(payload);
  6. }
  7. // Equivalent to this...
  8. this.generateActions(
  9. 'getTopCharactersSuccess',
  10. 'getTopCharactersFail'
  11. );

最后,我们通过alt.createActions将FooterActions封装并暴露出来,然后我们可以在Footer组件里导入并使用它。

Store

下面,在app/stores目录下新建文件FooterStore.js

  1. import alt from '../alt';
  2. import FooterActions from '../actions/FooterActions';
  3. class FooterStore {
  4. constructor() {
  5. this.bindActions(FooterActions);
  6. this.characters = [];
  7. }
  8. onGetTopCharactersSuccess(data) {
  9. this.characters = data.slice(0, 5);
  10. }
  11. onGetTopCharactersFail(jqXhr) {
  12. // Handle multiple response formats, fallback to HTTP status code number.
  13. toastr.error(jqXhr.responseJSON && jqXhr.responseJSON.message || jqXhr.responseText || jqXhr.statusText);
  14. }
  15. }
  16. export default alt.createStore(FooterStore);

在store中创建的变量,比如this所赋值的变量,都将成为状态的一部分。当Footer组件初始化并调用FooterStore.getState(),它会获取在构造函数中指定的当前状态(在一开始只是一个空数组,而遍历空数组会返回另一个空数组,所以在Footer组件第一次加载时并没有渲染任何内容)。

bindActions用于将action绑定到store中定义的相应处理函数。比如,一个命名为foo的action会匹配store中叫做onFoo或者foo的处理函数,不过需要注意它不会同时匹配两者。因此我们在FooterActions.js中定义的action getTopCharactersSuccessgetTopCharactersFail会匹配到这里的处理函数onGetTopCharactersSuccessonGetTopCharactersFail

注意:如需更精细的控制store监听的action以及它们绑定的处理函数,可参看文档中的bindListeners方法。

onGetTopCharactersSuccess处理函数中我们更新了store的数据,现在它包含Top 5角色,并且我们在Footer组件中初始化了store监听器,当FooterStore更新后组件会自动的重新渲染。

我们会使用Toastr库来处理通知。也许你会问为什么不使用纯React通知组件呢?也许你以前看到过为React设计的通知组件,但我个人认为这是少数不太适合用React的地方(还有一个是tooltips)。我认为要从应用的任何地方显示一个通知,使用命令方式远比声明式要简单,我以前曾经构建过使用React和Flux的通知组件,但老实说,用来它处理显隐状态、动画以及z-index位置等,非常痛苦。

打开app/components下的App.js并导入Footer组件:

  1. import Footer from './Footer';

然后将<Footer />添加到<RouterHandler / >组件后面:

  1. <div>
  2. <RouteHandler />
  3. <Footer />
  4. </div>

刷新浏览器你应该看到新的底部:

我们稍后会实现Express API以及添加人物角色数据库,不过现在让我们还是继续构建Navbar组件。因为之前已经讲过了alt action和store,这里将会尽量简略的说明Navbar组件如何构建。

app/components目录新建文件Navbar.js

  1. import React from 'react';
  2. import {Link} from 'react-router';
  3. import NavbarStore from '../stores/NavbarStore';
  4. import NavbarActions from '../actions/NavbarActions';
  5. class Navbar extends React.Component {
  6. constructor(props) {
  7. super(props);
  8. this.state = NavbarStore.getState();
  9. this.onChange = this.onChange.bind(this);
  10. }
  11. componentDidMount() {
  12. NavbarStore.listen(this.onChange);
  13. NavbarActions.getCharacterCount();
  14. let socket = io.connect();
  15. socket.on('onlineUsers', (data) => {
  16. NavbarActions.updateOnlineUsers(data);
  17. });
  18. $(document).ajaxStart(() => {
  19. NavbarActions.updateAjaxAnimation('fadeIn');
  20. });
  21. $(document).ajaxComplete(() => {
  22. setTimeout(() => {
  23. NavbarActions.updateAjaxAnimation('fadeOut');
  24. }, 750);
  25. });
  26. }
  27. componentWillUnmount() {
  28. NavbarStore.unlisten(this.onChange);
  29. }
  30. onChange(state) {
  31. this.setState(state);
  32. }
  33. handleSubmit(event) {
  34. event.preventDefault();
  35. let searchQuery = this.state.searchQuery.trim();
  36. if (searchQuery) {
  37. NavbarActions.findCharacter({
  38. searchQuery: searchQuery,
  39. searchForm: this.refs.searchForm.getDOMNode(),
  40. router: this.context.router
  41. });
  42. }
  43. }
  44. render() {
  45. return (
  46. <nav className='navbar navbar-default navbar-static-top'>
  47. <div className='navbar-header'>
  48. <button type='button' className='navbar-toggle collapsed' data-toggle='collapse' data-target='#navbar'>
  49. <span className='sr-only'>Toggle navigation</span>
  50. <span className='icon-bar'></span>
  51. <span className='icon-bar'></span>
  52. <span className='icon-bar'></span>
  53. </button>
  54. <Link to='/' className='navbar-brand'>
  55. <span ref='triangles' className={'triangles animated ' + this.state.ajaxAnimationClass}>
  56. <div className='tri invert'></div>
  57. <div className='tri invert'></div>
  58. <div className='tri'></div>
  59. <div className='tri invert'></div>
  60. <div className='tri invert'></div>
  61. <div className='tri'></div>
  62. <div className='tri invert'></div>
  63. <div className='tri'></div>
  64. <div className='tri invert'></div>
  65. </span>
  66. NEF
  67. <span className='badge badge-up badge-danger'>{this.state.onlineUsers}</span>
  68. </Link>
  69. </div>
  70. <div id='navbar' className='navbar-collapse collapse'>
  71. <form ref='searchForm' className='navbar-form navbar-left animated' onSubmit={this.handleSubmit.bind(this)}>
  72. <div className='input-group'>
  73. <input type='text' className='form-control' placeholder={this.state.totalCharacters + ' characters'} value={this.state.searchQuery} onChange={NavbarActions.updateSearchQuery} />
  74. <span className='input-group-btn'>
  75. <button className='btn btn-default' onClick={this.handleSubmit.bind(this)}><span className='glyphicon glyphicon-search'></span></button>
  76. </span>
  77. </div>
  78. </form>
  79. <ul className='nav navbar-nav'>
  80. <li><Link to='/'>Home</Link></li>
  81. <li><Link to='/stats'>Stats</Link></li>
  82. <li className='dropdown'>
  83. <a href='#' className='dropdown-toggle' data-toggle='dropdown'>Top 100 <span className='caret'></span></a>
  84. <ul className='dropdown-menu'>
  85. <li><Link to='/top'>Top Overall</Link></li>
  86. <li className='dropdown-submenu'>
  87. <Link to='/top/caldari'>Caldari</Link>
  88. <ul className='dropdown-menu'>
  89. <li><Link to='/top/caldari/achura'>Achura</Link></li>
  90. <li><Link to='/top/caldari/civire'>Civire</Link></li>
  91. <li><Link to='/top/caldari/deteis'>Deteis</Link></li>
  92. </ul>
  93. </li>
  94. <li className='dropdown-submenu'>
  95. <Link to='/top/gallente'>Gallente</Link>
  96. <ul className='dropdown-menu'>
  97. <li><Link to='/top/gallente/gallente'>Gallente</Link></li>
  98. <li><Link to='/top/gallente/intaki'>Intaki</Link></li>
  99. <li><Link to='/top/gallente/jin-mei'>Jin-Mei</Link></li>
  100. </ul>
  101. </li>
  102. <li className='dropdown-submenu'>
  103. <Link to='/top/minmatar'>Minmatar</Link>
  104. <ul className='dropdown-menu'>
  105. <li><Link to='/top/minmatar/brutor'>Brutor</Link></li>
  106. <li><Link to='/top/minmatar/sebiestor'>Sebiestor</Link></li>
  107. <li><Link to='/top/minmatar/vherokior'>Vherokior</Link></li>
  108. </ul>
  109. </li>
  110. <li className='dropdown-submenu'>
  111. <Link to='/top/amarr'>Amarr</Link>
  112. <ul className='dropdown-menu'>
  113. <li><Link to='/top/amarr/amarr'>Amarr</Link></li>
  114. <li><Link to='/top/amarr/ni-kunni'>Ni-Kunni</Link></li>
  115. <li><Link to='/top/amarr/khanid'>Khanid</Link></li>
  116. </ul>
  117. </li>
  118. <li className='divider'></li>
  119. <li><Link to='/shame'>Hall of Shame</Link></li>
  120. </ul>
  121. </li>
  122. <li className='dropdown'>
  123. <a href='#' className='dropdown-toggle' data-toggle='dropdown'>Female <span className='caret'></span></a>
  124. <ul className='dropdown-menu'>
  125. <li><Link to='/female'>All</Link></li>
  126. <li className='dropdown-submenu'>
  127. <Link to='/female/caldari'>Caldari</Link>
  128. <ul className='dropdown-menu'>
  129. <li><Link to='/female/caldari/achura'>Achura</Link></li>
  130. <li><Link to='/female/caldari/civire/'>Civire</Link></li>
  131. <li><Link to='/female/caldari/deteis'>Deteis</Link></li>
  132. </ul>
  133. </li>
  134. <li className='dropdown-submenu'>
  135. <Link to='/female/gallente'>Gallente</Link>
  136. <ul className='dropdown-menu'>
  137. <li><Link to='/female/gallente/gallente'>Gallente</Link></li>
  138. <li><Link to='/female/gallente/intaki'>Intaki</Link></li>
  139. <li><Link to='/female/gallente/jin-mei'>Jin-Mei</Link></li>
  140. </ul>
  141. </li>
  142. <li className='dropdown-submenu'>
  143. <Link to='/female/minmatar'>Minmatar</Link>
  144. <ul className='dropdown-menu'>
  145. <li><Link to='/female/minmatar/brutor'>Brutor</Link></li>
  146. <li><Link to='/female/minmatar/sebiestor'>Sebiestor</Link></li>
  147. <li><Link to='/female/minmatar/vherokior'>Vherokior</Link></li>
  148. </ul>
  149. </li>
  150. <li className='dropdown-submenu'>
  151. <Link to='/female/amarr'>Amarr</Link>
  152. <ul className='dropdown-menu'>
  153. <li><Link to='/female/amarr/amarr'>Amarr</Link></li>
  154. <li><Link to='/female/amarr/ni-kunni'>Ni-Kunni</Link></li>
  155. <li><Link to='/female/amarr/khanid'>Khanid</Link></li>
  156. </ul>
  157. </li>
  158. </ul>
  159. </li>
  160. <li className='dropdown'>
  161. <a href='#' className='dropdown-toggle' data-toggle='dropdown'>Male <span className='caret'></span></a>
  162. <ul className='dropdown-menu'>
  163. <li><Link to='/male'>All</Link></li>
  164. <li className='dropdown-submenu'>
  165. <Link to='/male/caldari'>Caldari</Link>
  166. <ul className='dropdown-menu'>
  167. <li><Link to='/male/caldari/achura'>Achura</Link></li>
  168. <li><Link to='/male/caldari/civire'>Civire</Link></li>
  169. <li><Link to='/male/caldari/deteis'>Deteis</Link></li>
  170. </ul>
  171. </li>
  172. <li className='dropdown-submenu'>
  173. <Link to='/male/gallente'>Gallente</Link>
  174. <ul className='dropdown-menu'>
  175. <li><Link to='/male/gallente/gallente'>Gallente</Link></li>
  176. <li><Link to='/male/gallente/intaki'>Intaki</Link></li>
  177. <li><Link to='/male/gallente/jin-mei'>Jin-Mei</Link></li>
  178. </ul>
  179. </li>
  180. <li className='dropdown-submenu'>
  181. <Link to='/male/minmatar'>Minmatar</Link>
  182. <ul className='dropdown-menu'>
  183. <li><Link to='/male/minmatar/brutor'>Brutor</Link></li>
  184. <li><Link to='/male/minmatar/sebiestor'>Sebiestor</Link></li>
  185. <li><Link to='/male/minmatar/vherokior'>Vherokior</Link></li>
  186. </ul>
  187. </li>
  188. <li className='dropdown-submenu'>
  189. <Link to='/male/amarr'>Amarr</Link>
  190. <ul className='dropdown-menu'>
  191. <li><Link to='/male/amarr/amarr'>Amarr</Link></li>
  192. <li><Link to='/male/amarr/ni-kunni'>Ni-Kunni</Link></li>
  193. <li><Link to='/male/amarr/khanid'>Khanid</Link></li>
  194. </ul>
  195. </li>
  196. </ul>
  197. </li>
  198. <li><Link to='/add'>Add</Link></li>
  199. </ul>
  200. </div>
  201. </nav>
  202. );
  203. }
  204. }
  205. Navbar.contextTypes = {
  206. router: React.PropTypes.func.isRequired
  207. };
  208. export default Navbar;

必须承认,这里使用循环的话可以少写一些代码,但现在这样对我来说更直观。

你可能立刻注意到的一个东西是class变量contextTypes。我们需要它来引用router的实例,从而让我们能访问当前路径、请求参数、路由参数以及到其它路由的变换。我们不在Navbar组件里直接使用它,而是将它作为一个参数传递给Navbar action,以使它能导航到特定character资料页面。

componentDidMount是我们发起与Socket.IO的连接,并初始化ajaxStartajaxComplete时间监听器地方,我们会在AJAX请求时在NEF logo旁边显示加载指示。

handleSubmit是用来处理表单提交的程序,在按下Enter键或点击Search图标时执行。它会做一些输入清理和验证工作,然后触发findCharacter action。另外我们还传递了搜索区域的DOM节点给action,以便当搜索结果为0时加载一个震动动画。

Actions

app/actions目录下新建文件NavbarActions.js

  1. import alt from '../alt';
  2. import {assign} from 'underscore';
  3. class NavbarActions {
  4. constructor() {
  5. this.generateActions(
  6. 'updateOnlineUsers',
  7. 'updateAjaxAnimation',
  8. 'updateSearchQuery',
  9. 'getCharacterCountSuccess',
  10. 'getCharacterCountFail',
  11. 'findCharacterSuccess',
  12. 'findCharacterFail'
  13. );
  14. }
  15. findCharacter(payload) {
  16. $.ajax({
  17. url: '/api/characters/search',
  18. data: { name: payload.searchQuery }
  19. })
  20. .done((data) => {
  21. assign(payload, data);
  22. this.actions.findCharacterSuccess(payload);
  23. })
  24. .fail(() => {
  25. this.actions.findCharacterFail(payload);
  26. });
  27. }
  28. getCharacterCount() {
  29. $.ajax({ url: '/api/characters/count' })
  30. .done((data) => {
  31. this.actions.getCharacterCountSuccess(data)
  32. })
  33. .fail((jqXhr) => {
  34. this.actions.getCharacterCountFail(jqXhr)
  35. });
  36. }
  37. }
  38. export default alt.createActions(NavbarActions);

我想大多数action的命名应该能够自我解释,不过为了更清楚的理解,在下面简单的描述一下它们是干什么的:

Action Description
updateOnlineUsers 当Socket.IO事件更新时设置在线用户数
updateAjaxAnimation 添加"fadeIn"或"fadeOut"类到加载指示器
updateSearchQuery 当使用键盘时设置搜索请求
getCharacterCount 从服务器获取总角色数
getCharacterCountSuccess 返回角色总数
getCharacterCountFail 返回jQuery jqXhr对象
findCharacter 根据名称查找角色

Store

app/stores目录下创建NavbarStore.js

  1. import alt from '../alt';
  2. import NavbarActions from '../actions/NavbarActions';
  3. class NavbarStore {
  4. constructor() {
  5. this.bindActions(NavbarActions);
  6. this.totalCharacters = 0;
  7. this.onlineUsers = 0;
  8. this.searchQuery = '';
  9. this.ajaxAnimationClass = '';
  10. }
  11. onFindCharacterSuccess(payload) {
  12. payload.router.transitionTo('/characters/' + payload.characterId);
  13. }
  14. onFindCharacterFail(payload) {
  15. payload.searchForm.classList.add('shake');
  16. setTimeout(() => {
  17. payload.searchForm.classList.remove('shake');
  18. }, 1000);
  19. }
  20. onUpdateOnlineUsers(data) {
  21. this.onlineUsers = data.onlineUsers;
  22. }
  23. onUpdateAjaxAnimation(className) {
  24. this.ajaxAnimationClass = className; //fadein or fadeout
  25. }
  26. onUpdateSearchQuery(event) {
  27. this.searchQuery = event.target.value;
  28. }
  29. onGetCharacterCountSuccess(data) {
  30. this.totalCharacters = data.count;
  31. }
  32. onGetCharacterCountFail(jqXhr) {
  33. toastr.error(jqXhr.responseJSON.message);
  34. }
  35. }
  36. export default alt.createStore(NavbarStore);

回忆一下我们在Navbar组件中的代码:

  1. <input type='text' className='form-control' placeholder={this.state.totalCharacters + ' characters'} value={this.state.searchQuery} onChange={NavbarActions.updateSearchQuery} />

因为onChange方法返回一个event对象,所以这里我们在onUpdateSearchQuery使用event.target.value来获取输入框的值。

再次打开App.js并导入Navbar组件:

  1. import Navbar from './Navbar';

然后在<RouterHandler />添加<Navbar />组件:

  1. <div>
  2. <Navbar />
  3. <RouteHandler />
  4. <Footer />
  5. </div>

由于我们还没有设置服务器端的Socke.IO,也没有实现任何API,所以现在你应该看不到在线访问人数或总的character数。

第十步:Socke.IO - 实时用户数

本节我们将聚焦在服务器端的Socket.IO。

打开server.js并找到下面的代码:

  1. app.listen(app.get('port'), function() {
  2. console.log('Express server listening on port ' + app.get('port'));
  3. });

用下面的代码替换上面的:

  1. /**
  2. * Socket.io stuff.
  3. */
  4. var server = require('http').createServer(app);
  5. var io = require('socket.io')(server);
  6. var onlineUsers = 0;
  7. io.sockets.on('connection', function(socket) {
  8. onlineUsers++;
  9. io.sockets.emit('onlineUsers', { onlineUsers: onlineUsers });
  10. socket.on('disconnect', function() {
  11. onlineUsers--;
  12. io.sockets.emit('onlineUsers', { onlineUsers: onlineUsers });
  13. });
  14. });
  15. server.listen(app.get('port'), function() {
  16. console.log('Express server listening on port ' + app.get('port'));
  17. });

概括的来说,当发起一个WebSocket连接,它增加onlineUsers数量(一个全局变量)并发布一个广播——“嘿,我现在有这么多在线访问者啦!”当某人关闭浏览器离开,onlineUsers数量减少并再次发布广播“嘿,有人刚刚离开了,我现在有这么多在线访问者了。”

注意:如果你从来没用过Socket.IO,那么这个聊天室应用教程非常适合你。

打开views目录下的index.html并添加下面的代码到其它script标签下面:

  1. <script src="/socket.io/socket.io.js"></script>

刷新浏览器,然后在不同的标签页打开http://localhost:3000以模拟不同的用户连接。现在你应该能在logo的圆点上看到访问者总数了。

到目前为止,我们既没有完成前端,也没有能用的API端点。我们可以在教程前半部分专注在前端,然后在后半部分专注于后端,或者反过来。但就我个人来说,我从来没像这样构建过任何App。在开发过程中,我一般在前端和后端之间切换着来做。

第十一步:添加Character的组件

这个组件包含一个简单的表单。成功或失败的消息会显示在输入框下的help-block里。

组件

app/components目录新建文件AddCharacter.js

  1. import React from 'react';
  2. import AddCharacterStore from '../stores/AddCharacterStore';
  3. import AddCharacterActions from '../actions/AddCharacterActions';
  4. class AddCharacter extends React.Component {
  5. constructor(props) {
  6. super(props);
  7. this.state = AddCharacterStore.getState();
  8. this.onChange = this.onChange.bind(this);
  9. }
  10. componentDidMount() {
  11. AddCharacterStore.listen(this.onChange);
  12. }
  13. componentWillUnmount() {
  14. AddCharacterStore.unlisten(this.onChange);
  15. }
  16. onChange(state) {
  17. this.setState(state);
  18. }
  19. handleSubmit(event) {
  20. event.preventDefault();
  21. var name = this.state.name.trim();
  22. var gender = this.state.gender;
  23. if (!name) {
  24. AddCharacterActions.invalidName();
  25. this.refs.nameTextField.getDOMNode().focus();
  26. }
  27. if (!gender) {
  28. AddCharacterActions.invalidGender();
  29. }
  30. if (name && gender) {
  31. AddCharacterActions.addCharacter(name, gender);
  32. }
  33. }
  34. render() {
  35. return (
  36. <div className='container'>
  37. <div className='row flipInX animated'>
  38. <div className='col-sm-8'>
  39. <div className='panel panel-default'>
  40. <div className='panel-heading'>Add Character</div>
  41. <div className='panel-body'>
  42. <form onSubmit={this.handleSubmit.bind(this)}>
  43. <div className={'form-group ' + this.state.nameValidationState}>
  44. <label className='control-label'>Character Name</label>
  45. <input type='text' className='form-control' ref='nameTextField' value={this.state.name}
  46. onChange={AddCharacterActions.updateName} autoFocus/>
  47. <span className='help-block'>{this.state.helpBlock}</span>
  48. </div>
  49. <div className={'form-group ' + this.state.genderValidationState}>
  50. <div className='radio radio-inline'>
  51. <input type='radio' name='gender' id='female' value='Female' checked={this.state.gender === 'Female'}
  52. onChange={AddCharacterActions.updateGender}/>
  53. <label htmlFor='female'>Female</label>
  54. </div>
  55. <div className='radio radio-inline'>
  56. <input type='radio' name='gender' id='male' value='Male' checked={this.state.gender === 'Male'}
  57. onChange={AddCharacterActions.updateGender}/>
  58. <label htmlFor='male'>Male</label>
  59. </div>
  60. </div>
  61. <button type='submit' className='btn btn-primary'>Submit</button>
  62. </form>
  63. </div>
  64. </div>
  65. </div>
  66. </div>
  67. </div>
  68. );
  69. }
  70. }
  71. export default AddCharacter;

现在你可以看到这些组件的一些共同点:

  1. 设置组件的初始状态为store中的值。
  2. componentDidMount中添加store监听者,在componentWillUnmount中移除。
  3. 添加onChange方法,无论何时当store改变后更新组件状态。

handleSubmit方法的作用和你想的一样——处理添加新角色的表单提交。当它为真时我们能在addCharacter action里完成表单验证,不过这样做的话,需要我们将输入区的DOM节点传到action,因为当nameTextField无效时,需要focus在输入框,这样用户可以直接输入而无需点击一下输入框。

Actions

app/actions目录新建AddCharacterActions.js

  1. import alt from '../alt';
  2. class AddCharacterActions {
  3. constructor() {
  4. this.generateActions(
  5. 'addCharacterSuccess',
  6. 'addCharacterFail',
  7. 'updateName',
  8. 'updateGender',
  9. 'invalidName',
  10. 'invalidGender'
  11. );
  12. }
  13. addCharacter(name, gender) {
  14. $.ajax({
  15. type: 'POST',
  16. url: '/api/characters',
  17. data: { name: name, gender: gender }
  18. })
  19. .done((data) => {
  20. this.actions.addCharacterSuccess(data.message);
  21. })
  22. .fail((jqXhr) => {
  23. this.actions.addCharacterFail(jqXhr.responseJSON.message);
  24. });
  25. }
  26. }
  27. export default alt.createActions(AddCharacterActions);

当角色被成功加入数据库后触发addCharacterSuccess,当失败时触发addCharacterFail,失败的原因可能是无效的名字,或角色已经在数据库中存在了。当角色的Name字段和Gender单选框改变时由onChange触发updateNameupdateGender,同样的,当输入的名字无效或没有选择性别时触发invalidNameinvalidGender

Store

app/stores目录新建AddCharacterStore.js

  1. import alt from '../alt';
  2. import AddCharacterActions from '../actions/AddCharacterActions';
  3. class AddCharacterStore {
  4. constructor() {
  5. this.bindActions(AddCharacterActions);
  6. this.name = '';
  7. this.gender = '';
  8. this.helpBlock = '';
  9. this.nameValidationState = '';
  10. this.genderValidationState = '';
  11. }
  12. onAddCharacterSuccess(successMessage) {
  13. this.nameValidationState = 'has-success';
  14. this.helpBlock = successMessage;
  15. }
  16. onAddCharacterFail(errorMessage) {
  17. this.nameValidationState = 'has-error';
  18. this.helpBlock = errorMessage;
  19. }
  20. onUpdateName(event) {
  21. this.name = event.target.value;
  22. this.nameValidationState = '';
  23. this.helpBlock = '';
  24. }
  25. onUpdateGender(event) {
  26. this.gender = event.target.value;
  27. this.genderValidationState = '';
  28. }
  29. onInvalidName() {
  30. this.nameValidationState = 'has-error';
  31. this.helpBlock = 'Please enter a character name.';
  32. }
  33. onInvalidGender() {
  34. this.genderValidationState = 'has-error';
  35. }
  36. }
  37. export default alt.createStore(AddCharacterStore);

nameValidationStategenderValidationState指向Bootstrap提供的代表验证状态的表单控件。

helpBlock是在输入框下显示的状态信息,如“Character has been added successfully”。

onInvalidName方法当Character Name字段为空时触发。如果name在EVE中不存在,将由onAddCharacterFail输出另一个错误信息。

最后,打开routes.js并添加新的路由/add,以及AddCharacter组件方法:

  1. import React from 'react';
  2. import {Route} from 'react-router';
  3. import App from './components/App';
  4. import Home from './components/Home';
  5. import AddCharacter from './components/AddCharacter';
  6. export default (
  7. <Route handler={App}>
  8. <Route path='/' handler={Home} />
  9. <Route path='/add' handler={AddCharacter} />
  10. </Route>
  11. );

这里简单总结了从你输入角色名称开始的整个流程:

  1. 触发updateName action,传递event对象。
  2. 调用onUpdateName store处理程序。
  3. 使用新的名称更新状态。

在下一节,我们将实现添加和保存新character到数据库的后端代码。

第十二步:数据库模式

在根目录新建目录models,然后进入目录并新建文件character.js

  1. var mongoose = require('mongoose');
  2. var characterSchema = new mongoose.Schema({
  3. characterId: { type: String, unique: true, index: true },
  4. name: String,
  5. race: String,
  6. gender: String,
  7. bloodline: String,
  8. wins: { type: Number, default: 0 },
  9. losses: { type: Number, default: 0 },
  10. reports: { type: Number, default: 0 },
  11. random: { type: [Number], index: '2d' },
  12. voted: { type: Boolean, default: false }
  13. });
  14. module.exports = mongoose.model('Character', characterSchema);

一个模式(schema)是你的MongoDB数据库中的数据的一个表示,你能强迫某些字段必须为特定的类型,甚至决定该字段是否必需、唯一或者仅包含指定的元素。

和抽象的模式相比,一个模型(model)是和实践更接近的对象,包含添加、删除、查询、更新数据的方法,在上面,我们创建了一个Character模型并将它暴露出来。

注意:为什么这个教程仍然使用MongoDB?为什么不使用MySQL、PostgreSQL、CouchDB甚至RethinkDB?这是因为对于要构建的应用来说,我并不真正关心数据库层到底是什么样的。我更关注在前端的技术栈,因为这是我最感兴趣的部分。MongoDB也许并适合所有的使用场景,但它是一个合适的通用数据库,并且过去3年来我和它相处良好。

这里大多数字段都能自我解释,不过randomvoted也许需要更多解释:

回到server.js,在文件开头添加下面的代码:

  1. var mongoose = require('mongoose');
  2. var Character = require('./models/character');

为了保证一致性和系统性,我经常按照下面的顺序导入模块:

  1. 核心Node.js模块——path、querystring、http
  2. 第三方NPM库——mongoose、express、request
  3. 应用本身文件——controllers、models、config

最后,为链接到数据库,在依赖模块和Express中间件之间添加下面的代码,它将在我们启动Express app的时候发起一个到MongoDB的连接池:

  1. mongoose.connect(config.database);
  2. mongoose.connection.on('error', function() {
  3. console.info('Error: Could not connect to MongoDB. Did you forget to run `mongod`?');
  4. });

注意:我们将在config.js中设置数据库的hostname以避免硬编码。

在根目录新建另一个文件config.js

  1. module.exports = {
  2. database: process.env.MONGO_URI || 'localhost'
  3. };

它将使用一个环境变量(如果可用)或降级到localhost,这将允许我们在本地开发时使用一个hostname,而在生产环境使用另一个,同时无需修改任何代码。这种方法对于处理OAuth客户端key和secret时特别有用。

现在让我们将它导入到server.js中:

  1. var config = require('./config');

在终端中打开一个新的标签并运行mongod

第十三步:Express API 路由(1/2)

在这一节我们将实现一个Express路由,以获取角色信息并存储进数据库。我们将使用EVE Online API来获取给定character name的Character ID,Race以及Bloodline。

注意:角色性别并不是公开数据,它需要一个API key。在我看来,让New Eden Faces变得非常棒的是它的开放生态:用户并不需要登录即可添加、查看EVE中的角色。这也是为什么我在表单里添加了性别选项让用户自己填写的缘故,虽然它的准确性的确依赖于用户的诚信。

下面的表格列出了每个路由的职责。不过,我们不会实现所有的路由,如果需要的话你可以自己实现它们。

Route POST GET PUT DELETE
/api/characters 添加新角色 获取随机两个角色 更新角色投票胜负信息 删除所有角色
/api/characters/:id N/A 获取角色 更新角色 删除角色

在server.js文件前面添加下列依赖:

  1. var async = require('async');
  2. var request = require('request');

我们将使用async.waterfall来管理多异步操作,使用request来向EVE Online API发起HTTP请求。

将我们的第一个路由添加到Express中间件后面,在第8步创建的React中间件前面:

  1. /**
  2. * POST /api/characters
  3. * Adds new character to the database.
  4. */
  5. app.post('/api/characters', function(req, res, next) {
  6. var gender = req.body.gender;
  7. var characterName = req.body.name;
  8. var characterIdLookupUrl = 'https://api.eveonline.com/eve/CharacterID.xml.aspx?names=' + characterName;
  9. var parser = new xml2js.Parser();
  10. async.waterfall([
  11. function(callback) {
  12. request.get(characterIdLookupUrl, function(err, request, xml) {
  13. if (err) return next(err);
  14. parser.parseString(xml, function(err, parsedXml) {
  15. if (err) return next(err);
  16. try {
  17. var characterId = parsedXml.eveapi.result[0].rowset[0].row[0].$.characterID;
  18. Character.findOne({ characterId: characterId }, function(err, character) {
  19. if (err) return next(err);
  20. if (character) {
  21. return res.status(409).send({ message: character.name + ' is already in the database.' });
  22. }
  23. callback(err, characterId);
  24. });
  25. } catch (e) {
  26. return res.status(400).send({ message: 'XML Parse Error' });
  27. }
  28. });
  29. });
  30. },
  31. function(characterId) {
  32. var characterInfoUrl = 'https://api.eveonline.com/eve/CharacterInfo.xml.aspx?characterID=' + characterId;
  33. request.get({ url: characterInfoUrl }, function(err, request, xml) {
  34. if (err) return next(err);
  35. parser.parseString(xml, function(err, parsedXml) {
  36. if (err) return res.send(err);
  37. try {
  38. var name = parsedXml.eveapi.result[0].characterName[0];
  39. var race = parsedXml.eveapi.result[0].race[0];
  40. var bloodline = parsedXml.eveapi.result[0].bloodline[0];
  41. var character = new Character({
  42. characterId: characterId,
  43. name: name,
  44. race: race,
  45. bloodline: bloodline,
  46. gender: gender,
  47. random: [Math.random(), 0]
  48. });
  49. character.save(function(err) {
  50. if (err) return next(err);
  51. res.send({ message: characterName + ' has been added successfully!' });
  52. });
  53. } catch (e) {
  54. res.status(404).send({ message: characterName + ' is not a registered citizen of New Eden.' });
  55. }
  56. });
  57. });
  58. }
  59. ]);
  60. });

注意:我一般在路由上面写块级注释,包括完整路径和简介,这样我就能使用查找功能(Command+F)来快速寻找路由,如下图所示:

下面就来按部就班的看一下它是如何工作的:

  1. 利用Character Name获取Character ID。
  2. 解析XML响应。
  3. 查询数据库看这个角色是否已经存在。
  4. 将Character ID传递给async.waterfall中的下一个函数。
  5. 利用Character ID获取基本的角色信息。
  6. 解析XML响应。
  7. 添加新角色到数据库。

在浏览器打开http://localhost:3000/add 并添加一些角色,你可以使用下面的名字:

或者,你也可以下载这个MongoDB文件dump并将它导入到你的数据库,它包含4000以上个角色。如果你之前添加了其中的一些角色,可能会出现“duplicate key errors”错误,不用管它:

下载之后使用下面的命令将它导入到数据库:

  1. $ mongorestore newedenfaces.bson

鉴于我们还没有实现相关的API,现在你还不能看到总的角色数,我们将在下下节来实现。

下面让我们先创建Home组件,这是一个初始页面,上面会并排显示两个角色。

译者注:下面会先第15节再第14节,原文如此

第十五步:Home组件

这是一个稍微简单些的组件,它唯一的职责就是显示两张图片并且处理点击事件,用于告知哪个角色胜出。

组件

components目录下新建文件Home.js

  1. import React from 'react';
  2. import {Link} from 'react-router';
  3. import HomeStore from '../stores/HomeStore'
  4. import HomeActions from '../actions/HomeActions';
  5. import {first, without, findWhere} from 'underscore';
  6. class Home extends React.Component {
  7. constructor(props) {
  8. super(props);
  9. this.state = HomeStore.getState();
  10. this.onChange = this.onChange.bind(this);
  11. }
  12. componentDidMount() {
  13. HomeStore.listen(this.onChange);
  14. HomeActions.getTwoCharacters();
  15. }
  16. componentWillUnmount() {
  17. HomeStore.unlisten(this.onChange);
  18. }
  19. onChange(state) {
  20. this.setState(state);
  21. }
  22. handleClick(character) {
  23. var winner = character.characterId;
  24. var loser = first(without(this.state.characters, findWhere(this.state.characters, { characterId: winner }))).characterId;
  25. HomeActions.vote(winner, loser);
  26. }
  27. render() {
  28. var characterNodes = this.state.characters.map((character, index) => {
  29. return (
  30. <div key={character.characterId} className={index === 0 ? 'col-xs-6 col-sm-6 col-md-5 col-md-offset-1' : 'col-xs-6 col-sm-6 col-md-5'}>
  31. <div className='thumbnail fadeInUp animated'>
  32. <img onClick={this.handleClick.bind(this, character)} src={'http://image.eveonline.com/Character/' + character.characterId + '_512.jpg'}/>
  33. <div className='caption text-center'>
  34. <ul className='list-inline'>
  35. <li><strong>Race:</strong> {character.race}</li>
  36. <li><strong>Bloodline:</strong> {character.bloodline}</li>
  37. </ul>
  38. <h4>
  39. <Link to={'/characters/' + character.characterId}><strong>{character.name}</strong></Link>
  40. </h4>
  41. </div>
  42. </div>
  43. </div>
  44. );
  45. });
  46. return (
  47. <div className='container'>
  48. <h3 className='text-center'>Click on the portrait. Select your favorite.</h3>
  49. <div className='row'>
  50. {characterNodes}
  51. </div>
  52. </div>
  53. );
  54. }
  55. }
  56. export default Home;

2015年7月27日更新:修复“Cannot read property 'characterId' of undefined”错误,我更新了在handleClick()方法里获取“失败”的Character ID。它使用_.findWhere在数组里查找“获胜”的角色对象,然后使用_.without获取不包含“获胜”角色的数组,因为数组只包含两个角色,所以这就是我们需要的,然后使用_.first获取数组第一个元素,也就是我们需要的对象。

鉴于角色数组只有两个元素,其实没有必要非要使用map方法不可,虽然这也能达到我们的目的。另一种做法是为characters[0]characters[1]各自创建标记。

  1. render() {
  2. return (
  3. <div className='container'>
  4. <h3 className='text-center'>Click on the portrait. Select your favorite.</h3>
  5. <div className='row'>
  6. <div className='col-xs-6 col-sm-6 col-md-5 col-md-offset-1'>
  7. <div className='thumbnail fadeInUp animated'>
  8. <img onClick={this.handleClick.bind(this, characters[0])} src={'http://image.eveonline.com/Character/' + characters[0].characterId + '_512.jpg'}/>
  9. <div className='caption text-center'>
  10. <ul className='list-inline'>
  11. <li><strong>Race:</strong> {characters[0].race}</li>
  12. <li><strong>Bloodline:</strong> {characters[0].bloodline}</li>
  13. </ul>
  14. <h4>
  15. <Link to={'/characters/' + characters[0].characterId}><strong>{characters[0].name}</strong></Link>
  16. </h4>
  17. </div>
  18. </div>
  19. </div>
  20. <div className='col-xs-6 col-sm-6 col-md-5'>
  21. <div className='thumbnail fadeInUp animated'>
  22. <img onClick={this.handleClick.bind(this, characters[1])} src={'http://image.eveonline.com/Character/' + characters[1].characterId + '_512.jpg'}/>
  23. <div className='caption text-center'>
  24. <ul className='list-inline'>
  25. <li><strong>Race:</strong> {characters[1].race}</li>
  26. <li><strong>Bloodline:</strong> {characters[1].bloodline}</li>
  27. </ul>
  28. <h4>
  29. <Link to={'/characters/' + characters[1].characterId}><strong>{characters[1].name}</strong></Link>
  30. </h4>
  31. </div>
  32. </div>
  33. </div>
  34. </div>
  35. </div>
  36. );
  37. }

第一张图片使用Bootstrap中的col-md-offset-1位移,所以两张图片是完美居中的。

注意我们在点击事件上绑定的不是this.handleClick,而是this.handleClick.bind(this, character)。简单的传递一个事件对象是不够的,它不会给我们任何有用的信息,不像文本字段、单选、复选框元素等。

MSDN文档中的解释:

  1. function.bind(thisArg[, arg1[, arg2[, ...]]])

简单的来说,因为我们需要在handleClick方法里引用this.state,所以需要将this上下文传递进去。另外我们还传递了被点击的角色对象,而不是当前的event对象。

handleClick方法里的character参数代表的是获胜的角色,因为它是被点击的那一个。因为我们仅有两个角色需要判断,所以不难分辨谁是输的那个。接下来将获胜和失败的角色Character ID传递给Character ID action。

Actions

actions目录下新建HomeActions.js

  1. import alt from '../alt';
  2. class HomeActions {
  3. constructor() {
  4. this.generateActions(
  5. 'getTwoCharactersSuccess',
  6. 'getTwoCharactersFail',
  7. 'voteFail'
  8. );
  9. }
  10. getTwoCharacters() {
  11. $.ajax({ url: '/api/characters' })
  12. .done(data => {
  13. this.actions.getTwoCharactersSuccess(data);
  14. })
  15. .fail(jqXhr => {
  16. this.actions.getTwoCharactersFail(jqXhr.responseJSON.message);
  17. });
  18. }
  19. vote(winner, loser) {
  20. $.ajax({
  21. type: 'PUT',
  22. url: '/api/characters' ,
  23. data: { winner: winner, loser: loser }
  24. })
  25. .done(() => {
  26. this.actions.getTwoCharacters();
  27. })
  28. .fail((jqXhr) => {
  29. this.actions.voteFail(jqXhr.responseJSON.message);
  30. });
  31. }
  32. }
  33. export default alt.createActions(HomeActions);

这里我们不需要voteSuccess action,因为getTwoCharacters已经满足了我们的需求。换句话说,在一次成功的投票之后,我们需要从数据库获取两个新的随机角色显示出来。

Store

stores目录下新建文件HomeStore.js

  1. import alt from '../alt';
  2. import HomeActions from '../actions/HomeActions';
  3. class HomeStore {
  4. constructor() {
  5. this.bindActions(HomeActions);
  6. this.characters = [];
  7. }
  8. onGetTwoCharactersSuccess(data) {
  9. this.characters = data;
  10. }
  11. onGetTwoCharactersFail(errorMessage) {
  12. toastr.error(errorMessage);
  13. }
  14. onVoteFail(errorMessage) {
  15. toastr.error(errorMessage);
  16. }
  17. }
  18. export default alt.createStore(HomeStore);

下一步,让我们实现剩下的Express路由,来获取并更新Home组件中的两个角色、获得总角色数量等等。

第十四步:Express API 路由(2/2)

让我们回到server.js。我希望现在你已经明白下面这些路由该放在哪里——在Express中间件后面和React中间件前面。

注意:请理解我们这里将所有的路由都放在server.js,是为了这个教程的方便。在我工作期间所构建的仪表盘项目里,所有的路由都被拆开分散到不同的文件,并放在routes目录下面,并且,所有的路由处理程序也都被打散,分成不同的文件放到controllers目录下。

让我们以获取Home组件中两个角色的路由作为开始。

GET /api/characters

  1. /**
  2. * GET /api/characters
  3. * Returns 2 random characters of the same gender that have not been voted yet.
  4. */
  5. app.get('/api/characters', function(req, res, next) {
  6. var choices = ['Female', 'Male'];
  7. var randomGender = _.sample(choices);
  8. Character.find({ random: { $near: [Math.random(), 0] } })
  9. .where('voted', false)
  10. .where('gender', randomGender)
  11. .limit(2)
  12. .exec(function(err, characters) {
  13. if (err) return next(err);
  14. if (characters.length === 2) {
  15. return res.send(characters);
  16. }
  17. var oppositeGender = _.first(_.without(choices, randomGender));
  18. Character
  19. .find({ random: { $near: [Math.random(), 0] } })
  20. .where('voted', false)
  21. .where('gender', oppositeGender)
  22. .limit(2)
  23. .exec(function(err, characters) {
  24. if (err) return next(err);
  25. if (characters.length === 2) {
  26. return res.send(characters);
  27. }
  28. Character.update({}, { $set: { voted: false } }, { multi: true }, function(err) {
  29. if (err) return next(err);
  30. res.send([]);
  31. });
  32. });
  33. });
  34. });

别忘了在最顶部添加Underscore.js模块,因为我们需要使用它的几个函数_.sample()_.first()_.without()

  1. var _ = require('underscore');

我已经尽力让这段代码易于理解,所以你应该很清楚如何获取两个随机角色。它将随机选择Male或Female性别并查询数据库以获取两个角色,如果获得的角色少于2个,它将尝试用另一个性别进行查询。比如,如果我们有10个男性角色但其中9个已经被投票过了,只显示一个角色没有意义。如果无论是男性还是女性角色查询返回都不足两个角色,说明我们已经耗尽了所有未投票的角色,应该重置投票计数,通过设置所有角色的voted:false即可办到。

PUT /api/characters

这个路由和前一个相关,它会分别更新获胜的wins字段和失败角色的losses字段。

  1. /**
  2. * PUT /api/characters
  3. * Update winning and losing count for both characters.
  4. */
  5. app.put('/api/characters', function(req, res, next) {
  6. var winner = req.body.winner;
  7. var loser = req.body.loser;
  8. if (!winner || !loser) {
  9. return res.status(400).send({ message: 'Voting requires two characters.' });
  10. }
  11. if (winner === loser) {
  12. return res.status(400).send({ message: 'Cannot vote for and against the same character.' });
  13. }
  14. async.parallel([
  15. function(callback) {
  16. Character.findOne({ characterId: winner }, function(err, winner) {
  17. callback(err, winner);
  18. });
  19. },
  20. function(callback) {
  21. Character.findOne({ characterId: loser }, function(err, loser) {
  22. callback(err, loser);
  23. });
  24. }
  25. ],
  26. function(err, results) {
  27. if (err) return next(err);
  28. var winner = results[0];
  29. var loser = results[1];
  30. if (!winner || !loser) {
  31. return res.status(404).send({ message: 'One of the characters no longer exists.' });
  32. }
  33. if (winner.voted || loser.voted) {
  34. return res.status(200).end();
  35. }
  36. async.parallel([
  37. function(callback) {
  38. winner.wins++;
  39. winner.voted = true;
  40. winner.random = [Math.random(), 0];
  41. winner.save(function(err) {
  42. callback(err);
  43. });
  44. },
  45. function(callback) {
  46. loser.losses++;
  47. loser.voted = true;
  48. loser.random = [Math.random(), 0];
  49. loser.save(function(err) {
  50. callback(err);
  51. });
  52. }
  53. ], function(err) {
  54. if (err) return next(err);
  55. res.status(200).end();
  56. });
  57. });
  58. });

这里我们使用async.parallel来同时进行两个数据库查询,因为这两个查询并不相互依赖。不过,因为我们有两个独立的MongoDB文档,还要进行两个独立的异步操作,因此我们还需要另一个async.parallel。一般来说,我们仅在两个角色都完成更新并没有错误后给出一个success的响应。

GET /api/characters/count

MOngoDB有一个内建的count()方法,可以返回所匹配的查询结果的数量。

  1. /**
  2. * GET /api/characters/count
  3. * Returns the total number of characters.
  4. */
  5. app.get('/api/characters/count', function(req, res, next) {
  6. Character.count({}, function(err, count) {
  7. if (err) return next(err);
  8. res.send({ count: count });
  9. });
  10. });

注意:从这个返回总数量的一次性路由上,你可能注意到我们开始与RESTful API设计模式背道而驰。很不幸这就是现实。我还没有在一个能完美实现RESTful API的项目中工作过,你可以参看Apigee写的这篇文章来进一步了解为什么会这样。

GET /api/characters/search

我上次检查时MongoDB还不支持大小写不敏感的查询,所以这里我们需要使用正则表达式,不过还好MongoDB提供了$regex操作符。

  1. /**
  2. * GET /api/characters/search
  3. * Looks up a character by name. (case-insensitive)
  4. */
  5. app.get('/api/characters/search', function(req, res, next) {
  6. var characterName = new RegExp(req.query.name, 'i');
  7. Character.findOne({ name: characterName }, function(err, character) {
  8. if (err) return next(err);
  9. if (!character) {
  10. return res.status(404).send({ message: 'Character not found.' });
  11. }
  12. res.send(character);
  13. });
  14. });

GET /api/characters/:id

这个路由是供角色资料页面使用的(我们将在下一节创建角色组件),教程最开始的图片就是这个页面。

  1. /**
  2. * GET /api/characters/:id
  3. * Returns detailed character information.
  4. */
  5. app.get('/api/characters/:id', function(req, res, next) {
  6. var id = req.params.id;
  7. Character.findOne({ characterId: id }, function(err, character) {
  8. if (err) return next(err);
  9. if (!character) {
  10. return res.status(404).send({ message: 'Character not found.' });
  11. }
  12. res.send(character);
  13. });
  14. });

GET /api/characters/top

当我开始构建这个项目时,我大概有7-9个几乎相同的路由来检索Top 100的角色。在经过一些代码重构后我仅留下了下面这一个:

  1. /**
  2. * GET /api/characters/top
  3. * Return 100 highest ranked characters. Filter by gender, race and bloodline.
  4. */
  5. app.get('/api/characters/top', function(req, res, next) {
  6. var params = req.query;
  7. var conditions = {};
  8. _.each(params, function(value, key) {
  9. conditions[key] = new RegExp('^' + value + '$', 'i');
  10. });
  11. Character
  12. .find(conditions)
  13. .sort('-wins') // Sort in descending order (highest wins on top)
  14. .limit(100)
  15. .exec(function(err, characters) {
  16. if (err) return next(err);
  17. // Sort by winning percentage
  18. characters.sort(function(a, b) {
  19. if (a.wins / (a.wins + a.losses) < b.wins / (b.wins + b.losses)) { return 1; }
  20. if (a.wins / (a.wins + a.losses) > b.wins / (b.wins + b.losses)) { return -1; }
  21. return 0;
  22. });
  23. res.send(characters);
  24. });
  25. });

比如,如果我们对男性、种族为Caldari、血统为Civire的Top 100角色感兴趣,你可以构造这样的URL路径:

  1. GET /api/characters/top?race=caldari&bloodline=civire&gender=male

如果你还不清楚如何构造conditions对象,这段经过注释的代码应该可以解释:

  1. // Query params object
  2. req.query = {
  3. race: 'caldari',
  4. bloodline: 'civire',
  5. gender: 'male'
  6. };
  7. var params = req.query;
  8. var conditions = {};
  9. // This each loop is equivalent...
  10. _.each(params, function(value, key) {
  11. conditions[key] = new RegExp('^' + value + '$', 'i');
  12. });
  13. // To this code
  14. conditions.race = new RegExp('^' + params.race + '$', 'i'); // /caldari$/i
  15. conditions.bloodline = new RegExp('^' + params.bloodline + '$', 'i'); // /civire$/i
  16. conditions.gender = new RegExp('^' + params.gender + '$', 'i'); // /male$/i
  17. // Which ultimately becomes this...
  18. Character
  19. .find({ race: /caldari$/i, bloodline: /civire$/i, gender: /male$/i })

在我们取回获胜数最多的角色后,我们会对胜率进行一个排序,不让最老的角色始终显示在前面。

GET /api/characters/shame

和前一个路由差不多,这个路由会取回失败最多的100个角色:

  1. /**
  2. * GET /api/characters/shame
  3. * Returns 100 lowest ranked characters.
  4. */
  5. app.get('/api/characters/shame', function(req, res, next) {
  6. Character
  7. .find()
  8. .sort('-losses')
  9. .limit(100)
  10. .exec(function(err, characters) {
  11. if (err) return next(err);
  12. res.send(characters);
  13. });
  14. });

POST /api/report

有些角色没有一个有效的avatar(一般是灰色轮廓),另有些角色的avatar是漆黑一片,它们在一开始就不应该添加到数据库中。但因为任何人都能添加任何角色,因此有些时候你需要从数据库移除一些异常角色。这里设置当一个角色被访问者举报4次后将被删除。

  1. /**
  2. * POST /api/report
  3. * Reports a character. Character is removed after 4 reports.
  4. */
  5. app.post('/api/report', function(req, res, next) {
  6. var characterId = req.body.characterId;
  7. Character.findOne({ characterId: characterId }, function(err, character) {
  8. if (err) return next(err);
  9. if (!character) {
  10. return res.status(404).send({ message: 'Character not found.' });
  11. }
  12. character.reports++;
  13. if (character.reports > 4) {
  14. character.remove();
  15. return res.send({ message: character.name + ' has been deleted.' });
  16. }
  17. character.save(function(err) {
  18. if (err) return next(err);
  19. res.send({ message: character.name + ' has been reported.' });
  20. });
  21. });
  22. });

GET /api/stats

最后,为角色的统计创建一个路由。是的,下面的代码可以用async.eachpromises来简化,不过记住,我在两年前开始创建New Eden Faces时对这些方案还不熟悉,到现在绝大部分的后端代码没怎么动过。不过即使这样,这些代码还是足够鲁棒,最少它很明确并且易读。

  1. /**
  2. * GET /api/stats
  3. * Returns characters statistics.
  4. */
  5. app.get('/api/stats', function(req, res, next) {
  6. async.parallel([
  7. function(callback) {
  8. Character.count({}, function(err, count) {
  9. callback(err, count);
  10. });
  11. },
  12. function(callback) {
  13. Character.count({ race: 'Amarr' }, function(err, amarrCount) {
  14. callback(err, amarrCount);
  15. });
  16. },
  17. function(callback) {
  18. Character.count({ race: 'Caldari' }, function(err, caldariCount) {
  19. callback(err, caldariCount);
  20. });
  21. },
  22. function(callback) {
  23. Character.count({ race: 'Gallente' }, function(err, gallenteCount) {
  24. callback(err, gallenteCount);
  25. });
  26. },
  27. function(callback) {
  28. Character.count({ race: 'Minmatar' }, function(err, minmatarCount) {
  29. callback(err, minmatarCount);
  30. });
  31. },
  32. function(callback) {
  33. Character.count({ gender: 'Male' }, function(err, maleCount) {
  34. callback(err, maleCount);
  35. });
  36. },
  37. function(callback) {
  38. Character.count({ gender: 'Female' }, function(err, femaleCount) {
  39. callback(err, femaleCount);
  40. });
  41. },
  42. function(callback) {
  43. Character.aggregate({ $group: { _id: null, total: { $sum: '$wins' } } }, function(err, totalVotes) {
  44. var total = totalVotes.length ? totalVotes[0].total : 0;
  45. callback(err, total);
  46. }
  47. );
  48. },
  49. function(callback) {
  50. Character
  51. .find()
  52. .sort('-wins')
  53. .limit(100)
  54. .select('race')
  55. .exec(function(err, characters) {
  56. if (err) return next(err);
  57. var raceCount = _.countBy(characters, function(character) { return character.race; });
  58. var max = _.max(raceCount, function(race) { return race });
  59. var inverted = _.invert(raceCount);
  60. var topRace = inverted[max];
  61. var topCount = raceCount[topRace];
  62. callback(err, { race: topRace, count: topCount });
  63. });
  64. },
  65. function(callback) {
  66. Character
  67. .find()
  68. .sort('-wins')
  69. .limit(100)
  70. .select('bloodline')
  71. .exec(function(err, characters) {
  72. if (err) return next(err);
  73. var bloodlineCount = _.countBy(characters, function(character) { return character.bloodline; });
  74. var max = _.max(bloodlineCount, function(bloodline) { return bloodline });
  75. var inverted = _.invert(bloodlineCount);
  76. var topBloodline = inverted[max];
  77. var topCount = bloodlineCount[topBloodline];
  78. callback(err, { bloodline: topBloodline, count: topCount });
  79. });
  80. }
  81. ],
  82. function(err, results) {
  83. if (err) return next(err);
  84. res.send({
  85. totalCount: results[0],
  86. amarrCount: results[1],
  87. caldariCount: results[2],
  88. gallenteCount: results[3],
  89. minmatarCount: results[4],
  90. maleCount: results[5],
  91. femaleCount: results[6],
  92. totalVotes: results[7],
  93. leadingRace: results[8],
  94. leadingBloodline: results[9]
  95. });
  96. });
  97. });

最后使用aggregate()方法的操作比较令人费解。必须承认,到这一步我也曾去寻求过帮助。在MongoDB里,聚合(aggregation)操作处理数据记录并且返回计算后的结果。在这里它通过将所有wins数量相加,来计算所有投票的总数。因为投票是一个零和游戏,获胜总数总是和失败总数相同,所以我们同样也可以使用losses数量来计算。

项目到这里基本就完成了。在教程的最后我还将给项目添加更多特性,给它稍稍扩展一下。

第十六步:角色(资料)组件

在这一节里我们将为角色创建资料页面。它和其它组件有些不同,其不同之处在于:

  1. 它有一个覆盖全页面的背景图片。
  2. 从一个角色页面导航至另一个角色页面并不会卸载组件,因此,在componentDidMount内部的getCharacter action仅会被调用一次,比如它更新了URL但并不获取新数据。

Component

app/components目录新建文件Character.js

  1. import React from 'react';
  2. import CharacterStore from '../stores/CharacterStore';
  3. import CharacterActions from '../actions/CharacterActions'
  4. class Character extends React.Component {
  5. constructor(props) {
  6. super(props);
  7. this.state = CharacterStore.getState();
  8. this.onChange = this.onChange.bind(this);
  9. }
  10. componentDidMount() {
  11. CharacterStore.listen(this.onChange);
  12. CharacterActions.getCharacter(this.props.params.id);
  13. $('.magnific-popup').magnificPopup({
  14. type: 'image',
  15. mainClass: 'mfp-zoom-in',
  16. closeOnContentClick: true,
  17. midClick: true,
  18. zoom: {
  19. enabled: true,
  20. duration: 300
  21. }
  22. });
  23. }
  24. componentWillUnmount() {
  25. CharacterStore.unlisten(this.onChange);
  26. $(document.body).removeClass();
  27. }
  28. componentDidUpdate(prevProps) {
  29. // Fetch new charachter data when URL path changes
  30. if (prevProps.params.id !== this.props.params.id) {
  31. CharacterActions.getCharacter(this.props.params.id);
  32. }
  33. }
  34. onChange(state) {
  35. this.setState(state);
  36. }
  37. render() {
  38. return (
  39. <div className='container'>
  40. <div className='profile-img'>
  41. <a className='magnific-popup' href={'https://image.eveonline.com/Character/' + this.state.characterId + '_1024.jpg'}>
  42. <img src={'https://image.eveonline.com/Character/' + this.state.characterId + '_256.jpg'} />
  43. </a>
  44. </div>
  45. <div className='profile-info clearfix'>
  46. <h2><strong>{this.state.name}</strong></h2>
  47. <h4 className='lead'>Race: <strong>{this.state.race}</strong></h4>
  48. <h4 className='lead'>Bloodline: <strong>{this.state.bloodline}</strong></h4>
  49. <h4 className='lead'>Gender: <strong>{this.state.gender}</strong></h4>
  50. <button className='btn btn-transparent'
  51. onClick={CharacterActions.report.bind(this, this.state.characterId)}
  52. disabled={this.state.isReported}>
  53. {this.state.isReported ? 'Reported' : 'Report Character'}
  54. </button>
  55. </div>
  56. <div className='profile-stats clearfix'>
  57. <ul>
  58. <li><span className='stats-number'>{this.state.winLossRatio}</span>Winning Percentage</li>
  59. <li><span className='stats-number'>{this.state.wins}</span> Wins</li>
  60. <li><span className='stats-number'>{this.state.losses}</span> Losses</li>
  61. </ul>
  62. </div>
  63. </div>
  64. );
  65. }
  66. }
  67. Character.contextTypes = {
  68. router: React.PropTypes.func.isRequired
  69. };
  70. export default Character;

componentDidMount里我们将当前Character ID(从URL获取)传递给getCharacter action并且初始化Magnific Popup lightbox插件。

注意:我从未成功使用ref="magnificPopup"进行插件初始化,这也是我采用代码中方法的原因。这也许不是最好的办法,但它能正常工作。

另外你需要注意,角色组件包含一个全页面背景图片,并且在componentWillUnmount时移除,因为其它组件不包含这样的背景图。它又是什么时候添加上去的呢?在store中当成功获取到角色数据时。

最后值得一提的是在componentDidUpdate中发生了什么。如果我们从一个角色页面跳转至另一个角色页面,我们仍然处于角色组件内,它不会被卸载掉。而因为它没有被卸载,componentDidMount不会去获取新角色数据,所以我们需要在componentDidUpdate中获取新数据,只要我们仍然处于同一个角色组件且URL是不同的,比如从/characters/1807823526跳转至/characters/467078888componentDidUpdate在组件的生命周期中,每一次组件状态变化后都会触发。

Actions

app/actions目录新建文件CharacterActions.js

  1. import alt from '../alt';
  2. class CharacterActions {
  3. constructor() {
  4. this.generateActions(
  5. 'reportSuccess',
  6. 'reportFail',
  7. 'getCharacterSuccess',
  8. 'getCharacterFail'
  9. );
  10. }
  11. getCharacter(characterId) {
  12. $.ajax({ url: '/api/characters/' + characterId })
  13. .done((data) => {
  14. this.actions.getCharacterSuccess(data);
  15. })
  16. .fail((jqXhr) => {
  17. this.actions.getCharacterFail(jqXhr);
  18. });
  19. }
  20. report(characterId) {
  21. $.ajax({
  22. type: 'POST',
  23. url: '/api/report',
  24. data: { characterId: characterId }
  25. })
  26. .done(() => {
  27. this.actions.reportSuccess();
  28. })
  29. .fail((jqXhr) => {
  30. this.actions.reportFail(jqXhr);
  31. });
  32. }
  33. }
  34. export default alt.createActions(CharacterActions);

Store

app/store目录新建文件CharacterStore.js

  1. import {assign, contains} from 'underscore';
  2. import alt from '../alt';
  3. import CharacterActions from '../actions/CharacterActions';
  4. class CharacterStore {
  5. constructor() {
  6. this.bindActions(CharacterActions);
  7. this.characterId = 0;
  8. this.name = 'TBD';
  9. this.race = 'TBD';
  10. this.bloodline = 'TBD';
  11. this.gender = 'TBD';
  12. this.wins = 0;
  13. this.losses = 0;
  14. this.winLossRatio = 0;
  15. this.isReported = false;
  16. }
  17. onGetCharacterSuccess(data) {
  18. assign(this, data);
  19. $(document.body).attr('class', 'profile ' + this.race.toLowerCase());
  20. let localData = localStorage.getItem('NEF') ? JSON.parse(localStorage.getItem('NEF')) : {};
  21. let reports = localData.reports || [];
  22. this.isReported = contains(reports, this.characterId);
  23. // If is NaN (from division by zero) then set it to "0"
  24. this.winLossRatio = ((this.wins / (this.wins + this.losses) * 100) || 0).toFixed(1);
  25. }
  26. onGetCharacterFail(jqXhr) {
  27. toastr.error(jqXhr.responseJSON.message);
  28. }
  29. onReportSuccess() {
  30. this.isReported = true;
  31. let localData = localStorage.getItem('NEF') ? JSON.parse(localStorage.getItem('NEF')) : {};
  32. localData.reports = localData.reports || [];
  33. localData.reports.push(this.characterId);
  34. localStorage.setItem('NEF', JSON.stringify(localData));
  35. toastr.warning('Character has been reported.');
  36. }
  37. onReportFail(jqXhr) {
  38. toastr.error(jqXhr.responseJSON.message);
  39. }
  40. }
  41. export default alt.createStore(CharacterStore);

这里我们使用了Underscore的两个辅助函数assigncontains,来合并两个对象并检查数组是否包含指定值。

注意:在我写本教程时Babel.js还不支持Object.assign方法,并且我觉得contains比相同功能的Array.indexOf() > -1可读性要好得多。

就像我在前面解释过的,这个组件在外观上和其它组件有显著的不同。添加profile类到<body>改变了页面整个外观和感觉,至于第二个CSS类,可能是caldarigallenteminmataramarr其中的一个,将决定使用哪一个背景图片。我一般会避免与组件render()之外的DOM直接交互,但这里为简单起见还是允许例外一次。最后,在onGetCharacterSuccess方法里我们需要检查角色在之前是否已经被该用户举报过。如果举报过,举报按钮将设置为disabled。因为这个限制很容易被绕过,所以如果你想严格对待举报的话,你可以在服务端执行一个IP检查。

如果角色是第一次被举报,相关信息会被存储到Local Storage里,因为我们不能在Local Storage存储对象,所以我们需要先用JSON.stringify()转换一下。

最后,打开routes.js并且为/characters/:id添加一个新路由。这个路由使用了动态区段id来匹配任意有效Character ID,同时,别忘了导入Character组件。

  1. import React from 'react';
  2. import {Route} from 'react-router';
  3. import App from './components/App';
  4. import Home from './components/Home';
  5. import AddCharacter from './components/AddCharacter';
  6. import Character from './components/Character';
  7. export default (
  8. <Route handler={App}>
  9. <Route path='/' handler={Home} />
  10. <Route path='/add' handler={AddCharacter} />
  11. <Route path='/characters/:id' handler={Character} />
  12. </Route>
  13. );

刷新浏览器,点击一个角色,现在你应该能看到新的角色资料页面。

下一节我们将介绍如何为Top100角色构建CharacterList组件,并且能够根据性别、种族、血统进行过滤。耻辱墙(Hall of Shame)同样也是该组件的一部分。

第十七步:Top 100 组件

这个组件使用Bootstrap的Media控件作为主要的界面,下面是它看起来的样子:

Component

app/components目录新建文件CharacterList.js

  1. import React from 'react';
  2. import {Link} from 'react-router';
  3. import {isEqual} from 'underscore';
  4. import CharacterListStore from '../stores/CharacterListStore';
  5. import CharacterListActions from '../actions/CharacterListActions';
  6. class CharacterList extends React.Component {
  7. constructor(props) {
  8. super(props);
  9. this.state = CharacterListStore.getState();
  10. this.onChange = this.onChange.bind(this);
  11. }
  12. componentDidMount() {
  13. CharacterListStore.listen(this.onChange);
  14. CharacterListActions.getCharacters(this.props.params);
  15. }
  16. componentWillUnmount() {
  17. CharacterListStore.unlisten(this.onChange);
  18. }
  19. componentDidUpdate(prevProps) {
  20. if (!isEqual(prevProps.params, this.props.params)) {
  21. CharacterListActions.getCharacters(this.props.params);
  22. }
  23. }
  24. onChange(state) {
  25. this.setState(state);
  26. }
  27. render() {
  28. let charactersList = this.state.characters.map((character, index) => {
  29. return (
  30. <div key={character.characterId} className='list-group-item animated fadeIn'>
  31. <div className='media'>
  32. <span className='position pull-left'>{index + 1}</span>
  33. <div className='pull-left thumb-lg'>
  34. <Link to={'/characters/' + character.characterId}>
  35. <img className='media-object' src={'http://image.eveonline.com/Character/' + character.characterId + '_128.jpg'} />
  36. </Link>
  37. </div>
  38. <div className='media-body'>
  39. <h4 className='media-heading'>
  40. <Link to={'/characters/' + character.characterId}>{character.name}</Link>
  41. </h4>
  42. <small>Race: <strong>{character.race}</strong></small>
  43. <br />
  44. <small>Bloodline: <strong>{character.bloodline}</strong></small>
  45. <br />
  46. <small>Wins: <strong>{character.wins}</strong> Losses: <strong>{character.losses}</strong></small>
  47. </div>
  48. </div>
  49. </div>
  50. );
  51. });
  52. return (
  53. <div className='container'>
  54. <div className='list-group'>
  55. {charactersList}
  56. </div>
  57. </div>
  58. );
  59. }
  60. }
  61. CharacterList.contextTypes = {
  62. router: React.PropTypes.func.isRequired
  63. };
  64. export default CharacterList;

鉴于角色数组已经按照胜率进行了排序,我们可以使用index + 1(从1到100)来作为数组下标直接输出角色。

Actions

app/actions目录新建CharacterListActions.js

  1. import alt from '../alt';
  2. class CharacterListActions {
  3. constructor() {
  4. this.generateActions(
  5. 'getCharactersSuccess',
  6. 'getCharactersFail'
  7. );
  8. }
  9. getCharacters(payload) {
  10. let url = '/api/characters/top';
  11. let params = {
  12. race: payload.race,
  13. bloodline: payload.bloodline
  14. };
  15. if (payload.category === 'female') {
  16. params.gender = 'female';
  17. } else if (payload.category === 'male') {
  18. params.gender = 'male';
  19. }
  20. if (payload.category === 'shame') {
  21. url = '/api/characters/shame';
  22. }
  23. $.ajax({ url: url, data: params })
  24. .done((data) => {
  25. this.actions.getCharactersSuccess(data);
  26. })
  27. .fail((jqXhr) => {
  28. this.actions.getCharactersFail(jqXhr);
  29. });
  30. }
  31. }
  32. export default alt.createActions(CharacterListActions);

这里的payload包含React Router参数,这些参数我们将在routes.js中指定。

  1. <Route path=':category' handler={CharacterList}>
  2. <Route path=':race' handler={CharacterList}>
  3. <Route path=':bloodline' handler={CharacterList} />
  4. </Route>
  5. </Route>

比如,如果我们访问http://localhost:3000/female/gallente/intaki ,则payload对象将包括下列数据:

  1. {
  2. category: 'female',
  3. race: 'gallente',
  4. bloodline: 'intaki'
  5. }

Store

app/store目录下新建文件CharacterListStore.js

  1. import alt from '../alt';
  2. import CharacterListActions from '../actions/CharacterListActions';
  3. class CharacterListStore {
  4. constructor() {
  5. this.bindActions(CharacterListActions);
  6. this.characters = [];
  7. }
  8. onGetCharactersSuccess(data) {
  9. this.characters = data;
  10. }
  11. onGetCharactersFail(jqXhr) {
  12. toastr.error(jqXhr.responseJSON.message);
  13. }
  14. }
  15. export default alt.createStore(CharacterListStore);

打开route.js并添加下列路由。所有内嵌路由都使用动态区段,所以不用重复输入。确保它们在路由的最后面,否则:category将会覆盖其它路由如/stats/add/shame。不要忘了导入CharacterList组件:

  1. import React from 'react';
  2. import {Route} from 'react-router';
  3. import App from './components/App';
  4. import Home from './components/Home';
  5. import AddCharacter from './components/AddCharacter';
  6. import Character from './components/Character';
  7. import CharacterList from './components/CharacterList';
  8. export default (
  9. <Route handler={App}>
  10. <Route path='/' handler={Home} />
  11. <Route path='/add' handler={AddCharacter} />
  12. <Route path='/characters/:id' handler={Character} />
  13. <Route path='/shame' handler={CharacterList} />
  14. <Route path=':category' handler={CharacterList}>
  15. <Route path=':race' handler={CharacterList}>
  16. <Route path=':bloodline' handler={CharacterList} />
  17. </Route>
  18. </Route>
  19. </Route>
  20. );

下面是所有动态区段可以取的值:

可以看到,如果我们使用硬编码的话,将如此多的路由包含进去将使route.js变得很长很长。

第十八步:Stats组件

我们最后一个组件非常简单,仅仅是一个包含一般统计的表格,比如角色总数,按种族、性别、总投票等等统计出来的数据。这些代码甚至都无需解释,因为它们很简单。

Component

app/components新建文件Stats.js

  1. import React from 'react';
  2. import StatsStore from '../stores/StatsStore'
  3. import StatsActions from '../actions/StatsActions';
  4. class Stats extends React.Component {
  5. constructor(props) {
  6. super(props);
  7. this.state = StatsStore.getState();
  8. this.onChange = this.onChange.bind(this);
  9. }
  10. componentDidMount() {
  11. StatsStore.listen(this.onChange);
  12. StatsActions.getStats();
  13. }
  14. componentWillUnmount() {
  15. StatsStore.unlisten(this.onChange);
  16. }
  17. onChange(state) {
  18. this.setState(state);
  19. }
  20. render() {
  21. return (
  22. <div className='container'>
  23. <div className='panel panel-default'>
  24. <table className='table table-striped'>
  25. <thead>
  26. <tr>
  27. <th colSpan='2'>Stats</th>
  28. </tr>
  29. </thead>
  30. <tbody>
  31. <tr>
  32. <td>Leading race in Top 100</td>
  33. <td>{this.state.leadingRace.race} with {this.state.leadingRace.count} characters</td>
  34. </tr>
  35. <tr>
  36. <td>Leading bloodline in Top 100</td>
  37. <td>{this.state.leadingBloodline.bloodline} with {this.state.leadingBloodline.count} characters
  38. </td>
  39. </tr>
  40. <tr>
  41. <td>Amarr Characters</td>
  42. <td>{this.state.amarrCount}</td>
  43. </tr>
  44. <tr>
  45. <td>Caldari Characters</td>
  46. <td>{this.state.caldariCount}</td>
  47. </tr>
  48. <tr>
  49. <td>Gallente Characters</td>
  50. <td>{this.state.gallenteCount}</td>
  51. </tr>
  52. <tr>
  53. <td>Minmatar Characters</td>
  54. <td>{this.state.minmatarCount}</td>
  55. </tr>
  56. <tr>
  57. <td>Total votes cast</td>
  58. <td>{this.state.totalVotes}</td>
  59. </tr>
  60. <tr>
  61. <td>Female characters</td>
  62. <td>{this.state.femaleCount}</td>
  63. </tr>
  64. <tr>
  65. <td>Male characters</td>
  66. <td>{this.state.maleCount}</td>
  67. </tr>
  68. <tr>
  69. <td>Total number of characters</td>
  70. <td>{this.state.totalCount}</td>
  71. </tr>
  72. </tbody>
  73. </table>
  74. </div>
  75. </div>
  76. );
  77. }
  78. }
  79. export default Stats;

Actions

app/actions目录新建Stats.js

  1. import alt from '../alt';
  2. class StatsActions {
  3. constructor() {
  4. this.generateActions(
  5. 'getStatsSuccess',
  6. 'getStatsFail'
  7. );
  8. }
  9. getStats() {
  10. $.ajax({ url: '/api/stats' })
  11. .done((data) => {
  12. this.actions.getStatsSuccess(data);
  13. })
  14. .fail((jqXhr) => {
  15. this.actions.getStatsFail(jqXhr);
  16. });
  17. }
  18. }
  19. export default alt.createActions(StatsActions);

Store

app/store目录新建Stats.js

  1. import {assign} from 'underscore';
  2. import alt from '../alt';
  3. import StatsActions from '../actions/StatsActions';
  4. class StatsStore {
  5. constructor() {
  6. this.bindActions(StatsActions);
  7. this.leadingRace = { race: 'Unknown', count: 0 };
  8. this.leadingBloodline = { bloodline: 'Unknown', count: 0 };
  9. this.amarrCount = 0;
  10. this.caldariCount = 0;
  11. this.gallenteCount = 0;
  12. this.minmatarCount = 0;
  13. this.totalVotes = 0;
  14. this.femaleCount = 0;
  15. this.maleCount = 0;
  16. this.totalCount = 0;
  17. }
  18. onGetStatsSuccess(data) {
  19. assign(this, data);
  20. }
  21. onGetStatsFail(jqXhr) {
  22. toastr.error(jqXhr.responseJSON.message);
  23. }
  24. }
  25. export default alt.createStore(StatsStore);

打开routes.js并添加新路由/stats。我们必须将它放在:category路由之前,这样它会被优先执行。

  1. import React from 'react';
  2. import {Route} from 'react-router';
  3. import App from './components/App';
  4. import Home from './components/Home';
  5. import AddCharacter from './components/AddCharacter';
  6. import Character from './components/Character';
  7. import CharacterList from './components/CharacterList';
  8. import Stats from './components/Stats';
  9. export default (
  10. <Route handler={App}>
  11. <Route path='/' handler={Home} />
  12. <Route path='/add' handler={AddCharacter} />
  13. <Route path='/characters/:id' handler={Character} />
  14. <Route path='/shame' handler={CharacterList} />
  15. <Route path='/stats' handler={Stats} />
  16. <Route path=':category' handler={CharacterList}>
  17. <Route path=':race' handler={CharacterList}>
  18. <Route path=':bloodline' handler={CharacterList} />
  19. </Route>
  20. </Route>
  21. </Route>
  22. );

刷新浏览器,你应该看到如下的新Stats组件:

第十九步:部署

现在我们的项目已经完成,而我们终于可以开始部署它了。网上有不少的托管服务提供商,不过如果你关注过我之前的项目或者教程的话,就会知道我为什么这么喜欢Heroku了,不过其它托管商的部署流程应该和它差不太多。

让我们先在根目录创建一个.gitignore文件。然后添加下面的内容,其中大多数来自于Github的gitignore仓库。

  1. # Logs
  2. logs
  3. *.log
  4. # Runtime data
  5. pids
  6. *.pid
  7. *.seed
  8. # Directory for instrumented libs generated by jscoverage/JSCover
  9. lib-cov
  10. # Coverage directory used by tools like istanbul
  11. coverage
  12. # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
  13. .grunt
  14. # Compiled binary addons (http://nodejs.org/api/addons.html)
  15. build/Release
  16. # Dependency directory
  17. # Commenting this out is preferred by some people, see
  18. # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
  19. node_modules
  20. bower_components
  21. # Users Environment Variables
  22. .lock-wscript
  23. # Project
  24. .idea
  25. *.iml
  26. .DS_Store
  27. # Compiled files
  28. public/css/*
  29. public/js/*

注意:我们仅签入源代码到Git中,不包括编译后的CSS和Gulp生成的JavaScript代码。

你还需要在package.json的"scripts"中添加下列代码:

  1. "postinstall": "bower install && gulp build"

因为我们没有签入编译后的CSS和JavaScript,以及第三方库,我们需要使用postinstall命令,让Heroku在部署后编译应用并下载Bower包,否则它将不包含main.css、vendor.js、vendor.bundle.js和bundle.js文件。

下一步,让我们在项目根目录下初始化一个新Git仓库:

  1. $ git init
  2. $ git add .gitignore
  3. $ git commit -m 'initial commit'

现在我们已经准备好将代码推送到Heroku了,不过,我们需要先在Heroku上新建一个应用。在新建应用后顺着下面这个页面的指南操作:

准备完毕后,现在运行下面的命令,这里newedenfaces是我所建应用的名称,把它替换为你在Heroku上新建的应用名称:

  1. $ heroku git:remote -a newedenfaces

然后,点击Settings标签,顺次点击Reveal Config Vars和Edit按钮,添加下面的环境变量,和我们在config.js中的设置相匹配:

KEY VALUE
MONGO_URI mongodb://admin:1234@ds061757.mongolab.com:61757/newedenfaces-tutorial

上面是我为这个教程提供的沙箱数据库,但如果你想创建自己的数据库的话,可以从MongoLabCompose甚至直接从Heroku Addons免费获取。

运行下面的命令,然后我们就大功告成!

  1. $ git push heroku master

现在,你可以从http://<app_name>.herokuapp.com这样的链接看到你的应用了。

第二十步: 附加资源

下面是一些我在学习React、Flux和ES6过程中找到的一些资源,大部分很用,有一些则很有趣。

Link Description
Elemental UI 漂亮的React UI组件库,包含按钮、表单、旋钮、模态框等等
Navigating the React Ecosystem 非常棒的博文,由Tomas Holas所作,探索了ES6、Generator、Babel、React、React Router、Alt、Flux、React表单、Typeahead等等,从很多层面上说它补足了这篇教程,非常推荐。
A Quick Tour Of ES6 关于ES6新特性的追加资源,非常注重实践并且易于阅读的博文
Atomic CSS 一个激进的新方式来设置你的App的样式。它需要花时间适应,不过一旦你适应,它的优点就显现出来了。你不用再使用CSS类,而是直接在组件中使用“原子的”CSS来设置样式。
classnames 一个React插件用于优雅的设置类名
Iso Alt的辅助类,用于从服务器传递原始数据到客户端

总结

在我去年底发布的上一篇博客中,我说道:

祝贺你成功坚持到了最后!这是我发布过最长的博客了。有趣的是,在TV Show Tracker博客中我也说过同样的话。

但是现在,这篇文章比那一篇还要长!我的确没有想到会写这么长,也绝不是为了打破记录而特意这么做。但我的确希望这篇教程对读者有帮助,并且内容丰富。如果你从本文中学到任何一点东西,那么我的辛苦就没有白费。

如果你喜欢这个项目,可以考虑扩展它,甚至基于New Eden Faces创建一个全新的应用。所有这些代码都放在Github上并且是完全免费的,所以你可以按照你的想法使用或修改它。下面是我想到的一些主意:

从我发布的TV Show Tracker教程所收到的邮件,我很高兴看到这些文章几乎对所有水平的人都有用。无论对刚开始编程的初学者,还是对资深的JavaScript专家,或者两者中间的人。

最后是我的一些学习经验,送给那些还在迷茫的人。

如果你还在迷茫是否要学习JavaScript

如果你还在迷茫是否要学习和使用ES6

如果你还在迷茫是否要使用React

如果你还在为如何学习编程而挣扎

如果你是一个寻求建议的大学生

(全文完)

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注