教程

由 18950417101 创建,Loen 最后一次修改 2015-11-06

我们将构建一个简单却真实的评论框,你可以将它放入你的博客,类似disqus、livefyre、facebook提供的实时评论的基础版。

我们将提供以下内容:

  • 一个展示所有评论的视图

  • 一个提交评论的表单

  • 用于构建自定制后台的接口链接(hooks)

同时也包含一些简洁的特性:

  • 评论体验优化: 评论在保存到服务器之前就展现在评论列表,因此用户体验很快。

  • 实时更新: 其他用户的评论将会实时展示。

  • Markdown格式: 用户可以使用MarkDown格式来编辑文本。

想要跳过所有的内容,只查看源代码?

所有代码都在GitHub。

运行一个服务器

虽然它不是入门教程的必需品,但接下来我们会添加一个功能,发送 POST ing请求到服务器。如果这是你熟知的事并且你想创建你自己的服务器,那么就这样干吧。而对于另外的一部分人,为了让你集中精力学习,而不用担忧服务器端方面,我们已经用了以下一系列的语言编写了简单的服务器代码 - JavaScript(使用 Node.js),Python和Ruby。所有代码都在GitHub。你可以查看代码或者下载 zip 文件来开始学习。

开始使用下载的教程,只需开始编辑 public/index.html 

开始学习

在这个教程里面,我们将使用放在 CDN 上预构建好的 JavaScript 文件。打开你最喜欢的编辑器,创建一个新的 HTML 文档:

 <!-- index.html -->
 <html>
  <head>
    <title>Hello React</title>
    <script src="http://fb.me/react- {{site.react_version}}.js"></script>
    <script src="http://fb.me/JSXTransformer- {{site.react_version}}.js"></script>
    <script src="http://code.jquery.com/ jquery-1.10.0.min.js"></script>
  </head>
  <body>
    <div id="content"></div>
    <script type="text/jsx">
      // Your code here
    </script>
  </body>
 </html>

在本教程其余的部分,我们将在此 script 标签中编写我们的 JavaScript 代码。

注意:

因为我们想简化 ajax 请求代码,所以在这里引入 jQuery,但是它对 React 并不是必须的。

你的第一个组件

React 中全是模块化、可组装的组件。以我们的评论框为例,我们将有如下的组件结构:

- CommentBox
  - CommentList
    - Comment
  - CommentForm

让我们构造 CommentBox 组件,它只是一个简单的 <div> 而已:

// tutorial1.jsvar CommentBox = React.createClass({
  render: function() {    return (
      <div className="commentBox">
        Hello, world! I am a CommentBox.
      </div>
    );
  }
});
React.render(
  <CommentBox />,
  document.getElementById('content')
);

JSX语法

首先你注意到 JavaScript 代码中 XML 式的语法语句。我们有一个简单的预编译器,用于将这种语法糖转换成纯的 JavaScript 代码:

// tutorial1-raw.jsvar CommentBox = React.createClass({displayName: 'CommentBox',
  render: function() {    return (
      React.createElement('div', {className: "commentBox"},        "Hello, world! I am a CommentBox."
      )
    );
  }
});
React.render(
  React.createElement(CommentBox, null),  document.getElementById('content')
);

JSX 语法是可选的,但是我们发现 JSX 语句比纯 JavaScript 更加容易使用。阅读更多关于 JSX 语法的文章。

发生了什么

我们通过 JavaScript 对象传递一些方法到 React.createClass() 来创建一个新的React组件。其中最重要的方法是render,该方法返回一颗 React 组件树,这棵树最终将会渲染成 HTML。

这个 <div> 标签不是真实的DOM节点;他们是 React div 组件的实例。你可以认为这些就是React知道如何处理的标记或者一些数据。React 是安全的。我们不生成 HTML 字符串,因此默认阻止了 XSS 攻击。

你没有必要返回基本的 HTML。你可以返回一个你(或者其他人)创建的组件树。这就使得 React 变得组件化:一个关键的前端维护原则。

React.render() 实例化根组件,启动框架,注入标记到原始的 DOM 元素中,作为第二个参数提供。

制作组件

让我们为 CommentList  CommentForm 构建骨架,这也会是一些简单的 <div> 

