摘要：是的源碼，算是一個基本的博客系統，包含文章發布，關注，評論等功能。這些功能可以說是任何一個網站的基礎。比如運營數據配置和其他數據配置分開，因為很有可能需要做一個小的工具來讓非技術人員配置相關參數。模式在中有一個專門的章節來講解。

1.1 what:
nodeclub是cnodejs.com的源碼，cnode算是一個基本的博客系統，包含文章發布， 關注，評論等功能。這些功能可以說是任何一個網站的基礎。從nodeclub里可以學到什么？

1.基本的架構

2.開發測試過程

3.MVC的設計

4.middleware 的正確用法

5.如何設計mongodb schema

6.如何正確的使用mongoose

7.如何實現一個標簽系統

8.plugins? services ?

9.如何正確的使用ejs helper

10.到底該怎樣寫路由， restful？

11.如何做基本的控制驗證

12.如何發郵件

13.session

14.github 用戶登錄

15.圖片上傳

16.消息發送

除了nodeclub源碼的學習筆記以外， 還會有一點最近搗鼓這一塊的經驗分享

1.一個完整的消息訂閱設計

2.消息推送, socket + express如何合作?

3.包裝action

4.蛋疼的異步回調如何處理

nodeclub源碼

1.2 why:
對于想用nodejs + express + mongodb 來做網站技術基礎的項目， nodeclub可以說是很好的源碼級指南，當然也是我的指南，這篇文章權當做個人學習nodeclub的學習筆記。

1.3 who

  who = 一名本應該在寫前端的但不知怎的一直在寫后端的馬膿 -> 
    @echo "github: https://github.com/6174"
    @echo "weibo: http://weibo.com/u/2254313183"
    @echo "email: 57017125@qq.com"
    @echo "ps: 一直在求后端partner中，有意者聯系我" 
    @send()

2.1 nodejs項目一大優點就是有一個package.json, 里邊的dependencies & devDependencies可以看到這個項目所有的依賴。 對于有經驗的開發者來說， 看完package.json基本就能知道項目的架構是怎樣。

2.2 dependencies

express: 基礎框架：

mongodb: 數據存儲

mongoose: orm

connect-mongo: session （對于redis， 可以使用connect-redis）

nodemailer：郵件

validator：驗證

passport，passport-github： passport，

loader: ejs-view-helper, 靜態資源加載處理

其他： event-proxy, node-markdown, ndir

2.3 devDependencies

測試框架：mocha, should

運行： forever

請求模擬: supertest

2.4 nodeclub以express + mongodb + mongoose作為基本框架, 典型的MVC應用

Model: 對應mongoose orm， models目錄

view： ejs模板， views目錄

controler：express middleware , contollers目錄

2.5 目錄結構：

- common/
- controllers/
- libs/
# express中間件， 基本的auth， session 驗證
- middlewares/
- models/
#消息， 郵件服務
- services/
- plugins/
#可以看做是對model處理的加工庫
- proxy/
- test/
- views/
- app.js
- route.js
- config.js

神圣的入口文件，幾乎每個項目都會有一個entry，對于了解一個應用熟悉入口邏輯很重要。 下面將分步來看看，nodeclub的app.js做了什么：

3.1.1 應用相關的配置的設置， 主要分為

1.應用全局數據配置

2.數據庫連接配置

3.session，auth相關配置

4.rss配置

5.mail配置

6.第三方連接相關配置， github， weibo

配置文件也是了解應用的一個好地方， 在config.default.js中可以看到以下信息, 這些很可能是我們平時做應用開發的時候沒有留意到的地方

  //--應用數據統計
  google_tracker_id: "UA-41753901-5",

  //--靜態文件很可能使用cdn來做
  site_static_host: "", // 靜態文件存儲域名

  //--求解釋
  site_enable_search_preview: false, // 開啟google search preview
  site_google_search_domain:  "cnodejs.org",  // google search preview中要搜索的域名

  //--運營數據
  list_topic_count: 20,
  post_interval: 10000,
  admins: { admin: true },
  side_ads:[]
  allow_sign_up: true,

  //--插件模式
  plugins: []

