2. 程式人生 > >Android網路程式設計之一：原生網路訪問簡單封裝

Android網路程式設計之一：原生網路訪問簡單封裝

阿新 • • 發佈：2019-01-29

前言：轉眼間2017了，去年給自己定的一週一篇部落格被拖成了一月一篇，後來忙著找工作也荒廢了。竟然還被CSDN部落格之星提名，又點燃了擼部落格的激情。
作為一個android codder，網略訪問基本上在專案中都會用到，常用的獲取JSON資料、下載檔案(圖片等)、上傳資料、上傳問檔案等等。Android原生的訪問網路有HttpClient和HttpURLConnection。在Android 6.0時刪除了HttpClient，OkHttp的呼聲也隨之高漲。

下面會對這幾種網路訪問模式寫下簡單的示例，網上大多示例都是訪問別人的伺服器或者本地的伺服器，不便於大家測試，我用阿里雲搭建了個簡單的服務端。

吐下槽，之前使用的MyEclipse開發Java Web，換電腦之後在網上搜怎麼配Mac上Java Web開發環境，有很多人提到使用IntelliJ IDEA，搞環境又搞了一兩天，本人後端小菜~

NetworkTask編寫

這裡我們使用AsyncTask的方式進行子執行緒訪問網路並回調到主執行緒，在建立NetworkTask的時候要傳入是GET還是POST請求，然後傳入引數開始訪問網略獲取資料。

1. 這裡我們約定`GET`請求時引數即為拼接的請求地址，如：
    new xxxNetworkTask(NetworkTask.GET).execute("http://123.57.31.11/androidnet/getJoke?id=5");
2. 約定`POST`請求時引數第一個為地址，其他為請求引數對，如：
    new xxxNetworkTask(NetworkTask.POST).execute("http://123.57.31.11/androidnet/getJoke", "id=5");

 
/**
 * 訪問網路AsyncTask基類,訪問網路在子執行緒進行並返回主執行緒通知訪問的結果
 */
public abstract class NetworkTask extends AsyncTask<String, Integer, String> {

    public static final String TAG = "NetworkTask";

    public static String GET = "GET";
    public static String POST = "POST";
    private String mRequestMethod;

    public NetworkTask(String method) {
        this
 
.mRequestMethod = method;
    }

    @Override
    protected String doInBackground(String... params) {
        String data;
        if(GET.equals(mRequestMethod)) {
            data = doGet(params[0]);
        } else if(POST.equals(mRequestMethod)) {
            data = doPost(params);
        } else {
            throw new RuntimeException("Request mode can only be GET or POST!");
        }
        return data;
    }

    @Override
    protected void onPostExecute(String result) {
        super.onPostExecute(result);
    }

    /**
     * 以GET的方式訪問網路
     * 
     * @param url
     * @return 返回的字串資料
     */
    public abstract String doGet(String url);

    /**
     * 以POST的方式訪問網路
     * 
     * @param params
     * @return 返回的字串資料
     */
    public abstract String doPost(String[] params);

}

然後我們加上返回資料的監聽回撥

/**
 * 訪問網路AsyncTask基類,訪問網路在子執行緒進行並返回主執行緒通知訪問的結果
 */
public abstract class NetworkTask extends AsyncTask<String, Integer, String> {

    public static final String TAG = "NetworkTask";

    public static String GET = "GET";
    public static String POST = "POST";
    // 訪問方式，只能是GET或POST
    private String mRequestMethod;
    // 是否訪問網路成功
    protected boolean isSuccess = true;
    // 監聽回撥
    private ResponceLintener mResponceLintener;

    public NetworkTask(String method) {
        this.mRequestMethod = method;
    }

    @Override
    protected String doInBackground(String... params) {
        String data;
        String url = params[0];
        if(GET.equals(mRequestMethod)) {
            data = doGet(url);
        } else if(POST.equals(mRequestMethod)) {
            Map<String, String> paramMap = new HashMap<String, String>();
            // 第一個引數為訪問的介面,不為body引數
            for (int i = 1; i < params.length; i++) {
                String[] value = new String[2];
                if (params[i].split("=").length == 1) {
                    value[0] = params[i].split("=")[0];
                    value[1] = "";
                } else {
                    value = params[i].split("=");
                }
                paramMap.put(value[0], value[1]);
            }
            data = doPost(url, paramMap);
        } else {
            throw new RuntimeException("Request mode can only be GET or POST!");
        }
        return data;
    }

