连接到网络

编写:kesenhoo - 原文:http://developer.android.com/training/basics/network-ops/connecting.html

这一课会演示如何实现一个简单的连接到网络的程序。它提供了一些我们在创建即使最简单的网络连接程序时也应该遵循的最佳示例。

请注意，想要执行本课的网络操作首先需要在程序的 manifest 文件中添加以下权限：

  1. <uses-permission android:name="android.permission.INTERNET" />
  2. <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

选择一个 HTTP Client

大多数连接网络的 Android app 会使用 HTTP 来发送与接收数据。Android 提供了两种 HTTP clients：HttpURLConnection 与 Apache HttpClient。二者均支持 HTTPS、流媒体上传和下载、可配置的超时、IPv6 与连接池（connection pooling）。对于 Android 2.3 Gingerbread 或更高的版本，推荐使用 HttpURLConnection。关于这部分的更多详情，请参考 Android’s HTTP Clients。

检查网络连接

在我们的 app 尝试连接网络之前，应通过函数 getActiveNetworkInfo() 和 isConnected() 检测当前网络是否可用。请注意，设备可能不在网络覆盖范围内，或者用户可能关闭 Wi-Fi 与移动网络连接。关于这部分的更多详情，请参考管理网络的使用情况

  1. public void myClickHandler(View view) {
  2.     ...
  3.     ConnectivityManager connMgr = (ConnectivityManager)
  4.         getSystemService(Context.CONNECTIVITY_SERVICE);
  5.     NetworkInfo networkInfo = connMgr.getActiveNetworkInfo();
  6.     if (networkInfo != null && networkInfo.isConnected()) {
  7.         // fetch data
  8.     } else {
  9.         // display error
  10.     }
  11.     ...
  12. }

在一个单独的线程中执行网络操作

网络操作会遇到不可预期的延迟。为了避免造成不好的用户体验，总是在 UI 线程之外单独的线程中执行网络操作。AsyncTask 类提供了一种简单的方式来处理这个问题。这部分的详情，请参考 Multithreading For Performance。

在下面的代码示例中，myClickHandler() 方法会执行 new DownloadWebpageTask().execute(stringUrl)。DownloadWebpageTask 是 AsyncTask 的子类，它实现了下面两个方法:

  • doInBackground() 执行 downloadUrl() 方法。它以网页的 URL 作为参数，方法 downloadUrl() 获取并处理网页返回的数据。执行完毕后，返回一个结果字符串。
  • onPostExecute() 接收结果字符串并把它显示到 UI 上。
  1. public class HttpExampleActivity extends Activity {
  2.     private static final String DEBUG_TAG = "HttpExample";
  3.     private EditText urlText;
  4.     private TextView textView;
  6.     @Override
  7.     public void onCreate(Bundle savedInstanceState) {
  8.         super.onCreate(savedInstanceState);
  9.         setContentView(R.layout.main);
  10.         urlText = (EditText) findViewById(R.id.myUrl);
  11.         textView = (TextView) findViewById(R.id.myText);
  12.     }
  14.     // When user clicks button, calls AsyncTask.
  15.     // Before attempting to fetch the URL, makes sure that there is a network connection.
  16.     public void myClickHandler(View view) {
  17.         // Gets the URL from the UI's text field.
  18.         String stringUrl = urlText.getText().toString();
  19.         ConnectivityManager connMgr = (ConnectivityManager)
  20.             getSystemService(Context.CONNECTIVITY_SERVICE);
  21.         NetworkInfo networkInfo = connMgr.getActiveNetworkInfo();
  22.         if (networkInfo != null && networkInfo.isConnected()) {
  23.             new DownloadWebpageText().execute(stringUrl);
  24.         } else {
  25.             textView.setText("No network connection available.");
  26.         }
  27.     }
  29.      // Uses AsyncTask to create a task away from the main UI thread. This task takes a
  30.      // URL string and uses it to create an HttpUrlConnection. Once the connection
  31.      // has been established, the AsyncTask downloads the contents of the webpage as
  32.      // an InputStream. Finally, the InputStream is converted into a string, which is
  33.      // displayed in the UI by the AsyncTask's onPostExecute method.
  34.      private class DownloadWebpageText extends AsyncTask {
  35.         @Override
  36.         protected String doInBackground(String... urls) {
  38.             // params comes from the execute() call: params[0] is the url.
  39.             try {
  40.                 return downloadUrl(urls[0]);
  41.             } catch (IOException e) {
  42.                 return "Unable to retrieve web page. URL may be invalid.";
  43.             }
  44.         }
  45.         // onPostExecute displays the results of the AsyncTask.
  46.         @Override
  47.         protected void onPostExecute(String result) {
  48.             textView.setText(result);
  49.        }
  50.     }
  51.     ...
  52. }

