用Java實現HTTP Multipart的服務端和客戶端

今天簡單介紹一下如何用Java支持HTTP Multipart的request和response。 整個項目的代碼可以在https://github.com/mcai4gl2/multi下載。

在這個程序里，我們的業務場景很簡單。在服務端有一個隨機數生成器，可以生成隨機的Integer和Guid，客戶端通過服務，可以請求一個或多個隨機數。同時，客戶端可以向服務端發送一個或多個隨機數，這些隨機數會被加入到一個隊列中，被其他的客戶端通過請求獲得。以下是我們的隨機數Bean的定義：

 

public class RandNumber {
    private String uuid;
    private Integer number;

    public String getUuid() {
        return uuid;
    }

    public void setUuid(String uuid) {
        this.uuid = uuid;
    }

    public Integer getNumber() {
        return number;
    }

    public void setNumber(Integer number) {
        this.number = number;
    }

    @Override
    public String toString() {
        return number + " " + uuid;
    }

    public static class Builder {
        private RandNumber number;

        public Builder() {
            number = new RandNumber();
        }

        public Builder randomlyGenerate() {
            Random random = new Random();
            number.setNumber(random.nextInt(100));
            number.setUuid(UUID.randomUUID().toString());
            return this;
        }

        public Builder withNumber(int num) {
            number.setNumber(num);
            return this;
        }

        public Builder withUuid(String uuid) {
            number.setUuid(uuid);
            return this;
        }

        public RandNumber build() {
            return number;
        }
    }
}

在這個類中，我們除了定義類的基本信息，還添加了一個Builder類。通過這個Builder類，我們可以很方便的生成RandNumber類。Builder類在我們的數據類的Constructor很復雜的時候，非常有用，可以使我們的代碼更具可讀性。

 

有了這個簡單的數據類，我們繼續定義一個簡單的業務類RandomNumberGenerator，它繼承了IRandomNumberGenerator接口：

 

public interface IRandomNumberGenerator {
    RandNumber getRandomNumber();
    RandNumber[] getRandomNumbers(int num);
    void submitRandomNumber(RandNumber randNumber);
    void submitRandomNumbers(RandNumber[] randNumbers);
}

同時，我們還定義了一個RandomNumberSerializer類，它可以對我們的數據類進行JSON Serialization操作，我們的服務端和客戶端都將使用它進行通信：

 

public interface IRandomNumberSerializer {
    String serializeRandomNumber(RandNumber number);
    RandNumber deserializeRandomNumber(String input);
    void serializeRandomNumber(RandNumber number, OutputStream stream);
    RandNumber deserializeRandomNumber(InputStream stream);
    String getContentType();
}

 

RandomNumberSerializer內部使用了Gson包來進行序列化操作。在上面的接口中，我們提供了對String和Stream的兩種方法，這樣，當我們進行HTTP通信的時候，我們可以直接對Network Stream進行操作。

有了上面的這些類，我們的Servlet服務端代碼就很簡單了：

 

@Controller
public class MultiPartRequestServlet {

    private static Logger log = Logger.getLogger(MultiPartRequestServlet.class);

    @Autowired
    private IRandomNumberSerializer randomNumberSerializer;
    @Autowired
    private IRandomNumberGenerator randomNumberGenerator;

    @RequestMapping(value="/get-multi", method = RequestMethod.GET)
    public void getMultiple(
            @RequestHeader("MAX_NUM_NUMS") int maxCount,
            HttpServletRequest request,
            HttpServletResponse response,
            ServletOutputStream outputStream) throws Exception {
        log.info("multi part get is called");
        response.setStatus(HttpServletResponse.SC_OK);
        String boundary = UUID.randomUUID().toString();
        response.setContentType("multipart/x-mixed-replace;boundary=" + boundary);

        RandNumber[] numbers = randomNumberGenerator.getRandomNumbers(maxCount);

        for (int index = 0; index < maxCount; index++) {
            outputStream.println("--" + boundary);
            outputStream.println("Content-Type: " + randomNumberSerializer.getContentType());
            outputStream.println();

            outputStream.println(randomNumberSerializer.serializeRandomNumber(numbers[index]));

            outputStream.println();
        }
        outputStream.println("--" + boundary + "--");
        outputStream.flush();
        outputStream.close();
    }

    @RequestMapping(value="/submit-multi", method = RequestMethod.POST)
    public void submitMultiple(HttpServletRequest request, HttpServletResponse response) throws Exception {
        log.info("multi part submit is called");
        if (!request.getContentType().startsWith("multipart/form-data")) {
            response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
        } else {
            request.setAttribute("org.eclipse.multipartConfig",
                    new MultipartConfigElement(System.getProperty("java.io.tmpdir")));
            Collection<Part> parts = request.getParts();
            for (Part part : parts) {
                RandNumber number = randomNumberSerializer.deserializeRandomNumber(part.getInputStream());
                randomNumberGenerator.submitRandomNumber(number);
            }
            response.setStatus(HttpServletResponse.SC_OK);
        }
    }

    @RequestMapping(value="/get-one", method = RequestMethod.GET)
    public void getOne(HttpServletRequest request, HttpServletResponse response, OutputStream outputStream) throws Exception {
        log.info("get is called");
        RandNumber number = randomNumberGenerator.getRandomNumber();
        response.setStatus(HttpServletResponse.SC_OK);
        response.setContentType(randomNumberSerializer.getContentType());
        randomNumberSerializer.serializeRandomNumber(number, outputStream);
        outputStream.flush();
        outputStream.close();
    }

    @RequestMapping(value="/submit-one", method = RequestMethod.POST)
    public void submitOne(HttpServletRequest request, HttpServletResponse response) throws Exception {
        log.info("submit is called");
        RandNumber number = randomNumberSerializer.deserializeRandomNumber(request.getInputStream());
        randomNumberGenerator.submitRandomNumber(number);
        response.setStatus(HttpServletResponse.SC_OK);
    }
}

在上面的代碼中，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。

 

@Override
    public RandNumber[] getRandomNumbers(int num) {
        HttpGet httpGet = new HttpGet(getMultipleUrl);
        httpGet.setHeader("MAX_NUM_NUMS", Integer.toString(num));
        try {
            HttpResponse httpResponse = httpClient.execute(httpGet);

            if (httpResponse.getStatusLine().getStatusCode() == HttpStatus.SC_OK) {
                ByteArrayDataSource source = new ByteArrayDataSource(httpResponse.getEntity().getContent(),
                        "multipart/mixed");
                MimeMultipart multipart = new MimeMultipart(source);

                List<RandNumber> numbers = new ArrayList<RandNumber>();

                for (int index = 0; index < multipart.getCount(); index++) {
                    numbers.add(randomNumberSerializer.deserializeRandomNumber(multipart.getBodyPart(index).getInputStream()));
                }
                return numbers.toArray(new RandNumber[numbers.size()]);
            } else {
                HttpEntity httpDataEntity = httpResponse.getEntity();
                EntityUtils.consumeQuietly(httpDataEntity);
                return null;
            }
        } catch (Exception ex) {
            log.error("Failed to get multiple random numbers", ex);
            return null;
        }
    }

除了代碼，我還添加了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