使用Koa2搭建web项目

　　随着Node.js的日益火热，各种框架开始层出不穷的涌现出来，Node.js也开始逐渐的被应用到处理服务端请求的场景中。搭建Web项目的框架也随之开始出现——express、koa、koa2、egg等，当然要了解其好坏还是要自己去啃源码的。本文将不会涉及到源码，只是带领初学者简单了解下Koa2的基本使用，欢迎大家在评论中互相交流学习。
注意：koa2使用了ES7的语法，所以使用时请升级Node版本到最新。　

　　了解更详细的源码信息可以到git上的koajs/koa去了解。

1.项目目录结构

2. 代码逻辑解析

2.1. 包结构文件

{
  "name": "weixin-node-koa",
  "version": "1.0.0",
  "description": "node.js with koa2",
  "private": true,
  "dependencies": {
    "koa": "^2.0.0",
    "koa-router": "^7.0.0",
    "mysql":"2.13.0"
  },
  "scripts": {
    "start": "node app.js"
  },
  "engines": {
    "node": ">=6.0.0"
  },
  "author": "Fly",
  "license": "CENTERM"
}

2.2. 启动入口文件

app.js

const Koa = require(‘koa‘);
const app = new Koa();
const router2controller = require(‘./app/router2controller.js‘);
const config = require(‘./config/config.local.js‘);

app.use(router2controller());
app.listen(config.port);
console.log("Server started and listen on port " + config.port);

如果请求的报文体是XML格式，可以添加下面的代码自动解析报文（注意引用koa-xxx的版本要与koa2对应）

const Koa = require(‘koa‘);
const app = new Koa();
const router2controller = require(‘./app/router2controller.js‘);
const config = require(‘./config/config.local.js‘);

//start接收到的xml数据请求单独解析存储
const xmlParser = require(‘koa-xml-body‘);
app.use(xmlParser()).use((ctx,next) => {
    ctx.data = ctx.request.body;
    return next();
});
//end

app.use(router2controller());
app.listen(config.port);
console.log("Server started and listen on port " + config.port);

从代码看到引入了一个router2controller.js的文件，这个文件是完成前端请求到具体处理方法的路由过程

2.3. 路由器文件

router2controller.js，该类将会自动扫描controller文件夹中的文件来加载请求映射，不需要挨个请求单独配置

koa-router原生提供方法如下：

router
.get(‘/‘, async (ctx,next) => {
this.body = ‘Hello World!‘;
})
.post(‘/users‘, async (ctx,next) => {
//TODO
})
.put(‘/users/:id‘, async (ctx,next) => {
//TODO
})
.del(‘/users/:id‘, async (ctx,next) => {
//TODO
});

自动扫描controller包实现方法如下

const fs = require(‘fs‘);
const router = require(‘koa-router‘)();

function addMapping(router, mapping) {
    for (var url in mapping) {
        if (url.startsWith(‘GET ‘)) {
            var path = url.substring(4);
            router.get(path, mapping[url]);
            console.log(`register URL mapping: GET ${path}`);
        } else if (url.startsWith(‘POST ‘)) {
            var path = url.substring(5);
            router.post(path, mapping[url]);
            console.log(`register URL mapping: POST ${path}`);
        } else if (url.startsWith(‘PUT ‘)) {
            var path = url.substring(4);
            router.put(path, mapping[url]);
            console.log(`register URL mapping: PUT ${path}`);
        } else if (url.startsWith(‘DELETE ‘)) {
            var path = url.substring(7);
            router.del(path, mapping[url]);
            console.log(`register URL mapping: DELETE ${path}`);
        } else {
            console.log(`invalid URL: ${url}`);
        }
    }
}

function addControllers(router, dir) {
    fs.readdirSync(__dirname + ‘/‘ + dir).filter((f) => {
        return f.endsWith(‘.js‘);
    }).forEach((f) => {
        console.log(`process controller: ${f}...`);
        let mapping = require(__dirname + ‘/‘ + dir + ‘/‘ + f);
        addMapping(router, mapping);
    });
}

module.exports = function (dir) {
    var controllersDir = dir || ‘controller‘;
    addControllers(router, controllersDir);
    return router.routes();
};

2.4. 控制器

userController.js，***Controller.js是用来处理具体请求信息以及返回数据的，userController.js中处理了GET请求获取用户信息，POST请求保存用户信息