上面这段代码的事件顺序如下:

  1. 当用户点击按钮时调用 myClickHandler()，app 将指定的 URL 传给 AsyncTask 的子类 DownloadWebpageTask。
  2. AsyncTask 的 doInBackground() 方法调用 downloadUrl() 方法。
  3. downloadUrl() 方法以一个 URL 字符串作为参数，并用它创建一个 URL 对象。
  4. 这个 URL 对象被用来创建一个 HttpURLConnection。
  5. 一旦建立连接，HttpURLConnection 对象将获取网页的内容并得到一个 InputStream。
  6. InputStream 被传给 readIt() 方法，该方法将流转换成字符串。
  7. 最后，AsyncTask 的 onPostExecute() 方法将字符串展示在 main activity 的 UI 上。

连接并下载数据

在执行网络交互的线程里面，我们可以使用 HttpURLConnection 来执行一个 GET 类型的操作并下载数据。在调用 connect() 之后，我们可以通过调用 getInputStream() 来得到一个包含数据的 InputStream 对象。

在下面的代码示例中，doInBackground() 方法会调用 downloadUrl()。这个 downloadUrl() 方法使用给予的 URL，通过 HttpURLConnection 连接到网络。一旦建立连接后，app 就会使用 getInputStream() 来获取包含数据的 InputStream。

  1. // Given a URL, establishes an HttpUrlConnection and retrieves
  2. // the web page content as a InputStream, which it returns as
  3. // a string.
  4. private String downloadUrl(String myurl) throws IOException {
  5.     InputStream is = null;
  6.     // Only display the first 500 characters of the retrieved
  7.     // web page content.
  8.     int len = 500;
  10.     try {
  11.         URL url = new URL(myurl);
  12.         HttpURLConnection conn = (HttpURLConnection) url.openConnection();
  13.         conn.setReadTimeout(10000 /* milliseconds */);
  14.         conn.setConnectTimeout(15000 /* milliseconds */);
  15.         conn.setRequestMethod("GET");
  16.         conn.setDoInput(true);
  17.         // Starts the query
  18.         conn.connect();
  19.         int response = conn.getResponseCode();
  20.         Log.d(DEBUG_TAG, "The response is: " + response);
  21.         is = conn.getInputStream();
  23.         // Convert the InputStream into a string
  24.         String contentAsString = readIt(is, len);
  25.         return contentAsString;
  27.     // Makes sure that the InputStream is closed after the app is
  28.     // finished using it.
  29.     } finally {
  30.         if (is != null) {
  31.             is.close();
  32.         }
  33.     }
  34. }

请注意，getResponseCode() 会返回连接的状态码（status code）。这是一种获知额外网络连接信息的有效方式。其中，状态码是 200 则意味着连接成功。

将输入流（InputStream）转换为字符串

InputStream 是一种可读的 byte 数据源。如果我们获得了一个 InputStream，通常会进行解码（decode）或者转换为目标数据类型。例如，如果我们是在下载图片数据，那么可能需要像下面这样解码并展示它：

  1. InputStream is = null;
  2. ...
  3. Bitmap bitmap = BitmapFactory.decodeStream(is);
  4. ImageView imageView = (ImageView) findViewById(R.id.image_view);
  5. imageView.setImageBitmap(bitmap);

在上面演示的示例中，InputStream 包含的是网页的文本内容。下面会演示如何把 InputStream 转换为字符串，以便显示在 UI 上。

  1. // Reads an InputStream and converts it to a String.
  2. public String readIt(InputStream stream, int len) throws IOException, UnsupportedEncodingException {
  3.     Reader reader = null;
  4.     reader = new InputStreamReader(stream, "UTF-8");
  5.     char[] buffer = new char[len];
  6.     reader.read(buffer);
  7.     return new String(buffer);
  8. }