零基础之Node.js搭建API服务器的详解
零基础之node.js搭建api服务器
这篇文章写给那些node.js零基础,但希望自己动手实现服务器api的前端开发者,尝试帮大家打开一扇门。
http服务器实现原理
http服务器之所以能提供前端使用的api,其实现原理是服务器保持监听计算机的某个端口(通常是80),等待客户端请求,当请求到达并经过一系列处理后,服务器发送响应数据给到前端。
平时大家通过ajax调用api,即是发起一次请求,经过服务器处理后,得到结果,然后再进行前端处理。如今使用高级编程语言,要实现服务器那部分功能已经变得非常简单,接下来我们了解一下使用node.js如何实现。
什么是node.js?它可以做什么?
node.js是一个javascript的运行时(runtime),它提供了大量用js与操作系统打交道的api,通过这些api,我们可以调用本地程序、读写磁盘、监听端口、发起网络请求等,这足以开发出一个功能完善的server。
前期准备
简单介绍完node.js,开始写代码之前,我们需要安装node.js,安装详细过程就不说明了,请大家google或者百度。不同系统安装过程不一样,如果是linux、mac,会相对顺利且遇到问题的可能性较低。
判断安装成功与否,windows下,在cmd中执行node -v,linux、mac下,在shell中执行node -v,正常输出版本号说明安装成功。
tips:
windows如果提示命令未找到,可能是未配置环境变量
实现简单的server
node.js安装成功,我们找个地方新建目录my-server作为我们的存放代码的地方,接下来所有的代码都在该目录下。首先,在my-server的目录下新建文件index.js,用如下代码实现一个简单的server:
// index.js // 通过require获取两个node内置模块 const http = require('http'); const nurl = require('url'); // '127.0.0.1'表明只有本机可访问,'0.0.0.0'表示所有人可访问 const hostname = '127.0.0.1'; const port = 3000; // 通过http.createserver获取一个server实例 // 其中(req, res) => {},在服务器每次接收到请求时都会被执行 const server = http.createserver((req, res) => { let method = req.method; // 客户端请求方法 let url = nurl.parse(req.url); // 将请求url字符串转换为node的url对象 // 如果客户端get请求'/',会执行这个分支里面的逻辑 if (method === 'get' && url.pathname === '/') { res.statuscode = 200; res.setheader('content-type', 'text/plain'); res.end('hello world'); return; } // 如果客户端get请求'/api/user',会执行这个分支里面的逻辑 if (method === 'get' && url.pathname === '/api/user') { res.statuscode = 200; res.setheader('content-type', 'application/json'); res.end(json.stringify({ code: 0, msg: '', result: { username: 'shasharoman' } })); return; } // 没有匹配其他分支的话,执行以下逻辑 res.statuscode = 404; res.setheader('content-type', 'text/plain'); res.end('not found'); }); // server开始监听,等待请求到来 server.listen(port, hostname, () => { console.log(`server running at http://${hostname}:${port}/`); });
文件内容编辑保存后,在my-server目录下通过命令node index.js启动服务,然后在浏览器中访问、、观察不同结果。
这是官方guides经过小小修改得到的代码,添加部分注释以及额外逻辑。主要为了更清晰传达以下几个知识点:
- 从req对象上获取method与url,这个req对象是客户端请求的“抽象表现”,平时写ajax指定的绝大部分内容都可以从该对象上获取
- 中间添加的两个if分支,主要是为了让大家了解服务器如何区分不同请求,决定做不同事情,即路由概念
- content-type: application/json,通常api会使用的响应格式,表明返回数据是json格式,这是一个http头部,属于http协议相关知识
- statuscode:404,http最常见的错误“not found”,也属于http协议相关知识
往前优化一步
通过上面的代码,实现了一个简单server,但真实场景下我们会这样去实现吗?答案是肯定不会,所以我们还需要一步步完善,做以下几个修改:
- 增加config,在其中配置hostname,port
- 增加controller,用于分层以及分模块
- 增加route,用于定义路由
代码不多,一共五个文件:
- config.js,配置文件
- route.js,路由定义文件
- controller/account.js,账号模块业务实现文件
- controller/index.js,业务汇总并暴露给外部
- index.js,项目启动文件
// config.js exports = module.exports = { hostname: '127.0.0.1', port: '3000' };
// route.js exports = module.exports = [{ method: 'get', path: '/api/user', impl: 'account.userbyid' }, { method: 'post', path: '/api/user', impl: 'account.createuser' }];
// controller/account.js exports.userbyid = userbyid; exports.createuser = createuser; function userbyid(req, res) { res.end('waiting for impl.'); } function createuser(req, res) { res.end('waiting for impl.'); }
// controller/index.js exports.account = require('./account');
// index.js const http = require('http'); const nurl = require('url'); const config = require('./config'); const controller = require('./controller'); const route = require('./route').map(item => { console.log(`route ${item.method}:${item.path}`); let tuple = item.impl.split('.'); item.impl = controller[tuple[0]][tuple[1]]; return item; }); const server = http.createserver((req, res) => { let method = req.method; let url = nurl.parse(req.url); let matchroute = route.find(item => { return item.method === method && item.path === url.pathname; }); if (matchroute) { matchroute.impl(req, res); return; } res.statuscode = 404; res.setheader('content-type', 'text/plain'); res.end('not found'); }); server.listen(config.port, config.hostname, () => { console.log(`server running at http://${config.hostname}:${config.port}/`); });
依旧是用node index.js启动server,如果要在现有模式下开发一个api,主要就两步:
- 在route.js中定义路由
- 在controller/中实现
做这个程度的优化,只是为了向大家传达一些比较宽泛的概念,还不是真正用来写api服务,只是为了大伙练练手。
这个程度还达不到真实场景需求,还需要经过几轮改造,包括模块、层、common、lib、query解析,body解析、更灵活的route等一系列事情,限于篇幅,有机会在一一讲述。
经过我的描述以及代码示例,如果大家有兴趣学习node.js,建议多搜搜相关知识,保持关注,然后在逐步去熟悉node.js流行的web框架如:express、koa等,不过框架只是更高层面的封装,基础的概念以及知识还是需要花时间才能掌握。
如果前端想尝试后端编程,请一定先学习http协议,推荐《http权威指南》从头到尾认真看一遍。
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对的支持。如果你想了解更多相关内容请查看下面相关链接
推荐阅读
-
零基础之Node.js搭建API服务器的详解
-
详解本地Node.js服务器作为api服务器的解决办法
-
从零学习node.js之搭建http服务器(二)
-
从零开始搭建前后端分离的NetCore2.2(EF Core CodeFirst+Autofac)+Vue的项目框架之十数据库基础方法的封装
-
详解本地Node.js服务器作为api服务器的解决办法
-
从零学习node.js之搭建http服务器(二)
-
Node.js原生api搭建web服务器的方法步骤
-
Python最详细的零基础入门之——多线程详解!
-
【从零开始搭建自己的.NET Core Api框架】(三)集成轻量级ORM——SqlSugar:3.2 在框架的基础上利用SqlSugar快速实现CRUD实战篇
-
【从零开始搭建自己的.NET Core Api框架】(五)由浅入深详解CORS跨域机制并快速实现