在Android上實(shí)現(xiàn)HttpServer的示例代碼
在最近的項(xiàng)目中因?yàn)橐肁ndroid作為一個(gè)服務(wù)器去做一個(gè)實(shí)時(shí)接收數(shù)據(jù)的功能，所以這個(gè)時(shí)候就要去做一個(gè)Android本地的微型服務(wù)器。
那么此時(shí)我首先想到了spring boot，因?yàn)樗且粋€(gè)服務(wù)器的框架。但是實(shí)際上我們根本用不到這么大型的服務(wù)器框架，配置這些都太麻煩。所以，我又找到了Ijetty、NanoHttpd和AndroidAsync這三個(gè)框架，都是比較微型的，適用于Android的。
經(jīng)過對(duì)比，Ijetty使用起來過于復(fù)雜，而且會(huì)莫名其妙的報(bào)一些不太容易解決的問題，所以，舍棄掉了。
因?yàn)闆]仔細(xì)深究Ijetty，所以就重點(diǎn)放到NanoHttpd和AndroidAsync；
那么就先來說下兩個(gè)的優(yōu)缺點(diǎn)：
1.NanoHttpd是BIO為底層封裝的框架，而AndroidAsync是NIO為底層封裝的，其他的是一樣的，而且其實(shí)AndroidAsync是仿照NanoHttpd框架寫的。所以，一定意義上來說，AndroidAsync是NanoHttpd的優(yōu)化版，當(dāng)然也要看具體應(yīng)用場(chǎng)景辣。
2.NanoHttpd只能用于HttpServer，但是AndroidAsync除了HttpServer的應(yīng)用還能用在webSocket、HttpClient等方面，其中從AndroidAsync中脫離出來的Ion的庫(kù)也是比較有名的。
3.NanoHttpd底層處理包含的返回狀態(tài)碼（例如： 200、300、400、500等）比較多；但是經(jīng)過筆者閱讀AndroidAsync的源碼發(fā)現(xiàn)，AndroidAsync底層封裝返回的狀態(tài)碼只有兩種：200、404，正好筆者發(fā)現(xiàn)了這個(gè)坑（下面會(huì)講到，OPTIONS的例子）
下面看一下具體使用方法吧。
1.先說NanoHttpd：
因?yàn)镹anoHttpd的框架實(shí)際就是一個(gè)單文件，可以直接去github上下載，下載地址
有了下載的文件，那么就可以繼承這個(gè)文件寫一個(gè)類，具體如下：
public class HttpServer extends NanoHTTPD {
private static final String TAG = "HttpServer";
public static final String DEFAULT_SHOW_PAGE = "index.html";
public static final int DEFAULT_PORT = 9511;//此參數(shù)隨便定義，最好定義1024-65535；1-1024是系統(tǒng)常用端口,1024-65535是非系統(tǒng)端口
public enum Status implements Response.IStatus {
REQUEST_ERROR(500, "請(qǐng)求失敗"),
REQUEST_ERROR_API(501, "無效的請(qǐng)求接口"),
REQUEST_ERROR_CMD(502, "無效命令");
private final int requestStatus;
private final String description;
Status(int requestStatus, String description) {
this.requestStatus = requestStatus;
this.description = description;
}
@Override
public String getDescription() {
return description;
}
@Override
public int getRequestStatus() {
return requestStatus;
}
}
public HttpServer() {//初始化端口
super(DEFAULT_PORT);
}
@Override
public Response serve(IHTTPSession session) {
String uri = session.getUri();
Map<String, String> headers = session.getHeaders();
//接收不到post參數(shù)的問題， http://blog.csdn.net/obguy/article/details/53841559
try {
session.parseBody(new HashMap<String, String>());
} catch (IOException e) {
e.printStackTrace();
} catch (ResponseException e) {
e.printStackTrace();
}
Map<String, String> parms = session.getParms();
try {
LogUtil.d(TAG, uri);
//判斷uri的合法性，自定義方法，這個(gè)是判斷是否是接口的方法
if (checkUri(uri)) {
// 針對(duì)的是接口的處理
if (headers != null) {
LogUtil.d(TAG, headers.toString());
}
if (parms != null) {
LogUtil.d(TAG, parms.toString());
}
if (StringUtil.isEmpty(uri)) {
throw new RuntimeException("無法獲取請(qǐng)求地址");
}
if (Method.OPTIONS.equals(session.getMethod())) {
LogUtil.d(TAG, "OPTIONS探測(cè)性請(qǐng)求");
return addHeaderResponse(Response.Status.OK);
}
switch (uri) {
case "/test": {//接口2
//此方法包括了封裝返回的接口請(qǐng)求數(shù)據(jù)和處理異常以及跨域
return getXXX(parms);
}
default: {
return addHeaderResponse(Status.REQUEST_ERROR_API);
}
}
} else {
//針對(duì)的是靜態(tài)資源的處理
String filePath = getFilePath(uri); // 根據(jù)url獲取文件路徑
if (filePath == null) {
LogUtil.d(TAG, "sd卡沒有找到");
return super.serve(session);
}
File file = new File(filePath);
if (file != null && file.exists()) {
LogUtil.d(TAG, "file path = " + file.getAbsolutePath());
//根據(jù)文件名返回mimeType： image/jpg, video/mp4, etc
String mimeType = getMimeType(filePath);
Response res = null;
InputStream is = new FileInputStream(file);
res = newFixedLengthResponse(Response.Status.OK, mimeType, is, is.available());
//下面是跨域的參數(shù)（因?yàn)橐话阋蚳5聯(lián)調(diào)，所以最好設(shè)置一下）
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);
return res;
} else {
LogUtil.d(TAG, "file path = " + file.getAbsolutePath() + "的資源不存在");
}
}
} catch (Exception e) {
e.printStackTrace();
}
//自己封裝的返回請(qǐng)求
return addHeaderRespose(Status.REQUEST_ERROR);
}
根據(jù)上面的例子，主要說以下幾點(diǎn)：
1）請(qǐng)求都能接收到，無論post還是get，或者是其他請(qǐng)求，如果需要過濾則自己去處理；
2）注意上面處理的接收不到post參數(shù)的問題，已經(jīng)給了參考鏈接在代碼注釋中，請(qǐng)查閱；
3）如果請(qǐng)求中既有接口又有靜態(tài)資源（例如html），那注意區(qū)分兩種請(qǐng)求，例如可以用uri去識(shí)別；當(dāng)然返回都可以用流的形式，都可以調(diào)用API方法newFixedLengthResponse();
4）筆者建議，最好處理一下跨域的問題，因?yàn)槭茿ndroid有可能和h5聯(lián)調(diào)，所以設(shè)置了跨域以后比較方便調(diào)試，當(dāng)然某些場(chǎng)景也可以忽略，看個(gè)人需求；方法已經(jīng)在以上代碼中寫了;
5）當(dāng)然最后最重要的一點(diǎn)肯定是開啟和關(guān)閉的代碼了：
/**
* 開啟本地網(wǎng)頁(yè)點(diǎn)歌的服務(wù)
*/
public static void startLocalChooseMusicServer() {
if (httpServer == null) {
httpServer = new HttpServer();
}
try {
// 啟動(dòng)web服務(wù)
if (!httpServer.isAlive()) {
httpServer.start();
}
Log.i(TAG, "The server started.");
} catch (Exception e) {
httpServer.stop();
Log.e(TAG, "The server could not start. e = " + e.toString());
}
}
/**
* 關(guān)閉本地服務(wù)
*/
public static void quitChooseMusicServer() {
if (httpServer != null) {
if (httpServer.isAlive()) {
httpServer.stop();
Log.d(TAG, "關(guān)閉局域網(wǎng)點(diǎn)歌的服務(wù)");
}
}
}
2再看一下AndroidAsync：
這個(gè)框架就比較有意思了，功能也多，本文直說HttpServer方面的相關(guān)知識(shí)，其余按下不表。
老規(guī)矩，先說用法：
在Gradle中加入:
dependencies {
compile 'com.koushikdutta.async:androidasync:2.2.1'
}
代碼示例：(此處沒有處理跨域，如果需要的話，請(qǐng)根據(jù)上一個(gè)例子去處理)
public class NIOHttpServer implements HttpServerRequestCallback {
private static final String TAG = "NIOHttpServer";
private static NIOHttpServer mInstance;
public static int PORT_LISTEN_DEFALT = 5000;
AsyncHttpServer server = new AsyncHttpServer();
public static NIOHttpServer getInstance() {
if (mInstance == null) {
// 增加類鎖,保證只初始化一次
synchronized (NIOHttpServer.class) {
if (mInstance == null) {
mInstance = new NIOHttpServer();
}
}
}
return mInstance;
}
//仿照nanohttpd的寫法
public static enum Status {
REQUEST_OK(200, "請(qǐng)求成功"),
REQUEST_ERROR(500, "請(qǐng)求失敗"),
REQUEST_ERROR_API(501, "無效的請(qǐng)求接口"),
REQUEST_ERROR_CMD(502, "無效命令"),
REQUEST_ERROR_DEVICEID(503, "不匹配的設(shè)備ID"),
REQUEST_ERROR_ENV(504, "不匹配的服務(wù)環(huán)境");
private final int requestStatus;
private final String description;
Status(int requestStatus, String description) {
this.requestStatus = requestStatus;
this.description = description;
}
public String getDescription() {
return description;
}
public int getRequestStatus() {
return requestStatus;
}
}
/**
* 開啟本地服務(wù)
*/
public void startServer() {
//如果有其他的請(qǐng)求方式，例如下面一行代碼的寫法
server.addAction("OPTIONS", "[\\d\\D]*", this);
server.get("[\\d\\D]*", this);
server.post("[\\d\\D]*", this);
server.listen(PORT_LISTEN_DEFALT);
}
@Override
public void onRequest(AsyncHttpServerRequest request, AsyncHttpServerResponse response) {
Log.d(TAG, "進(jìn)來了，哈哈");
String uri = request.getPath();
//這個(gè)是獲取header參數(shù)的地方，一定要謹(jǐn)記哦
Multimap headers = request.getHeaders().getMultiMap();
if (checkUri(uri)) {// 針對(duì)的是接口的處理
//注意：這個(gè)地方是獲取post請(qǐng)求的參數(shù)的地方，一定要謹(jǐn)記哦
Multimap parms = (( AsyncHttpRequestBody<Multimap>)request.getBody()).get();
if (headers != null) {
LogUtil.d(TAG, headers.toString());
}
if (parms != null) {
LogUtil.d(TAG, "parms = " + parms.toString());
}
if (StringUtil.isEmpty(uri)) {
throw new RuntimeException("無法獲取請(qǐng)求地址");
}
if ("OPTIONS".toLowerCase().equals(request.getMethod().toLowerCase())) {
LogUtil.d(TAG, "OPTIONS探測(cè)性請(qǐng)求");
addCORSHeaders(Status.REQUEST_OK, response);
return;
}
switch (uri) {
case "/test": {//接口2
//此方法包括了封裝返回的接口請(qǐng)求數(shù)據(jù)和處理異常以及跨域
return getXXX(parms);
}
default: {
return addHeaderResponse(Status.REQUEST_ERROR_API);
}
}
} else {
// 針對(duì)的是靜態(tài)資源的處理
String filePath = getFilePath(uri); // 根據(jù)url獲取文件路徑
if (filePath == null) {
LogUtil.d(TAG, "sd卡沒有找到");
response.send("sd卡沒有找到");
return;
}
File file = new File(filePath);
if (file != null && file.exists()) {
Log.d(TAG, "file path = " + file.getAbsolutePath());
response.sendFile(file);//和nanohttpd不一樣的地方
} else {
Log.d(TAG, "file path = " + file.getAbsolutePath() + "的資源不存在");
}
}
}
}
根據(jù)上面的例子，主要說以下幾點(diǎn)：｛大概說的就是api用法啊這一類的｝
1）例如：server.addAction("OPTIONS", "[\d\D]", this)是通用的過濾請(qǐng)求的方法。第一個(gè)參數(shù)是請(qǐng)求的方法，例如用“OPTIONS”、“DELETE”、“POST”、“GET”等（注意用大寫），第二個(gè)參數(shù)是過濾uri的正則表達(dá)式，此處是過濾所有的uri，第三個(gè)是回調(diào)參數(shù)。server.post("[\d\D]", this)、server.get("[\d\D]*", this)這個(gè)是上一個(gè)方法的特例。server.listen(PORT_LISTEN_DEFALT)這個(gè)是監(jiān)聽端口;
2） request.getHeaders().getMultiMap()這個(gè)是獲取header參數(shù)的地方，一定要謹(jǐn)記哦;
3）(( AsyncHttpRequestBody<Multimap>)request.getBody()).get()這個(gè)地方是獲取post請(qǐng)求的參數(shù)的地方;
4）獲取靜態(tài)資源的代碼是在回調(diào)方法onResponse的else中，例子如上。
5）說一下OPTIONS的坑點(diǎn)，因?yàn)锳ndroidAsync這個(gè)框架中封裝的返回http的狀態(tài)碼只有兩種，假如過濾方法中沒有包含例如OPTIONS的請(qǐng)求方法，實(shí)際上返回給客戶端的http狀態(tài)碼是400，而反映到瀏覽器的報(bào)錯(cuò)信息竟然是跨域的問題，找了很久才找到，請(qǐng)注意。
總結(jié)：
1）同一個(gè)頁(yè)面：
NanoHttpd耗時(shí)：1.4s
AndroidAsync耗時(shí)：1.4s
但是在第二次進(jìn)去的時(shí)候，AndroidAsync的耗時(shí)明顯比第一個(gè)少了，筆者猜測(cè)是因?yàn)锳ndroidAsync底層做了一些處理。
2）從api分析的話，NanoHttpd的用法比較方便，獲取傳遞的參數(shù)那些的api比較好用；AndroidAsync的api就相對(duì)來說要復(fù)雜一些，例如params的獲取。
3）從場(chǎng)景來分析的話，如果需要并發(fā)量高的需求，一定要用AndroidAsync；但是如果不需要的話，那就再具體分析。
以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。
相關(guān)文章
Android使用AlertDialog實(shí)現(xiàn)的信息列表單選、多選對(duì)話框功能
在使用AlertDialog實(shí)現(xiàn)單選和多選對(duì)話框時(shí)，分別設(shè)置setSingleChoiceItems()和setMultiChoiceItems()函數(shù)。具體實(shí)現(xiàn)代碼大家參考下本文吧2017-03-03
Android Studio出現(xiàn)Failed to pull selection: open failed: Permi
本篇文章給大家分享了Android Studio中導(dǎo)出數(shù)據(jù)庫(kù)文件的方法以及出現(xiàn)Failed to pull selection: open failed: Permission denied的解決思路，有興趣的學(xué)習(xí)下。2018-05-05
Android實(shí)現(xiàn)一個(gè)帶粘連效果的LoadingBar
Loading效果相信大家應(yīng)該都實(shí)現(xiàn)過，最近發(fā)現(xiàn)了一個(gè)不錯(cuò)的效果，決定分享給大家，所以下面這篇文章主要給大家介紹了關(guān)于利用Android實(shí)現(xiàn)一個(gè)帶粘連效果的LoadingBar的相關(guān)資料，需要的朋友可以參考借鑒，下面來一起看看吧。2017-12-12
Android下拉刷新控件SwipeRefreshLayout源碼解析
這篇文章主要為大家詳細(xì)解析Android下拉刷新控件SwipeRefreshLayout源碼，感興趣的小伙伴們可以參考一下2016-07-07
Android 序列化的存儲(chǔ)和讀取總結(jié)及簡(jiǎn)單使用
這篇文章主要介紹了Android 序列化的存儲(chǔ)和讀取總結(jié)及簡(jiǎn)單使用的相關(guān)資料,Serializable接口和Parcelable接口，本文對(duì)這兩種方式進(jìn)行簡(jiǎn)單的總結(jié)和使用，需要的朋友可以參考下2016-12-12
Flutter 日期時(shí)間DatePicker控件及國(guó)際化
這篇文章主要介紹了Flutter 日期時(shí)間DatePicker控件及國(guó)際化，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-03-03
這篇文章主要為大家詳細(xì)介紹了Android自定義可控制速度的跑馬燈，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2022-06-06
Android實(shí)現(xiàn)為Tab添加Menu的方法
這篇文章主要介紹了Android實(shí)現(xiàn)為Tab添加Menu的方法,分析了兩種解決方法的思路并對(duì)比分析了相應(yīng)的優(yōu)缺點(diǎn),具有一定參考借鑒價(jià)值,需要的朋友可以參考下2016-10-10
Android中使用ListView實(shí)現(xiàn)漂亮的表格效果
這篇文章主要介紹了Android中使用ListView實(shí)現(xiàn)漂亮的表格效果,本文用詳細(xì)的代碼實(shí)例創(chuàng)建了一個(gè)股票行情表格,需要的朋友可以參考下2014-10-10
詳解Android控件之DatePicker、TimePicker探究
本篇文章主要介紹了Android控件之DatePicker、TimePicker探究，非常具有實(shí)用價(jià)值，需要的朋友可以參考下。2016-12-12