const userService = require(‘./../service/userService.js‘);

var getUserinfo = (ctx, next) => {
    let query = ctx.query;
    let userId = query.id;
    let userInfo = userService.getUserById(userId);

    let html = ‘<html><body>‘
        + ‘<div> userinfo:&nbsp;‘ + userInfo + ‘</div>‘
        + ‘</body></html>‘;
    ctx.response.type =‘text/html‘;
    ctx.response.body = html;
};

var saveUserinfo = (ctx, next) => {
    const requestString = ctx.data;
    //TODO数据处理
    Console.log(requestString);
};

module.exports = {
    ‘GET /getUserinfo‘: getUserinfo,
    ‘POST /saveUserinfo‘: saveUserinfo
};

2.5. 数据处理

userService.js，处理封装从***Dao.js获取到的数据返回给Controller

const userDao = require(‘./../dao/userDao.js‘);

var getUserById = async (userId) => {
    var users = userDao.getUserById(userId);
    var responseContent = ‘‘;
    for(let user of users) {
        reaponseContent += ‘姓名：‘ + user.name + ‘&nbsp;|‘;
        reaponseContent += ‘年龄：‘ + user.age + ‘&nbsp;|‘;
        reaponseContent += ‘身高：‘ + user.height + ‘<br />‘;
    }
    return responseContent;
}

module.exports = {
    getUserById : getUserById
};

2.6. 数据获取

userDao.js，通过请求传入参数来获取user数据

const mysql = require(‘./../utils/mysqlUtil.js‘);

var getUserById = async (userId) => {
    let mysqlOptions = {
        sql : ‘select * from table_user where user_id = ?‘,
        args : [userId]
    };

    var users = await mysql.execQuery(mysqlOptions);
    if(users.length == 0) {
        return null;
    } else {
        return users;
    }
};

module.exports = {
    getUserById : getUserById
};

2.7. 数据库操作

mysqlUtil.js，包含了数据库连接池控制，连接建立、释放管理，执行Dao发起的数据库操作请求

const mysql = require(‘mysql‘);
const config = require(‘./../../config/config.local.js‘);

var connectionPool = mysql.createPool({
    ‘host‘ : config.database.host,
    ‘port‘:config.database.port,
    ‘user‘ : config.database.user,
    ‘password‘ : config.database.password,
    ‘database‘ : config.database.database,
    ‘charset‘: config.database.charset,
    ‘connectionLimit‘: config.database.connectionLimit,
    ‘supportBigNumbers‘: true,
    ‘bigNumberStrings‘: true
});

var release = connection => {
    connection.end(function(error) {
        if(error) {
            console.log(‘Connection closed failed.‘);
        } else {
            console.log(‘Connection closed succeeded.‘);
        }
    });
};

var execQuery = sqlOptions => {
    var results = new Promise((resolve, reject) => {
            connectionPool.getConnection((error,connection) => {
            if(error) {
                console.log("Get connection from mysql pool failed !");
                throw error;
            }

            var sql = sqlOptions[‘sql‘];
            var args = sqlOptions[‘args‘];

            if(!args) {
                var query = connection.query(sql, (error, results) => {
                    if(error) {
                        console.log(‘Execute query error !‘);
                        throw error;
                    }

                    resolve(results);
                });
            } else {
                var query = connection.query(sql, args, function(error, results) {
                    if(error) {
                        console.log(‘Execute query error !‘);
                        throw error;
                    }

                    resolve(results);
                });
            }

            connection.release(function(error) {
                if(error) {
                    console.log(‘Mysql connection close failed !‘);
                    throw error;
                }
            });
        });
    }).then(function (chunk) {
        return chunk;
    });

    return results;
};

module.exports = {
    release : release,
    execQuery : execQuery
}

此实例我并没有整理并在本机运行过，但这个包结构的思路还是值得学习的，整个实例的代码详见http://bijian1013.iteye.com/blog/2425085。

文章来源：https://blog.csdn.net/ererfei/article/details/68060551

原文地址：https://www.cnblogs.com/flyingeagle/p/9192460.html

时间： 2024-07-31 21:36:58

使用Koa2搭建web项目的相关文章

Spring-Boot快速搭建web项目详细总结