3.1.2 當然這里的配置文件是default的，配置文件可以放在一個config的文件夾下面，多個文件的方式來整理。比如運營數據配置和其他數據配置分開，因為很有可能需要做一個小的工具來讓非技術人員配置相關參數。這時候可以用一個index.js作為facade，相當于一個大的node module。

3.2.1 之前已經講了models目錄對應MVC的M部分。

3.2.2 models目錄下面有index.js, require("./models")相當于require("./models/index")
index相當于一個模型的facade, index.js做得事情分別是

1.connect mongodb

2.require各個model模塊

3.exports 所有的model
簡單而言就是初始化了應用model層。

3.2.3 模型使用orm框架mogoose來寫，了解mogoose過后， models部分的代碼也就是秒懂了
， 我說的只是代碼，literaly, 一個項目的核心就是model的設計，以前做過的任何項目都是一樣， 數據庫table的設計好壞直接影響應用的開發以及性能。 下面來看看各個model的schema設計(幾乎直接ctr+c, ctr+v加上了一點點注釋) :

3.2.4 user

    var UserSchema = new Schema({
          //--基本用戶信息， index表示在mongodb中會建立索引
          //--unique: true 唯一性設置
          name: { type: String, index: true },
          loginname: { type: String, unique: true },
          pass: { type: String },
          email: { type: String, unique: true },
          url: { type: String },
          profile_image_url: {type: String},
          location: { type: String },
          signature: { type: String },
          profile: { type: String },
          weibo: { type: String },
          avatar: { type: String },
          githubId: { type: String, index: true },
          githubUsername: {type: String},
          is_block: {type: Boolean, default: false},

          //--用戶產生數據meta
          score: { type: Number, default: 0 },
          topic_count: { type: Number, default: 0 },
          reply_count: { type: Number, default: 0 },
          follower_count: { type: Number, default: 0 },
          following_count: { type: Number, default: 0 },
          collect_tag_count: { type: Number, default: 0 },
          collect_topic_count: { type: Number, default: 0 },
          create_at: { type: Date, default: Date.now },
          update_at: { type: Date, default: Date.now },
          is_star: { type: Boolean },
          level: { type: String },
          active: { type: Boolean, default: true },

          //-mail
          receive_reply_mail: {type: Boolean, default: false },
          receive_at_mail: { type: Boolean, default: false },
          from_wp: { type: Boolean },
          retrieve_time : {type: Number},
          retrieve_key : {type: String}
        });

3.2.5 topic 話題

        //1 <- 多
        //tag <- topic <- collect  
        var TopicSchema = new Schema({
          title: { type: String },
          content: { type: String },
          author_id: { type: ObjectId },
          top: { type: Boolean, default: false },
          reply_count: { type: Number, default: 0 },
          visit_count: { type: Number, default: 0 },
          collect_count: { type: Number, default: 0 },
          create_at: { type: Date, default: Date.now },
          update_at: { type: Date, default: Date.now },
          //--這里reply的設計方式不知道是否合適， 因為mongdb不同于關系型數據庫，這里每次讀取文章都需要重reply集合里邊查找遍歷一邊，文章是讀繁忙的。
          //-- 一個document的大小為5Mb， 一本牛津詞典的內容， 我覺得將reply放在這里應該不會有太大問題。 即便不存放reply 內容， 存放一個id數組也會好很多。
          //-- 客官們怎么看?  
          last_reply: { type: ObjectId },
          last_reply_at: { type: Date, default: Date.now },
          content_is_html: { type: Boolean }
        });

        var ReplySchema = new Schema({
          content: { type: String },
          topic_id: { type: ObjectId, index: true },
          author_id: { type: ObjectId },
          reply_id : { type: ObjectId },
          create_at: { type: Date, default: Date.now },
          update_at: { type: Date, default: Date.now },
          content_is_html: { type: Boolean }
        });

        //--話題集合
        var TopicCollectSchema = new Schema({
          user_id: { type: ObjectId },
          topic_id: { type: ObjectId },
          create_at: { type: Date, default: Date.now }
        });

        //--話題標簽
        var TopicTagSchema = new Schema({
          topic_id: { type: ObjectId },
          tag_id: { type: ObjectId },
          create_at: { type: Date, default: Date.now }
        });     

