Nodejs學習筆記（十五）—Node.js + Koa2 構建網站簡單示例

時間 2019-11-12

標籤 nodejs 學習筆記十五 node.js node koa2 koa 構建網站簡單示例欄目 Node.js 简体版

原文原文鏈接

前言

　　前面一有寫到一篇Node.js+Express構建網站簡單示例：http://www.cnblogs.com/zhongweiv/p/nodejs_express_webapp.htmljavascript

　　這篇仍是用之前的例子，用Node.js+Koa2構建css

　　Koa: https://github.com/koajs/koahtml

　　　　 http://koa.bootcss.com (中文)java

　　Koa就很少介紹了，前面也寫過Express，同一個團隊打造，前面也過express文章，對比着看，天然能夠看出些優勢！node

搭建項目及其它準備工做

建立數據庫mysql

CREATE DATABASE IF NOT EXISTS nodesample CHARACTER SET UTF8;

USE nodesample;

SET FOREIGN_KEY_CHECKS=0;

DROP TABLE IF EXISTS `userinfo`;
CREATE TABLE `userinfo` (
  `Id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主鍵',
  `UserName` varchar(64) NOT NULL COMMENT '用戶名',
  `UserPass` varchar(64) NOT NULL COMMENT '用戶密碼',
  PRIMARY KEY (`Id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='用戶信息表';

建立Koa2項目jquery

安裝koa-generator: https://github.com/17koa/koa-generatorgit

npm install -g koa-generator

安裝成功後下圖（版本：1.1.16）github

而後建立Koa2項目，安裝相關依賴項web

cd 工做目錄
koa2 項目名
cd 項目目錄 && npm install

安裝項目其它須要包

1.安裝使用MySQL須要的包

npm install --save mysql

沒有使用過的能夠看我之前寫的相關操做文章：http://www.cnblogs.com/zhongweiv/p/nodejs_mysql.html

2.安裝ejs（koa2默認爲jade，我習慣使用ejs）

npm install --save ejs

沒有使用過的能夠看我之前寫的相關操做文章：http://www.cnblogs.com/zhongweiv/p/nodejs_express.html

3.安裝Session存儲相關包(存儲到redis)

npm install koa-session https://github.com/koajs/session

npm install --save koa-session

koa-session-redis https://github.com/Chilledheart/koa-session-redis

npm install --save koa-session-redis

清除冗餘文件並從新規劃項目目錄

1.刪除掉建立項目後自帶的views和routes下的文件

2.從新規劃項目目錄，規劃後以下

目錄規則解釋：

1.新增pub目錄：主要爲了統一存放"數據訪問"、"業務邏輯"、"公共方法文件"、"數據庫幫助文件"、"配置文件"等

2.新增pub目錄下utils目錄：主要爲了統一存放相似"公共函數文件"、"返回值文件"、"枚舉文件"等公共文件

3.新增pub目錄下config目錄：主要爲了統一存放各類類型的配置文件

4.新增pub目錄下db目錄：主要爲了統一存放各類數據庫幫助類，好比："mysql-helper.js"、"mongo-helper.js"等等

5.新增pub目錄下model目錄：主要爲了統一存放各類數據庫各表CURD操做

6.新增pub目錄下bll目錄：主要爲了統一存放各類業務邏輯的具體實現

配置文件

從上面的圖能夠看出，我在pub下新建的config目錄下新建了一個config.js

這個config.js中將編寫「開發環境」和「發佈環境」中所需的配置，代碼以下

/**
 * 配置文件
 */
//發佈配置
const production = {

    //服務器端口
    SERVER_PORT : 3000,

    //REDIS配置
    REDIS: {
        host: 'localhost',            
        port: 6379,
        password: "abcd",
        maxAge: 3600000
    },

    //MYSQL數據庫配置
    MYSQL: {
        host: "localhost",
        user: "root",
        password: "abcd",
        port: "3306",
        database: "nodesample",
        supportBigNumbers: true,
        multipleStatements: true,
        timezone: 'utc'
    }

}

//開發配置
const development = {

    //服務器端口
    SERVER_PORT : 3000,

    //REDIS配置
    REDIS: {
        host: 'localhost',            
        port: 6379,
        password: "abcd",
        maxAge: 3600000
    },

    //MYSQL數據庫配置
    MYSQL: {
        host: "localhost",
        user: "root",
        password: "abcd",
        port: "3306",
        database: "nodesample",
        supportBigNumbers: true,
        multipleStatements: true,
        timezone: 'utc'
    }

}

const config = development

module.exports = config

規劃示例路由，並新建相關文件

示例中將有註冊、登陸功能，先規劃好路由，新建routes、views下的相關須要的文件（如項目目錄圖中文件），並修改app.js文件

const Koa = require('koa')
const app = new Koa()
const views = require('koa-views')
const json = require('koa-json')
const onerror = require('koa-onerror')
const bodyparser = require('koa-bodyparser')
const logger = require('koa-logger')

const config = require('./pub/config/config.js');
const session = require('koa-session');
const RedisStore = require('koa2-session-redis');

const index = require('./routes/index')
const reg = require('./routes/reg')
const login = require('./routes/login')
const logout = require('./routes/logout')

// error handler
onerror(app)

// middlewares
app.use(bodyparser({
  enableTypes:['json', 'form', 'text']
}))
app.use(json())
app.use(logger())
app.use(require('koa-static')(__dirname + '/public'))

app.use(views(__dirname + '/views', {
  extension: 'ejs'
}))

// logger
app.use(async (ctx, next) => {
  const start = new Date()
  await next()
  const ms = new Date() - start
  console.log(`${ctx.method} ${ctx.url} - ${ms}ms`)
})

app.keys = ['Porschev'];
const redis_conf = {  
  key: 'Porschev',
  maxAge: config.REDIS.maxAge,
  overwrite: true,
  httpOnly: true,  
  rolling: false,
  sign: true,
  store: new RedisStore({
    host: config.REDIS.host,
    port: config.REDIS.port,    
    password: config.REDIS.password    
  })
};

app.use(session(redis_conf, app));

// routes
app.use(index.routes(), index.allowedMethods())
app.use(reg.routes(), reg.allowedMethods())
app.use(login.routes(), login.allowedMethods())
app.use(logout.routes(), logout.allowedMethods())

// error-handling
app.on('error', (err, ctx) => {
  console.error('server error', err, ctx)
});

app.listen(config.SERVER_PORT, () => {
  console.log(`Starting at port ${config.SERVER_PORT}!`)
});

module.exports = app

　　注意看紅色標記修改或增長的部分

實現數據訪問和業務邏輯相關方法

1.首先編寫一個mysql-helper.js方便以鏈接池的方式進行操做

const config = require('./../config/config.js')
const mysql = require("mysql")

const pool = mysql.createPool(config.MYSQL)
  
let query = function(sql, args) {
  
    return new Promise((resolve, reject) => {
        pool.getConnection(function(err, connection) {
            if (err) {
                resolve(err)
            } else {
                connection.query(sql, args, (err, result) => {
        
                    if (err) {
                        reject(err)
                    } else {
                        resolve(result)
                    }
                    connection.release()

                })
            }
        })
    })
  
}

module.exports = { 
    query 
}

2.編寫數據訪問相關方法（model目錄下的userinfo.js），以下

const mysqlHelper = require('./../db/mysql-helper.js')

const userinfo = {

  /**
   * 增長一條數據
   * @param  {object} args  參數
   * @return {object}       結果
   */
  async add ( args ) {
    let sql = 'INSERT INTO userinfo(UserName, UserPass) VALUES(?, ?)'
    let params = [args.username, args.userpass]
    let result = await mysqlHelper.query(sql, params)
    return result
  },

  /**
   * 根據UserName獲得一條數據
   * @param  {object} args  參數
   * @return {object}       結果
   */
  async getByUserName( args ){
    let sql = 'SELECT Id, UserName, UserPass FROM userinfo WHERE UserName = ?'
    let params = [args.username]
    let result = await mysqlHelper.query(sql, params)
    return result
  },

   /**
   * 根據UserName獲得數量
   * @param  {object} args  參數
   * @return {object}       結果
   */
  async getCountByUserName( args ){
    let sql = 'SELECT COUNT(1) AS UserNum FROM userinfo WHERE UserName = ?'
    let params = [args.username]
    let result = await mysqlHelper.query(sql, params)
    return result
  },

}

module.exports = userinfo

3.在寫業務邏輯以前先規劃好返回值（utils目錄下retcode.js）

retcode.js

/*
 * 返回碼
 */
const RetCode = {
    SessionExpired: -1,             //session過時
    Fail: 0,                        //失敗
    Success: 1,                     //成功
    ArgsError: 2,                   //參數錯誤
    UserExisted: 10,                //用戶已經存在
    UsernameOrPasswordError: 11,    //用戶名或者密碼錯誤      
    UserNotExist: 12,               //用戶不存在    
};

module.exports = RetCode

4.編寫「登陸」、「註冊」等業務邏輯（bll下userinfo.js）

const usermodel = require('./../model/userinfo.js')
const retCode = require('./../utils/retcode.js')

const userinfo = {

  /**
   * 註冊
   * @param  {object} ctx   上下文
   * @return {object}       結果
   */
  async register ( ctx ) {
    let form = ctx.request.body
    
    const args = {
        username: form.username,
        userpass: form.userpass
    }
        
    let result = {
        code: retCode.Success,    
        data: null
    }
    
    //驗證非空
    if(!args.username || !args.userpass){
        result.code = retCode.ArgsError        
        return result
    }

    //根據用戶名獲得用戶數量
    let userNumResult = await usermodel.getCountByUserName(args)

    //用戶名已被註冊
    if(userNumResult[0].UserNum > 0){
        result.code = retCode.UserExisted        
        return result
    }

    //插入註冊數據
    let userResult = await usermodel.add(args)

    if(userResult.insertId <= 0){
        result.code = retCode.Fail        
        return result
    }

    return result
  },

  /**
   * 登陸
   * @param  {object} ctx   上下文
   * @return {object}       結果
   */
  async login ( ctx ) {
    let form = ctx.request.body
    
    const args = {
        username: form.username,
        userpass: form.userpass
    }
        
    let result = {
        code: retCode.Success,    
        data: null
    }
    
    //驗證非空
    if(!args.username || !args.userpass){
        result.code = retCode.ArgsError        
        return result
    }

    //根據用戶名獲得用戶信息
    let userResult = await usermodel.getByUserName(args)

    //用戶不存在
    if(userResult.length == 0){
        result.code = retCode.UserNotExist        
        return result
    }
    
    //用戶名或密碼錯誤
    if(userResult[0].UserName != args.username || userResult[0].UserPass != args.userpass){
        result.code = retCode.UsernameOrPasswordError        
        return result
    }

    //將用戶ID存入Session中
    ctx.session = {id: userResult[0].Id}

    return result
  },

}

module.exports = userinfo

註冊

1.views目錄下reg.ejs

<html>
<head>
<title>Nodejs學習筆記（十五）--- Node.js + Koa2 構建網站簡單示例</title>
</head>
<body>
<h1><%= title %></h1>
登陸名：<input type="text" id="txtUserName" maxlength="20" />
<br/>
<br/>
密碼：<input type="password" id="txtUserPwd" maxlength="12" />
<br/>
<br/>
密碼：<input type="password" id="txtUserRePwd" maxlength="12" />
<br/>
<br/>
<input type="button" id="btnSub" value="註冊" />
</body>
</html>

<script src="/javascripts/jquery-1.11.2.min.js" type="text/javascript"></script>
<script src="/javascripts/md5.js" type="text/javascript"></script>

<script type="text/javascript">   
    $(function(){
        $('#btnSub').on('click', function(){
            var $txtUserName = $('#txtUserName'),
                txtUserNameVal = $.trim($txtUserName.val()),
                $txtUserPwd = $('#txtUserPwd'),
                txtUserPwdVal = $.trim($txtUserPwd.val()),
                $txtUserRePwd = $('#txtUserRePwd'),
                txtUserRePwdVal = $.trim($txtUserRePwd.val());
                       
            if(txtUserNameVal.length == 0){
                alert('用戶名不能爲空');                
                return false;
            }

            if(txtUserPwdVal.length == 0){                
                alert('密碼不能爲空');                
                return false;
            }

            if(txtUserRePwdVal.length == 0){
                alert('重複密碼不能爲空');   
                return false;
            }

            if(txtUserPwdVal != txtUserRePwdVal){                 
                alert('兩次密碼不一致');                 
                return false;
            }

            $.ajax({
                url: '/reg',
                type: 'POST',
                dataType: 'json',
                data: {
                    username: txtUserNameVal,                    
                    userpass: hex_md5(txtUserPwdVal)                                        
                },
                beforeSend: function (xhr) {},
                success: function (res) {
                    if (res != null && res.code) {

                        var retVal = parseInt(res.code);

                        switch (retVal) {
                            case 2:
                                alert('輸入有誤');
                                break;
                            case 0:
                                alert('註冊失敗');
                                break;
                            case 1:
                                alert('註冊成功!');
                                location.href = '/login'                                
                                break;
                            case 10:
                                alert('用戶已註冊');
                                break;                         
                        }
                    }
                    else {
                        alert('操做失敗');
                    }

                },
                complete: function (XMLHttpRequest, textStatus) {},
                error: function (XMLHttpRequest, textStatus, errorThrown) {
                    alert('操做失敗');
                }
            });            
        })
    });

</script>

2.routes目錄下reg.js

const router = require('koa-router')()
const userBll = require('./../pub/bll/userinfo.js')
const title = '註冊'

router.prefix('/reg')

router.get('/', async (ctx, next) => {
  await ctx.render('reg', { title })
})

router.post('/', async (ctx, next) => {

  let result = await userBll.register(ctx)

  ctx.body = result;

})

module.exports = router

登陸

1.views目錄下login.ejs

<html>
<head>
<title>Nodejs學習筆記（十五）--- Node.js + Koa2 構建網站簡單示例</title>
</head>
<body>
<h1><%= title %></h1>
登陸名：<input type="text" id="txtUserName" maxlength="20" />
<br/>
<br/>
密碼：<input type="password" id="txtUserPwd" maxlength="12" />
<br/>
<br/>
<input type="button" id="btnSub" value="登陸" />
</body>
</html>

<script src="/javascripts/jquery-1.11.2.min.js" type="text/javascript"></script>
<script src="/javascripts/md5.js" type="text/javascript"></script>

<script type="text/javascript">   
    $(function(){
        $('#btnSub').on('click', function(){
            var $txtUserName = $('#txtUserName'),
                txtUserNameVal = $.trim($txtUserName.val()),
                $txtUserPwd = $('#txtUserPwd'),
                txtUserPwdVal = $.trim($txtUserPwd.val());
                       
            if(txtUserNameVal.length == 0){
                alert('用戶名不能爲空');                
                return false;
            }

            if(txtUserPwdVal.length == 0){                
                alert('密碼不能爲空');                
                return false;
            }
           
            $.ajax({
                url: '/login',
                type: 'POST',
                dataType: 'json',
                data: {
                    username: txtUserNameVal,                    
                    userpass: hex_md5(txtUserPwdVal)                                        
                },
                beforeSend: function (xhr) {},
                success: function (res) {
                    if (res != null && res.code) {

                        var retVal = parseInt(res.code);

                        switch (retVal) {
                            case 2:
                                alert('輸入有誤');
                                break;
                            case 0:
                                alert('登陸失敗');
                                break;
                            case 1:
                                alert('登陸成功!');
                                location.href = '/'                                
                                break;
                            case 11:
                                alert('用戶名或者密碼錯誤');
                                break;
                            case 12:
                                alert('用戶不存在');
                                break;
                        }
                    }
                    else {
                        alert('操做失敗');
                    }

                },
                complete: function (XMLHttpRequest, textStatus) {},
                error: function (XMLHttpRequest, textStatus, errorThrown) {
                    alert('操做失敗');
                }
            });            
        })
    });

</script>

2.routes目錄下login.js

const router = require('koa-router')()
const userBll = require('./../pub/bll/userinfo.js')
const title = '登陸'

router.prefix('/login')

router.get('/', async (ctx, next) => {
  await ctx.render('login', { title })
})

router.post('/', async (ctx, next) => {
  
    let result = await userBll.login(ctx);

    ctx.body = result;
  
})

module.exports = router

首頁

1.views目錄下index.ejs

<html>
<head>
<title>Nodejs學習筆記（十五）--- Node.js + Koa2 構建網站簡單示例</title>
</head>
<body>
<h1><%= title %></h1>

<% if(id != null) {%>
    <h3>登陸用戶ID：<%= id %> <a id="btnLogOut" href="javascript:void(0);">安全退出</a></h3>
<% } %>
</body>
</html>

<script src="/javascripts/jquery-1.11.2.min.js" type="text/javascript"></script>

<script type="text/javascript">   
    $(function(){
        $('#btnLogOut').on('click', function(){
           
           if(!confirm('確認要退出嗎?')){
                return;
           }

            $.ajax({
                url: '/logout',
                type: 'POST',
                dataType: 'json',
                data: {},
                beforeSend: function (xhr) {},
                success: function (res) {
                    if (res != null && res.code) {

                        var retVal = parseInt(res.code);

                        switch (retVal) {                           
                            case 0:
                                alert('失敗');
                                break;
                            case 1:
                                alert('成功!');
                                location.href = '/login'                                
                                break;                           
                        }
                    }
                    else {
                        alert('操做失敗');
                    }

                },
                complete: function (XMLHttpRequest, textStatus) {},
                error: function (XMLHttpRequest, textStatus, errorThrown) {
                    alert('操做失敗');
                }
            });            
        })
    });

</script>

2.routes目錄下index.js

const router = require('koa-router')()
const title = '首頁'

router.get('/', async (ctx, next) => {  
  //判斷登陸
  if(!ctx.session || !ctx.session.id){
    await ctx.redirect('/login')  
  }else{    
    const id = ctx.session.id;
    await ctx.render('index', { title, id })
  }  
})

module.exports = router

　　index.js文件中實現若是不存在session則跳回登陸頁

安全退出

1.routes目錄下logout.js

const router = require('koa-router')()
const retCode = require('./../pub/utils/retcode.js')

router.prefix('/logout')

router.get('/', async (ctx, next) => {
  await ctx.render('logout', {})
})

router.post('/', async (ctx, next) => {
  
  ctx.session = null;

  let result = {
    code: retCode.Success,    
    data: null
  }

  ctx.body = result;
  
})

module.exports = router