你們好!這是首次在segmentfault發文章,但願能對你們有所幫助。Node.JS對於追逐全棧開發的小夥伴們天然不陌生。他是創建與chrome V8引擎下的高性能,異步IO、事件驅動javascript語言,使編寫高性能Web服務垂手可得。今天要分享的是一個使用Node.JS逐步推演創建一個完善的json服務的過程。經過對代碼逐步完善來介紹Node.JS的特色及執行流程。閒話少量,進入正題。javascript
業務場景描述:監聽指定端口,分析請求url,返回對應的圖片目錄或圖片文件列表。 Round 1:搭建json服務 監聽8000端口
var _http=require("http"); var _url=require("url"); var _fs=require("fs"); /** * test res show message is success! */ var _server=_http.createServer((req,res)=>{ console.log("json webservice is running\n"); res.end("hello accp!"); }); _server.listen(8000);
已上代碼實現監聽本地8000端口,當經過瀏覽器訪問時,便可觸發對應代碼。如圖html
Round 2 : 返回json格式數據
var _http=require("http"); var _url=require("url"); var _fs=require("fs"); /** * test res show json message is success! */ var _server=_http.createServer((req,res)=>{ console.log("json sebservice is running!\n"); //http://nodejs.cn/api/http.html#http_response_writehead_statuscode_statusmessage_headers //response html head http://www.runoob.com/http/http-header-fields.html //Content-Type MIME VALUES //a pplication/msword doc Microsoft Word // application/octet-stream bin dms lha lzh exe class 可執行程序 // application/pdf pdf Adobe Acrobat // application/postscript ai eps ps PostScript // appication/powerpoint ppt Microsoft Powerpoint // appication/rtf rtf rtf 格式 // appication/x-compress z unix 壓縮文件 // application/x-gzip gz gzip // application/x-gtar gtar tar 文檔 (gnu 格式 ) // application/x-shockwave-flash swf MacroMedia Flash // application/x-tar tar tar(4.3BSD) // application/zip zip winzip // audio/basic au snd sun/next 聲音文件 // audio/mpeg mpeg mp2 Mpeg 聲音文件 // audio/x-aiff mid midi rmf Midi 格式 // audio/x-pn-realaudio ram ra Real Audio 聲音 // audio/x-pn-realaudio-plugin rpm Real Audio 插件 // audio/x-wav wav Microsoft Windows 聲音 // image/cgm cgm 計算機圖形元文件 // image/gif gif COMPUSERVE GIF 圖像 // image/jpeg jpeg jpg jpe JPEG 圖像 // image/png png PNG 圖像 // text/html HTML // text/plain TXT // text/xml XML // text/json json字符串 res.writeHead(200,{'Content-Type':'text/json'}); var out={ err:null, data:{ showMessage:"hello world" } }; res.end(JSON.stringify(out)); }); _server.listen(8000);
Round 3:測試 json webservice 輸出 文件夾列表 列表
/** * * @authors Your Name (you@example.org) * @date 2018-02-21 14:44:34 * @version $Id$ */ var _http=require("http"); var _url=require("url"); var _fs=require("fs"); /** * 測試 json webservice 輸出 文件夾列表 */ var _server=_http.createServer((req,res)=>{ console.log("json webservice is running!\n"); var out={}; load_image_list((err,files)=>{ if(err){ res.writeHead(403,{ "Content-Type":"text/json; charset=utf-8" }); out={err:err,data:{}}; res.end(JSON.stringify(out)); return; } //指定 返回字符串編碼 res.writeHead(200,{ "Content-Type":"text/json; charset=utf-8" }); out={err:err,data:{imageList:files}}; res.end(JSON.stringify(out),'utf-8'); return; }); //http://nodejs.cn/api/fs.html#fs_fs_readdir_path_options_callback }); /** * 初始化 圖片列表 返回 指定圖片文件夾列表 * bug 未對目錄下 文件類型進行判斷 同時返回 當前目錄下 全部文件類型 * @param {Function} callback 回調函數 * * @return {[type]} [description] */ var load_image_list=function(callback){ _fs.readdir("images/",(err,files)=>{ if(err){ callback(err); console.log("load_image_list try exception!\n"); return; } callback(null,files); }); }; _server.listen(8000);
這裏能夠看到load_image_list方法註釋內容提到,當前代碼存在必定的漏洞,若是當前文件夾目錄下存在圖片文件,在返回結果時也會返回如圖。針對此bug修改load_image_list。
java
** * 初始化 圖片列表 返回 指定圖片文件夾列表 * 增長 對指定目錄下 文件類型的判斷 只返回 文件夾 * @param {Function} callback 回調函數 * * @return {[type]} [description] */ var load_image_list=function(callback){ _fs.readdir('images/',(err,files)=>{ if(err){ console.log("load image list throw exception!\n"); callback(err); return; } var only_dir=[]; //建立 匿名方法 經過遞歸方式 將異步判斷 變動爲 同步判斷 (function rtnPathIsDirList(index){ if(index==files.length){ callback(null,only_dir); return; } _fs.stat("images/"+files[index], (err,stats)=>{ if(err){ console.log("load image list check file type throw exception!\n"); callback(err); return; } if(stats.isDirectory()){ only_dir.push(files[index]); } rtnPathIsDirList(index+1); return; }); })(0); }); };
Round 4 :增長 路由器 功能 針對 傳遞進來的 url進行 分析
/** * * @authors Your Name (you@example.org) * @date 2018-02-21 15:01:25 * @version $Id$ */ var _http=require("http"); var _url=require("url"); var _fs=require("fs"); /** * 測試 json webservice 輸出 文件夾列表 * 增長 路由器 功能 針對 傳遞進來的 url進行 分析 * 增長 加載 圖片列表 文件目錄 輸入 */ var _url=require('url'); var _server=_http.createServer((req,res)=>{ console.log("json webservice is running!\n"); var out={}; //增長 請求 url 的分析 console.log(req.url); var urlValue=req.url; var urlLength=urlValue.length; //console.log("urlValue.substr(1,11)"+urlValue.substr(1,11)); //排除 瀏覽器 發起的 獲取 圖標請求 if(urlValue=="/favicon.ico"){ console.log("web brower favicon request!\n"); res.end(); return; } if(urlValue=="/images.json"){ //獲取 根目錄 文件夾列表 console.log("load images list is running!\n"); handle_list_image(req,res,urlValue.substr(1,6)+"/"); return; }else if(urlValue.substr(1,6)=="images"&&urlValue.substr(urlLength-4)=="json"){ //加載 某一個 目錄下 的文件 console.log("load image path:"+urlValue.substr(1,urlValue.length-6)); handle_list_imageFile(req,res,urlValue.substr(1,urlValue.length-6)+"/"); return; }else{ //無正常 數據 加載 返回404 錯誤。 sendFailMessage(404,"請求頁面不存在",res); console.log("error"); return; } //http://nodejs.cn/api/fs.html#fs_fs_readdir_path_options_callback }); /** * 獲取圖片列表 * 增長加載圖片列表路徑參數 * 將返回成功信息和失敗信息進行封裝 * * @param {[type]} req [description] * @param {[type]} res [description] * @param {[string]} filePath [加載更目錄] * * @return {[type]} [description] */ var handle_list_image=function(req,res,filePath){ load_image_list(filePath,(err,files)=>{ if(err){ // res.writeHead(403,{ // "Content-Type":"text/json; charset=utf-8" // }); // out={err:err,data:{}}; // res.end(JSON.stringify(out)); sendFailMessage(403,err,res); return; } //指定 返回字符串編碼 // res.writeHead(200,{ // "Content-Type":"text/json; charset=utf-8" // }); // out={err:null,data:{imageList:files}}; // res.end(JSON.stringify(out),'utf-8'); // var data={imageList:files}; sendSuccessMessage(data,res); return; }); }; /** * 獲取文件 圖片文件列表 * * @param {[type]} req [description] * @param {[type]} res [description] * @param {[type]} filePath [description] * * @return {[type]} [description] */ var handle_list_imageFile=function(req,res,filePath){ load_imageFile_list(filePath,(err,files)=>{ if(err){ // res.writeHead(403,{ // "Content-Type":"text/json; charset=utf-8" // }); // out={err:err,data:{}}; // res.end(JSON.stringify(out)); sendFailMessage(403,err,res); return; } //指定 返回字符串編碼 // res.writeHead(200,{ // "Content-Type":"text/json; charset=utf-8" // }); // out={err:null,data:{imageList:files}}; // res.end(JSON.stringify(out),'utf-8'); // var data={imageList:files}; sendSuccessMessage(data,res); return; }); }; /** * 返回成功信息 * * @param {json} dataContent 返回數據json信息 * @param {response} res [description] * * @return {[type]} [description] */ var sendSuccessMessage=function(dataContent,res){ //指定 返回字符串編碼 res.writeHead(200,{ "Content-Type":"text/json; charset=utf-8" }); out={err:null,data:dataContent}; res.end(JSON.stringify(out),'utf-8'); } /** * 返回失敗信息 * * @param {int} code 失敗代碼 * @param {error} err [description] * @param {[type]} res [description] * * @return {[type]} [description] */ var sendFailMessage=function(code,err,res){ res.writeHead(code,{ "Content-Type":"text/json; charset=utf-8" }); out={err:err,data:{}}; res.end(JSON.stringify(out)); } /** * 初始化 圖片列表 返回 指定圖片文件夾列表 * 增長 對指定目錄下 文件類型的判斷 只返回 文件夾 * 增長 遍歷目錄 變量 * @param {stinrg} filePath 加載目錄 * @param {Function} callback 回調函數 * * @return {[type]} [description] */ var load_image_list=function(filePath,callback){ _fs.readdir(filePath,(err,files)=>{ if(err){ console.log("load image list throw exception!\n"); callback(err); return; } var only_dir=[]; //建立 匿名方法 經過遞歸方式 將異步判斷 變動爲 同步判斷 (function rtnPathIsDirList(index){ if(index==files.length){ callback(null,only_dir); return; } _fs.stat(filePath+files[index], (err,stats)=>{ if(err){ console.log("load image list check file type throw exception!\n"); callback(err); return; } if(stats.isDirectory()){ only_dir.push(files[index]); } rtnPathIsDirList(index+1); return; }); })(0); }); }; /** * 初始化 圖片列表 返回 指定圖片文件列表 * 增長 對指定目錄下 文件類型的判斷 只返回 文件 * 增長 遍歷目錄 變量 * @param {stinrg} filePath 加載目錄 * @param {Function} callback 回調函數 * * @return {[type]} [description] */ var load_imageFile_list=function(filePath,callback){ _fs.readdir(filePath,(err,files)=>{ if(err){ console.log("load image file list throw exception!\n"); callback(err); return; } var only_dir=[]; //建立 匿名方法 經過遞歸方式 將異步判斷 變動爲 同步判斷 (function rtnPathIsDirList(index){ if(index==files.length){ callback(null,only_dir); return; } _fs.stat(filePath+files[index], (err,stats)=>{ if(err){ console.log("load image list check file type throw exception!\n"); callback(err); return; } if(stats.isFile()&&files[index].substr(files[index].length-3,3)=="jpg"){ console.log("files[index]:"+files[index]); console.log("files[index].substr(files[index].length-3,3):"+files[index].substr(files[index].length-3,3)+"\n"); only_dir.push(files[index]); } rtnPathIsDirList(index+1); return; }); })(0); }); }; _server.listen(8000);
這裏主要是增長了路由的功能,測試訪問路徑以下:
http://localhost:8000 返回結果如圖;
node
http://localhost:8000/images.json 返回結果如圖;
web
http://localhost:8000/images/image1.json 返回結果如圖;
chrome