3.2.6 tag
標簽系統

        //tag <- collect
        var TagSchema = new Schema({
          name: { type: String },
          order: { type: Number, default: 1 },
          description: { type: String },
          background: { type: String },
          topic_count: { type: Number, default: 0 },
          collect_count: { type: Number, default: 0 },
          create_at: { type: Date, default: Date.now }
        });

        var TagCollectSchema = new Schema({
          user_id: { type: ObjectId, index: true },
          tag_id: { type: ObjectId },
          create_at: { type: Date, default: Date.now }
        });

3.2.7 關系

        var RelationSchema = new Schema({
          user_id: { type: ObjectId },
          follow_id: { type: ObjectId },
          create_at: { type: Date, default: Date.now }
        });

3.2.8 消息
消息model設計， 對于一個blog來說， 基本的只有回復消息， 這里加了關注和@消息。

    /*
     * type:
     * reply: xx 回復了你的話題
     * reply2: xx 在話題中回復了你
     * follow: xx 關注了你
     * at: xx ＠了你
     */
    var MessageSchema = new Schema({
      type: { type: String },
      master_id: { type: ObjectId, index: true },
      author_id: { type: ObjectId },
      topic_id: { type: ObjectId },
      reply_id: { type: ObjectId },
      has_read: { type: Boolean, default: false },
      create_at: { type: Date, default: Date.now }
    });

3.3.1 express的基礎是middleware，或者說express的基礎是connect，connect的基礎是middleware。middleware模式在professional nodejs中有一個專門的章節來講解。何為middleware呢？ middleware模式 相當于一個加工流水線（大家叫middleware stack），每一個middleware相當于一個加工步驟，當出現一個http請求的時候，http請求會挨著每個middleware執行下去。
express里處理一個請求的過程基本上就是請求通過middleware stack的過程： * -> middlewares -> 路由 -> controllers -> errorhandlering。

3.3.2 middleware 怎樣做到的， 異步的方法呢？ middleware使用promise的方式來處理異步，所有每個middleware都有三個參數req, res, next, 對于異步的情況， 必須要調用next()方法。不然后續的middleware就無法執行。 ps: debug 的時候沒調用next()還不會報錯，一定注意

3.3.3 auth.js
auth.js exports出來的函數全部都是中間件，從變量名就完全清楚的知道到底在做什么了

    //-- 需要admin權限
    exports.adminRequired = function (req, res, next) {}

    //-- 需要有用戶
    exports.userRequired = function (req, res, next) {}

    //-- 需要有用戶并登錄
    exports.signinRequired = function (req, res, next) {
        if (!req.session.user) {
            res.render("notify/notify", {error: "未登入用戶不能發布話題。"});
            return;
        }
        next();   
    }

    //-- 屏蔽用戶 -_-
    exports.blockUser = function (req, res, next) {}

這里其實就可以看到中間件的作用了，我們以前寫php的時候每次都需要判斷用戶是否登錄， 沒登陸redirect到index.php ，只不過這里的方式是通過中間件來處理。
明白這里什么意思，其他的中間件模塊也就秒懂了。

3.4.1 express 的世界里另外一個很重要的就是route， nodejs啟動的是服務， 監聽了某一端口， 接受http or https or sockt請求, 那url中像"/index.php?blabla"這一串的存在怎么處理呢， express的route功能就可以幫我們解析。

