Best Practices for Sending Bitmap Files via POST with HttpURLConnection in Android

Introduction

In Android development, HttpURLConnection is recommended for HTTP operations, making file sending a common task. This article focuses on a reliable implementation for sending bitmap files via POST requests, avoiding unnecessary complexities such as cookies or authentication.

Core Implementation Steps: Using HttpURLConnection

The key to sending files is using the multipart/form-data content type. Here is a step-by-step guide based on the best answer.

Setting Up Request Parameters

First, initialize the HttpURLConnection and set necessary properties, ensuring the use of POST method and output stream.

HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("POST");
connection.setDoOutput(true);
connection.setRequestProperty("Content-Type", "multipart/form-data;boundary=*****");

In this code, the boundary string is used to define separators for multipart data; ensure it is unique.

Converting Bitmap to Byte Array

To avoid saving the bitmap to a file, convert it to a byte array. For example, for a black-and-white bitmap, use the following code for conversion.

byte[] pixels = new byte[bitmap.getWidth() * bitmap.getHeight()];
for (int i = 0; i < bitmap.getWidth(); ++i) {
    for (int j = 0; j < bitmap.getHeight(); ++j) {
        pixels[i * bitmap.getHeight() + j] = (byte) ((bitmap.getPixel(i, j) & 0x80) >> 7);
    }
}

Note that the original answer had an indexing error, corrected here as pixels[i * bitmap.getHeight() + j] for improved accuracy.

Writing the Request Body

Use a DataOutputStream to write the multipart data to the request body, including boundaries and content.

DataOutputStream request = new DataOutputStream(connection.getOutputStream());
request.writeBytes("--*****\r\n");
request.writeBytes("Content-Disposition: form-data; name=\"bitmap\";filename=\"bitmap.bmp\"\r\n");
request.writeBytes("\r\n");
request.write(pixels);
request.writeBytes("\r\n");
request.writeBytes("--*****--\r\n");
request.flush();
request.close();

Handling Server Response

After sending the request, read the server's response stream to obtain the result.

InputStream responseStream = connection.getInputStream();
BufferedReader reader = new BufferedReader(new InputStreamReader(responseStream));
StringBuilder response = new StringBuilder();
String line;
while ((line = reader.readLine()) != null) {
    response.append(line).append("\n");
}
reader.close();
connection.disconnect();

Supplementary Method: Using MultipartEntity

As a supplementary approach, Apache HttpClient's MultipartEntity can simplify the process, but note that HttpClient is deprecated in newer Android versions, so HttpURLConnection is recommended.

Example code:

MultipartEntity reqEntity = new MultipartEntity();
ByteArrayBody contentPart = new ByteArrayBody(bitmapBytes, "filename.png");
reqEntity.addPart("picture", contentPart);
// Then use similar connection setup and write reqEntity to the output stream.

Best Practices and Considerations

In Android, network operations should avoid execution on the main thread to prevent blocking the user interface. It is advisable to use AsyncTask or other concurrency mechanisms.

Additionally, handle exceptions properly and ensure streams and connections are closed to avoid resource leaks. The methods described in this article are based on Q&A data, aiming to provide a logical and easy-to-understand implementation.