nodeJS（2）深瞭解： nodeJS 項目架構詳解（app.js + Express + Http）

時間 2019-11-19

標籤 nodejs 瞭解項目架構詳解 app.js app express http 欄目系統架構简体版

原文原文鏈接

簡略瞭解：nodeJS 深瞭解（1）： Node.js + Express 構建網站預備知識php

環境：

環境： win7 + nodeJShtml

版本（node）：node

新建 nodeJS 項目：

名稱爲: techNode
express： 4.14.1
模板： EJS （2.5.5）
得到文件目錄以下：

其中重點文件/文件夾說明：python

techNode：web

-bin/www: 啓動運行（服務端口設置等，可與 app.js 合併）數據庫

-public: 存放靜態文件（在 app.js 中設置的，所以該文件夾名稱可自擬）express

-routes: 存放路由文件（裏面的文件，在 app.js 中或其餘文件中，使用「require(‘*****’)」引用該目錄下的 js 文件，所以文件夾名稱能夠自擬）json

-views: 存放頁面文件（app.js 中設置，所以該文件夾名稱可自擬）api

-- ***.ejs: 具體的頁面文件（後綴名 .ejs 是由於此處使用的是 ejs 模板，該設置在 app.js 中，所以能夠本身設置爲本身喜歡/習慣的方式）瀏覽器

-app.js: 服務的入口文件（重要!!! 整個項目的運行基礎架構，基礎的設置）

-package.json: 服務說明（包含：項目名稱，做者等信息；以及整個項目所須要的包的信息）

!!! 所以： 必不可少的文件 app.js [bin/www], package.json 文件，其他均可自行設定並在 app.js 中進行更改聲明

重要的 app.js

由於個人自生成的 package.json 文件在上面截圖中已顯示，此處再也不重複，下面看下具體的 app.js，如下是自生成的 app.js 文件，我添加了說明：

var express = require('express');    /* 重要： 不可少 */ 
var path = require('path');  /* 重要：目錄設置時，可以使用其方法引用根目錄， 不可少 */
var favicon = require('serve-favicon');
var logger = require('morgan');
var cookieParser = require('cookie-parser');
var bodyParser = require('body-parser');


/* 聲明要訪問的路由(該路由指定路由文件--html/ejs/...)， 該路由可自定義 */
var index = require('./routes/index');
// var users = require('./routes/users');

var app = express();  /* 重要： 不可少 */

// view engine setup
app.set('views', path.join(__dirname, 'views')); //定義模板（views ）搜索路徑，在根目錄的 views 文件夾下,可自定義
app.set('view engine', 'ejs');  //設置模板引擎 爲： EJS, 可自定義

// uncomment after placing your favicon in /public
//app.use(favicon(path.join(__dirname, 'public', 'favicon.ico')));
app.use(logger('dev'));
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: false }));
app.use(cookieParser());
app.use(express.static(path.join(__dirname, 'public')));  //指定靜態文件名稱是 public, 文件夾名可自定義

/* 訪問已定義的路由文件 */
app.use('/', index);
// app.use('/users', users);

// 404 處理: catch 404 and forward to error handler
app.use(function(req, res, next) {
  var err = new Error('Not Found');
  err.status = 404;
  next(err);
});

// 錯誤處理：error handler
app.use(function(err, req, res, next) {
  // set locals, only providing error in development
  res.locals.message = err.message;
  res.locals.error = req.app.get('env') === 'development' ? err : {};

  // render the error page
  res.status(err.status || 500);
  res.render('error');
});

module.exports = app;  /* 拋出 app 變量方法， 爲 bin/www 中端口設置進行「鋪墊」 */

接着看看自生成的 bin/www 文件：

#!/usr/bin/env node
/**
 * Module dependencies.
 */

var app = require('../app');  /* 引用 ../app.js 文件,實質是指向 app = express() 變量方法的引用 */
var debug = require('debug')('technode:server');
var http = require('http');  /* 提供 httpServer 服務模塊，不可少 */

/**
 * Get port from environment and store in Express.
 */

var port = normalizePort(process.env.PORT || '3000');  /* 聲明端口， 不可少； normalizePort： 自定義方法,端口設置 */
app.set('port', port);  /* 設定（綁定）端口 */

/**
 * Create HTTP server.
 */

var server = http.createServer(app);  /* 使用 定義的 http 服務, 不可少 */

/**
 * Listen on provided port, on all network interfaces.
 */