    @Override
    protected void onPostExecute(String result) {
        if(null != mResponceLintener) {
            if(isSuccess) {
                mResponceLintener.onSuccess(result);
            } else {
                mResponceLintener.onError(result);
            }
        }
    }

    /**
     * 以GET的方式訪問網路
     * 
     * @param url
     * @return 返回的字串資料
     */
    public abstract String doGet(String url);

    /**
     * 以POST的方式訪問網路
     * 
     * @param url
     * @param paramMap
     * @return 返回的字串資料
     */
    public abstract String doPost(String url, Map<String, String> paramMap);

    public void setResponceLintener(ResponceLintener l) {
        this.mResponceLintener = l;
    }

    public interface ResponceLintener {
        /**
         * 成功的監聽回撥
         * @param result
         */
        void onSuccess(String result);
        /**
         * 失敗的監聽回撥
         * @param error
         */
        void onError(String error);
    }

}

OK，經過簡單的封裝之後，我們在使用不同的形式訪問網路時只需要對應的去實現doGet和doPost就可以了。

HttpClient

儘管HttpClient刪除了，我們還是簡單回顧下它的使用。

HttpClientNetworkTask

建立HttpClientNetworkTask繼承NetworkTask並實現抽象方法。

/**
 * 以HttpClient訪問網路AsyncTask,訪問網路在子執行緒進行並返回主執行緒通知訪問的結果
 */
public class HttpClientNetworkTask extends NetworkTask {

    public HttpClientNetworkTask(String method) {
        super(method);
    }

    @Override
    public String doGet(String url) {
        return null;
    }

    @Override
    public String doPost(String url, Map<String, String> paramMap) {
        return null;
    }

}

下面我們只需要使用HttpClient去完成響應的網路請求就可以啦~ 是不是很清爽~~

HttpClient使用步驟：

  1. 建立HttpClient物件；
  2. 建立請求的物件，如果為GET請求，則建立HttpGet物件，如果為POST請求，則建立HttpPost物件；
  3. 呼叫HttpClient物件的execute傳送請求，執行該方法後，將獲得伺服器返回的HttpResponse物件；
  4. 檢查相應狀態是否正常；
  5. 獲得相應物件當中的資料。

GET

@Override
public String doGet(String url) {
    String result = null;
    HttpClient httpCient = new DefaultHttpClient();
    HttpGet httpGet = new HttpGet(url);
    try {
        HttpResponse httpResponse = httpCient.execute(httpGet);
        if (httpResponse.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
             HttpEntity entity = httpResponse.getEntity();
             result = EntityUtils.toString(entity,"utf-8");
        } else {
            isSuccess = false;
            result = "網路響應狀態碼不為200!";
        }
    } catch (IOException e) {
        isSuccess = false;
        result = "網路訪問錯誤:" + e.getMessage();
    }

    return result;
}

使用如下：

NetworkTask networkTask = new HttpClientNetworkTask(NetworkTask.GET);
networkTask.execute("http://123.57.31.11/androidnet/getJoke?id=5");
networkTask.setResponceLintener(new NetworkTask.ResponceLintener() {

    @Override
    public void onSuccess(String result) {
        tv.setText(result);
    }

    @Override
    public void onError(String error) {
        Toast.makeText(getApplicationContext(), error, Toast.LENGTH_SHORT).show();
    }
});

據說沒圖不便於理解，上圖：

網路訪問

POST

@Override
public String doPost(String url, Map<String, String> paramMap) {
    String result;
    HttpClient httpCient = new DefaultHttpClient();
    HttpPost httpRequest = new HttpPost(url);
    // 使用NameValuePair來儲存要傳遞的Post引數
    List<NameValuePair> params = new ArrayList<NameValuePair>();
    for (Map.Entry<String, String> entry : paramMap.entrySet()) {
        params.add(new BasicNameValuePair(entry.getKey(), entry.getValue()));
    }
    try {
        httpRequest.setEntity(new UrlEncodedFormEntity(params, HTTP.UTF_8));
        HttpResponse response = httpCient.execute(httpRequest);
        if (response.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
            result = EntityUtils.toString(response.getEntity());
        } else {
            isSuccess = false;
            result = "網路響應狀態碼不為200!";
        }
    } catch (IOException e) {
        isSuccess = false;
        result = "網路訪問錯誤:" + e.getMessage();
    }

    return result;
}

使用如下：