最近在学习Spring Boot 相关的技术,刚接触就有种相见恨晚的感觉,因为用spring boot进行项目的搭建是在太方便了,我们往往只需要很简单的几步,便可完成一个spring MVC项目的搭建,感觉就是下图: 好,下面就本人搭建项目的过程简单说说如何快速搭建一个spring MVC项目,相信我,spring-boot这趟车,你上了根本就停不下来了! 下面是这篇博客的主要内容: 1.spring boot 介绍 2.spring boot 项目快速搭建 3.spring-boot中单元测试

搭建web项目结合spring+cxf的webservice服务

服务端: 服务端和客户端都需要引入包 1 antlr-2.7.7.jar 2 aopalliance-1.0.jar 3 asm-3.3.jar 4 commons-collections-3.2.1.jar 5 commons-lang-2.6.jar 6 commons-logging-1.1.1.jar 7 cxf-2.4.2.jar 8 cxf-manifest.jar 9 cxf-xjc-boolean-2.4.0.jar 10 cxf-xjc-bug671-2.4.0.jar 11

使用idea+springboot+Mybatis搭建web项目

使用idea+springboot+Mybatis搭建web项目 springboot的优势之一就是快速搭建项目,省去了自己导入jar包和配置xml的时间,使用非常方便. 1.创建项目project,然后选择Spring initializr,点击下一步  2.按图示进行勾选,点击下一步,给项目起个名字,点击确定. 3.项目生成有,点击add as maven project,idea 会自动下载jar包,时间比较长  4.项目生成后格式如下图所示:  其中DemoApplication.jav

如何使用maven搭建web项目

博客园注册了有二十多天了,还没有写过博客,今天就发一篇,也便于后面查找笔记. 我个人已经做了几年的java web开发了,由于所在的公司是业务型公司,用的都是一些老旧的稳定技术,很少接触到稍微新点的内容, 经过几年的不进则退,自己的技术能力已经开始慢慢的被时代潮流淘汰.为了在大浪淘沙中能生存下来,自己要好好加油,从基本内容开始,稳步沉淀,更新自己的技术库. 不求一口吃个大胖子,只求每天进步一点点. 废话不多说,言归正传.如何使用maven搭建web项目呢? 第一步:首先创建一个maven项目 创

springBoot 搭建web项目（前后端分离，附项目源代码地址）

springBoot 搭建web项目(前后端分离,附项目源代码地址) 概述 该项目包含springBoot-example-ui 和 springBoot-example,分别为前端与后端,前后端分离,利用ajax交互. springBoot-example-ui 前端html 技术:BootStrap + layer + jquery + css + html 该项目git地址:https://github.com/jiangcaijun/springBoot-example-ui sprin

Spring Boot入门-快速搭建web项目

Spring Boot 概述: Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can "just run".We take an opinionated view of the Spring platform and third-party libraries so you can get started with minimum

(第01节)IDEA快速搭建web项目

在配置好环境,熟悉了IDEA的基本操作后,就要开始搭建WEB项目了: File——>new——>project——>然后选择Maven 点击Create from archetype,选择下面的maven-archetype-webapp,点击next Groupld:一般是自己的域名倒写 Artifactld:一般是文件名 点击NEXT,选择自己MAVEN的版本和配置文件还有仓库存放地址 再点击+号添加 再点击Finish,完成 原文地址:https://www.cnblogs.com

模拟搭建Web项目的真实运行环境（一）

序言 最近尝试完整搭建一个Web项目的运行环境,总结一下这几个月学到的知识点. 后面的文章主要包括一下几个内容: A. 搭建一个Linux服务器,用来部署Redis.Mongo等数据存储环境: B. 搭建一个Windows Server 2008,用IIS来部署Web项目: 接下来进入主题,本篇主要介绍用虚拟机部署测试环境的时候, 如何配置相关的网络连接. 一.用VM安装一个win7客户端.ubuntu服务器.windows server 2008服务器 这里就不介绍怎么安装了,网上有很多教程.

idea 搭建web项目

1.首先要选择idea ultimate,而不能选择idea community,因为idea community 不能创建web项目. ultimate可按照 http://idea.lanyus.com/ 教程破解 2.首先new->File创建一个maven项目(后续想使用maven做个小项目练习) 3.选择File->project Structure ->Module,选中Demos点击左上角加号,选择web,设置使用默认 4.在web->WEB-INF下新建两个文件夹,