PostMethod

一、PostMethod是什麼

PostMethod是Apache HttpClient提供的一種HTTP方法。但是，PostMethod不僅僅是一種HTTP方法，它還提供了一些有用的功能。

它提供了多種方式向服務器發送數據，並且可以發送亂碼和二進制數據。通過PostMethod，我們可以很方便地在Java中進行HTTP請求和響應的處理。

下面是PostMethod的一個基本使用示例：

import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.NameValuePair;
import org.apache.commons.httpclient.methods.PostMethod;

public class PostExample {

   public static void main(String[] args) {
       HttpClient client = new HttpClient();
       PostMethod post = new PostMethod("http://www.example.com/post.jsp");

       NameValuePair[] data = {
           new NameValuePair("username", "myusername"),
           new NameValuePair("password", "mypassword")
       };
       post.setRequestBody(data);

       try {
           client.executeMethod(post);
           System.out.println(post.getResponseBodyAsString());
       } catch (IOException e) {
           e.printStackTrace();
       } finally {
           post.releaseConnection();
       }
   }
}

二、PostMethod的主要功能

1. 發送表單數據

PostMethod是最常用的將表單數據發送到服務器的方法之一。如果您需要將表單數據發送到服務器，可以使用NameValuePair對象來設置表單字段和值。

下面是一個例子：

PostMethod post = new PostMethod("http://www.example.com/post.jsp");
NameValuePair[] data = {
   new NameValuePair("username", "myusername"),
   new NameValuePair("password", "mypassword")
};
post.setRequestBody(data);

2. 發送JSON數據

PostMethod可以使用setRequestBody(String)方法直接發送JSON數據。

下面是一個例子，顯示如何將JSON作為請求體發送：

PostMethod post = new PostMethod("http://www.example.com/post.json");
String jsonBody = "{\"name\":\"Jersey\",\"category\":\"JAX-RS\"}";
post.setRequestBody(jsonBody);

3. 發送XML數據

PostMethod可以使用setRequestBody(InputStream)方法發送XML數據。您也可以使用setRequestEntity(RequestEntity)方法發送DOM、SAX或者JAXB創建的XML內容。

PostMethod post = new PostMethod("http://www.example.com/post.xml");
InputStream requestBody = new ByteArrayInputStream("Hello world!".getBytes());
post.setRequestBody(requestBody);

4. 設置超時時間

PostMethod可以通過HttpMethod的setSoTimeout(int)方法設置超時時間。超時時間設置後，如果在指定時間內沒有收到響應，請求將會被中止。

PostMethod post = new PostMethod("http://www.example.com/post.jsp");
post.getParams().setSoTimeout(5000);

三、PostMethod的實戰應用

1. 使用PostMethod上傳文件到服務器

PostMethod可以通過MultipartRequestEntity類來上傳文件。MultipartRequestEntity類可以將多個請求實體組合成一個多部分請求實體。

PostMethod post = new PostMethod("http://www.example.com/upload");
File file = new File("/path/to/file");
Part[] parts = {
    new StringPart("text", "test"),
    new FilePart("file", file)
};
post.setRequestEntity(new MultipartRequestEntity(parts, post.getParams()));

2. 使用PostMethod發送HTTP請求，並解析響應

PostMethod可以使用getResponseBodyAsStream()方法讀取響應內容。如果您需要讀取String、JSON或XML格式的響應，請使用以下代碼示例：

PostMethod post = new PostMethod("http://www.example.com/post.jsp");
try {
   HttpClient client = new HttpClient();
   client.executeMethod(post);
   String responseBody = post.getResponseBodyAsString();
   // do something with responseBody
} catch (IOException e) {
   e.printStackTrace();
} finally {
   post.releaseConnection();
}

3. 使用PostMethod處理Cookie

PostMethod可以處理Cookie，只需將Cookie存儲在CookieStore中即可。以下是一個請求示例：

HttpClient client = new HttpClient();
CookieStore cookieStore = new BasicCookieStore();
client.setState(new HttpState(cookieStore));
PostMethod post = new PostMethod("http://www.example.com/post.jsp");

//添加Cookie  
HttpCookie httpCookie1 = new HttpCookie("Username", "Tom");
httpCookie1.setDomain("localhost"); 
httpCookie1.setPath("/");
client.getState().addCookie(httpCookie1);  
HttpCookie httpCookie2 = new HttpCookie("Password", "123");
httpCookie2.setDomain("localhost");
httpCookie2.setPath("/");
client.getState().addCookie(httpCookie2); 

NameValuePair[] data = {
   new NameValuePair("username", "myusername"),
   new NameValuePair("password", "mypassword")
};
post.setRequestBody(data);

client.executeMethod(post);

總結

PostMethod是一種非常實用的HTTP方法，可以方便地將數據發送到服務器。此外，它還提供了許多有用的功能，例如上傳文件、解析響應以及處理Cookie。使用PostMethod，我們可以輕鬆地實現客戶端與服務端之間的數據交互。