用Java实现HTTP Multipart的服务端和客户端

今天简单介绍一下如何用Java支持HTTP Multipart的request和response。 整个项目的代码可以在https://github.com/mcai4gl2/multi下载。

在这个程序里，我们的业务场景很简单。在服务端有一个随机数生成器，可以生成随机的Integer和Guid，客户端通过服务，可以请求一个或多个随机数。同时，客户端可以向服务端发送一个或多个随机数，这些随机数会被加入到一个队列中，被其他的客户端通过请求获得。以下是我们的随机数Bean的定义：

 

[java]  view plain copy

 

1. public class RandNumber {  
2.     private String uuid;  
3.     private Integer number;  
4.   
5.     public String getUuid() {  
6.         return uuid;  
7.     }  
8.   
9.     public void setUuid(String uuid) {  
10.         this.uuid = uuid;  
11.     }  
12.   
13.     public Integer getNumber() {  
14.         return number;  
15.     }  
16.   
17.     public void setNumber(Integer number) {  
18.         this.number = number;  
19.     }  
20.   
21.     @Override  
22.     public String toString() {  
23.         return number + " " + uuid;  
24.     }  
25.   
26.     public static class Builder {  
27.         private RandNumber number;  
28.   
29.         public Builder() {  
30.             number = new RandNumber();  
31.         }  
32.   
33.         public Builder randomlyGenerate() {  
34.             Random random = new Random();  
35.             number.setNumber(random.nextInt(100));  
36.             number.setUuid(UUID.randomUUID().toString());  
37.             return this;  
38.         }  
39.   
40.         public Builder withNumber(int num) {  
41.             number.setNumber(num);  
42.             return this;  
43.         }  
44.   
45.         public Builder withUuid(String uuid) {  
46.             number.setUuid(uuid);  
47.             return this;  
48.         }  
49.   
50.         public RandNumber build() {  
51.             return number;  
52.         }  
53.     }  
54. }  

在这个类中，我们除了定义类的基本信息，还添加了一个Builder类。通过这个Builder类，我们可以很方便的生成RandNumber类。Builder类在我们的数据类的Constructor很复杂的时候，非常有用，可以使我们的代码更具可读性。

 

有了这个简单的数据类，我们继续定义一个简单的业务类RandomNumberGenerator，它继承了IRandomNumberGenerator接口：

 

[java]  view plain copy

 

1. public interface IRandomNumberGenerator {  
2.     RandNumber getRandomNumber();  
3.     RandNumber[] getRandomNumbers(int num);  
4.     void submitRandomNumber(RandNumber randNumber);  
5.     void submitRandomNumbers(RandNumber[] randNumbers);  
6. }  

同时，我们还定义了一个RandomNumberSerializer类，它可以对我们的数据类进行JSON Serialization操作，我们的服务端和客户端都将使用它进行通信：

 

[java]  view plain copy

 

1. public interface IRandomNumberSerializer {  
2.     String serializeRandomNumber(RandNumber number);  
3.     RandNumber deserializeRandomNumber(String input);  
4.     void serializeRandomNumber(RandNumber number, OutputStream stream);  
5.     RandNumber deserializeRandomNumber(InputStream stream);  
6.     String getContentType();  
7. }  

 

RandomNumberSerializer内部使用了Gson包来进行序列化操作。在上面的接口中，我们提供了对String和Stream的两种方法，这样，当我们进行HTTP通信的时候，我们可以直接对Network Stream进行操作。

有了上面的这些类，我们的Servlet服务端代码就很简单了：

 

[java]  view plain copy

 