3.4.2 MVC中如何將一個請求和controller聯系起來呢， route就是這樣的紐帶

  //--get, post 請求
  app.get("/signin", sign.showLogin);
  app.post("/signin", sign.login);
  //--使用中間件
  app.get("/signup", configMiddleware.github, passport.authenticate("github"));
  app.post("/:topic_id/reply", auth.userRequired, limit.postInterval, reply.add);

3.4.3 route是了解一個應用最佳的地方，一個請求如何處理， 到相應的controller去看就知道了。 相比起在PHP環境下配置更加靈活。當然你說你通過nginx來配置也很靈活，好吧，我們說的不是一回事。

3.5.1 experess initialize: app.js 中其他大多部分就是express的初始化了， 初始化流程如下：

1.配置上傳 upload_dir

2.模板引擎設置

3.express通用中間件設置

4.pasport中間件

5.自定義中間件

1.auth_user

2.block_user

3.staticfile: upload

4.staticfile: user_data

6.csrf

7.errorhandler

8.set view cache

@Note：配置的順序很重要， 中間件的執行順序是按照定義順序來執行的， 如果一個中間件依賴另外的中間件， 而自己先執行了， 這種情況就會錯誤。 常見的問題就是session配置， 一定要記得配置session中間件的時候， 要先配置cookieParser。

3.5.2 session設置
這個步驟在initialize里邊已經有了， 不過再多帶帶講一下， nodeclub使用的是connect-mongo來作為session的存儲

    //--cookieParser一定要在前面， 因為session的設置依賴cookie
    app.use(express.cookieParser());
    app.use(express.session({
      secret: config.session_secret,
      store: new MongoStore({
        db: config.db_name,
      }),
    }));

3.5.3 view helpers
使用過ejs的肯定知道， ejs里邊view helper設置很簡單， 就像賦值變量一樣。 當對于一些通用的helper可以這樣設置：

        app.helpers({
          config: config,
          Loader: Loader,
          assets: assets
        });
        app.dynamicHelpers(require("./common/render_helpers"));

3.5.4 github pasport initialize

        // github oauth
        passport.serializeUser(function (user, done) {
          done(null, user);
        });
        passport.deserializeUser(function (user, done) {
          done(null, user);
        });
        passport.use(new GitHubStrategy(config.GITHUB_OAUTH, 
  githubStrategyMiddleware));

3.5.5 start app

4.1 user 是每個應用都會處理的基本， 注冊登錄登出， 看看nodeclub做了哪些事情：

4.2 路由：

  //--設置能否直接注冊， 不能的話通過github注冊
  if (config.allow_sign_up) {
    app.get("/signup", sign.showSignup);
    app.post("/signup", sign.signup);
  } else {
    app.get("/signup", configMiddleware.github, passport.authenticate("github"));
  }
  app.post("/signout", sign.signout);
  app.get("/signin", sign.showLogin);
  app.post("/signin", sign.login);

4.3 controller & model：sign.signup

    sanitize = validator.sanitize;
    check = validator.check;
    exports.signup = function (req, res, next) {
      //--xss 消毒
      var name = sanitize(req.body.name).trim();
      name = sanitize(name).xss();
      ...
      //--validations
      try {
        check(name, "用戶名只能使用0-9，a-z，A-Z。").isAlphanumeric();
      } catch (e) {
        res.render("sign/signup", {error: e.message, name: name, email: email});
        return;
      }
      ...
      //--用用戶名登錄或者email登錄
      query = {"$or": [{"loginname": loginname}, {"email": email}]}
      User.getUserByQuery(query, {}, function(){
        ...
        pass = md5(pass);
        ...
        User.newAndSave(name, loginname, pass, email, avatar_url, false, function (err) {
          ...
          // 發送激活郵件
          mail.sendActiveMail(email, md5(email + config.session_secret), name);
          res.render("sign/signup", {
            success: "歡迎加入 " + config.name + "！我們已給您的注冊郵箱發送了一封郵件，請點擊里面的鏈接來激活您的帳號。"
          });
        })
      })
    }   