NetworkTask networkTask = new HttpClientNetworkTask(NetworkTask.POST);
networkTask.execute("http://123.57.31.11/androidnet/getJoke", "id=5");
networkTask.setResponceLintener(new NetworkTask.ResponceLintener() {

    @Override
    public void onSuccess(String result) {
        tv.setText(result);
    }

    @Override
    public void onError(String error) {
        Toast.makeText(getApplicationContext(), error, Toast.LENGTH_SHORT).show();
    }
});

HttpURLConnection

HttpURLConnectionNetworkTask

建立HttpURLConnectionNetworkTask繼承NetworkTask並實現抽象方法。

/**
 * 以HttpURLConnection訪問網路AsyncTask,訪問網路在子執行緒進行並返回主執行緒通知訪問的結果
 */
public class HttpURLConnectionNetworkTask extends NetworkTask {

    public HttpURLConnectionNetworkTask(String method) {
        super(method);
    }

    @Override
    public String doGet(String url) {
        return null;
    }

    @Override
    public String doPost(String url, Map<String, String> paramMap) {
        return null;
    }

}

下面我們用HttpURLConnection去完成響應的網路。

HttpURLConnection使用步驟：

  1. 例項化URL物件；
  2. 例項化HttpUrlConnection物件；
  3. 設定請求連線屬性，傳遞引數等；
  4. 獲取返回碼判斷是否連結成功；
  5. 讀取輸入流；
  6. 關閉連結。

GET

@Override
public String doGet(String httpUrl) {
    String result;
    try {
        URL url = new URL(httpUrl);
        HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection();
        urlConnection.setRequestMethod("GET");
        urlConnection.setReadTimeout(5000);
        urlConnection.setConnectTimeout(5000);
        urlConnection.setRequestProperty("Charset", "UTF-8");
        if (urlConnection.getResponseCode() == 200) {
            InputStream is = urlConnection.getInputStream();
            result = readFromStream(is);
        } else {
            isSuccess = false;
            result = "網路響應狀態碼不為200!";
        }
    } catch(IOException e) {
        isSuccess = false;
        result = "網路訪問錯誤:" + e.getMessage();
    }

    return result;
}

這裡編寫了一個從流獲取字串的工具

/**
 * 輸入流獲取字串
 * 
 * @param is 輸入流
 * @return String 返回的字串
 * @throws IOException
 */
public String readFromStream(InputStream is) throws IOException {
    ByteArrayOutputStream baos = new ByteArrayOutputStream();
    byte[] buffer = new byte[1024];
    int len = 0;
    while ((len = is.read(buffer)) != -1) {
        baos.write(buffer, 0, len);
    }
    is.close();
    String result = baos.toString();
    baos.close();
    return result;
}

使用方法和HttpClientNetworkTask一樣，只不過是把實現類由HttpClientNetworkTask換為HttpURLConnection:

NetworkTask networkTask = new HttpURLConnectionNetworkTask(NetworkTask.GET);
networkTask.execute("http://123.57.31.11/androidnet/getJoke?id=6");
networkTask.setResponceLintener(new NetworkTask.ResponceLintener() {

    @Override
    public void onSuccess(String result) {
        tv.setText(result);
    }

    @Override
    public void onError(String error) {
        Toast.makeText(getApplicationContext(), error, Toast.LENGTH_SHORT).show();
    }
});

POST

@Override
public String doPost(String httpUrl, Map<String, String> paramMap) {
    String result;
    try {
        URL url = new URL(httpUrl);
        HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection();
        urlConnection.setRequestMethod("POST");
        urlConnection.setReadTimeout(5000);
        urlConnection.setConnectTimeout(5000);
        // 配置連線的Content-type
        urlConnection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
        urlConnection.setDoOutput(true);    // 傳送POST請求必須設定允許輸出 
        urlConnection.setDoInput(true);     // 傳送POST請求必須設定允許輸入 

        String data = "";
        boolean firstParam = true;
        for (Map.Entry<String, String> entry : paramMap.entrySet()) {
            if(firstParam) {
                data += entry.getKey() + "=" + URLEncoder.encode(entry.getValue(), "UTF-8");
                firstParam = false;
            } else {
                data += "&" + entry.getKey() + "=" + URLEncoder.encode(entry.getValue(), "UTF-8");
            }
        }
        OutputStream os = urlConnection.getOutputStream();
        os.write(data.getBytes());
        os.flush();

        if (urlConnection.getResponseCode() == 200) {
            InputStream is = urlConnection.getInputStream();
            result = readFromStream(is);
        } else {
            isSuccess = false;
            result = "網路響應狀態碼不為200!";
        }
    } catch (IOException e) {
        isSuccess = false;
        result = "網路訪問錯誤:" + e.getMessage();
    }

    return result;
}