server.listen(port);  /* 使用（監聽）端口, 不可少 */
server.on('error', onError);
server.on('listening', onListening);

/**
 * Normalize a port into a number, string, or false.
 */
function normalizePort(val) {
  var port = parseInt(val, 10);

  if (isNaN(port)) {
    // named pipe
    return val;
  }

  if (port >= 0) {
    // port number
    return port;
  }

  return false;
}

/**
 * Event listener for HTTP server "error" event.
 */
function onError(error) {
  if (error.syscall !== 'listen') {
    throw error;
  }

  var bind = typeof port === 'string'
    ? 'Pipe ' + port
    : 'Port ' + port;

  // handle specific listen errors with friendly messages
  switch (error.code) {
    case 'EACCES':
      console.error(bind + ' requires elevated privileges');
      process.exit(1);
      break;
    case 'EADDRINUSE':
      console.error(bind + ' is already in use');
      process.exit(1);
      break;
    default:
      throw error;
  }
}

/**
 * Event listener for HTTP server "listening" event.
 */
function onListening() {
  var addr = server.address();
  var bind = typeof addr === 'string'
    ? 'pipe ' + addr
    : 'port ' + addr.port;
  debug('Listening on ' + bind);
}

Express 和 Http 模塊：

Express 模塊

Express 是一個簡潔而靈活的 node.js Web應用框架, 提供了一系列強大特性幫助你建立各類 Web 應用，和豐富的 HTTP 工具。

使用 Express 能夠快速地搭建一個完整功能的網站。
Express 框架核心特性：
- 能夠設置中間件來響應 HTTP 請求。
- 定義了路由表用於執行不一樣的 HTTP 請求動做。
- 能夠經過向模板傳遞參數來動態渲染 HTML 頁面。

如下幾個重要的模塊是須要與 express 框架一塊兒安裝的：

body-parser - node.js 中間件，用於處理 JSON, Raw, Text 和 URL 編碼的數據。

cookie-parser - 這就是一個解析Cookie的工具。經過req.cookies能夠取到傳過來的cookie，並把它們轉成對象。

multer - node.js 中間件，用於處理 enctype="multipart/form-data"（設置表單的MIME編碼）的表單數據。(eg: 多圖片/多文件路徑時)

Express 框架實例：

引入了 express 模塊，並在客戶端發起請求後，響應 "Hello World" 字符串。
建立 express_demo.js 文件，代碼以下所示：
var express = require('express');
var app = express();
 
app.get('/', function (req, res) {
   res.send('Hello World');
})
 
var server = app.listen(8081, function () {
 
  var host = server.address().address
  var port = server.address().port
 
  console.log("應用實例，訪問地址爲 http://%s:%s", host, port)
 
})

執行以上代碼：
$ node express_demo.js 
應用實例，訪問地址爲 http://0.0.0.0:8081 ， 會看到 Hello world  字樣

請求和響應

Express 應用使用回調函數的參數： request 和 response 對象來處理請求和響應的數據。