5.1 使用User.newAndSave，

5.2 異步 callback pyramid
一個應用通常會遇到這樣的情景， 一個頁面需要的數據包括， 文章列表， 評論列表，用戶數據，廣告數據， other stuff... 問題是每個都是異步的， 怎么辦。 user數據獲取過后的callback調用文章列表獲取， 文章列表獲取的callback調用評論列表的獲取... 這樣就太蛋疼了。 nodeclub使用了eventproxy模塊優雅的解決這樣的問題：

    render = function(){}
    var proxy = EventProxy.create("tags", "topics", "hot_topics", "stars", "tops", "no_reply_topics", "pages", render);
    proxy.fail(next);
    Tag.getAllTags(proxy.done("tags"));
    Topic.getTopicsByQuery(query, options, proxy.done("topics"));
    User.getUsersByQuery({ is_star: true }, { limit: 5 }, proxy.done("stars"));

看完代碼不言而喻。。。
當然異步處理的方法有很多:
- 1.基于事件的：eventProxy
- 2.基于promise的：Async.js Q.js, when.js
- 3.基于編譯的：continuation, wind
- 4.基于語言語法的：yield， livescript
文章最后會講一下我我的異步選擇方案

6.1 原先以為有動態的消息推送， 有隊列處理， 錯了， 木有

6.2 在sublime text里邊全局搜索sendReply2Message會發現是在controller/reply.js里邊調用的， 也就是說，消息是直接觸發的。

6.3 好吧， 這部分大概大家都能秒懂。。

7.1.1 一個項目必定離不開測試， nodeclub基于mocha BDD測試框架， 一切的前提假設至少能看懂jasmine或者mocha或者任何一個BDD風格的測試代碼。

7.1.2 打開即看到app.js

  var app = require("../app");
  describe("app.js", function () {
    //--before， 執行it的前面會執行
    before(function (done) {
      //--done, 異步方法
      app.listen(3001, done);
    });
    after(function () {
      app.close();
    });
    it("should / status 200", function (done) {
      //--使用 app.request()就可以模擬請求了？ 這個api哪里來的， 求解釋？
      app.request().get("/").end(function (res) {
        res.should.status(200);
        done();
      });
    });
  });
  //--按理說應該是可以正常運行了但是我一直出現這個錯誤:
  //--connect ADDRNOTAVAIL 知道的求解釋
  //--我嘗試用supertest直接測試， 但是也是一直timeout， mocha
  //--里邊加大timeout時間， 結果就是一直沒反應。 

  //--分析原因， express版本問題， nodeclub中express的版本還是2.x, 所以才會有
  //--app.request(), app.close()這些api
  //--第二個原因， 到supertest官網， 發現人家都已經轉戰到superagent項目了， 于是我寫了下面這個測試腳本， 可以通過了
  var express = require("express");
  var should = require("should");
  var path = require("path");
  var superagent = require("superagent");
  var app = express()
  app.get("/user", function(req, res, next) {
      res.send(200, {
          name: "tobi"
      })
  })
  describe("myapp.js", function() {
      this.timeout(5000)
      before(function(done) {
          app.listen(21, done);
      })
      after(function() {
          // app.close()
      })
      it("should /status 200", function(done) {
          agent = superagent.agent()
          agent.get("http://localhost:21/user").end(function(err, res) {
            console.log(err, res)
            res.should.have.status(200);
            res.text.should.include("tobi");
            return done();
          });
      })
  })

nodejs是單線程應用， 如果我們用node命令來運行我們的應用， 當出現一個小錯誤， 它就掛了。 然后沒有然后了。 避免這種問題的方法有如下工具：

1.forever

2.nodemon

3.supervisor
nodeclub 使用forever來運行項目， 使用這類工具的好處就是， 當有代碼改動過后， 會自動的重啟應用。 不必每次自己去運行node *.js

待續...