使用方法和HttpClientNetworkTask一樣，只不過是把實現類由HttpClientNetworkTask換為HttpURLConnection:

NetworkTask networkTask = new HttpURLConnectionNetworkTask(NetworkTask.POST);
networkTask.execute("http://123.57.31.11/androidnet/getJoke", "id=6");
networkTask.setResponceLintener(new NetworkTask.ResponceLintener() {

    @Override
    public void onSuccess(String result) {
        tv.setText(result);
    }

    @Override
    public void onError(String error) {
        Toast.makeText(getApplicationContext(), error, Toast.LENGTH_SHORT).show();
    }
});

總結

其實開發的時候我們不是很關心具體是怎麼聯網的，封裝好之後使用起來越簡單越好。我給你地址和引數你去訪問網略然後返回我關心的資料就可以了。

以上是使用HttpClient和HttpURLConnection進行了GET和POST的返回資料為字串型別簡單封裝，有興趣的朋友也可以進行OkHttp或其他方式的封裝。

當然在使用的時候可能會有更加複雜的場景，比如：上傳一個圖片、下載一個檔案等。

我們最常使用的還是獲取JSON型別的資料，然後封裝到實體。那麼這一塊如何封裝呢？接下來的一篇部落格將拋開NetworkTask進行獲取JSON資料並封裝到實體的簡單編寫。

相關推薦

Android網路程式設計之一：原生網路訪問簡單封裝