// tutorial2.jsvar CommentList = React.createClass({
  render: function() {    return (
      <div className="commentList">
        Hello, world! I am a CommentList.
      </div>
    );
  }
});var CommentForm = React.createClass({
  render: function() {    return (
      <div className="commentForm">
        Hello, world! I am a CommentForm.
      </div>
    );
  }
});

下一步,更新 CommentBox 组件,使用这些新的组件:

// tutorial3.jsvar CommentBox = React.createClass({
  render: function() {    return (
      <div className="commentBox">
        <h1>Comments</h1>
        <CommentList />
        <CommentForm />
      </div>
    );
  }
});

注意我们是如何混合 HTML 标签和我们创建的组件。HTML 组件就是普通的 React 组件,就像你定义的一样,只有一点不一样。JSX 编译器会自动重写 HTML 标签为 React.createElement(tagName) 表达式,其它什么都不做。这是为了避免全局命名空间污染。

组件属性

让我们创建我们的第三个组件,Comment。我们想传递给它作者名字和评论文本,以便于我们能够对每一个独立的评论重用相同的代码。首先让我们添加一些评论到 CommentList

// tutorial4.jsvar CommentList = React.createClass({
  render: function() {    return (
      <div className="commentList">
        <Comment author="Pete Hunt">This is one comment</Comment>
        <Comment author="Jordan Walke">This is *another* comment</Comment>
      </div>
    );
  }
});

请注意,我们已经从父节点 CommentList 组件传递给子节点 Comment 组件一些数据。例如,我们传递了 Pete Hunt(通过一个属性)和 This is one comment (通过类似于XML的子节点)给第一个 Comment。从父节点传递到子节点的数据称为 props,是属性(properties)的缩写。

使用props

让我们创建评论组件。通过 props,就能够从中读取到从 CommentList 传递过来的数据,然后渲染一些标记:

// tutorial5.jsvar Comment = React.createClass({
  render: function() {    return (
      <div className="comment">
        <h2 className="commentAuthor">
          {this.props.author}
        </h2>
        {this.props.children}
      </div>
    );
  }
});

在 JSX 中通过将 JavaScript 表达式放在大括号中(作为属性或者子节点),你可以生成文本或者 React 组件到节点树中。我们访问传递给组件的命名属性作为 this.props 的键,任何内嵌的元素作为 this.props.children

添加 Markdown

Markdown 是一种简单的格式化内联文本的方式。例如,用星号包裹文本将会使其强调突出。

首先,添加第三方的 Showdown 库到你的应用。这是一个JavaScript库,处理 Markdown 文本并且转换为原始的 HTML。这需要在你的头部添加一个 script 标签(我们已经在 React 操练场上包含了这个标签):

 <!-- index.html -->
 <head>
  <title>Hello React</title>
  <script src="http://fb.me/react-{{site.react_version}}.js"></script>
  <script src="http://fb.me/JSXTransformer-{{site.react_version}}.js"></script>
  <script src="http://code.jquery.com/jquery-1.10.0.min.js"></script>
  <script src="http://cdnjs.cloudflare.com/ajax/libs/showdown/0.3.1/showdown.min.js"></script>
 </head>

下一步,让我们转换评论文本为 Markdown 格式,然后输出它:

// tutorial6.jsvar converter = new Showdown.converter();var Comment = React.createClass({
  render: function() {    return (
      <div className="comment">
        <h2 className="commentAuthor">
          {this.props.author}
        </h2>
        {converter.makeHtml(this.props.children.toString())}
      </div>
    );
  }
});

我们在这里唯一需要做的就是调用 Showdown 库。我们需要把this.props.children从 React 的包裹文本转换成 Showdown 能处理的原始的字符串,所以我们显示地调用了toString()

但是这里有一个问题!我们渲染的评论在浏览器里面看起来像这样:“<p>This is <em>another</em>comment</p>”。我们想这些标签真正地渲染成 HTML。

那是 React 在保护你免受 XSS 攻击。这里有一种方法解决这个问题,但是框架会警告你别使用这种方法:

// tutorial7.jsvar converter = new Showdown.converter();var Comment = React.createClass({
  render: function() {    var rawMarkup = converter.makeHtml(this.props.children.toString());    return (
      <div className="comment">
        <h2 className="commentAuthor">
          {this.props.author}
        </h2>
        <span dangerouslySetInnerHTML={{"{{"}}__html: rawMarkup}} />
      </div>
    );
  }
});

