在Android上实现HttpServer的示例代码
在最近的项目中因为要用Android作为一个服务器去做一个实时接收数据的功能,所以这个时候就要去做一个Android本地的微型服务器。
那么此时我首先想到了springboot,因为他是一个服务器的框架。但是实际上我们根本用不到这么大型的服务器框架,配置这些都太麻烦。所以,我又找到了Ijetty、NanoHttpd和AndroidAsync这三个框架,都是比较微型的,适用于Android的。
经过对比,Ijetty使用起来过于复杂,而且会莫名其妙的报一些不太容易解决的问题,所以,舍弃掉了。
因为没仔细深究Ijetty,所以就重点放到NanoHttpd和AndroidAsync;
那么就先来说下两个的优缺点:
1.NanoHttpd是BIO为底层封装的框架,而AndroidAsync是NIO为底层封装的,其他的是一样的,而且其实AndroidAsync是仿照NanoHttpd框架写的。所以,一定意义上来说,AndroidAsync是NanoHttpd的优化版,当然也要看具体应用场景辣。
2.NanoHttpd只能用于HttpServer,但是AndroidAsync除了HttpServer的应用还能用在webSocket、HttpClient等方面,其中从AndroidAsync中脱离出来的Ion的库也是比较有名的。
3.NanoHttpd底层处理包含的返回状态码(例如:200、300、400、500等)比较多;但是经过笔者阅读AndroidAsync的源码发现,AndroidAsync底层封装返回的状态码只有两种:200、404,正好笔者发现了这个坑(下面会讲到,OPTIONS的例子)
下面看一下具体使用方法吧。
1.先说NanoHttpd:
因为NanoHttpd的框架实际就是一个单文件,可以直接去github上下载,下载地址
有了下载的文件,那么就可以继承这个文件写一个类,具体如下:
publicclassHttpServerextendsNanoHTTPD{ privatestaticfinalStringTAG="HttpServer"; publicstaticfinalStringDEFAULT_SHOW_PAGE="index.html"; publicstaticfinalintDEFAULT_PORT=9511;//此参数随便定义,最好定义1024-65535;1-1024是系统常用端口,1024-65535是非系统端口 publicenumStatusimplementsResponse.IStatus{ REQUEST_ERROR(500,"请求失败"), REQUEST_ERROR_API(501,"无效的请求接口"), REQUEST_ERROR_CMD(502,"无效命令"); privatefinalintrequestStatus; privatefinalStringdescription; Status(intrequestStatus,Stringdescription){ this.requestStatus=requestStatus; this.description=description; } @Override publicStringgetDescription(){ returndescription; } @Override publicintgetRequestStatus(){ returnrequestStatus; } } publicHttpServer(){//初始化端口 super(DEFAULT_PORT); } @Override publicResponseserve(IHTTPSessionsession){ Stringuri=session.getUri(); Mapheaders=session.getHeaders(); //接收不到post参数的问题,http://blog.csdn.net/obguy/article/details/53841559 try{ session.parseBody(newHashMap ()); }catch(IOExceptione){ e.printStackTrace(); }catch(ResponseExceptione){ e.printStackTrace(); } Map parms=session.getParms(); try{ LogUtil.d(TAG,uri); //判断uri的合法性,自定义方法,这个是判断是否是接口的方法 if(checkUri(uri)){ //针对的是接口的处理 if(headers!=null){ LogUtil.d(TAG,headers.toString()); } if(parms!=null){ LogUtil.d(TAG,parms.toString()); } if(StringUtil.isEmpty(uri)){ thrownewRuntimeException("无法获取请求地址"); } if(Method.OPTIONS.equals(session.getMethod())){ LogUtil.d(TAG,"OPTIONS探测性请求"); returnaddHeaderResponse(Response.Status.OK); } switch(uri){ case"/test":{//接口2 //此方法包括了封装返回的接口请求数据和处理异常以及跨域 returngetXXX(parms); } default:{ returnaddHeaderResponse(Status.REQUEST_ERROR_API); } } }else{ //针对的是静态资源的处理 StringfilePath=getFilePath(uri);//根据url获取文件路径 if(filePath==null){ LogUtil.d(TAG,"sd卡没有找到"); returnsuper.serve(session); } Filefile=newFile(filePath); if(file!=null&&file.exists()){ LogUtil.d(TAG,"filepath="+file.getAbsolutePath()); //根据文件名返回mimeType:image/jpg,video/mp4,etc StringmimeType=getMimeType(filePath); Responseres=null; InputStreamis=newFileInputStream(file); res=newFixedLengthResponse(Response.Status.OK,mimeType,is,is.available()); //下面是跨域的参数(因为一般要和h5联调,所以最好设置一下) response.addHeader("Access-Control-Allow-Headers",allowHeaders); response.addHeader("Access-Control-Allow-Methods","GET,POST,PUT,DELETE,HEAD"); response.addHeader("Access-Control-Allow-Credentials","true"); response.addHeader("Access-Control-Allow-Origin","*"); response.addHeader("Access-Control-Max-Age",""+42*60*60); returnres; }else{ LogUtil.d(TAG,"filepath="+file.getAbsolutePath()+"的资源不存在"); } } }catch(Exceptione){ e.printStackTrace(); } //自己封装的返回请求 returnaddHeaderRespose(Status.REQUEST_ERROR); }
根据上面的例子,主要说以下几点:
1)请求都能接收到,无论post还是get,或者是其他请求,如果需要过滤则自己去处理;
2)注意上面处理的接收不到post参数的问题,已经给了参考链接在代码注释中,请查阅;
3)如果请求中既有接口又有静态资源(例如html),那注意区分两种请求,例如可以用uri去识别;当然返回都可以用流的形式,都可以调用API方法newFixedLengthResponse();
4)笔者建议,最好处理一下跨域的问题,因为是Android有可能和h5联调,所以设置了跨域以后比较方便调试,当然某些场景也可以忽略,看个人需求;方法已经在以上代码中写了;
5)当然最后最重要的一点肯定是开启和关闭的代码了:
/** *开启本地网页点歌的服务 */ publicstaticvoidstartLocalChooseMusicServer(){ if(httpServer==null){ httpServer=newHttpServer(); } try{ //启动web服务 if(!httpServer.isAlive()){ httpServer.start(); } Log.i(TAG,"Theserverstarted."); }catch(Exceptione){ httpServer.stop(); Log.e(TAG,"Theservercouldnotstart.e="+e.toString()); } } /** *关闭本地服务 */ publicstaticvoidquitChooseMusicServer(){ if(httpServer!=null){ if(httpServer.isAlive()){ httpServer.stop(); Log.d(TAG,"关闭局域网点歌的服务"); } } }
2再看一下AndroidAsync:
这个框架就比较有意思了,功能也多,本文直说HttpServer方面的相关知识,其余按下不表。
老规矩,先说用法:
在Gradle中加入:
dependencies{ compile'com.koushikdutta.async:androidasync:2.2.1' }
代码示例:(此处没有处理跨域,如果需要的话,请根据上一个例子去处理)
publicclassNIOHttpServerimplementsHttpServerRequestCallback{ privatestaticfinalStringTAG="NIOHttpServer"; privatestaticNIOHttpServermInstance; publicstaticintPORT_LISTEN_DEFALT=5000; AsyncHttpServerserver=newAsyncHttpServer(); publicstaticNIOHttpServergetInstance(){ if(mInstance==null){ //增加类锁,保证只初始化一次 synchronized(NIOHttpServer.class){ if(mInstance==null){ mInstance=newNIOHttpServer(); } } } returnmInstance; } //仿照nanohttpd的写法 publicstaticenumStatus{ REQUEST_OK(200,"请求成功"), REQUEST_ERROR(500,"请求失败"), REQUEST_ERROR_API(501,"无效的请求接口"), REQUEST_ERROR_CMD(502,"无效命令"), REQUEST_ERROR_DEVICEID(503,"不匹配的设备ID"), REQUEST_ERROR_ENV(504,"不匹配的服务环境"); privatefinalintrequestStatus; privatefinalStringdescription; Status(intrequestStatus,Stringdescription){ this.requestStatus=requestStatus; this.description=description; } publicStringgetDescription(){ returndescription; } publicintgetRequestStatus(){ returnrequestStatus; } } /** *开启本地服务 */ publicvoidstartServer(){ //如果有其他的请求方式,例如下面一行代码的写法 server.addAction("OPTIONS","[\\d\\D]*",this); server.get("[\\d\\D]*",this); server.post("[\\d\\D]*",this); server.listen(PORT_LISTEN_DEFALT); } @Override publicvoidonRequest(AsyncHttpServerRequestrequest,AsyncHttpServerResponseresponse){ Log.d(TAG,"进来了,哈哈"); Stringuri=request.getPath(); //这个是获取header参数的地方,一定要谨记哦 Multimapheaders=request.getHeaders().getMultiMap(); if(checkUri(uri)){//针对的是接口的处理 //注意:这个地方是获取post请求的参数的地方,一定要谨记哦 Multimapparms=((AsyncHttpRequestBody)request.getBody()).get(); if(headers!=null){ LogUtil.d(TAG,headers.toString()); } if(parms!=null){ LogUtil.d(TAG,"parms="+parms.toString()); } if(StringUtil.isEmpty(uri)){ thrownewRuntimeException("无法获取请求地址"); } if("OPTIONS".toLowerCase().equals(request.getMethod().toLowerCase())){ LogUtil.d(TAG,"OPTIONS探测性请求"); addCORSHeaders(Status.REQUEST_OK,response); return; } switch(uri){ case"/test":{//接口2 //此方法包括了封装返回的接口请求数据和处理异常以及跨域 returngetXXX(parms); } default:{ returnaddHeaderResponse(Status.REQUEST_ERROR_API); } } }else{ //针对的是静态资源的处理 StringfilePath=getFilePath(uri);//根据url获取文件路径 if(filePath==null){ LogUtil.d(TAG,"sd卡没有找到"); response.send("sd卡没有找到"); return; } Filefile=newFile(filePath); if(file!=null&&file.exists()){ Log.d(TAG,"filepath="+file.getAbsolutePath()); response.sendFile(file);//和nanohttpd不一样的地方 }else{ Log.d(TAG,"filepath="+file.getAbsolutePath()+"的资源不存在"); } } } }
根据上面的例子,主要说以下几点:{大概说的就是api用法啊这一类的}
1)例如:server.addAction("OPTIONS","[\d\D]",this)是通用的过滤请求的方法。第一个参数是请求的方法,例如用“OPTIONS”、“DELETE”、“POST”、“GET”等(注意用大写),第二个参数是过滤uri的正则表达式,此处是过滤所有的uri,第三个是回调参数。server.post("[\d\D]",this)、server.get("[\d\D]*",this)这个是上一个方法的特例。server.listen(PORT_LISTEN_DEFALT)这个是监听端口;
2)request.getHeaders().getMultiMap()这个是获取header参数的地方,一定要谨记哦;
3)((AsyncHttpRequestBody
4)获取静态资源的代码是在回调方法onResponse的else中,例子如上。
5)说一下OPTIONS的坑点,因为AndroidAsync这个框架中封装的返回http的状态码只有两种,假如过滤方法中没有包含例如OPTIONS的请求方法,实际上返回给客户端的http状态码是400,而反映到浏览器的报错信息竟然是跨域的问题,找了很久才找到,请注意。
总结:
1)同一个页面:
NanoHttpd耗时:1.4s
AndroidAsync耗时:1.4s
但是在第二次进去的时候,AndroidAsync的耗时明显比第一个少了,笔者猜测是因为AndroidAsync底层做了一些处理。
2)从api分析的话,NanoHttpd的用法比较方便,获取传递的参数那些的api比较好用;AndroidAsync的api就相对来说要复杂一些,例如params的获取。
3)从场景来分析的话,如果需要并发量高的需求,一定要用AndroidAsync;但是如果不需要的话,那就再具体分析。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。