app.get('/', function (req, res) { // -- })

request 和 response 對象的具體介紹：

Request 對象 - request 對象表示 HTTP 請求，包含了請求查詢字符串，參數，內容，HTTP 頭部等屬性。常見屬性有：

req.app：當callback爲外部文件時，用req.app訪問express的實例
req.baseUrl：獲取路由當前安裝的URL路徑
req.body / req.cookies：得到「請求主體」/ Cookies
req.fresh / req.stale：判斷請求是否還「新鮮」
req.hostname / req.ip：獲取主機名和IP地址
req.originalUrl：獲取原始請求URL
req.params：獲取路由的parameters
req.path：獲取請求路徑
req.protocol：獲取協議類型
req.query：獲取URL的查詢參數串
req.route：獲取當前匹配的路由
req.subdomains：獲取子域名
req.accepts()：檢查可接受的請求的文檔類型
req.acceptsCharsets / req.acceptsEncodings / req.acceptsLanguages：返回指定字符集的第一個可接受字符編碼
req.get()：獲取指定的HTTP請求頭
req.is()：判斷請求頭Content-Type的MIME類型

Response 對象 - response 對象表示 HTTP 響應，即在接收到請求時向客戶端發送的 HTTP 響應數據。常見屬性有：

res.app：同req.app同樣
res.append()：追加指定HTTP頭
res.set()在res.append()後將重置以前設置的頭
res.cookie(name，value [，option])：設置Cookie
opition: domain / expires / httpOnly / maxAge / path / secure / signed
res.clearCookie()：清除Cookie
res.download()：傳送指定路徑的文件
res.get()：返回指定的HTTP頭
res.json()：傳送JSON響應
res.jsonp()：傳送JSONP響應
res.location()：只設置響應的Location HTTP頭，不設置狀態碼或者close response
res.redirect()：設置響應的Location HTTP頭，而且設置狀態碼302
res.send()：傳送HTTP響應
res.sendFile(path [，options] [，fn])：傳送指定路徑的文件 -會自動根據文件extension設定Content-Type
res.set()：設置HTTP頭，傳入object能夠一次設置多個頭
res.status()：設置HTTP狀態碼
res.type()：設置Content-Type的MIME類型

路由

咱們已經瞭解了 HTTP 請求的基本應用，而路由決定了由誰(指定腳本)去響應客戶端請求。

在HTTP請求中，咱們能夠經過路由提取出請求的URL以及GET/POST參數。

擴展 Hello World，添加一些功能來處理更多類型的 HTTP 請求。
建立 express_demo2.js 文件，代碼以下所示：
var express = require('express');
var app = express();
 
//  主頁輸出 "Hello World"
app.get('/', function (req, res) {
   console.log("主頁 GET 請求");
   res.send('Hello GET');
})
 
 
//  POST 請求
app.post('/', function (req, res) {
   console.log("主頁 POST 請求");
   res.send('Hello POST');
})
 
//  /del_user 頁面響應
app.get('/del_user', function (req, res) {
   console.log("/del_user 響應 DELETE 請求");
   res.send('刪除頁面');
})
 
//  /list_user 頁面 GET 請求
app.get('/list_user', function (req, res) {
   console.log("/list_user GET 請求");
   res.send('用戶列表頁面');
})
 
// 對頁面 abcd, abxcd, ab123cd, 等響應 GET 請求
app.get('/ab*cd', function(req, res) {   
   console.log("/ab*cd GET 請求");
   res.send('正則匹配');
})
 
 
var server = app.listen(8081, function () {
 
  var host = server.address().address
  var port = server.address().port
 
  console.log("應用實例，訪問地址爲 http://%s:%s", host, port)
 
})

執行以上代碼：
$ node express_demo2.js 
應用實例，訪問地址爲 http://0.0.0.0:8081, 能夠嘗試訪問 http://127.0.0.1:8081 不一樣的地址，查看效果。

靜態文件

Express 提供了內置的中間件 express.static 來設置靜態文件如：圖片， CSS, JavaScript 等。

你可使用 express.static 中間件來設置靜態文件路徑。例如，若是你將圖片， CSS, JavaScript 文件放在 public 目錄下，你能夠這麼寫：

app.use(express.static('public'));

咱們能夠到 public/images 目錄下放些圖片,以下所示：

node_modules
server.js public/ public/images public/images/logo.png

讓咱們再修改下 "Hello World" 應用添加處理靜態文件的功能。

建立 express_demo3.js 文件，代碼以下所示：
var express = require('express');
var app = express();
 
app.use(express.static('public'));
 
app.get('/', function (req, res) {
   res.send('Hello World');
})
 
var server = app.listen(8081, function () {
 
  var host = server.address().address
  var port = server.address().port
 
  console.log("應用實例，訪問地址爲 http://%s:%s", host, port)
 
})

執行以上代碼：
$ node express_demo3.js 
應用實例，訪問地址爲 http://0.0.0.0:8081/imgaes/logo.png (前提有該文件)，則可顯示圖片

GET 方法

如下實例演示了在表單中經過 GET 方法提交兩個參數，咱們可使用 server.js 文件內的 process_get 路由器來處理輸入：

index.htm 文件代碼：

<html>
<body>
   <form action="http://127.0.0.1:8081/process_get" method="GET">
      First Name: <input type="text" name="first_name">  <br>
 
      Last Name: <input type="text" name="last_name">
      <input type="submit" value="Submit">
   </form>
</body>
</html>

server.js 文件代碼：

var express = require('express');
var app = express();
 
app.use(express.static('public'));
 
app.get('/index.htm', function (req, res) {
   res.sendFile( __dirname + "/" + "index.htm" );
})
 
app.get('/process_get', function (req, res) {
   // 輸出 JSON 格式
   var response = {
       "first_name":req.query.first_name,
       "last_name":req.query.last_name
   };
   console.log(response);
   res.end(JSON.stringify(response));
})
 
var server = app.listen(8081, function () {
 
  var host = server.address().address
  var port = server.address().port
 
  console.log("應用實例，訪問地址爲 http://%s:%s", host, port)
 
})

執行以上代碼：

node server.js 應用實例，訪問地址爲 http://0.0.0.0:8081

如今你能夠向表單輸入數據，並提交，以下演示(注意此處的 process_post 後會顯示參數內容，不安全)：

POST 方法

如下實例演示了在表單中經過 POST 方法提交兩個參數，咱們可使用 server.js 文件內的 process_post 路由器來處理輸入：

index.htm 文件代碼：

<html>
<body>
    <form action="http://127.0.0.1:8081/process_post" method="POST">
        First Name: <input type="text" name="first_name">  <br>
 
        Last Name: <input type="text" name="last_name">
        <input type="submit" value="Submit">
    </form>
</body>
</html>

server.js 文件代碼:

var express = require('express');
var app = express();
var bodyParser = require('body-parser');
 
// 建立 application/x-www-form-urlencoded 編碼解析
var urlencodedParser = bodyParser.urlencoded({ extended: false })
 
app.use(express.static('public'));
 
app.get('/index.htm', function (req, res) {
   res.sendFile( __dirname + "/" + "index.htm" );
})
 
app.post('/process_post', urlencodedParser, function (req, res) {
 
   // 輸出 JSON 格式
   var response = {
       "first_name":req.body.first_name,
       "last_name":req.body.last_name
   };
   console.log(response);
   res.end(JSON.stringify(response));
})
 
var server = app.listen(8081, function () {
 
  var host = server.address().address
  var port = server.address().port
 
  console.log("應用實例，訪問地址爲 http://%s:%s", host, port)
 
})

執行以上代碼：

$ node server.js 應用實例，訪問地址爲 http://0.0.0.0:8081

如今你能夠向表單輸入數據，並提交，以下演示(注意此處的 process_post 後沒有顯示參數內容)：

文件上傳

如下咱們建立一個用於上傳文件的表單，使用 POST 方法，表單 enctype 屬性設置爲 multipart/form-data。

index.htm 文件代碼：

<html>
<head>
    <title>文件上傳表單</title>
</head>
<body>
    <h3>文件上傳：</h3>
    選擇一個文件上傳: <br />
    <form action="/file_upload" method="post" enctype="multipart/form-data">
       <input type="file" name="image" size="50" />
       <br />
       <input type="submit" value="上傳文件" />
    </form>
</body>
</html>

server.js 文件代碼：

<pre>
var express = require('express');
var app = express();
var fs = require("fs");
 
var bodyParser = require('body-parser');
var multer  = require('multer');
 
app.use(express.static('public'));
app.use(bodyParser.urlencoded({ extended: false }));
app.use(multer({ dest: '/tmp/'}).array('image'));
 
app.get('/index.htm', function (req, res) {
   res.sendFile( __dirname + "/" + "index.htm" );
})
 
app.post('/file_upload', function (req, res) {
 
   console.log(req.files[0]);  // 上傳的文件信息
 
   var des_file = __dirname + "/" + req.files[0].originalname;
   fs.readFile( req.files[0].path, function (err, data) {
        fs.writeFile(des_file, data, function (err) {
         if( err ){
              console.log( err );
         }else{
               response = {
                   message:'File uploaded successfully', 
                   filename:req.files[0].originalname
              };
          }
          console.log( response );
          res.end( JSON.stringify( response ) );
       });
   });
})
 
var server = app.listen(8081, function () {
 
  var host = server.address().address
  var port = server.address().port
 
  console.log("應用實例，訪問地址爲 http://%s:%s", host, port)
 
})

執行以上代碼：

$ node server.js 應用實例，訪問地址爲 http://0.0.0.0:8081

瀏覽器訪問 http://127.0.0.1:8081/index.htm，如圖所示：

如今你能夠向表單輸入數據，並提交，以下演示：

Cookie 管理

咱們可使用中間件向 Node.js 服務器發送 cookie 信息，如下代碼輸出了客戶端發送的 cookie 信息：

express_cookie.js 文件代碼：

var express      = require('express')
var cookieParser = require('cookie-parser')
 
var app = express()
app.use(cookieParser())
 
app.get('/', function(req, res) {
  console.log("Cookies: ", req.cookies)
})
 
app.listen(8081)

執行以上代碼：

$ node express_cookie.js

如今你能夠訪問 http://127.0.0.1:8081 並查看終端信息的輸出，以下演示：

相關資料

Express官網： http://expressjs.com/
Express4.x API 中文版： Express4.x API Chinese
Express4.x API：http://expressjs.com/zh-cn/4x/api.html

Node.js Web 模塊（Htttp）

什麼是 Web 服務器？

Web服務器通常指網站服務器，是指駐留於因特網上某種類型計算機的程序，Web服務器的基本功能就是提供Web信息瀏覽服務。它只需支持HTTP協議、HTML文檔格式及URL，與客戶端的網絡瀏覽器配合。

大多數 web 服務器都支持服務端的腳本語言（php、python、ruby）等，並經過腳本語言從數據庫獲取數據，將結果返回給客戶端瀏覽器。

目前最主流的三個Web服務器是Apache、Nginx、IIS。

Web 應用架構

- Client - 客戶端，通常指瀏覽器，瀏覽器能夠經過 HTTP 協議向服務器請求數據。
- Server - 服務端，通常指 Web 服務器，能夠接收客戶端請求，並向客戶端發送響應數據。
- Business - 業務層，經過 Web 服務器處理應用程序，如與數據庫交互，邏輯運算，調用外部程序等。
- Data - 數據層，通常由數據庫組成。

使用 Node 建立 Web 服務器

Node.js 提供了 http 模塊，http 模塊主要用於搭建 HTTP 服務端和客戶端，使用 HTTP 服務器或客戶端功能必須調用 http 模塊，代碼以下：

var http = require('http');

如下是演示一個最基本的 HTTP 服務器架構(使用8081端口)，建立 server.js 文件，代碼以下所示：

server.js 文件代碼：

var http = require('http');
var fs = require('fs');
var url = require('url');


// 建立服務器
http.createServer( function (request, response) {  
   // 解析請求，包括文件名
   var pathname = url.parse(request.url).pathname;
   
   // 輸出請求的文件名
   console.log("Request for " + pathname + " received.");
   
   // 從文件系統中讀取請求的文件內容
   fs.readFile(pathname.substr(1), function (err, data) {
      if (err) {
         console.log(err);
         // HTTP 狀態碼: 404 : NOT FOUND
         // Content Type: text/plain
         response.writeHead(404, {'Content-Type': 'text/html'});
      }else{             
         // HTTP 狀態碼: 200 : OK
         // Content Type: text/plain
         response.writeHead(200, {'Content-Type': 'text/html'});    
         
         // 響應文件內容
         response.write(data.toString());        
      }
      //  發送響應數據
      response.end();
   });   
}).listen(8081);

// 控制檯會輸出如下信息
console.log('Server running at http://127.0.0.1:8081/');

　　接下來咱們在該目錄下建立一個 index.htm 文件，代碼以下：

index.html 文件：

<html>
<head>
    <title>Sample Page</title>
</head>
<body>
     Hello World!
</body>
</html>

執行 server.js 文件：

$ node server.js Server running at http://127.0.0.1:8081/

接着咱們在瀏覽器中打開地址：http://127.0.0.1:8081/index.htm，顯示以下圖所示:

執行 server.js 的控制檯輸出信息以下：

Server running at http://127.0.0.1:8081/ Request for /index.htm received. # 客戶端請求信息

Gif 實例演示

使用 Node 建立 Web 客戶端

Node 建立 Web 客戶端須要引入 http 模塊，建立 client.js 文件，代碼以下所示：

 client.js 文件：

var http = require('http');

// 用於請求的選項
var options = {
   host: 'localhost',
   port: '8081',
   path: '/index.htm'  
};

// 處理響應的回調函數
var callback = function(response){
   // 不斷更新數據
   var body = '';
   response.on('data', function(data) {
      body += data;
   });
   
   response.on('end', function() {
      // 數據接收完成
      console.log(body);
   });
}
// 向服務端發送請求
var req = http.request(options, callback);
req.end();

新開一個終端，執行 client.js 文件，輸出結果以下：

$ node client.js <html> <head> <title>Sample Page</title> </head> <body> Hello World! </body> </html>

執行 server.js 的控制檯輸出信息以下：

Server running at http://127.0.0.1:8081/ Request for /index.htm received. # 客戶端請求信息

Gif 實例演示

此節完成！

相關標籤/搜索

nodejs+express+express

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。