这是一个特殊的 API,故意让插入原始的 HTML 变得困难,但是对于 Showdown,我们将利用这个后门。

记住: 使用这个功能,你会依赖于 Showdown 的安全性。

接入数据模型

到目前为止,我们已经在源代码里面直接插入了评论数据。相反,让我们渲染一小块JSON数据到评论列表。最终,数据将会来自服务器,但是现在,写在你的源代码中:

// tutorial8.jsvar data = [
  {author: "Pete Hunt", text: "This is one comment"},
  {author: "Jordan Walke", text: "This is *another* comment"}
];

我们需要用一种模块化的方式将数据传入到 CommentList。修改 CommentBox  React.render() 方法,通过 props 传递数据到 CommentList

// tutorial9.js
var CommentBox = React.createClass({
  render: function() {
    return (      <div className="commentBox">
        <h1>Comments</h1>
        <CommentList data={this.props.data} />
        <CommentForm />
      </div>
    );
  }
});

React.render(  <CommentBox data={data} />,
  document.getElementById('content')
);

现在数据在 CommentList 中可用了,让我们动态地渲染评论:

// tutorial10.jsvar CommentList = React.createClass({
  render: function() {    var commentNodes = this.props.data.map(function (comment) {      return (        <Comment author={comment.author}>
          {comment.text}        </Comment>
      );
    });    return (      <div className="commentList">
        {commentNodes}      </div>
    );
  }
});

就是这样!

从服务器获取数据

让我们用一些从服务器获取的动态数据替换硬编码的数据。我们将移除数据属性,用获取数据的URL来替换它:

// tutorial11.jsReact.render(
  <CommentBox url="comments.json" />,
  document.getElementById('content')
);

这个组件和前面的组件是不一样的,因为它必须重新渲染自己。该组件将不会有任何数据,直到请求从服务器返回,此时该组件或许需要渲染一些新的评论。

响应状态变化(Reactive state)

到目前为止,每一个组件都根据自己的 props 渲染了自己一次。props 是不可变的:它们从父节点传递过来,被父节点“拥有”。为了实现交互,我们给组件引进了可变的 statethis.state 是组件私有的,可以通过调用this.setState() 来改变它。当状态更新之后,组件重新渲染自己。

render() methods are written declaratively as functions of this.props and this.state. 框架确保UI始终和输入保持一致。

当服务器获取数据的时候,我们将会用已有的数据改变评论。让我们给 CommentBox 组件添加一个评论数组作为它的状态:

// tutorial12.jsvar CommentBox = React.createClass({
  getInitialState: function() {    return {data: []};
  },
  render: function() {    return (
      <div className="commentBox">
        <h1>Comments</h1>
        <CommentList data={this.state.data} />
        <CommentForm />
      </div>
    );
  }
});

getInitialState()在组件的生命周期中仅执行一次,设置组件的初始化状态。

更新状态

当组件第一次创建的时候,我们想从服务器获取(使用GET方法)一些JSON数据,更新状态,反映出最新的数据。在真实的应用中,这将会是一个动态功能点,但是对于这个例子,我们将会使用一个静态的JSON文件来使事情变得简单:

// tutorial13.json[
  {"author": "Pete Hunt", "text": "This is one comment"},
  {"author": "Jordan Walke", "text": "This is *another* comment"}
]

我们将会使用jQuery帮助发出一个一步的请求到服务器。

注意:因为这会变成一个AJAX应用,你将会需要使用一个web服务器来开发你的应用,而不是一个放置在你的文件系统上面的一个文件。如上所述,我们已经在GitHub上面提供了几个你可以使用的服务器。这些服务器提供了你学习下面教程所需的功能。

// tutorial13.jsvar CommentBox = React.createClass({
  getInitialState: function() {    return {data: []};
  },
  componentDidMount: function() {
    $.ajax({
      url: this.props.url,
      dataType: 'json',
      success: function(data) {        this.setState({data: data});
      }.bind(this),
      error: function(xhr, status, err) {        console.error(this.props.url, status, err.toString());
      }.bind(this)
    });
  },
  render: function() {    return (      <div className="commentBox">
        <h1>Comments</h1>
        <CommentList data={this.state.data} />
        <CommentForm />
      </div>
    );
  }
});

