Подключение к сети

Этот урок покажет вам, как реализовать простое приложение, которое подключается к сети. Он объясняет некоторые из лучших практик, которым вы должны следовать при создании даже самого простого приложения с сетевым подключением.

Обратите внимание, что для выполнения сетевых операций, описанных в этом уроке, манифест приложения должен включать в себя следующие разрешения:

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

Выбор HTTP клиента

Большинство Android приложений с подключением к сети используют HTTP для передачи и приема данных. Android включает в себя два HTTP клиента: HttpURLConnection и Apache HttpClient. Оба поддерживают HTTPS, потоковую загрузку данных, настраиваемые временные интервалы, IPv6, и пул соединений. Мы рекомендуем использовать HttpURLConnection для приложений, ориентированных на Gingerbread и выше. Более детальное обсуждения этой теме читайте в блоге HTTP клиенты Android.

Проверка сетевого соединения

Перед тем, как ваше приложение попытается подключиться к сети, оно должно проверить, доступно ли подключение к сети, используя getActiveNetworkInfo() и isConnected(). Помните, что устройство может быть вне зоны действия сети, или пользователь может отключить Wi-Fi и мобильный доступ к сети. Более детальное обсуждение этой темы см. в уроке Управление использованием сети.

public void myClickHandler(View view) {
    ...
    ConnectivityManager connMgr = (ConnectivityManager) 
        getSystemService(Context.CONNECTIVITY_SERVICE);
    NetworkInfo networkInfo = connMgr.getActiveNetworkInfo();
    if (networkInfo != null && networkInfo.isConnected()) {
        // fetch data
    } else {
        // display error
    }
    ...
}

Выполнение сетевых операций в отдельном потоке

Сетевые операции могут иметь непредсказуемые задержки. Чтобы этого не приводило к плохому пользовательскому опыту, всегда выполняйте сетевые операции в отдельном потоке. AsyncTask класс предоставляет один из самых простых способов выполнить новую задачу вне потока пользовательского интерфейса. Более детальное обсуждение этой темы читайте в блоге Многопоточность для повышения производительности.

В следующем фрагменте, myClickHandler() метод вызывает new DownloadWebpageTask().execute(stringUrl). DownloadWebpageTask класс является подклассом AsyncTask. DownloadWebpageTask реализует следующие AsyncTask методы:

  • doInBackground() выполняет метод downloadUrl(). Он передает URL веб-страницы в качестве параметра. Метод downloadUrl() получает и обрабатывает содержимое веб-страницы. Когда он заканчивает, он передает обратно результирующую строку.
  • onPostExecute() принимает возвращенную строку и отображает её в пользовательском интерфейсе.
public class HttpExampleActivity extends Activity {
    private static final String DEBUG_TAG = "HttpExample";
    private EditText urlText;
    private TextView textView;
    
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);   
        urlText = (EditText) findViewById(R.id.myUrl);
        textView = (TextView) findViewById(R.id.myText);
    }

    // When user clicks button, calls AsyncTask.
    // Before attempting to fetch the URL, makes sure that there is a network connection.
    public void myClickHandler(View view) {
        // Gets the URL from the UI's text field.
        String stringUrl = urlText.getText().toString();
        ConnectivityManager connMgr = (ConnectivityManager) 
            getSystemService(Context.CONNECTIVITY_SERVICE);
        NetworkInfo networkInfo = connMgr.getActiveNetworkInfo();
        if (networkInfo != null && networkInfo.isConnected()) {
            new DownloadWebpageTask().execute(stringUrl);
        } else {
            textView.setText("No network connection available.");
        }
    }

     // Uses AsyncTask to create a task away from the main UI thread. This task takes a 
     // URL string and uses it to create an HttpUrlConnection. Once the connection
     // has been established, the AsyncTask downloads the contents of the webpage as
     // an InputStream. Finally, the InputStream is converted into a string, which is
     // displayed in the UI by the AsyncTask's onPostExecute method.
     private class DownloadWebpageTask extends AsyncTask<String, Void, String> {
        @Override
        protected String doInBackground(String... urls) {
              
            // params comes from the execute() call: params[0] is the url.
            try {
                return downloadUrl(urls[0]);
            } catch (IOException e) {
                return "Unable to retrieve web page. URL may be invalid.";
            }
        }
        // onPostExecute displays the results of the AsyncTask.
        @Override
        protected void onPostExecute(String result) {
            textView.setText(result);
       }
    }
    ...
}

Последовательность событий в этом фрагменте выглядит следующим образом:

  1. Когда пользователь нажимает кнопку, которая вызывает myClickHandler(), приложение передает указанный URL в AsyncTask подкласс DownloadWebpageTask.
  2. AsyncTask метод doInBackground() вызывает downloadUrl() метод.
  3. downloadUrl() метод принимает URL в виде строки в качестве параметра и использует его, чтобы создать URL объект.
  4. URL объект используется для установления HttpURLConnection.
  5. После того, как соединение было установлено, HttpURLConnection объект извлекает содержимое веб-страницы, в виде InputStream.
  6. InputStream передается в readIt() метод, который преобразует поток в строку.
  7. В заключение, AsyncTask onPostExecute() метод отображает строку в пользовательском интерфейсе основной деятельности.

Подключение и загрузка данных

В вашем потоке, который выполняет сетевые операции, вы можете использовать HttpURLConnection для выполнения GET и загрузки данных. После вызова connect(), вы можете получить InputStream данных, вызвав getInputStream().

В следующем фрагменте, doInBackground() метод вызывает метод downloadUrl(). downloadUrl() метод принимает заданный URL и использует его для подключения к сети через HttpURLConnection. После того, как соединение было установлено, приложение использует метод getInputStream() для получения данных, в виде InputStream.

// Given a URL, establishes an HttpUrlConnection and retrieves
// the web page content as a InputStream, which it returns as
// a string.
private String downloadUrl(String myurl) throws IOException {
    InputStream is = null;
    // Only display the first 500 characters of the retrieved
    // web page content.
    int len = 500;
        
    try {
        URL url = new URL(myurl);
        HttpURLConnection conn = (HttpURLConnection) url.openConnection();
        conn.setReadTimeout(10000 /* milliseconds */);
        conn.setConnectTimeout(15000 /* milliseconds */);
        conn.setRequestMethod("GET");
        conn.setDoInput(true);
        // Starts the query
        conn.connect();
        int response = conn.getResponseCode();
        Log.d(DEBUG_TAG, "The response is: " + response);
        is = conn.getInputStream();

        // Convert the InputStream into a string
        String contentAsString = readIt(is, len);
        return contentAsString;
        
    // Makes sure that the InputStream is closed after the app is
    // finished using it.
    } finally {
        if (is != null) {
            is.close();
        } 
    }
}

Обратите внимание, что метод getResponseCode() возвращает для соединения его код состояния. Это полезный способ получить дополнительную информацию о соединении. Код состояния 200 указывает на успешное завершение.

Преобразование InputStream в строку

InputStream является источником байт данных для чтения. Как только вы получите InputStream, обычно нужно декодировать или преобразовать данные к целевому типу данных. Например, если вы загружали данные изображения, вы можете декодировать и отобразить его, как показано ниже:

InputStream is = null;
...
Bitmap bitmap = BitmapFactory.decodeStream(is);
ImageView imageView = (ImageView) findViewById(R.id.image_view);
imageView.setImageBitmap(bitmap);

В примере показанном выше, InputStream представляет собой текст веб-страницы. Вот пример преобразования InputStream в строку, которую деятельность может отобразить в пользовательском интерфейсе:

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