前言：轉眼間2017了，去年給自己定的一週一篇部落格被拖成了一月一篇，後來忙著找工作也荒廢了。竟然還被CSDN部落格之星提名，又點燃了擼部落格的激情。 作為一個android codder，網略訪問基本上在專案中都會用到，常用的獲取JSON資料、下載檔案(

網路程式設計之：TCP伺服器的簡單實現

說到TCP伺服器，就不得不提socket程式設計，我們知道，在TCP/IP協議中,“IP地址+TCP或UDP埠號”唯一標識⽹絡通訊中的唯一一個程序,“IP地址+埠號”就稱為socket。 在TCP協

詳解C# 網路程式設計系列：實現類似QQ的即時通訊程式

https://www.jb51.net/article/101289.htm   引言： 前面專題中介紹了UDP、TCP和P2P程式設計，並且通過一些小的示例來讓大家更好的理解它們的工作原理以及怎樣.Net類庫去實現它們的。為了讓大家更好的理解我們平常中常見的軟體QQ的工作原理，所以在本專題

net網路程式設計之一 Socket程式設計

分享一下我老師大神的人工智慧教程！零基礎，通俗易懂！http://blog.csdn.net/jiangjunshow 也歡迎大家轉載本篇文章。分享知識，造福人民，實現我們中華民族偉大復興！        

Qt網路程式設計之一http

     Qt網路程式設計，其實主要就是QNetworkAccessManager、QNetworkRequest和QNetworkReply這三個類的主要內容。在之前，Qt網路程式設計主要是使用QHttp等類，但是現在在幫助手冊中這些類已經標記為過時的，所以，現在用

Qt：Qt實現Winsock網路程式設計—非阻塞模式下的簡單遠端控制的開發（WSAAsyncSelect）

Qt實現Winsock網路程式設計—非阻塞模式下的簡單遠端控制的開發（WSAAsyncSelect） 前言 這邊部落格應該是 Qt實現Winsock網路程式設計—TCP服務端和客戶端通訊（多執行緒） 的姐妹篇，上篇部落格中的socket通訊中所用的Windows api函式 都是

網路程式設計七：HttpClient配置ssl,繞過證書驗證

1、HttpClient配置ssl,繞過證書驗證： 自定義實現X509ExtendedTrustManager，JDK會使用TrustAnyTrustManager來驗證證書演算法，而這個類所有的驗證方

javaSE (四十）網路程式設計（TCP傳輸、伺服器多執行緒、網路程式設計練習：反轉字串、上傳檔案）

1、TCP傳輸： 1.客戶端 建立Socket連結服務端（指定ip地址，埠號），通過ip地址找到對應的伺服器 呼叫Socket的getInputStream和getOutputStream方法獲取和伺服器端相連的IO流 2.伺服器端 建立Se

《Linux網路程式設計》： 無連線和麵向連線協議的區別

網路程式設計中最基本的概念就是面向連線（connection-oriented）和無連線（connectionless）協議。儘管本質上來說，兩者之間的區別並不難理解，但對那些剛剛開始進行網路程式設計的人來說，卻是個很容易混淆的問題。這個問題與上下文有些關聯：很顯然，如果兩臺計算機要進行通訊，就必須

《Linux網路程式設計》： 網路協議入門

我們每天使用網際網路，你是否想過，它是如何實現的？ 全世界幾十億臺電腦，連線在一起，兩兩通訊。北京的某一塊網絡卡送出訊號，深圳的另一塊網絡卡居然就收到了，兩者實際上根本不知道對方的物理位置，你不覺得這是很神奇的事情嗎？ 為了使各種不同的計算機之間可以互聯，ARPANet指定了一套計算

【Java網路程式設計】：JDK API實現OIO和NIO

前言 網路程式設計是Java的一大難點，JDK自帶的api可以實現網路程式設計。 我們將從一個應用程式開始我們對傳輸的學習，這個應用程式只簡單地接受連線，然後向客戶端寫“Hi!”，然後關閉連線。 1. OIO實現 應用程式的阻塞（OIO）版程式碼如下： package

高效能網路程式設計(一)：單臺伺服器併發TCP連線數到底可以有多少

前言 曾幾何時我們還在尋求網路程式設計中C10K問題（有關C10K問題請見文章《The C10K problem（英文線上閱讀、英文PDF版下載、中文譯文）》）的解決方案，但是現在從硬體和作業系統支援來看單臺伺服器支援上萬併發連線已經沒有多少挑戰性了。 我們先假設單臺伺服器最多隻能支援萬級併發連線，其實

【Java網路程式設計】：Netty實現OIO和NIO

承接上文：https://blog.csdn.net/hxcaifly/article/details/85274664 前言 單純地使用Java JDK來實現網路NIO是一件開發成本非常高的事情。然而，Netty 為它所有的傳輸實現提供了一個通用API，這使得這種

c++網路程式設計3：UDP程式設計

一.概念：         UDP是傳輸層中面向無連線的協議，所以UDP丟包後是不會重傳的，而且他在程式設計上服務端和客戶端是沒有區別的，有的只是“虛擬上”的服務端和客戶端，他在程式設計的實現上也很簡單，不像TCP那麼複雜。 二.UDP終端的程式設計       由於UD

linux下C/C++網路程式設計基本：socket實現tcp和udp的例子

簡單的linux下socket程式設計，分別基於TCP和UDP協議實現的簡單程式 linux下socket程式設計可以概括為以下幾個函式的運用： socket() bind() listen

《Linux網路程式設計》： TCP程式設計

TCP程式設計 TCP 程式設計的 C/S 架構 基於 TCP 的網路程式設計開發分為伺服器端和客戶端兩部分，常見的核心步驟和流程如下：   TCP 客戶端程式設計 對於 TCP 客戶端程式設計流程，有點類似於打電話過程：找個可以通話的手機（socke

《Linux網路程式設計》： 埠複用（多個套接字繫結同一個埠）

在《繫結( bind )埠需要注意的問題》提到：一個網路應用程式只能繫結一個埠( 一個套接字只能繫結一個埠 )。 請檢視《Linux網路程式設計》： 繫結( bind )埠需要注意的問題 實際上，預設的情況下，如果一個網路應用程式的一個套接字 綁定了一個埠( 佔用了 80

《Linux網路程式設計》： connect()、listen()和accept()三者之間的關係

基於 TCP 的網路程式設計開發分為伺服器端和客戶端兩部分，常見的核心步驟和流程如下：   connect()函式 對於客戶端的 connect() 函式，該函式的功能為客戶端主動連線伺服器，建立連線是通過三次握手，而這個連線的過程是由核心完成，不是這個函式完

《Linux網路程式設計》： UDP程式設計

UDP程式設計 1. UDP 程式設計的 C/S 架構 2. UDP 客戶端程式 ssize_t sendto(   int sockfd，const void *buf,size_t nbytes,int flags,const struct so

《Linux網路程式設計》： 繫結( bind )埠需要注意的問題

所謂繫結(bind)是指別人連線我只能通過我所繫結的埠，相當於，我買了一個手機，別人要想聯絡我，必須要知道我的手機號碼，這時候，我需要怎麼辦呢？我需要給手機插上電話卡，固定一個電話號碼，這樣別人就能通過這個電話號碼聯絡我。手機插上電話卡，固定一個電話號碼，類似於繫結(bind)的過程，繫結(bi