Repository: nswbmw/N-blog
Branch: master
Commit: c842ec496fd9
Files: 64
Total size: 128.6 KB
Directory structure:
gitextract_ihiav8sp/
├── .editorconfig
├── .eslintrc.json
├── .github/
│ └── ISSUE_TEMPLATE.md
├── .gitignore
├── README.md
├── book/
│ ├── 1.1 Node.js 的安装与使用.md
│ ├── 1.2 MongoDB 的安装与使用.md
│ ├── 2.1 require.md
│ ├── 2.2 exports 和 module.exports.md
│ ├── 2.3 Promise.md
│ ├── 2.4 环境变量.md
│ ├── 2.5 package.json.md
│ ├── 2.6 npm 使用注意事项.md
│ ├── 3.1 初始化一个 Express 项目.md
│ ├── 3.2 路由.md
│ ├── 3.3 模板引擎.md
│ ├── 3.4 Express 浅析.md
│ ├── 4.1 开发环境.md
│ ├── 4.10 留言.md
│ ├── 4.11 404 页面.md
│ ├── 4.12 错误页面.md
│ ├── 4.13 日志.md
│ ├── 4.14 测试.md
│ ├── 4.15 部署.md
│ ├── 4.2 准备工作.md
│ ├── 4.3 配置文件.md
│ ├── 4.4 功能设计.md
│ ├── 4.5 页面设计.md
│ ├── 4.6 连接数据库.md
│ ├── 4.7 注册.md
│ ├── 4.8 登出与登录.md
│ └── 4.9 文章.md
├── config/
│ └── default.js
├── index.js
├── lib/
│ └── mongo.js
├── logs/
│ └── .gitignore
├── middlewares/
│ └── check.js
├── models/
│ ├── comments.js
│ ├── posts.js
│ └── users.js
├── package.json
├── public/
│ ├── css/
│ │ └── style.css
│ └── img/
│ └── .gitignore
├── routes/
│ ├── comments.js
│ ├── index.js
│ ├── posts.js
│ ├── signin.js
│ ├── signout.js
│ └── signup.js
├── test/
│ └── signup.js
└── views/
├── 404.ejs
├── components/
│ ├── comments.ejs
│ ├── nav-setting.ejs
│ ├── nav.ejs
│ ├── notification.ejs
│ └── post-content.ejs
├── create.ejs
├── edit.ejs
├── footer.ejs
├── header.ejs
├── post.ejs
├── posts.ejs
├── signin.ejs
└── signup.ejs
================================================
FILE CONTENTS
================================================
================================================
FILE: .editorconfig
================================================
# editorconfig.org
root = true
[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
tab_width = 2
[*.md]
trim_trailing_whitespace = false
[Makefile]
indent_style = tab
================================================
FILE: .eslintrc.json
================================================
{
"extends": "standard",
"globals": {
"describe": true,
"beforeEach": true,
"afterEach": true,
"after": true,
"it": true
}
}
================================================
FILE: .github/ISSUE_TEMPLATE.md
================================================
提问方式：
1. 请先从错误栈自己定位问题，尝试亲自解决问题
2. 解决不了再去历史 isuue 里查看是否有相似的问题
3. 最后，提交新的 issue，并将错误代码提交到你的 GitHub，我抽空会帮你调试
不好的提问方式：
1. 只有标题，没有描述
2. 描述不清楚
================================================
FILE: .gitignore
================================================
config/*
!config/default.*
npm-debug.log
node_modules
coverage
================================================
FILE: README.md
================================================
## N-blog
使用 Express + MongoDB 搭建多人博客
## 开发环境
- Node.js: `8.9.1`
- MongoDB: `3.4.10`
- Express: `4.16.2`
## 目录
- 开发环境搭建
- [Node.js 的安装与使用](https://github.com/nswbmw/N-blog/blob/master/book/1.1%20Node.js%20%E7%9A%84%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8.md)
- [安装 Node.js](https://github.com/nswbmw/N-blog/blob/master/book/1.1%20Node.js%20%E7%9A%84%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8.md#111-安装-nodejs)
- [n 和 nvm](https://github.com/nswbmw/N-blog/blob/master/book/1.1%20Node.js%20%E7%9A%84%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8.md#112-n-和-nvm)
- [nrm](https://github.com/nswbmw/N-blog/blob/master/book/1.1%20Node.js%20%E7%9A%84%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8.md#113-nrm)
- [MongoDB 的安装与使用](https://github.com/nswbmw/N-blog/blob/master/book/1.2%20MongoDB%20%E7%9A%84%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8.md)
- [安装与启动 MongoDB](https://github.com/nswbmw/N-blog/blob/master/book/1.2%20MongoDB%20%E7%9A%84%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8.md#121-安装与启动-mongodb)
- [Robomongo 和 MongoChef](https://github.com/nswbmw/N-blog/blob/master/book/1.2%20MongoDB%20%E7%9A%84%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8.md#122-robomongo-和-mongochef)
- Node.js 知识点讲解
- [require](https://github.com/nswbmw/N-blog/blob/master/book/2.1%20require.md)
- [exports 和 module.exports](https://github.com/nswbmw/N-blog/blob/master/book/2.2%20exports%20%E5%92%8C%20module.exports.md)
- [Promise](https://github.com/nswbmw/N-blog/blob/master/book/2.3%20Promise.md)
- [环境变量](https://github.com/nswbmw/N-blog/blob/master/book/2.4%20%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F.md)
- [packge.json](https://github.com/nswbmw/N-blog/blob/master/book/2.5%20package.json.md)
- [semver](https://github.com/nswbmw/N-blog/blob/master/book/2.5%20package.json.md#251-semver)
- [npm 使用注意事项](https://github.com/nswbmw/N-blog/blob/master/book/2.6%20npm%20%E4%BD%BF%E7%94%A8%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9.md)
- [npm init](https://github.com/nswbmw/N-blog/blob/master/book/2.6%20npm%20%E4%BD%BF%E7%94%A8%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9.md#261-npm-init)
- [npm install](https://github.com/nswbmw/N-blog/blob/master/book/2.6%20npm%20%E4%BD%BF%E7%94%A8%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9.md#262-npm-install)
- [npm scripts](https://github.com/nswbmw/N-blog/blob/master/book/2.6%20npm%20%E4%BD%BF%E7%94%A8%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9.md#263-npm-scripts)
- [npm shrinkwrap ](https://github.com/nswbmw/N-blog/blob/master/book/2.6%20npm%20%E4%BD%BF%E7%94%A8%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9.md#264-npm-shrinkwrap)
- Hello, Express
- [初始化一个 Express 项目](https://github.com/nswbmw/N-blog/blob/master/book/3.1%20%E5%88%9D%E5%A7%8B%E5%8C%96%E4%B8%80%E4%B8%AA%20Express%20%E9%A1%B9%E7%9B%AE.md)
- [supervisor](https://github.com/nswbmw/N-blog/blob/master/book/3.1%20%E5%88%9D%E5%A7%8B%E5%8C%96%E4%B8%80%E4%B8%AA%20Express%20%E9%A1%B9%E7%9B%AE.md#311-supervisor)
- [路由](https://github.com/nswbmw/N-blog/blob/master/book/3.2%20%E8%B7%AF%E7%94%B1.md)
- [express.Router](https://github.com/nswbmw/N-blog/blob/master/book/3.2%20%E8%B7%AF%E7%94%B1.md#321-expressrouter)
- [模板引擎](https://github.com/nswbmw/N-blog/blob/master/book/3.3%20%E6%A8%A1%E6%9D%BF%E5%BC%95%E6%93%8E.md)
- [ejs](https://github.com/nswbmw/N-blog/blob/master/book/3.3%20%E6%A8%A1%E6%9D%BF%E5%BC%95%E6%93%8E.md#331-ejs)
- [includes](https://github.com/nswbmw/N-blog/blob/master/book/3.3%20%E6%A8%A1%E6%9D%BF%E5%BC%95%E6%93%8E.md#332-includes)
- [Express 浅析](https://github.com/nswbmw/N-blog/blob/master/book/3.4%20Express%20%E6%B5%85%E6%9E%90.md)
- [中间件与 next](https://github.com/nswbmw/N-blog/blob/master/book/3.4%20Express%20%E6%B5%85%E6%9E%90.md#341-中间件与-next)
- [错误处理](https://github.com/nswbmw/N-blog/blob/master/book/3.4%20Express%20%E6%B5%85%E6%9E%90.md#342-错误处理)
- 一个简单的博客
- [开发环境](https://github.com/nswbmw/N-blog/blob/master/book/4.1%20%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83.md)
- [准备工作](https://github.com/nswbmw/N-blog/blob/master/book/4.2%20%E5%87%86%E5%A4%87%E5%B7%A5%E4%BD%9C.md)
- [目录结构](https://github.com/nswbmw/N-blog/blob/master/book/4.2%20%E5%87%86%E5%A4%87%E5%B7%A5%E4%BD%9C.md#421-目录结构)
- [安装依赖模块](https://github.com/nswbmw/N-blog/blob/master/book/4.2%20%E5%87%86%E5%A4%87%E5%B7%A5%E4%BD%9C.md#422-安装依赖模块)
- [ESLint](https://github.com/nswbmw/N-blog/blob/master/book/4.2%20%E5%87%86%E5%A4%87%E5%B7%A5%E4%BD%9C.md#423-eslint)
- [EditorConfig](https://github.com/nswbmw/N-blog/blob/master/book/4.2%20%E5%87%86%E5%A4%87%E5%B7%A5%E4%BD%9C.md#424-editorconfig)
- [配置文件](https://github.com/nswbmw/N-blog/blob/master/book/4.3%20%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6.md)
- [config-lite](https://github.com/nswbmw/N-blog/blob/master/book/4.3%20%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6.md#431-config-lite)
- [功能设计](https://github.com/nswbmw/N-blog/blob/master/book/4.4%20%E5%8A%9F%E8%83%BD%E8%AE%BE%E8%AE%A1.md)
- [功能与路由设计](https://github.com/nswbmw/N-blog/blob/master/book/4.4%20%E5%8A%9F%E8%83%BD%E8%AE%BE%E8%AE%A1.md#441-功能与路由设计)
- [会话](https://github.com/nswbmw/N-blog/blob/master/book/4.4%20%E5%8A%9F%E8%83%BD%E8%AE%BE%E8%AE%A1.md#442-会话)
- [页面通知](https://github.com/nswbmw/N-blog/blob/master/book/4.4%20%E5%8A%9F%E8%83%BD%E8%AE%BE%E8%AE%A1.md#443-页面通知)
- [权限控制](https://github.com/nswbmw/N-blog/blob/master/book/4.4%20%E5%8A%9F%E8%83%BD%E8%AE%BE%E8%AE%A1.md#444-权限控制)
- [页面设计](https://github.com/nswbmw/N-blog/blob/master/book/4.5%20%E9%A1%B5%E9%9D%A2%E8%AE%BE%E8%AE%A1.md)
- [组件](https://github.com/nswbmw/N-blog/blob/master/book/4.5%20%E9%A1%B5%E9%9D%A2%E8%AE%BE%E8%AE%A1.md#451-组件)
- [app.locals 和 res.locals](https://github.com/nswbmw/N-blog/blob/master/book/4.5%20%E9%A1%B5%E9%9D%A2%E8%AE%BE%E8%AE%A1.md#452-applocals-和-reslocals)
- [连接数据库](https://github.com/nswbmw/N-blog/blob/master/book/4.6%20%E8%BF%9E%E6%8E%A5%E6%95%B0%E6%8D%AE%E5%BA%93.md)
- [为什么使用 Mongolass](https://github.com/nswbmw/N-blog/blob/master/book/4.6%20%E8%BF%9E%E6%8E%A5%E6%95%B0%E6%8D%AE%E5%BA%93.md#461-为什么使用-mongolass)
- [注册](https://github.com/nswbmw/N-blog/blob/master/book/4.7%20%E6%B3%A8%E5%86%8C.md)
- [用户模型设计](https://github.com/nswbmw/N-blog/blob/master/book/4.7%20%E6%B3%A8%E5%86%8C.md#471-用户模型设计)
- [注册页](https://github.com/nswbmw/N-blog/blob/master/book/4.7%20%E6%B3%A8%E5%86%8C.md#472-注册页)
- [注册与文件上传](https://github.com/nswbmw/N-blog/blob/master/book/4.7%20%E6%B3%A8%E5%86%8C.md#473-注册与文件上传)
- [登出与登录](https://github.com/nswbmw/N-blog/blob/master/book/4.8%20%E7%99%BB%E5%87%BA%E4%B8%8E%E7%99%BB%E5%BD%95.md)
- [登出](https://github.com/nswbmw/N-blog/blob/master/book/4.8%20%E7%99%BB%E5%87%BA%E4%B8%8E%E7%99%BB%E5%BD%95.md#481-登出)
- [登录页](https://github.com/nswbmw/N-blog/blob/master/book/4.8%20%E7%99%BB%E5%87%BA%E4%B8%8E%E7%99%BB%E5%BD%95.md#482-登录页)
- [登录](https://github.com/nswbmw/N-blog/blob/master/book/4.8%20%E7%99%BB%E5%87%BA%E4%B8%8E%E7%99%BB%E5%BD%95.md#483-登录)
- [文章](https://github.com/nswbmw/N-blog/blob/master/book/4.9%20%E6%96%87%E7%AB%A0.md)
- [文章模型设计](https://github.com/nswbmw/N-blog/blob/master/book/4.9%20%E6%96%87%E7%AB%A0.md#491-文章模型设计)
- [发表文章](https://github.com/nswbmw/N-blog/blob/master/book/4.9%20%E6%96%87%E7%AB%A0.md#492-发表文章)
- [主页与文章页](https://github.com/nswbmw/N-blog/blob/master/book/4.9%20%E6%96%87%E7%AB%A0.md#493-主页与文章页)
- [编辑与删除文章](https://github.com/nswbmw/N-blog/blob/master/book/4.9%20%E6%96%87%E7%AB%A0.md#494-编辑与删除文章)
- [留言](https://github.com/nswbmw/N-blog/blob/master/book/4.10%20%E7%95%99%E8%A8%80.md)
- [留言模型设计](https://github.com/nswbmw/N-blog/blob/master/book/4.10%20%E7%95%99%E8%A8%80.md#4101-留言模型设计)
- [显示留言](https://github.com/nswbmw/N-blog/blob/master/book/4.10%20%E7%95%99%E8%A8%80.md#4102-显示留言)
- [发表与删除留言](https://github.com/nswbmw/N-blog/blob/master/book/4.10%20%E7%95%99%E8%A8%80.md#4103-发表与删除留言)
- [404页面](https://github.com/nswbmw/N-blog/blob/master/book/4.11%20404%20%E9%A1%B5%E9%9D%A2.md)
- [错误页面](https://github.com/nswbmw/N-blog/blob/master/book/4.12%20%E9%94%99%E8%AF%AF%E9%A1%B5%E9%9D%A2.md)
- [日志](https://github.com/nswbmw/N-blog/blob/master/book/4.13%20%E6%97%A5%E5%BF%97.md)
- [winston 和 express-winston](https://github.com/nswbmw/N-blog/blob/master/book/4.13%20%E6%97%A5%E5%BF%97.md#4131-winston-和-express-winston)
- [.gitignore](https://github.com/nswbmw/N-blog/blob/master/book/4.13%20%E6%97%A5%E5%BF%97.md#4132-gitignore)
- [测试](https://github.com/nswbmw/N-blog/blob/master/book/4.14%20%E6%B5%8B%E8%AF%95.md)
- [mocha 和 supertest](https://github.com/nswbmw/N-blog/blob/master/book/4.14%20%E6%B5%8B%E8%AF%95.md#4141-mocha-和-supertest)
- [测试覆盖率](https://github.com/nswbmw/N-blog/blob/master/book/4.14%20%E6%B5%8B%E8%AF%95.md#4142-测试覆盖率)
- [部署](https://github.com/nswbmw/N-blog/blob/master/book/4.15%20%E9%83%A8%E7%BD%B2.md)
- [申请 MLab](https://github.com/nswbmw/N-blog/blob/master/book/4.15%20%E9%83%A8%E7%BD%B2.md#4151-申请-mlab)
- [pm2](https://github.com/nswbmw/N-blog/blob/master/book/4.15%20%E9%83%A8%E7%BD%B2.md#4152-pm2)
- [部署到 Heroku](https://github.com/nswbmw/N-blog/blob/master/book/4.15%20%E9%83%A8%E7%BD%B2.md#4152-部署到-heroku)
- [部署到 UCloud](https://github.com/nswbmw/N-blog/blob/master/book/4.15%20%E9%83%A8%E7%BD%B2.md#4153-部署到-ucloud)
- [部署到阿里云](https://github.com/nswbmw/N-blog/blob/master/book/4.15%20%E9%83%A8%E7%BD%B2.md#4154-部署到阿里云)
- 扩展训练
- 添加分页功能
- 添加二级评论功能
- 添加标签(tag)功能
## 捐赠
您的捐赠，是我持续开源的动力。
支付宝 | 微信
------|------
 | 
================================================
FILE: book/1.1 Node.js 的安装与使用.md
================================================
## 1.1.1 安装 Node.js
有三种方式安装 Node.js：一是通过安装包安装，二是通过源码编译安装，三是在 Linux 下可以通过 yum|apt-get 安装，在 Mac 下可以通过 [Homebrew](http://brew.sh/) 安装。对于 Windows 和 Mac 用户，推荐使用安装包安装，Linux 用户推荐使用源码编译安装。
#### Windows 和 Mac 安装：
**第一步：**
打开 [Node.js 官网](https://nodejs.org/en/)，可以看到以下两个下载选项：
左边的是 LTS 版，用过 ubuntu 的同学可能比较熟悉，即长期支持版本，大多数人用这个就可以了。右边是最新版，支持最新的语言特性（比如对 ES6 的支持更全面），想尝试新特性的开发者可以安装这个版本。我们选择左边的 v6.9.1 LTS 点击下载。
> 小提示：从 [http://node.green](http://node.green) 上可以看到 Node.js 各个版本对 ES6 的支持情况。
**第二步：**
安装 Node.js，这个没什么好说的，一直点击 `继续` 即可。
**第三步：**
提示安装成功后，打开终端输入以下命令，可以看到 node 和 npm 都已经安装好了：
#### Linux 安装：
Linux 用户可通过源码编译安装：
```sh
curl -O https://nodejs.org/dist/v6.9.1/node-v6.9.1.tar.gz
tar -xzvf node-v6.9.1.tar.gz
cd node-v6.9.1
./configure
make
make install
```
> 注意: 如果编译过程报错，可能是缺少某些依赖包。因为报错内容不尽相同，请读者自行求助搜索引擎或 [stackoverflow](http://stackoverflow.com/)。
## 1.1.2 n 和 nvm
通常我们使用稳定的 LTS 版本的 Node.js 即可，但有的情况下我们又想尝试一下新的特性，我们总不能来回安装不同版本的 Node.js 吧，这个时候我们就需要 [n](https://github.com/tj/n) 或者 [nvm](https://github.com/creationix/nvm) 了。n 和 nvm 是两个常用的 Node.js 版本管理工具，关于 n 和 nvm 的使用以及区别，[这篇文章](http://taobaofed.org/blog/2015/11/17/nvm-or-n/) 讲得特别详细，这里不再赘述。
## 1.1.3 nrm
[nrm](https://github.com/Pana/nrm) 是一个管理 npm 源的工具。用过 ruby 和 gem 的同学会比较熟悉，通常我们会把 gem 源切到国内的淘宝镜像，这样在安装和更新一些包的时候比较快。nrm 同理，用来切换官方 npm 源和国内的 npm 源（如: [cnpm](http://cnpmjs.org/)），当然也可以用来切换官方 npm 源和公司私有 npm 源。
全局安装 nrm:
```sh
npm i nrm -g
```
查看当前 nrm 内置的几个 npm 源的地址：
切换到 cnpm：
下一节：[1.2 MongoDB 的安装与使用](https://github.com/nswbmw/N-blog/blob/master/book/1.2%20MongoDB%20%E7%9A%84%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8.md)
================================================
FILE: book/1.2 MongoDB 的安装与使用.md
================================================
## 1.2.1 安装与启动 MongoDB
- Windows 用户向导：https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/
- Linux 用户向导：https://docs.mongodb.com/manual/administration/install-on-linux/
- Mac 用户向导：https://docs.mongodb.com/manual/tutorial/install-mongodb-on-os-x/
## 1.2.2 Robomongo 和 Mongochef
#### Robomongo
[Robomongo](https://robomongo.org/) 是一个基于 Shell 的跨平台开源 MongoDB 可视化管理工具，支持 Windows、Linux 和 Mac，嵌入了 JavaScript 引擎和 MongoDB mongo，只要你会使用 mongo shell，你就会使用 Robomongo，它还提供了语法高亮、自动补全、差别视图等。
[Robomongo 下载地址](https://robomongo.org/download)
下载并安装成功后点击左上角的 `Create` 创建一个连接，给该连接起个名字如: `localhost`，使用默认地址（localhost）和端口（27017）即可，点击 `Save` 保存。
双击 `localhost` 连接到 MongoDB 并进入交互界面，尝试插入一条数据并查询出来，如下所示:
#### MongoChef
[MongoChef](http://3t.io/mongochef/) 是另一款强大的 MongoDB 可视化管理工具，支持 Windows、Linux 和 Mac。
[MongoChef 下载地址](http://3t.io/mongochef/#mongochef-download-compare)，我们选择左侧的非商业用途的免费版下载。
安装成功后跟 Robomongo 一样，也需要创建一个新的连接的配置，成功后双击进入到 MongoChef 主页面，如下所示:
还可以使用 shell 模式:
> 小提示: MongoChef 相较于 Robomongo 更强大一些，但 Robomongo 比较轻量也能满足大部分的常规需求，所以哪一个适合自己还需读者自行尝试。
上一节：[1.1 Node.js 的安装与使用](https://github.com/nswbmw/N-blog/blob/master/book/1.1%20Node.js%20%E7%9A%84%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8.md)
下一节：[2.1 require](https://github.com/nswbmw/N-blog/blob/master/book/2.1%20require.md)
================================================
FILE: book/2.1 require.md
================================================
require 用来加载一个文件的代码，关于 require 的机制这里不展开讲解，请仔细阅读 [官方文档](https://nodejs.org/api/modules.html)。
简单概括以下几点:
- require 可加载 .js、.json 和 .node 后缀的文件
- require 的过程是同步的，所以这样是错误的:
```sh
setTimeout(() => {
module.exports = { a: 'hello' }
}, 0)
```
require 这个文件得到的是空对象 `{}`
- require 目录的机制是:
- 如果目录下有 package.json 并指定了 main 字段，则用之
- 如果不存在 package.json，则依次尝试加载目录下的 index.js 和 index.node
- require 过的文件会加载到缓存，所以多次 require 同一个文件（模块）不会重复加载
- 判断是否是程序的入口文件有两种方式:
- require.main === module（推荐）
- module.parent === null
#### 循环引用
循环引用（或循环依赖）简单点来说就是 a 文件 require 了 b 文件，然后 b 文件又反过来 require 了 a 文件。我们用 a->b 代表 b require 了 a。
简单的情况:
```
a->b
b->a
```
复杂点的情况:
```
a->b
b->c
c->a
```
循环引用并不会报错，导致的结果是 require 的结果是空对象 `{}`，原因是 b require 了 a，a 又去 require 了 b，此时 b 还没初始化好，所以只能拿到初始值 `{}`。当产生循环引用时一般有两种方法解决：
1. 通过分离共用的代码到另一个文件解决，如上面简单的情况，可拆出共用的代码到 c 中，如下:
```
c->a
c->b
```
2. 不在最外层 require，在用到的地方 require，通常在函数的内部
总的来说，循环依赖的陷阱并不大容易出现，但一旦出现了，对于新手来说还真不好定位。它的存在给我们提了个醒，要时刻注意你项目的依赖关系不要过于复杂，哪天你发现一个你明明已经 exports 了的方法报 `undefined is not a function`，我们就该提醒一下自己：哦，也许是它来了。
官方示例: [https://nodejs.org/api/modules.html#modules_cycles](https://nodejs.org/api/modules.html#modules_cycles)
上一节：[1.2 MongoDB 的安装与使用](https://github.com/nswbmw/N-blog/blob/master/book/1.2%20MongoDB%20%E7%9A%84%E5%AE%89%E8%A3%85%E4%B8%8E%E4%BD%BF%E7%94%A8.md)
下一节：[2.2 exports 和 module.exports](https://github.com/nswbmw/N-blog/blob/master/book/2.2%20exports%20%E5%92%8C%20module.exports.md)
================================================
FILE: book/2.2 exports 和 module.exports.md
================================================
require 用来加载代码，而 exports 和 module.exports 则用来导出代码。
很多新手可能会迷惑于 exports 和 module.exports 的区别，为了更好的理解 exports 和 module.exports 的关系，我们先来巩固下 js 的基础。示例：
**test.js**
```js
var a = {name: 1}
var b = a
console.log(a)
console.log(b)
b.name = 2
console.log(a)
console.log(b)
var b = {name: 3}
console.log(a)
console.log(b)
```
运行 test.js 结果为：
```
{ name: 1 }
{ name: 1 }
{ name: 2 }
{ name: 2 }
{ name: 2 }
{ name: 3 }
```
**解释**：a 是一个对象，b 是对 a 的引用，即 a 和 b 指向同一块内存，所以前两个输出一样。当对 b 作修改时，即 a 和 b 指向同一块内存地址的内容发生了改变，所以 a 也会体现出来，所以第三四个输出一样。当 b 被覆盖时，b 指向了一块新的内存，a 还是指向原来的内存，所以最后两个输出不一样。
明白了上述例子后，我们只需知道三点就知道 exports 和 module.exports 的区别了：
1. module.exports 初始值为一个空对象 {}
2. exports 是指向的 module.exports 的引用
3. require() 返回的是 module.exports 而不是 exports
Node.js 官方文档的截图证实了我们的观点:
#### exports = module.exports = {...}
我们经常看到这样的写法：
```js
exports = module.exports = {...}
```
上面的代码等价于:
```js
module.exports = {...}
exports = module.exports
```
原理很简单：module.exports 指向新的对象时，exports 断开了与 module.exports 的引用，那么通过 exports = module.exports 让 exports 重新指向 module.exports。
> 小提示：ES6 的 import 和 export 不在本文的讲解范围，有兴趣的读者可以去学习阮一峰老师的[《ECMAScript6入门》](http://es6.ruanyifeng.com/)。
上一节：[2.1 require](https://github.com/nswbmw/N-blog/blob/master/book/2.1%20require.md)
下一节：[2.3 Promise](https://github.com/nswbmw/N-blog/blob/master/book/2.3%20Promise.md)
================================================
FILE: book/2.3 Promise.md
================================================
网上已经有许多关于 Promise 的资料了，这里不在赘述。以下 4 个链接供读者学习：
1. https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise （基础）
2. http://liubin.org/promises-book/ （开源 Promise 迷你书）
3. http://fex.baidu.com/blog/2015/07/we-have-a-problem-with-promises/ （进阶）
4. https://promisesaplus.com/ （官方定义规范）
Promise 用于异步流程控制，生成器与 yield 也能实现流程控制（基于 co），但不在本教程讲解范围内，读者可参考我的另一部教程 [N-club](https://github.com/nswbmw/N-club)。async/await 结合 Promise 也可以实现流程控制，有兴趣请查阅 [《ECMAScript6入门》](http://es6.ruanyifeng.com/#docs/async#async函数)。
### 深入 Promise
- [Promise 必知必会（十道题）](https://zhuanlan.zhihu.com/p/30797777)
- [深入 Promise(一)——Promise 实现详解](https://zhuanlan.zhihu.com/p/25178630)
- [深入 Promise(二)——进击的 Promise](https://zhuanlan.zhihu.com/p/25198178)
- [深入 Promise(三)——命名 Promise](https://zhuanlan.zhihu.com/p/25199781)
上一节：[2.2 exports 和 module.exports](https://github.com/nswbmw/N-blog/blob/master/book/2.2%20exports%20%E5%92%8C%20module.exports.md)
下一节：[2.4 环境变量](https://github.com/nswbmw/N-blog/blob/master/book/2.4%20%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F.md)
================================================
FILE: book/2.4 环境变量.md
================================================
环境变量不属于 Node.js 的知识范畴，只不过我们在开发 Node.js 应用时经常与环境变量打交道，所以这里简单介绍下。
环境变量（environment variables）一般是指在操作系统中用来指定操作系统运行环境的一些参数。在 Mac 和 Linux 的终端直接输入 env，会列出当前的环境变量，如：USER=xxx。简单来讲，环境变量就是传递参数给运行程序的。
在 Node.js 中，我们经常这么用:
```sh
NODE_ENV=test node app
```
通过以上命令启动程序，指定当前环境变量 `NODE_ENV` 的值为 test，那么在 app.js 中可通过 `process.env` 来获取环境变量:
```
console.log(process.env.NODE_ENV) //test
```
另一个常见的例子是使用 [debug](https://www.npmjs.com/package/debug) 模块时:
```sh
DEBUG=* node app
```
Windows 用户需要首先设置环境变量，然后再执行程序：
```sh
set DEBUG=*
set NODE_ENV=test
node app
```
或者使用 [cross-env](https://www.npmjs.com/package/cross-env)：
```sh
npm i cross-env -g
```
使用方式：
```sh
cross-env NODE_ENV=test node app
```
上一节：[2.3 Promise](https://github.com/nswbmw/N-blog/blob/master/book/2.3%20Promise.md)
下一节：[2.5 packge.json](https://github.com/nswbmw/N-blog/blob/master/book/2.5%20package.json.md)
================================================
FILE: book/2.5 package.json.md
================================================
package.json 对于 Node.js 应用来说是一个不可或缺的文件，它存储了该 Node.js 应用的名字、版本、描述、作者、入口文件、脚本、版权等等信息。npm 官网有 package.json 每个字段的详细介绍：[https://docs.npmjs.com/files/package.json](https://docs.npmjs.com/files/package.json)。
## 2.5.1 semver
语义化版本（semver）即 dependencies、devDependencies 和 peerDependencies 里的如：`"co": "^4.6.0"`。
semver 格式：`主版本号.次版本号.修订号`。版本号递增规则如下：
- `主版本号`：做了不兼容的 API 修改
- `次版本号`：做了向下兼容的功能性新增
- `修订号`：做了向下兼容的 bug 修正
更多阅读：
1. http://semver.org/lang/zh-CN/
2. http://taobaofed.org/blog/2016/08/04/instructions-of-semver/
作为 Node.js 的开发者，我们在发布 npm 模块的时候一定要遵守语义化版本的命名规则，即：有 breaking change 发大版本，有新增的功能发小版本，有小的 bug 修复或优化则发修订版本。
上一节：[2.4 环境变量](https://github.com/nswbmw/N-blog/blob/master/book/2.4%20%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F.md)
下一节：[2.6 npm 使用注意事项](https://github.com/nswbmw/N-blog/blob/master/book/2.6%20npm%20%E4%BD%BF%E7%94%A8%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9.md)
================================================
FILE: book/2.6 npm 使用注意事项.md
================================================
## 2.6.1 npm init
使用 `npm init` 初始化一个空项目是一个好的习惯，即使你对 package.json 及其他属性非常熟悉，`npm init` 也是你开始写新的 Node.js 应用或模块的一个快捷的办法。`npm init` 有智能的默认选项，比如从根目录名称推断模块名称，通过 `~/.npmrc` 读取你的信息，用你的 Git 设置来确定 repository 等等。
## 2.6.2 npm install
`npm install` 是我们最常用的 npm 命令之一，因此我们需要好好了解下这个命令。终端输入 `npm install -h` 查看使用方式:
可以看出：我们通过 `npm install` 可以安装 npm 上发布的某个版本、某个tag、某个版本区间的模块，甚至可以安装本地目录、压缩包和 git/github 的库作为依赖。
> 小提示: `npm i` 是 `npm install` 的简写，建议使用 `npm i`。
直接使用 `npm i` 安装的模块是不会写入 package.json 的 dependencies (或 devDependencies)，需要额外加个参数:
1. `npm i express --save`/`npm i express -S` (安装 express，同时将 `"express": "^4.14.0"` 写入 dependencies )
2. `npm i express --save-dev`/`npm i express -D` (安装 express，同时将 `"express": "^4.14.0"` 写入 devDependencies )
3. `npm i express --save --save-exact` (安装 express，同时将 `"express": "4.14.0"` 写入 dependencies )
第三种方式将固定版本号写入 dependencies，建议线上的 Node.js 应用都采取这种锁定版本号的方式，因为你不可能保证第三方模块下个小版本是没有验证 bug 的，即使是很流行的模块。拿 Mongoose 来说，Mongoose 4.1.4 引入了一个 bug 导致调用一个文档 entry 的 remove 会删除整个集合的文档，见：[https://github.com/Automattic/mongoose/blob/master/History.md#415--2015-09-01](https://github.com/Automattic/mongoose/blob/master/History.md#415--2015-09-01)。
> 后面会介绍更安全的 `npm shrinkwrap` 的用法。
运行以下命令：
```sh
npm config set save-exact true
```
这样每次 `npm i xxx --save` 的时候会锁定依赖的版本号，相当于加了 `--save-exact` 参数。
> 小提示：`npm config set` 命令将配置写到了 ~/.npmrc 文件，运行 `npm config list` 查看。
## 2.6.3 npm scripts
npm 提供了灵活而强大的 scripts 功能，见 [官方文档](https://docs.npmjs.com/misc/scripts)。
npm 的 scripts 有一些内置的缩写命令，如常用的：
- `npm start` 等价于 `npm run start`
- `npm test` 等价于 `npm run test`
## 2.6.4 npm shrinkwrap
前面说过要锁定依赖的版本，但这并不能完全防止意外情况的发生，因为锁定的只是最外一层的依赖，而里层依赖的模块的 package.json 有可能写的是 `"mongoose": "*"`。为了彻底锁定依赖的版本，让你的应用在任何机器上安装的都是同样版本的模块（不管嵌套多少层），通过运行 `npm shrinkwrap`，会在当前目录下产生一个 `npm-shrinkwrap.json`，里面包含了通过 node_modules 计算出的模块的依赖树及版本。上面的截图也显示：只要目录下有 npm-shrinkwrap.json 则运行 `npm install` 的时候会优先使用 npm-shrinkwrap.json 进行安装，没有则使用 package.json 进行安装。
更多阅读：
1. https://docs.npmjs.com/cli/shrinkwrap
2. http://tech.meituan.com/npm-shrinkwrap.html
> 注意: 如果 node_modules 下存在某个模块（如直接通过 `npm install xxx` 安装的）而 package.json 中没有，运行 `npm shrinkwrap` 则会报错。另外，`npm shrinkwrap` 只会生成 dependencies 的依赖，不会生成 devDependencies 的。
上一节：[2.5 packge.json](https://github.com/nswbmw/N-blog/blob/master/book/2.5%20package.json.md)
下一节：[3.1 初始化一个 Express 项目](https://github.com/nswbmw/N-blog/blob/master/book/3.1%20%E5%88%9D%E5%A7%8B%E5%8C%96%E4%B8%80%E4%B8%AA%20Express%20%E9%A1%B9%E7%9B%AE.md)
================================================
FILE: book/3.1 初始化一个 Express 项目.md
================================================
首先，我们新建一个目录 myblog，在该目录下运行 `npm init` 生成一个 package.json，如下所示：
> 注意：括号里的是默认值，如果使用默认值则直接回车即可，否则输入自定义内容后回车。
然后安装 express 并写入 package.json：
```sh
npm i express@4.14.0 --save
```
新建 index.js，添加如下代码：
```js
const express = require('express')
const app = express()
app.get('/', function (req, res) {
res.send('hello, express')
})
app.listen(3000)
```
以上代码的意思是：生成一个 express 实例 app，挂载了一个根路由控制器，然后监听 3000 端口并启动程序。运行 `node index`，打开浏览器访问 `localhost:3000` 时，页面应显示 hello, express。
这是最简单的一个使用 express 的例子，后面会介绍路由及模板的使用。
## 3.1.1 supervisor
在开发过程中，每次修改代码保存后，我们都需要手动重启程序，才能查看改动的效果。使用 [supervisor](https://www.npmjs.com/package/supervisor) 可以解决这个繁琐的问题，全局安装 supervisor：
```sh
npm i -g supervisor
```
运行 `supervisor index` 启动程序，如下所示：
supervisor 会监听当前目录下 node 和 js 后缀的文件，当这些文件发生改动时，supervisor 会自动重启程序。
上一节：[2.6 npm 使用注意事项](https://github.com/nswbmw/N-blog/blob/master/book/2.6%20npm%20%E4%BD%BF%E7%94%A8%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9.md)
下一节：[3.2 路由](https://github.com/nswbmw/N-blog/blob/master/book/3.2%20%E8%B7%AF%E7%94%B1.md)
================================================
FILE: book/3.2 路由.md
================================================
前面我们只是挂载了根路径的路由控制器，现在修改 index.js 如下：
```js
const express = require('express')
const app = express()
app.get('/', function (req, res) {
res.send('hello, express')
})
app.get('/users/:name', function (req, res) {
res.send('hello, ' + req.params.name)
})
app.listen(3000)
```
以上代码的意思是：当访问根路径时，依然返回 hello, express，当访问如 `localhost:3000/users/nswbmw` 路径时，返回 hello, nswbmw。路径中 `:name` 起了占位符的作用，这个占位符的名字是 name，可以通过 `req.params.name` 取到实际的值。
> 小提示：express 使用了 [path-to-regexp](https://www.npmjs.com/package/path-to-regexp) 模块实现的路由匹配。
不难看出：req 包含了请求来的相关信息，res 则用来返回该请求的响应，更多请查阅 [express 官方文档](http://expressjs.com/en/4x/api.html)。下面介绍几个常用的 req 的属性：
- `req.query`: 解析后的 url 中的 querystring，如 `?name=haha`，req.query 的值为 `{name: 'haha'}`
- `req.params`: 解析 url 中的占位符，如 `/:name`，访问 /haha，req.params 的值为 `{name: 'haha'}`
- `req.body`: 解析后请求体，需使用相关的模块，如 [body-parser](https://www.npmjs.com/package/body-parser)，请求体为 `{"name": "haha"}`，则 req.body 为 `{name: 'haha'}`
## 3.2.1 express.Router
上面只是很简单的路由使用的例子（将所有路由控制函数都放到了 index.js），但在实际开发中通常有几十甚至上百的路由，都写在 index.js 既臃肿又不好维护，这时可以使用 express.Router 实现更优雅的路由解决方案。在 myblog 目录下创建空文件夹 routes，在 routes 目录下创建 index.js 和 users.js。最后代码如下：
**index.js**
```js
const express = require('express')
const app = express()
const indexRouter = require('./routes/index')
const userRouter = require('./routes/users')
app.use('/', indexRouter)
app.use('/users', userRouter)
app.listen(3000)
```
**routes/index.js**
```js
const express = require('express')
const router = express.Router()
router.get('/', function (req, res) {
res.send('hello, express')
})
module.exports = router
```
**routes/users.js**
```js
const express = require('express')
const router = express.Router()
router.get('/:name', function (req, res) {
res.send('hello, ' + req.params.name)
})
module.exports = router
```
以上代码的意思是：我们将 `/` 和 `/users/:name` 的路由分别放到了 routes/index.js 和 routes/users.js 中，每个路由文件通过生成一个 express.Router 实例 router 并导出，通过 `app.use` 挂载到不同的路径。这两种代码实现了相同的功能，但在实际开发中推荐使用 express.Router 将不同的路由分离到不同的路由文件中。
更多 express.Router 的用法见 [express 官方文档](http://expressjs.com/en/4x/api.html#router)。
上一节：[3.1 初始化一个 Express 项目](https://github.com/nswbmw/N-blog/blob/master/book/3.1%20%E5%88%9D%E5%A7%8B%E5%8C%96%E4%B8%80%E4%B8%AA%20Express%20%E9%A1%B9%E7%9B%AE.md)
下一节：[3.3 模板引擎](https://github.com/nswbmw/N-blog/blob/master/book/3.3%20%E6%A8%A1%E6%9D%BF%E5%BC%95%E6%93%8E.md)
================================================
FILE: book/3.3 模板引擎.md
================================================
模板引擎（Template Engine）是一个将页面模板和数据结合起来生成 html 的工具。上例中，我们只是返回纯文本给浏览器，现在我们修改代码返回一个 html 页面给浏览器。
## 3.3.1 ejs
模板引擎有很多，[ejs](https://www.npmjs.com/package/ejs) 是其中一种，因为它使用起来十分简单，而且与 express 集成良好，所以我们使用 ejs。安装 ejs：
```sh
npm i ejs --save
```
修改 index.js 如下：
**index.js**
```js
const path = require('path')
const express = require('express')
const app = express()
const indexRouter = require('./routes/index')
const userRouter = require('./routes/users')
app.set('views', path.join(__dirname, 'views'))// 设置存放模板文件的目录
app.set('view engine', 'ejs')// 设置模板引擎为 ejs
app.use('/', indexRouter)
app.use('/users', userRouter)
app.listen(3000)
```
通过 `app.set` 设置模板引擎为 ejs 和存放模板的目录。在 myblog 下新建 views 文件夹，在 views 下新建 users.ejs，添加如下代码：
**views/users.ejs**
```html
<%= name.toUpperCase() %>
hello, <%= name %>
```
修改 routes/users.js 如下：
**routes/users.js**
```js
const express = require('express')
const router = express.Router()
router.get('/:name', function (req, res) {
res.render('users', {
name: req.params.name
})
})
module.exports = router
```
通过调用 `res.render` 函数渲染 ejs 模板，res.render 第一个参数是模板的名字，这里是 users 则会匹配 views/users.ejs，第二个参数是传给模板的数据，这里传入 name，则在 ejs 模板中可使用 name。`res.render` 的作用就是将模板和数据结合生成 html，同时设置响应头中的 `Content-Type: text/html`，告诉浏览器我返回的是 html，不是纯文本，要按 html 展示。现在我们访问 `localhost:3000/users/haha`，如下图所示：
上面代码可以看到，我们在模板 `<%= name.toUpperCase() %>` 中使用了 JavaScript 的语法 `.toUpperCase()` 将名字转化为大写，那这个 `<%= xxx %>` 是什么东西呢？ejs 有 3 种常用标签：
1. `<% code %>`：运行 JavaScript 代码，不输出
2. `<%= code %>`：显示转义后的 HTML内容
3. `<%- code %>`：显示原始 HTML 内容
> 注意：`<%= code %>` 和 `<%- code %>` 都可以是 JavaScript 表达式生成的字符串，当变量 code 为普通字符串时，两者没有区别。当 code 比如为 `hello
` 这种字符串时，`<%= code %>` 会原样输出 `hello
`，而 `<%- code %>` 则会显示 H1 大的 hello 字符串。
下面的例子解释了 `<% code %>` 的用法：
**Data**
```
supplies: ['mop', 'broom', 'duster']
```
**Template**
```ejs
<% for(var i=0; i
- <%= supplies[i] %>
<% } %>
```
**Result**
```html
```
更多 ejs 的标签请看 [官方文档](https://www.npmjs.com/package/ejs#tags)。
## 3.3.2 includes
我们使用模板引擎通常不是一个页面对应一个模板，这样就失去了模板的优势，而是把模板拆成可复用的模板片段组合使用，如在 views 下新建 header.ejs 和 footer.ejs，并修改 users.ejs：
**views/header.ejs**
```ejs
```
**views/footer.ejs**
```ejs
```
**views/users.ejs**
```ejs
<%- include('header') %>
<%= name.toUpperCase() %>
hello, <%= name %>
<%- include('footer') %>
```
我们将原来的 users.ejs 拆成出了 header.ejs 和 footer.ejs，并在 users.ejs 通过 ejs 内置的 include 方法引入，从而实现了跟以前一个模板文件相同的功能。
> 小提示：拆分模板组件通常有两个好处：
>
> 1. 模板可复用，减少重复代码
> 2. 主模板结构清晰
> 注意：要用 `<%- include('header') %>` 而不是 `<%= include('header') %>`
上一节：[3.2 路由](https://github.com/nswbmw/N-blog/blob/master/book/3.2%20%E8%B7%AF%E7%94%B1.md)
下一节：[3.4 Express 浅析](https://github.com/nswbmw/N-blog/blob/master/book/3.4%20Express%20%E6%B5%85%E6%9E%90.md)
================================================
FILE: book/3.4 Express 浅析.md
================================================
前面我们讲解了 express 中路由和模板引擎 ejs 的用法，但 express 的精髓并不在此，在于中间件的设计理念。
## 3.4.1 中间件与 next
express 中的中间件（middleware）就是用来处理请求的，当一个中间件处理完，可以通过调用 `next()` 传递给下一个中间件，如果没有调用 `next()`，则请求不会往下传递，如内置的 `res.render` 其实就是渲染完 html 直接返回给客户端，没有调用 `next()`，从而没有传递给下一个中间件。看个小例子，修改 index.js 如下：
**index.js**
```js
const express = require('express')
const app = express()
app.use(function (req, res, next) {
console.log('1')
next()
})
app.use(function (req, res, next) {
console.log('2')
res.status(200).end()
})
app.listen(3000)
```
此时访问 `localhost:3000`，终端会输出：
```
1
2
```
通过 `app.use` 加载中间件，在中间件中通过 next 将请求传递到下一个中间件，next 可接受一个参数接收错误信息，如果使用了 `next(error)`，则会返回错误而不会传递到下一个中间件，修改 index.js 如下：
**index.js**
```js
const express = require('express')
const app = express()
app.use(function (req, res, next) {
console.log('1')
next(new Error('haha'))
})
app.use(function (req, res, next) {
console.log('2')
res.status(200).end()
})
app.listen(3000)
```
此时访问 `localhost:3000`，终端会输出错误信息：
浏览器会显示：
> 小提示：`app.use` 有非常灵活的使用方式，详情见 [官方文档](http://expressjs.com/en/4x/api.html#app.use)。
express 有成百上千的第三方中间件，在开发过程中我们首先应该去 npm 上寻找是否有类似实现的中间件，尽量避免造轮子，节省开发时间。下面给出几个常用的搜索 npm 模块的网站：
1. [http://npmjs.com](http://npmjs.com)(npm 官网)
2. [http://node-modules.com](http://node-modules.com)
3. [https://npms.io](https://npms.io)
4. [https://nodejsmodules.org](https://nodejsmodules.org)
> 小提示：express@4 之前的版本基于 connect 这个模块实现的中间件的架构，express@4 及以上的版本则移除了对 connect 的依赖自己实现了，理论上基于 connect 的中间件（通常以 `connect-` 开头，如 `connect-mongo`）仍可结合 express 使用。
> 注意：中间件的加载顺序很重要！比如：通常把日志中间件放到比较靠前的位置，后面将会介绍的 `connect-flash` 中间件是基于 session 的，所以需要在 `express-session` 后加载。
## 3.4.2 错误处理
上面的例子中，应用程序为我们自动返回了错误栈信息（express 内置了一个默认的错误处理器），假如我们想手动控制返回的错误内容，则需要加载一个自定义错误处理的中间件，修改 index.js 如下：
**index.js**
```js
const express = require('express')
const app = express()
app.use(function (req, res, next) {
console.log('1')
next(new Error('haha'))
})
app.use(function (req, res, next) {
console.log('2')
res.status(200).end()
})
//错误处理
app.use(function (err, req, res, next) {
console.error(err.stack)
res.status(500).send('Something broke!')
})
app.listen(3000)
```
此时访问 `localhost:3000`，浏览器会显示 `Something broke!`。
> 小提示：关于 express 的错误处理，详情见 [官方文档](http://expressjs.com/en/guide/error-handling.html)。
上一节：[3.3 模板引擎](https://github.com/nswbmw/N-blog/blob/master/book/3.3%20%E6%A8%A1%E6%9D%BF%E5%BC%95%E6%93%8E.md)
下一节：[4.1 开发环境](https://github.com/nswbmw/N-blog/blob/master/book/4.1%20%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83.md)
================================================
FILE: book/4.1 开发环境.md
================================================
从本章开始，正式学习如何使用 Express + MongoDB 搭建一个博客。
#### Node.js: `8.9.1`
#### MongoDB: `3.4.10`
#### Express: `4.16.2`
上一节：[3.4 Express 浅析](https://github.com/nswbmw/N-blog/blob/master/book/3.4%20Express%20%E6%B5%85%E6%9E%90.md)
下一节：[4.2 准备工作](https://github.com/nswbmw/N-blog/blob/master/book/4.2%20%E5%87%86%E5%A4%87%E5%B7%A5%E4%BD%9C.md)
================================================
FILE: book/4.10 留言.md
================================================
## 4.10.1 留言模型设计
我们只需要留言的作者 id、留言内容和关联的文章 id 这几个字段，修改 lib/mongo.js，添加如下代码：
**lib/mongo.js**
```js
exports.Comment = mongolass.model('Comment', {
author: { type: Mongolass.Types.ObjectId, required: true },
content: { type: 'string', required: true },
postId: { type: Mongolass.Types.ObjectId, required: true }
})
exports.Comment.index({ postId: 1, _id: 1 }).exec()// 通过文章 id 获取该文章下所有留言，按留言创建时间升序
```
## 4.10.2 显示留言
在实现留言功能之前，我们先让文章页可以显示留言列表。首先创建留言的模板，新建 views/components/comments.ejs，添加如下代码：
**views/components/comments.ejs**
```ejs
```
> 注意：我们在提交留言表单时带上了文章 id（postId），通过 hidden 隐藏。
在文章页引入留言的模板片段，修改 views/post.ejs 为：
**views/post.ejs**
```ejs
<%- include('header') %>
<%- include('components/post-content') %>
<%- include('components/comments') %>
<%- include('footer') %>
```
新建 models/comments.js，存放留言相关的数据库操作，添加如下代码：
**models/comments.js**
```js
const marked = require('marked')
const Comment = require('../lib/mongo').Comment
// 将 comment 的 content 从 markdown 转换成 html
Comment.plugin('contentToHtml', {
afterFind: function (comments) {
return comments.map(function (comment) {
comment.content = marked(comment.content)
return comment
})
}
})
module.exports = {
// 创建一个留言
create: function create (comment) {
return Comment.create(comment).exec()
},
// 通过留言 id 获取一个留言
getCommentById: function getCommentById (commentId) {
return Comment.findOne({ _id: commentId }).exec()
},
// 通过留言 id 删除一个留言
delCommentById: function delCommentById (commentId) {
return Comment.deleteOne({ _id: commentId }).exec()
},
// 通过文章 id 删除该文章下所有留言
delCommentsByPostId: function delCommentsByPostId (postId) {
return Comment.deleteMany({ postId: postId }).exec()
},
// 通过文章 id 获取该文章下所有留言，按留言创建时间升序
getComments: function getComments (postId) {
return Comment
.find({ postId: postId })
.populate({ path: 'author', model: 'User' })
.sort({ _id: 1 })
.addCreatedAt()
.contentToHtml()
.exec()
},
// 通过文章 id 获取该文章下留言数
getCommentsCount: function getCommentsCount (postId) {
return Comment.count({ postId: postId }).exec()
}
}
```
> 小提示：我们让留言也支持了 markdown。
> 注意：删除一篇文章成功后也要删除该文章下所有的评论，上面 delCommentsByPostId 就是用来做这件事的。
修改 models/posts.js，在：
**models/posts.js**
```js
const Post = require('../lib/mongo').Post
```
下添加如下代码：
```js
const CommentModel = require('./comments')
// 给 post 添加留言数 commentsCount
Post.plugin('addCommentsCount', {
afterFind: function (posts) {
return Promise.all(posts.map(function (post) {
return CommentModel.getCommentsCount(post._id).then(function (commentsCount) {
post.commentsCount = commentsCount
return post
})
}))
},
afterFindOne: function (post) {
if (post) {
return CommentModel.getCommentsCount(post._id).then(function (count) {
post.commentsCount = count
return post
})
}
return post
}
})
```
在 PostModel 上注册了 `addCommentsCount` 用来给每篇文章添加留言数 `commentsCount`，在 `getPostById` 和 `getPosts` 方法里的：
```
.addCreatedAt()
```
下添加：
```
.addCommentsCount()
```
这样主页和文章页的文章就可以正常显示留言数了。
然后将 `delPostById` 修改为：
```js
// 通过用户 id 和文章 id 删除一篇文章
delPostById: function delPostById (postId, author) {
return Post.deleteOne({ author: author, _id: postId })
.exec()
.then(function (res) {
// 文章删除后，再删除该文章下的所有留言
if (res.result.ok && res.result.n > 0) {
return CommentModel.delCommentsByPostId(postId)
}
})
}
```
> 小提示：虽然目前看起来使用 Mongolass 自定义插件并不能节省代码，反而使代码变多了。Mongolass 插件真正的优势在于：在项目非常庞大时，可通过自定义的插件随意组合（及顺序）实现不同的输出，如上面的 `getPostById` 需要将取出 markdown 转换成 html，则使用 `.contentToHtml()`，否则像 `getRawPostById` 则不必使用。
修改 routes/posts.js，在：
**routes/posts.js**
```js
const PostModel = require('../models/posts')
```
下引入 CommentModel:
```js
const CommentModel = require('../models/comments')
```
在文章页传入留言列表，将：
```js
// GET /posts/:postId 单独一篇的文章页
router.get('/:postId', function (req, res, next) {
...
})
```
修改为：
```js
// GET /posts/:postId 单独一篇的文章页
router.get('/:postId', function (req, res, next) {
const postId = req.params.postId
Promise.all([
PostModel.getPostById(postId), // 获取文章信息
CommentModel.getComments(postId), // 获取该文章所有留言
PostModel.incPv(postId)// pv 加 1
])
.then(function (result) {
const post = result[0]
const comments = result[1]
if (!post) {
throw new Error('该文章不存在')
}
res.render('post', {
post: post,
comments: comments
})
})
.catch(next)
})
```
现在刷新文章页试试吧，此时已经显示了留言的输入框。
## 4.10.3 发表与删除留言
现在我们来实现发表与删除留言的功能。将 routes/comments.js 修改如下：
```js
const express = require('express')
const router = express.Router()
const checkLogin = require('../middlewares/check').checkLogin
const CommentModel = require('../models/comments')
// POST /comments 创建一条留言
router.post('/', checkLogin, function (req, res, next) {
const author = req.session.user._id
const postId = req.fields.postId
const content = req.fields.content
// 校验参数
try {
if (!content.length) {
throw new Error('请填写留言内容')
}
} catch (e) {
req.flash('error', e.message)
return res.redirect('back')
}
const comment = {
author: author,
postId: postId,
content: content
}
CommentModel.create(comment)
.then(function () {
req.flash('success', '留言成功')
// 留言成功后跳转到上一页
res.redirect('back')
})
.catch(next)
})
// GET /comments/:commentId/remove 删除一条留言
router.get('/:commentId/remove', checkLogin, function (req, res, next) {
const commentId = req.params.commentId
const author = req.session.user._id
CommentModel.getCommentById(commentId)
.then(function (comment) {
if (!comment) {
throw new Error('留言不存在')
}
if (comment.author.toString() !== author.toString()) {
throw new Error('没有权限删除留言')
}
CommentModel.delCommentById(commentId)
.then(function () {
req.flash('success', '删除留言成功')
// 删除成功后跳转到上一页
res.redirect('back')
})
.catch(next)
})
})
module.exports = router
```
至此，我们完成了创建留言和删除留言的逻辑。刷新页面，尝试留言试试吧。留言成功后，将鼠标悬浮在留言上可以显示出 `删除` 的按钮，点击可以删除留言。
上一节：[4.9 文章](https://github.com/nswbmw/N-blog/blob/master/book/4.9%20%E6%96%87%E7%AB%A0.md)
下一节：[4.11 404页面](https://github.com/nswbmw/N-blog/blob/master/book/4.11%20404%20%E9%A1%B5%E9%9D%A2.md)
================================================
FILE: book/4.11 404 页面.md
================================================
现在访问一个不存在的地址，如：`http://localhost:3000/haha` 页面会显示：
```
Cannot GET /haha
```
我们来自定义 404 页面。修改 routes/index.js，在：
**routes/index.js**
```js
app.use('/comments', require('./comments'))
```
下添加如下代码：
```js
// 404 page
app.use(function (req, res) {
if (!res.headersSent) {
res.status(404).render('404')
}
})
```
新建 views/404.ejs，添加如下代码：
**views/404.ejs**
```ejs
<%= blog.title %>
```
这里我们只为了演示 express 中处理 404 的情况，用了腾讯公益的 404 页面，刷新一下页面看下效果吧。
上一节：[4.10 留言](https://github.com/nswbmw/N-blog/blob/master/book/4.10%20%E7%95%99%E8%A8%80.md)
下一节：[4.12 错误页面](https://github.com/nswbmw/N-blog/blob/master/book/4.12%20%E9%94%99%E8%AF%AF%E9%A1%B5%E9%9D%A2.md)
================================================
FILE: book/4.12 错误页面.md
================================================
前面讲到 express 有一个内置的错误处理逻辑，如果程序出错，会直接将错误栈返回并显示到页面上。如访问：`localhost:3000/posts/xxx/edit` 没有权限编辑的文章页，将会直接在页面中显示错误栈，如下：
```js
Error: 权限不足
at /Users/nswbmw/Desktop/myblog/routes/posts.js:95:15
at
at process._tickCallback (internal/process/next_tick.js:188:7)
```
现在我们修改代码，实现复用页面通知。修改 index.js，在 `app.listen` 上面添加如下代码：
**index.js**
```js
app.use(function (err, req, res, next) {
console.error(err)
req.flash('error', err.message)
res.redirect('/posts')
})
```
这里我们实现了将错误信息用页面通知展示的功能，刷新页面将会跳转到主页并显示『权限不足』的红色通知。
上一节：[4.11 404页面](https://github.com/nswbmw/N-blog/blob/master/book/4.11%20404%20%E9%A1%B5%E9%9D%A2.md)
下一节：[4.13 日志](https://github.com/nswbmw/N-blog/blob/master/book/4.13%20%E6%97%A5%E5%BF%97.md)
================================================
FILE: book/4.13 日志.md
================================================
现在我们来实现日志功能，日志分为正常请求的日志和错误请求的日志，我们希望实现这两种日志都打印到终端并写入文件。
## 4.13.1 winston 和 express-winston
我们使用 [winston](https://www.npmjs.com/package/winston) 和 [express-winston](https://www.npmjs.com/package/express-winston) 记录日志。
新建 logs 目录存放日志文件，修改 index.js，在：
**index.js**
```js
const pkg = require('./package')
```
下引入所需模块：
```js
const winston = require('winston')
const expressWinston = require('express-winston')
```
将：
```
// 路由
routes(app)
```
修改为：
```js
// 正常请求的日志
app.use(expressWinston.logger({
transports: [
new (winston.transports.Console)({
json: true,
colorize: true
}),
new winston.transports.File({
filename: 'logs/success.log'
})
]
}))
// 路由
routes(app)
// 错误请求的日志
app.use(expressWinston.errorLogger({
transports: [
new winston.transports.Console({
json: true,
colorize: true
}),
new winston.transports.File({
filename: 'logs/error.log'
})
]
}))
```
刷新页面看一下终端输出及 logs 下的文件。
可以看出：winston 将正常请求的日志打印到终端并写入了 `logs/success.log`，将错误请求的日志打印到终端并写入了 `logs/error.log`。
> 注意：记录正常请求日志的中间件要放到 `routes(app)` 之前，记录错误请求日志的中间件要放到 `routes(app)` 之后。
## 4.13.2 .gitignore
如果我们想把项目托管到 git 服务器上（如: [GitHub](https://github.com)），而不想把线上配置、本地调试的 logs 以及 node_modules 添加到 git 的版本控制中，这个时候就需要 .gitignore 文件了，git 会读取 .gitignore 并忽略这些文件。在 myblog 下新建 .gitignore 文件，添加如下配置：
**.gitignore**
```
config/*
!config/default.*
npm-debug.log
node_modules
coverage
```
需要注意的是，通过设置：
```
config/*
!config/default.*
```
这样只有 config/default.js 会加入 git 的版本控制，而 config 目录下的其他配置文件则会被忽略，因为把线上配置加入到 git 是一个不安全的行为，通常你需要本地或者线上环境手动创建 config/production.js，然后添加一些线上的配置（如：mongodb 配置）即可覆盖相应的 default 配置。
> 注意：后面讲到部署到 Heroku 时，因为无法登录到 Heroku 主机，所以可以把以下两行删掉，将 config/production.js 也加入 git 中。
>
> ```
> config/*
> !config/default.*
> ```
然后在 public/img 目录下创建 .gitignore：
```
# Ignore everything in this directory
*
# Except this file
!.gitignore
```
这样 git 会忽略 public/img 目录下所有上传的头像，而不忽略 public/img 目录。同理，在 logs 目录下创建 .gitignore 忽略日志文件：
```
# Ignore everything in this directory
*
# Except this file
!.gitignore
```
上一节：[4.12 错误页面](https://github.com/nswbmw/N-blog/blob/master/book/4.12%20%E9%94%99%E8%AF%AF%E9%A1%B5%E9%9D%A2.md)
下一节：[4.14 测试](https://github.com/nswbmw/N-blog/blob/master/book/4.14%20%E6%B5%8B%E8%AF%95.md)
================================================
FILE: book/4.14 测试.md
================================================
## 4.14.1 mocha 和 supertest
[mocha](https://www.npmjs.com/package/mocha) 和 [supertest](https://www.npmjs.com/package/supertest) 是常用的测试组合，通常用来测试 restful 的 api 接口，这里我们也可以用来测试我们的博客应用。
在 myblog 下新建 test 文件夹存放测试文件，以注册为例讲解 mocha 和 supertest 的用法。首先安装所需模块：
```sh
npm i mocha supertest --save-dev
```
修改 package.json，将：
**package.json**
```json
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
}
```
修改为：
```json
"scripts": {
"test": "mocha test"
}
```
指定执行 test 目录的测试。修改 index.js，将：
**index.js**
```js
// 监听端口，启动程序
app.listen(config.port, function () {
console.log(`${pkg.name} listening on port ${config.port}`)
})
```
修改为:
```js
if (module.parent) {
// 被 require，则导出 app
module.exports = app
} else {
// 监听端口，启动程序
app.listen(config.port, function () {
console.log(`${pkg.name} listening on port ${config.port}`)
})
}
```
这样做可以实现：直接启动 index.js 则会监听端口启动程序，如果 index.js 被 require 了，则导出 app，通常用于测试。
找一张图片用于测试上传头像，放到 test 目录下，如 avatar.png。新建 test/signup.js，添加如下测试代码：
**test/signup.js**
```js
const path = require('path')
const assert = require('assert')
const request = require('supertest')
const app = require('../index')
const User = require('../lib/mongo').User
const testName1 = 'testName1'
const testName2 = 'nswbmw'
describe('signup', function () {
describe('POST /signup', function () {
const agent = request.agent(app)// persist cookie when redirect
beforeEach(function (done) {
// 创建一个用户
User.create({
name: testName1,
password: '123456',
avatar: '',
gender: 'x',
bio: ''
})
.exec()
.then(function () {
done()
})
.catch(done)
})
afterEach(function (done) {
// 删除测试用户
User.deleteMany({ name: { $in: [testName1, testName2] } })
.exec()
.then(function () {
done()
})
.catch(done)
})
after(function (done) {
process.exit()
})
// 用户名错误的情况
it('wrong name', function (done) {
agent
.post('/signup')
.type('form')
.field({ name: '' })
.attach('avatar', path.join(__dirname, 'avatar.png'))
.redirects()
.end(function (err, res) {
if (err) return done(err)
assert(res.text.match(/名字请限制在 1-10 个字符/))
done()
})
})
// 性别错误的情况
it('wrong gender', function (done) {
agent
.post('/signup')
.type('form')
.field({ name: testName2, gender: 'a' })
.attach('avatar', path.join(__dirname, 'avatar.png'))
.redirects()
.end(function (err, res) {
if (err) return done(err)
assert(res.text.match(/性别只能是 m、f 或 x/))
done()
})
})
// 其余的参数测试自行补充
// 用户名被占用的情况
it('duplicate name', function (done) {
agent
.post('/signup')
.type('form')
.field({ name: testName1, gender: 'm', bio: 'noder', password: '123456', repassword: '123456' })
.attach('avatar', path.join(__dirname, 'avatar.png'))
.redirects()
.end(function (err, res) {
if (err) return done(err)
assert(res.text.match(/用户名已被占用/))
done()
})
})
// 注册成功的情况
it('success', function (done) {
agent
.post('/signup')
.type('form')
.field({ name: testName2, gender: 'm', bio: 'noder', password: '123456', repassword: '123456' })
.attach('avatar', path.join(__dirname, 'avatar.png'))
.redirects()
.end(function (err, res) {
if (err) return done(err)
assert(res.text.match(/注册成功/))
done()
})
})
})
})
```
此时编辑器会报语法错误（如：describe 未定义等等），修改 .eslintrc.json 如下：
```json
{
"extends": "standard",
"globals": {
"describe": true,
"beforeEach": true,
"afterEach": true,
"after": true,
"it": true
}
}
```
这样，eslint 会忽略 globals 中变量未定义的警告。运行 `npm test` 看看效果吧，其余的测试请读者自行完成。
## 4.14.2 测试覆盖率
我们写测试肯定想覆盖所有的情况（包括各种出错的情况及正确时的情况），但光靠想需要写哪些测试是不行的，总也会有疏漏，最简单的办法就是可以直观的看出测试是否覆盖了所有的代码，这就是测试覆盖率，即被测试覆盖到的代码行数占总代码行数的比例。
> 注意：即使测试覆盖率达到 100% 也不能说明你的测试覆盖了所有的情况，只能说明基本覆盖了所有的情况。
[istanbul](https://www.npmjs.com/package/istanbul) 是一个常用的生成测试覆盖率的库，它会将测试的结果报告生成 html 页面，并放到项目根目录的 coverage 目录下。首先安装 istanbul:
```
npm i istanbul --save-dev
```
配置 istanbul 很简单，将 package.json 中：
**package.json**
```json
"scripts": {
"test": "mocha test"
}
```
修改为：
```json
"scripts": {
"test": "istanbul cover _mocha"
}
```
**注意**：Windows 下需要改成 `istanbul cover node_modules/mocha/bin/_mocha`。
即可将 istanbul 和 mocha 结合使用，运行 `npm test` 终端会打印：
打开 myblog/coverage/Icov-report/index.html，如下所示：
可以点进去查看某个代码文件具体的覆盖率，如下所示：
红色的行表示测试没有覆盖到，因为我们只写了 name 和 gender 的测试。
上一节：[4.13 日志](https://github.com/nswbmw/N-blog/blob/master/book/4.13%20%E6%97%A5%E5%BF%97.md)
下一节：[4.15 部署](https://github.com/nswbmw/N-blog/blob/master/book/4.15%20%E9%83%A8%E7%BD%B2.md)
================================================
FILE: book/4.15 部署.md
================================================
## 4.15.1 申请 MLab
[MLab](https://mlab.com) (前身是 MongoLab) 是一个 mongodb 云数据库提供商，我们可以选择 500MB 空间的免费套餐用来测试。注册成功后，点击右上角的 `Create New` 创建一个数据库（如: myblog），成功后点击进入到该数据库详情页，注意页面中有一行黄色的警告：
```
A database user is required to connect to this database. To create one now, visit the 'Users' tab and click the 'Add database user' button.
```
每个数据库至少需要一个 user，所以我们点击 Users 下的 `Add database user` 创建一个用户。
> 注意：不要选中 `Make read-only`，因为我们有写数据库的操作。
最后分配给我们的类似下面的 mongodb url：
```
mongodb://:@ds139327.mlab.com:39327/myblog
```
如我创建的用户名和密码都为 myblog 的用户，新建 config/production.js，添加如下代码：
**config/production.js**
```js
module.exports = {
mongodb: 'mongodb://myblog:myblog@ds139327.mlab.com:39327/myblog'
}
```
停止程序，然后以 production 配置启动程序:
```sh
npm i cross-env --save-dev # 本地安装 cross-env
npm i cross-env -g # 全局安装 cross-env
cross-env NODE_ENV=production supervisor index
```
> 注意：cross-env 用来兼容 Windows 系统和 Linux/Mac 系统设置环境变量的差异。
## 4.15.2 pm2
当我们的博客要部署到线上服务器时，不能单纯的靠 `node index` 或者 `supervisor index` 来启动了，因为我们断掉 SSH 连接后服务就终止了，这时我们就需要像 [pm2](https://www.npmjs.com/package/pm2) 或者 [forever](https://www.npmjs.com/package/forever) 这样的进程管理工具了。pm2 是 Node.js 下的生产环境进程管理工具，就是我们常说的进程守护工具，可以用来在生产环境中进行自动重启、日志记录、错误预警等等。以 pm2 为例，全局安装 pm2：
```sh
npm i pm2 -g
```
修改 package.json，添加 start 的命令：
**package.json**
```json
"scripts": {
"test": "istanbul cover _mocha",
"start": "cross-env NODE_ENV=production pm2 start index.js --name 'myblog'"
}
```
然后运行 `npm start` 通过 pm2 启动程序，如下图所示 ：
pm2 常用命令:
1. `pm2 start/stop`: 启动/停止程序
2. `pm2 reload/restart [id|name]`: 重启程序
3. `pm2 logs [id|name]`: 查看日志
4. `pm2 l/list`: 列出程序列表
更多命令请使用 `pm2 -h` 查看。
## 4.15.2 部署到 Heroku
[Heroku](https://www.heroku.com) 是一个支持多种编程语言的云服务平台，Heroku 也提供免费的基础套餐供开发者测试使用。现在，我们将论坛部署到 Heroku。
> 注意：新版 heroku 会有填写信用卡的步骤，如果没有信用卡请跳过本节。
首先，需要到 [https://toolbelt.heroku.com/](https://toolbelt.heroku.com/) 下载安装 Heroku 的命令行工具包 toolbelt。然后登录（如果没有账号，请注册）到 Heroku 的 Dashboard，点击右上角 New -> Create New App 创建一个应用。创建成功后运行：
```sh
heroku login
```
填写正确的 email 和 password 验证通过后，本地会产生一个 SSH public key。在部署到 Heroku 之前，我们需要对代码进行简单的修改。如下：
1.删掉 .gitignore 中：
```
config/*
!config/default.*
```
因为我们无法登录到 Heroku 主机创建 production 配置文件，所以这里将 production 配置也上传到 Heroku。
2.打开 index.js，将 `app.listen` 修改为：
```js
const port = process.env.PORT || config.port
app.listen(port, function () {
console.log(`${pkg.name} listening on port ${port}`)
})
```
因为 Heroku 会动态分配端口（通过环境变量 PORT 指定），所以不能用配置文件里写死的端口。
3.修改 package.json，在 scripts 添加：
```json
"heroku": "NODE_ENV=production node index"
```
在根目录下新建 Procfile 文件，添加如下内容：
```
web: npm run heroku
```
Procfile 文件告诉 Heroku 该使用什么命令启动一个 web 服务。更多信息见：[https://devcenter.heroku.com/articles/getting-started-with-nodejs](https://devcenter.heroku.com/articles/getting-started-with-nodejs)。
然后输入以下命令：
```sh
git init
heroku git:remote -a 你的应用名称
git add .
git commit -am "init"
git push heroku master
```
稍后，我们的论坛就部署成功了。使用：
```sh
heroku open
```
打开应用主页。如果出现 "Application error"，使用：
```sh
heroku logs
```
查看日志，调试完后 commit 并 push 到 heroku重新部署。
## 4.15.3 部署到 UCloud
### 创建主机
1. 注册 UCloud
2. 点击左侧的 `云主机`，然后点击 `创建主机`，统统选择最低配置
3. 右侧付费方式选择 `按时`（每小时），点击 `立即购买`
4. 在支付确认页面，点击 `确认支付`
购买成功后回到主机管理列表，如下所示：
> 注意：下面所有的 ip 都替换为你自己的外网 ip。
### 环境搭建与部署
修改 config/production.js，将 port 修改为 80 端口：
**config/production.js**
```js
module.exports = {
port: 80,
mongodb: 'mongodb://myblog:myblog@ds139327.mlab.com:39327/myblog'
}
```
登录主机，用刚才设置的密码：
```sh
ssh root@106.75.47.229
```
因为是 CentOS 系统，所以我选择使用 yum 安装，而不是下载源码编译安装：
```sh
yum install git #安装git
yum install nodejs #安装 Node.js
yum install npm #安装 npm
npm i npm -g #升级 npm
npm i pm2 -g #安装 pm2
npm i n -g #安装 n
n v8.9.1 #安装 v8.9.1 版本的 Node.js
n use 8.9.1 #使用 v8.9.1 版本的 Node.js
node -v
```
> 注意：如果 `node -v` 显示的不是 8.9.1，则断开 ssh，重新登录主机再试试。
此时应该在 `/root` 目录下，运行以下命令：
```sh
git clone https://github.com/nswbmw/N-blog.git myblog #或在本机 myblog 目录下运行 rsync -av --exclude="node_modules" ./ root@106.75.47.229:/root/myblog
cd myblog
npm i
npm start
pm2 logs
```
> 注意：如果不想用 git 的形式将代码拉到云主机上，可以用 rsync 将本地的代码同步到你的 UCloud 主机上，如上所示。
最后，访问你的公网 ip 地址试试吧，如下所示：
> 小提示：因为我们选择的按时付费套餐，测试完成后，可在主机管理页面选择关闭主机，节约费用。
## 4.15.4 部署到阿里云
### 创建主机
1. 注册/登录
2. 充值 100（因为我们选择『按量付费』，阿里云要求最低账户余额 >= 100）
3. 进入『云服务器 ECS』
4. 点击『创建实例』
进入创建实例页面，按下图选择配置：
需要注意几点：
1. 计费方式：按量付费
2. 公网 ip 地址：分配
3. 安全组：选中开启 80 端口
4. 镜像：Ubuntu 16.04 64位
点击『开通进入下一页』，选中：
> 注意：这里我们只是演示，所以自动释放时间只设置了几个小时
点击『去开通』创建成功，然后点击提示中的『管理控制台』进入 ECS 管理页，刚才创建的机器需要等待几分钟才会初始化成功。成功后如下所示：
### 环境搭建
复制创建的机器的公网 ip 地址，运行：
```sh
ssh root@39.106.134.66
```
输入刚才设置的密码登录远程主机。
#### 安装 Node.js
我们下载编译好的 Node.js 压缩包，解压然后使用软连接。
```sh
wget https://nodejs.org/dist/v8.9.1/node-v8.9.1-linux-x64.tar.xz
tar -xvf node-v8.9.1-linux-x64.tar.xz
mv node-v8.9.1-linux-x64 nodejs
ln -s ~/nodejs/bin/* /usr/local/bin/
node -v
npm -v
```
#### 安装 MongoDB
```sh
wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-ubuntu1604-3.4.10.tgz
tar -xvf mongodb-linux-x86_64-ubuntu1604-3.4.10.tgz
mv mongodb-linux-x86_64-ubuntu1604-3.4.10 mongodb
ln -s ~/mongodb/bin/* /usr/local/bin/
mongod --version
mongo --version
mkdir mongodb/data
mongod --dbpath=mongodb/data &
```
#### 安装 Git
```sh
apt-get update
apt-get install git
git clone https://github.com/nswbmw/N-blog.git #或者你的 GitHub blog 地址
cd N-blog
npm i
vim config/default.js #修改端口 3000->80
node index
```
此时，浏览器中访问你的机器的公网 ip 试试吧。
#### 使用 PM2 启动
```sh
npm i pm2 -g
ln -s ~/nodejs/bin/* /usr/local/bin/
pm2 start index.js --name="myblog"
```
这里我们使用 pm2 启动博客，所以关掉终端后博客仍然在运行。
上一节：[4.14 测试](https://github.com/nswbmw/N-blog/blob/master/book/4.14%20%E6%B5%8B%E8%AF%95.md)
================================================
FILE: book/4.2 准备工作.md
================================================
## 4.2.1 目录结构
我们停止 supervisor 并删除 myblog 目录从头来过。重新创建 myblog，运行 `npm init`，如下：
在 myblog 目录下创建以下目录及空文件（package.json 除外）：
对应文件及文件夹的用处：
1. `models`: 存放操作数据库的文件
2. `public`: 存放静态文件，如样式、图片等
3. `routes`: 存放路由文件
4. `views`: 存放模板文件
5. `index.js`: 程序主文件
6. `package.json`: 存储项目名、描述、作者、依赖等等信息
> 小提示：不知读者发现了没有，我们遵循了 MVC（模型(model)－视图(view)－控制器(controller/route)） 的开发模式。
## 4.2.2 安装依赖模块
运行以下命令安装所需模块：
```sh
npm i config-lite connect-flash connect-mongo ejs express express-session marked moment mongolass objectid-to-timestamp sha1 winston express-winston --save
npm i https://github.com:utatti/express-formidable.git --save # 从 GitHub 安装 express-formidable 最新版，v1.0.0 有 bug
```
对应模块的用处：
1. `express`: web 框架
2. `express-session`: session 中间件
3. `connect-mongo`: 将 session 存储于 mongodb，结合 express-session 使用
4. `connect-flash`: 页面通知的中间件，基于 session 实现
5. `ejs`: 模板
6. `express-formidable`: 接收表单及文件上传的中间件
7. `config-lite`: 读取配置文件
8. `marked`: markdown 解析
9. `moment`: 时间格式化
10. `mongolass`: mongodb 驱动
11. `objectid-to-timestamp`: 根据 ObjectId 生成时间戳
12. `sha1`: sha1 加密，用于密码加密
13. `winston`: 日志
14. `express-winston`: express 的 winston 日志中间件
后面会详细讲解这些模块的用法。
## 4.2.3 ESLint
ESLint 是一个代码规范和语法错误检查工具。使用 ESLint 可以规范我们的代码书写，可以在编写代码期间就能发现一些低级错误。
ESLint 需要结合编辑器或 IDE 使用，如：
- Sublime Text 需要装两个插件：SublimeLinter + SublimeLinter-contrib-eslint
- VS Code 需要装一个插件：ESLint
> 小提示：Sublime Text 安装插件通过 ctrl+shift+p 调出 Package Control，输入 install 选择 Install Package 回车。输入对应插件名搜索，回车安装。
> 小提示：VS Code 安装插件需要点击左侧『扩展』页
全局安装 eslint：
```sh
npm i eslint -g
```
运行：
```sh
eslint --init
```
初始化 eslint 配置，依次选择：
-> Use a popular style guide
-> Standard
-> JSON
> 注意：如果 Windows 用户使用其他命令行工具无法上下切换选项，切换回 cmd。
eslint 会创建一个 .eslintrc.json 的配置文件，同时自动安装并添加相关的模块到 devDependencies。这里我们使用 Standard 规范，其主要特点是不加分号。
### 4.2.4 EditorConfig
EditorConfig 是一个保持缩进风格的一致的工具，当多人共同开发一个项目的时候，往往会出现每个人用不同编辑器的情况，而且有的人用 tab 缩进，有的人用 2 个空格缩进，有的人用 4 个空格缩进，EditorConfig 就是为了解决这个问题而诞生。
EditorConfig 需要结合编辑器或 IDE 使用，如：
- Sublime Text 需要装一个插件：EditorConfig
- VS Code 需要装一个插件：EditorConfig for VS Code
在 myblog 目录下新建 .editorconfig 的文件，添加如下内容：
```
# editorconfig.org
root = true
[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
tab_width = 2
[*.md]
trim_trailing_whitespace = false
[Makefile]
indent_style = tab
```
这里我们使用 2 个空格缩进，tab 长度也是 2 个空格。trim_trailing_whitespace 用来删除每一行最后多余的空格，insert_final_newline 用来在代码最后插入一个空的换行。
上一节：[4.1 开发环境](https://github.com/nswbmw/N-blog/blob/master/book/4.1%20%E5%BC%80%E5%8F%91%E7%8E%AF%E5%A2%83.md)
下一节：[4.3 配置文件](https://github.com/nswbmw/N-blog/blob/master/book/4.3%20%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6.md)
================================================
FILE: book/4.3 配置文件.md
================================================
不管是小项目还是大项目，将配置与代码分离是一个非常好的做法。我们通常将配置写到一个配置文件里，如 config.js 或 config.json ，并放到项目的根目录下。但实际开发时我们会有许多环境，如本地开发环境、测试环境和线上环境等，不同环境的配置不同（如：MongoDB 的地址），我们不可能每次部署时都要去修改引用 config.test.js 或者 config.production.js。config-lite 模块正是你需要的。
## 4.3.1 config-lite
[config-lite](https://www.npmjs.com/package/config-lite) 是一个轻量的读取配置文件的模块。config-lite 会根据环境变量（`NODE_ENV`）的不同加载 config 目录下不同的配置文件。如果不设置 `NODE_ENV`，则读取默认的 default 配置文件，如果设置了 `NODE_ENV`，则会合并指定的配置文件和 default 配置文件作为配置，config-lite 支持 .js、.json、.node、.yml、.yaml 后缀的文件。
如果程序以 `NODE_ENV=test node app` 启动，则 config-lite 会依次降级查找 `config/test.js`、`config/test.json`、`config/test.node`、`config/test.yml`、`config/test.yaml` 并合并 default 配置; 如果程序以 `NODE_ENV=production node app` 启动，则 config-lite 会依次降级查找 `config/production.js`、`config/production.json`、`config/production.node`、`config/production.yml`、`config/production.yaml` 并合并 default 配置。
config-lite 还支持冒泡查找配置，即从传入的路径开始，从该目录不断往上一级目录查找 config 目录，直到找到或者到达根目录为止。
在 myblog 下新建 config 目录，在该目录下新建 default.js，添加如下代码：
**config/default.js**
```js
module.exports = {
port: 3000,
session: {
secret: 'myblog',
key: 'myblog',
maxAge: 2592000000
},
mongodb: 'mongodb://localhost:27017/myblog'
}
```
配置释义：
1. `port`: 程序启动要监听的端口号
2. `session`: express-session 的配置信息，后面介绍
3. `mongodb`: mongodb 的地址，以 `mongodb://` 协议开头，`myblog` 为 db 名
上一节：[4.2 准备工作](https://github.com/nswbmw/N-blog/blob/master/book/4.2%20%E5%87%86%E5%A4%87%E5%B7%A5%E4%BD%9C.md)
下一节：[4.4 功能设计](https://github.com/nswbmw/N-blog/blob/master/book/4.4%20%E5%8A%9F%E8%83%BD%E8%AE%BE%E8%AE%A1.md)
================================================
FILE: book/4.4 功能设计.md
================================================
## 4.4.1 功能与路由设计
在开发博客之前，我们首先需要明确博客要实现哪些功能。由于本教程面向初学者，所以只实现了博客最基本的功能，其余的功能（如归档、标签、分页等等）读者可自行实现。
功能及路由设计如下：
1. 注册
1. 注册页：`GET /signup`
2. 注册（包含上传头像）：`POST /signup`
2. 登录
1. 登录页：`GET /signin`
2. 登录：`POST /signin`
3. 登出：`GET /signout`
4. 查看文章
1. 主页：`GET /posts`
2. 个人主页：`GET /posts?author=xxx`
3. 查看一篇文章（包含留言）：`GET /posts/:postId`
5. 发表文章
1. 发表文章页：`GET /posts/create`
2. 发表文章：`POST /posts/create`
6. 修改文章
1. 修改文章页：`GET /posts/:postId/edit`
2. 修改文章：`POST /posts/:postId/edit`
7. 删除文章：`GET /posts/:postId/remove`
8. 留言
1. 创建留言：`POST /comments`
2. 删除留言：`GET /comments/:commentId/remove`
由于我们博客页面是后端渲染的，所以只通过简单的 `(GET)` 和 ` ` 的前面，因为只有页面加载完后才能通过 JQuery 获取 DOM 元素。
在 views 目录下新建 components 目录用来存放组件（即可以复用的模板片段），在该目录下创建以下文件：
**views/components/nav.ejs**
```ejs
留言
<% comments.forEach(function (comment) { %>