1. @Controller  
2. public class MultiPartRequestServlet {  
3.   
4.     private static Logger log = Logger.getLogger(MultiPartRequestServlet.class);  
5.   
6.     @Autowired  
7.     private IRandomNumberSerializer randomNumberSerializer;  
8.     @Autowired  
9.     private IRandomNumberGenerator randomNumberGenerator;  
10.   
11.     @RequestMapping(value="/get-multi", method = RequestMethod.GET)  
12.     public void getMultiple(  
13.             @RequestHeader("MAX_NUM_NUMS") int maxCount,  
14.             HttpServletRequest request,  
15.             HttpServletResponse response,  
16.             ServletOutputStream outputStream) throws Exception {  
17.         log.info("multi part get is called");  
18.         response.setStatus(HttpServletResponse.SC_OK);  
19.         String boundary = UUID.randomUUID().toString();  
20.         response.setContentType("multipart/x-mixed-replace;boundary=" + boundary);  
21.   
22.         RandNumber[] numbers = randomNumberGenerator.getRandomNumbers(maxCount);  
23.   
24.         for (int index = 0; index < maxCount; index++) {  
25.             outputStream.println("--" + boundary);  
26.             outputStream.println("Content-Type: " + randomNumberSerializer.getContentType());  
27.             outputStream.println();  
28.   
29.             outputStream.println(randomNumberSerializer.serializeRandomNumber(numbers[index]));  
30.   
31.             outputStream.println();  
32.         }  
33.         outputStream.println("--" + boundary + "--");  
34.         outputStream.flush();  
35.         outputStream.close();  
36.     }  
37.   
38.     @RequestMapping(value="/submit-multi", method = RequestMethod.POST)  
39.     public void submitMultiple(HttpServletRequest request, HttpServletResponse response) throws Exception {  
40.         log.info("multi part submit is called");  
41.         if (!request.getContentType().startsWith("multipart/form-data")) {  
42.             response.setStatus(HttpServletResponse.SC_BAD_REQUEST);  
43.         } else {  
44.             request.setAttribute("org.eclipse.multipartConfig",  
45.                     new MultipartConfigElement(System.getProperty("java.io.tmpdir")));  
46.             Collection<Part> parts = request.getParts();  
47.             for (Part part : parts) {  
48.                 RandNumber number = randomNumberSerializer.deserializeRandomNumber(part.getInputStream());  
49.                 randomNumberGenerator.submitRandomNumber(number);  
50.             }  
51.             response.setStatus(HttpServletResponse.SC_OK);  
52.         }  
53.     }  
54.   
55.     @RequestMapping(value="/get-one", method = RequestMethod.GET)  
56.     public void getOne(HttpServletRequest request, HttpServletResponse response, OutputStream outputStream) throws Exception {  
57.         log.info("get is called");  
58.         RandNumber number = randomNumberGenerator.getRandomNumber();  
59.         response.setStatus(HttpServletResponse.SC_OK);  
60.         response.setContentType(randomNumberSerializer.getContentType());  
61.         randomNumberSerializer.serializeRandomNumber(number, outputStream);  
62.         outputStream.flush();  
63.         outputStream.close();  
64.     }  
65.   
66.     @RequestMapping(value="/submit-one", method = RequestMethod.POST)  
67.     public void submitOne(HttpServletRequest request, HttpServletResponse response) throws Exception {  
68.         log.info("submit is called");  
69.         RandNumber number = randomNumberSerializer.deserializeRandomNumber(request.getInputStream());  
70.         randomNumberGenerator.submitRandomNumber(number);  
71.         response.setStatus(HttpServletResponse.SC_OK);  
72.     }  
73. }  

在上面的代码中，getOne和submitOne很简单，这里我们主要讨论getMultiple和submitMultiple。在getMultiple中，我们直接操作outputStream来实现Multipart协议。而在submitMultiple中，我们则通过Servlet 3.0的getParts方法来直接获得每一个Part。需要注意的是，getParts是在Servlet 3.0中才新添加的方法，在我们部署服务的时候，我们要部署在支持Servlet 3.0的container里（在这里我对Tomcat7和Jetty8进行了测试）。同时，我们在调用getParts之前，我们对request添加了一个attribute，这个attribute只在部署在Jetty时需要。

 

下面的代码是一个简单的getMultiple的客户端，在这段代码中，我们使用Apache HttpClient来进行HTTP，我们使用了java mail中的MimeMultipart来处理服务端的repsonse。

 

[java]  view plain copy

 

1. @Override  
2.     public RandNumber[] getRandomNumbers(int num) {  
3.         HttpGet httpGet = new HttpGet(getMultipleUrl);  
4.         httpGet.setHeader("MAX_NUM_NUMS", Integer.toString(num));  
5.         try {  
6.             HttpResponse httpResponse = httpClient.execute(httpGet);  
7.   
8.             if (httpResponse.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {  
9.                 ByteArrayDataSource source = new ByteArrayDataSource(httpResponse.getEntity().getContent(),  
10.                         "multipart/mixed");  
11.                 MimeMultipart multipart = new MimeMultipart(source);  
12.   
13.                 List<RandNumber> numbers = new ArrayList<RandNumber>();  
14.   
15.                 for (int index = 0; index < multipart.getCount(); index++) {  
16.                     numbers.add(randomNumberSerializer.deserializeRandomNumber(multipart.getBodyPart(index).getInputStream()));  
17.                 }  
18.                 return numbers.toArray(new RandNumber[numbers.size()]);  
19.             } else {  
20.                 HttpEntity httpDataEntity = httpResponse.getEntity();  
21.                 EntityUtils.consumeQuietly(httpDataEntity);  
22.                 return null;  
23.             }  
24.         } catch (Exception ex) {  
25.             log.error("Failed to get multiple random numbers", ex);  
26.             return null;  
27.         }  
28.     }  

除了代码，我还添加了Maven打包配置和发布到local tomcat的脚本。整个Maven项目会被打包成两个文件，一个JAR和一个WAR。JAR打包包含了一个Jetty的服务端程序入口，和一个SampleClient的程序入口。而另一个WAR包可以直接发布到Tomcat上进行调试。这些都是为了我们可以更方便的在本地进行代码调试，在tomcat的启动脚本中，我还打开了JPDA端口，这样我们可以通过IDE对部署在Tomcat上的服务端进行调试。

 

这些基本的配置，可以大大提高我们编程调试的效率。这也是我写这篇文章的另一个原因。希望这些配置，可以帮到有需要的朋友。

原文：http://blog.csdn.net/mcai4gl2/article/details/12354945 

 相关文章：http://www.360doc.com/content/11/0809/16/1073512_139171830.shtml

转载于:https://www.cnblogs.com/langtianya/p/4005520.html