在这里,componentDidMount是一个在组件被渲染的时候React自动调用的方法。动态更新的关键点是调用this.setState()。我们把旧的评论数组替换成从服务器拿到的新的数组,然后UI自动更新。正是有了这种响应式,一个小的改变都会触发实时的更新。这里我们将使用简单的轮询,但是你可以简单地使用WebSockets或者其它技术。

// tutorial14.jsvar CommentBox = React.createClass({
  loadCommentsFromServer: function() {
    $.ajax({
      url: this.props.url,
      dataType: 'json',
      success: function(data) {        this.setState({data: data});
      }.bind(this),
      error: function(xhr, status, err) {        console.error(this.props.url, status, err.toString());
      }.bind(this)
    });
  },
  getInitialState: function() {    return {data: []};
  },
  componentDidMount: function() {    this.loadCommentsFromServer();
    setInterval(this.loadCommentsFromServer, this.props.pollInterval);
  },
  render: function() {    return (      <div className="commentBox">
        <h1>Comments</h1>
        <CommentList data={this.state.data} />
        <CommentForm />
      </div>
    );
  }
});

React.render(  <CommentBox url="comments.json" pollInterval={2000} />,
  document.getElementById('content')
);

我们在这里所做的就是把AJAX调用移到一个分离的方法中去,组件第一次加载以及之后每隔两秒钟,调用这个方法。尝试在你的浏览器中运行,然后改变comments.json文件;在两秒钟之内,改变将会显示出来!

添加新的评论

现在是时候构造表单了。我们的CommentForm组件应该询问用户的名字和评论内容,然后发送一个请求到服务器,保存这条评论。

// tutorial15.jsvar CommentForm = React.createClass({
  render: function() {    return (
      <form className="commentForm">
        <input type="text" placeholder="Your name" />
        <input type="text" placeholder="Say something..." />
        <input type="submit" value="Post" />
      </form>
    );
  }
});

让我们使表单可交互。当用户提交表单的时候,我们应该清空表单,提交一个请求到服务器,然后刷新评论列表。首先,让我们监听表单的提交事件和清空表单。

// tutorial16.jsvar CommentForm = React.createClass({
  handleSubmit: function(e) {
    e.preventDefault();    var author = this.refs.author.getDOMNode().value.trim();    var text = this.refs.text.getDOMNode().value.trim();    if (!text || !author) {      return;
    }    // TODO: send request to the server
    this.refs.author.getDOMNode().value = '';    this.refs.text.getDOMNode().value = '';    return;
  },
  render: function() {    return (
      <form className="commentForm" onSubmit={this.handleSubmit}>
        <input type="text" placeholder="Your name" ref="author" />
        <input type="text" placeholder="Say something..." ref="text" />
        <input type="submit" value="Post" />
      </form>
    );
  }
});
事件

React使用驼峰命名规范的方式给组件绑定事件处理器。我们给表单绑定一个onSubmit处理器,用于当表单提交了合法的输入后清空表单字段。

在事件回调中调用preventDefault()来避免浏览器默认地提交表单。

Refs

我们利用Ref属性给子组件命名,this.refs引用组件。我们可以在组件上调用getDOMNode()获取浏览器本地的DOM元素。

回调函数作为属性

当用户提交评论的时候,我们需要刷新评论列表来加进这条新评论。在CommentBox中完成所有逻辑是合适的,因为CommentBox拥有代表评论列表的状态(state)。

我们需要从子组件传回数据到它的父组件。我们在父组件的render方法中做这件事:传递一个新的回调函数(handleCommentSubmit)到子组件,绑定它到子组件的onCommentSubmit事件上。无论事件什么时候触发,回调函数都将会被调用:

// tutorial17.jsvar CommentBox = React.createClass({
  loadCommentsFromServer: function() {
    $.ajax({
      url: this.props.url,
      dataType: 'json',
      success: function(data) {        this.setState({data: data});
      }.bind(this),
      error: function(xhr, status, err) {        console.error(this.props.url, status, err.toString());
      }.bind(this)
    });
  },
  handleCommentSubmit: function(comment) {    // TODO: submit to the server and refresh the list
  },
  getInitialState: function() {    return {data: []};
  },
  componentDidMount: function() {    this.loadCommentsFromServer();
    setInterval(this.loadCommentsFromServer, this.props.pollInterval);
  },
  render: function() {    return (      <div className="commentBox">
        <h1>Comments</h1>
        <CommentList data={this.state.data} />
        <CommentForm onCommentSubmit={this.handleCommentSubmit} />
      </div>
    );
  }
});

当用户提交表单的时候,让我们在CommentForm中调用这个回调函数:

// tutorial18.jsvar CommentForm = React.createClass({
  handleSubmit: function(e) {
    e.preventDefault();    var author = this.refs.author.getDOMNode().value.trim();    var text = this.refs.text.getDOMNode().value.trim();    if (!text || !author) {      return;
    }    this.props.onCommentSubmit({author: author, text: text});    this.refs.author.getDOMNode().value = '';    this.refs.text.getDOMNode().value = '';    return;
  },
  render: function() {    return (
      <form className="commentForm" onSubmit={this.handleSubmit}>
        <input type="text" placeholder="Your name" ref="author" />
        <input type="text" placeholder="Say something..." ref="text" />
        <input type="submit" value="Post" />
      </form>
    );
  }
});

现在回调函数已经就绪,唯一我们需要做的就是提交到服务器,然后刷新列表:

// tutorial19.jsvar CommentBox = React.createClass({
  loadCommentsFromServer: function() {
    $.ajax({
      url: this.props.url,
      dataType: 'json',
      success: function(data) {        this.setState({data: data});
      }.bind(this),
      error: function(xhr, status, err) {        console.error(this.props.url, status, err.toString());
      }.bind(this)
    });
  },
  handleCommentSubmit: function(comment) {
    $.ajax({
      url: this.props.url,
      dataType: 'json',
      type: 'POST',
      data: comment,
      success: function(data) {        this.setState({data: data});
      }.bind(this),
      error: function(xhr, status, err) {        console.error(this.props.url, status, err.toString());
      }.bind(this)
    });
  },
  getInitialState: function() {    return {data: []};
  },
  componentDidMount: function() {    this.loadCommentsFromServer();
    setInterval(this.loadCommentsFromServer, this.props.pollInterval);
  },
  render: function() {    return (      <div className="commentBox">
        <h1>Comments</h1>
        <CommentList data={this.state.data} />
        <CommentForm onCommentSubmit={this.handleCommentSubmit} />
      </div>
    );
  }
});

优化:提前更新

我们的应用现在已经完成了所有功能,但是在你的评论出现在列表之前,你必须等待请求完成,感觉很慢。我们可以提前添加这条评论到列表中,从而使应用感觉更快。

// tutorial20.jsvar CommentBox = React.createClass({
  loadCommentsFromServer: function() {
    $.ajax({
      url: this.props.url,
      dataType: 'json',
      success: function(data) {        this.setState({data: data});
      }.bind(this),
      error: function(xhr, status, err) {        console.error(this.props.url, status, err.toString());
      }.bind(this)
    });
  },
  handleCommentSubmit: function(comment) {    var comments = this.state.data;    var newComments = comments.concat([comment]);    this.setState({data: newComments});
    $.ajax({
      url: this.props.url,
      dataType: 'json',
      type: 'POST',
      data: comment,
      success: function(data) {        this.setState({data: data});
      }.bind(this),
      error: function(xhr, status, err) {        console.error(this.props.url, status, err.toString());
      }.bind(this)
    });
  },
  getInitialState: function() {    return {data: []};
  },
  componentDidMount: function() {    this.loadCommentsFromServer();
    setInterval(this.loadCommentsFromServer, this.props.pollInterval);
  },
  render: function() {    return (      <div className="commentBox">
        <h1>Comments</h1>
        <CommentList data={this.state.data} />
        <CommentForm onCommentSubmit={this.handleCommentSubmit} />
      </div>
    );
  }
});

祝贺你!

你刚刚通过一些简单步骤够早了一个评论框。了解更多关于为什么使用React的内容,或者深入学习API参考,开始专研!祝你好运!


以上内容是否对您有帮助:
二维码
建议反馈
二维码