spring mvc 配置xml數據格式，webservice

參考 

Http請求中Content-Type講解以及在Spring MVC中的應用

http://blog.csdn.net/blueheart20/article/details/45174399

spring mvc設置應答體的content type

http://hw1287789687.iteye.com/blog/2188480

引言： 在Http請求中，我們每天都在使用Content-type來指定不同格式的請求信息，但是卻很少有人去全面瞭解content-type中允許的值有多少，這裏將講解Content-Type的可用值，以及在spring MVC中如何使用它們來映射請求信息。

1.  Content-Type

  MediaType，即是Internet Media Type，互聯網媒體類型；也叫做MIME類型，在Http協議消息頭中，使用Content-Type來表示具體請求中的媒體類型信息。

類型格式：type/subtype(;parameter)? type
主類型，任意的字符串，如text，如果是*號代表所有；
subtype 子類型，任意的字符串，如html，如果是*號代表所有；
parameter 可選，一些參數，如Accept請求頭的q參數， Content-Type的 charset參數。

 例如： Content-Type: text/html;charset:utf-8;

 常見的媒體格式類型如下：

•     text/html ： HTML格式
•     text/plain ：純文本格式      
  
•     text/xml ：  XML格式
•     image/gif ：gif圖片格式    
  
•     image/jpeg ：jpg圖片格式 
  
•     image/png：png圖片格式

   以application開頭的媒體格式類型：

•    application/xhtml+xml ：XHTML格式
•    application/xml     ： XML數據格式
•    application/atom+xml  ：Atom XML聚合格式    
  
•    application/json    ： JSON數據格式
•    application/pdf       ：pdf格式  
  
•    application/msword  ： Word文檔格式
•    application/octet-stream ： 二進制流數據（如常見的文件下載）
•    application/x-www-form-urlencoded ： <form encType=””>中默認的encType，form表單數據被編碼爲key/value格式發送到服務器（表單默認的提交數據的格式）

   另外一種常見的媒體格式是上傳文件之時使用的：

•     multipart/form-data ： 需要在表單中進行文件上傳時，就需要使用該格式

     以上就是我們在日常的開發中，經常會用到的若干content-type的內容格式。

2.   Spring MVC中關於關於Content-Type類型信息的使用

    首先我們來看看RequestMapping中的Class定義：

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Mapping
public @interface RequestMapping {
      String[] value() default {};
      RequestMethod[] method() default {};
      String[] params() default {};
      String[] headers() default {};
      String[] consumes() default {};
      String[] produces() default {};
}

value:  指定請求的實際地址， 比如 /action/info之類。
method：  指定請求的method類型， GET、POST、PUT、DELETE等
consumes： 指定處理請求的提交內容類型（Content-Type），例如application/json, text/html;
produces:    指定返回的內容類型，僅當request請求頭中的(Accept)類型中包含該指定類型才返回
params： 指定request中必須包含某些參數值是，才讓該方法處理
headers： 指定request中必須包含某些指定的header值，才能讓該方法處理請求

其中，consumes， produces使用content-typ信息進行過濾信息；headers中可以使用content-type進行過濾和判斷。

3. 使用示例

  3.1 headers

@RequestMapping(value = "/test", method = RequestMethod.GET, headers="Referer=http://www.ifeng.com/")
public void testHeaders(@PathVariable String ownerId, @PathVariable String petId) {
  // implementation omitted
}

  這裏的Headers裏面可以匹配所有Header裏面可以出現的信息，不侷限在Referer信息。

  示例2

@RequestMapping(value = "/response/ContentType", headers = "Accept=application/json")
public void response2(HttpServletResponse response) throws IOException {
    //表示響應的內容區數據的媒體類型爲json格式，且編碼爲utf-8(客戶端應該以utf-8解碼)
    response.setContentType("application/json;charset=utf-8");
    //寫出響應體內容
    String jsonData = "{\"username\":\"zhang\", \"password\":\"123\"}";
    response.getWriter().write(jsonData);
}

服務器根據請求頭“Accept=application/json”生產json數據。

當你有如下Accept頭，將遵守如下規則進行應用：
①Accept：text/html,application/xml,application/json
      將按照如下順序進行produces的匹配 ①text/html ②application/xml ③application/json
②Accept：application/xml;q=0.5,application/json;q=0.9,text/html
      將按照如下順序進行produces的匹配 ①text/html ②application/json ③application/xml
      參數爲媒體類型的質量因子，越大則優先權越高(從0到1)
③Accept：*/*,text/*,text/html
      將按照如下順序進行produces的匹配 ①text/html ②text/* ③*/*

即匹配規則爲：最明確的優先匹配。

Requests部分

Header	解釋	示例
Accept	指定客戶端能夠接收的內容類型	Accept: text/plain, text/html
Accept-Charset	瀏覽器可以接受的字符編碼集。	Accept-Charset: iso-8859-5
Accept-Encoding	指定瀏覽器可以支持的web服務器返回內容壓縮編碼類型。	Accept-Encoding: compress, gzip
Accept-Language	瀏覽器可接受的語言	Accept-Language: en,zh
Accept-Ranges	可以請求網頁實體的一個或者多個子範圍字段	Accept-Ranges: bytes
Authorization	HTTP授權的授權證書	Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Cache-Control	指定請求和響應遵循的緩存機制	Cache-Control: no-cache
Connection	表示是否需要持久連接。（HTTP 1.1默認進行持久連接）	Connection: close
Cookie	HTTP請求發送時，會把保存在該請求域名下的所有cookie值一起發送給web服務器。	Cookie: $Version=1; Skin=new;
Content-Length	請求的內容長度	Content-Length: 348
Content-Type	請求的與實體對應的MIME信息	Content-Type: application/x-www-form-urlencoded
Date	請求發送的日期和時間	Date: Tue, 15 Nov 2010 08:12:31 GMT
Expect	請求的特定的服務器行爲	Expect: 100-continue
From	發出請求的用戶的Email	From: [email protected]
Host	指定請求的服務器的域名和端口號	Host: www.zcmhi.com
If-Match	只有請求內容與實體相匹配纔有效	If-Match: “737060cd8c284d8af7ad3082f209582d”
If-Modified-Since	如果請求的部分在指定時間之後被修改則請求成功，未被修改則返回304代碼	If-Modified-Since: Sat, 29 Oct 2010 19:43:31 GMT
If-None-Match	如果內容未改變返回304代碼，參數爲服務器先前發送的Etag，與服務器迴應的Etag比較判斷是否改變	If-None-Match: “737060cd8c284d8af7ad3082f209582d”
If-Range	如果實體未改變，服務器發送客戶端丟失的部分，否則發送整個實體。參數也爲Etag	If-Range: “737060cd8c284d8af7ad3082f209582d”
If-Unmodified-Since	只在實體在指定時間之後未被修改才請求成功	If-Unmodified-Since: Sat, 29 Oct 2010 19:43:31 GMT
Max-Forwards	限制信息通過代理和網關傳送的時間	Max-Forwards: 10
Pragma	用來包含實現特定的指令	Pragma: no-cache
Proxy-Authorization	連接到代理的授權證書	Proxy-Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Range	只請求實體的一部分，指定範圍	Range: bytes=500-999
Referer	先前網頁的地址，當前請求網頁緊隨其後,即來路	Referer: http://www.zcmhi.com/archives/71.html
TE	客戶端願意接受的傳輸編碼，並通知服務器接受接受尾加頭信息	TE: trailers,deflate;q=0.5
Upgrade	向服務器指定某種傳輸協議以便服務器進行轉換（如果支持）	Upgrade: HTTP/2.0, SHTTP/1.3, IRC/6.9, RTA/x11
User-Agent	User-Agent的內容包含發出請求的用戶信息	User-Agent: Mozilla/5.0 (Linux; X11)
Via	通知中間網關或代理服務器地址，通信協議	Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1)
Warning	關於消息實體的警告信息	Warn: 199 Miscellaneous warning

Responses 部分 

Header	解釋	示例
Accept-Ranges	表明服務器是否支持指定範圍請求及哪種類型的分段請求	Accept-Ranges: bytes
Age	從原始服務器到代理緩存形成的估算時間（以秒計，非負）	Age: 12
Allow	對某網絡資源的有效的請求行爲，不允許則返回405	Allow: GET, HEAD
Cache-Control	告訴所有的緩存機制是否可以緩存及哪種類型	Cache-Control: no-cache
Content-Encoding	web服務器支持的返回內容壓縮編碼類型。	Content-Encoding: gzip
Content-Language	響應體的語言	Content-Language: en,zh
Content-Length	響應體的長度	Content-Length: 348
Content-Location	請求資源可替代的備用的另一地址	Content-Location: /index.htm
Content-MD5	返回資源的MD5校驗值	Content-MD5: Q2hlY2sgSW50ZWdyaXR5IQ==
Content-Range	在整個返回體中本部分的字節位置	Content-Range: bytes 21010-47021/47022
Content-Type	返回內容的MIME類型	Content-Type: text/html; charset=utf-8
Date	原始服務器消息發出的時間	Date: Tue, 15 Nov 2010 08:12:31 GMT
ETag	請求變量的實體標籤的當前值	ETag: “737060cd8c284d8af7ad3082f209582d”
Expires	響應過期的日期和時間	Expires: Thu, 01 Dec 2010 16:00:00 GMT
Last-Modified	請求資源的最後修改時間	Last-Modified: Tue, 15 Nov 2010 12:45:26 GMT
Location	用來重定向接收方到非請求URL的位置來完成請求或標識新的資源	Location: http://www.zcmhi.com/archives/94.html
Pragma	包括實現特定的指令，它可應用到響應鏈上的任何接收方	Pragma: no-cache
Proxy-Authenticate	它指出認證方案和可應用到代理的該URL上的參數	Proxy-Authenticate: Basic
refresh	應用於重定向或一個新的資源被創造，在5秒之後重定向（由網景提出，被大部分瀏覽器支持）	Refresh: 5; url= http://www.zcmhi.com/archives/94.html
Retry-After	如果實體暫時不可取，通知客戶端在指定時間之後再次嘗試	Retry-After: 120
Server	web服務器軟件名稱	Server: Apache/1.3.27 (Unix) (Red-Hat/Linux)
Set-Cookie	設置Http Cookie	Set-Cookie: UserID=JohnDoe; Max-Age=3600; Version=1
Trailer	指出頭域在分塊傳輸編碼的尾部存在	Trailer: Max-Forwards
Transfer-Encoding	文件傳輸編碼	Transfer-Encoding:chunked
Vary	告訴下游代理是使用緩存響應還是從原始服務器請求	Vary: *
Via	告知代理客戶端響應是通過哪裏發送的	Via: 1.0 fred, 1.1 nowhere.com (Apache/1.1)
Warning	警告實體可能存在的問題	Warning: 199 Miscellaneous warning
WWW-Authenticate	表明客戶端請求實體應該使用的授權方案	WWW-Authenticate: Basic

3.2 params的示例

@RequestMapping(value = "/test/{userId}", method = RequestMethod.GET, params="myParam=myValue")
public void findUser(@PathVariable String userId) {
  // implementation omitted
}

  僅處理請求中包含了名爲“myParam”，值爲“myValue”的請求，起到了一個過濾的作用。

3.3 consumes/produces

@Controller
@RequestMapping(value = "/users", method = RequestMethod.POST, consumes="application/json", produces="application/json")
@ResponseBody
public List<User> addUser(@RequestBody User userl) {
    // implementation omitted
    return List<User> users;
}

  方法僅處理request Content-Type爲“application/json”類型的請求. produces標識==>處理request請求中Accept頭中包含了"application/json"的請求，同時暗示了返回的內容類型爲application/json;

4. 總結

  在本文中，首先介紹了Content-Type主要支持的格式內容，然後基於@RequestMapping標註的內容介紹了主要的使用方法，其中,headers, consumes,produces,都是使用Content-Type中使用的各種媒體格式內容，可以基於這個格式內容來進行訪問的控制和過濾。

參考資料：

1.  HTTP中支持的Content-Type: http://tool.oschina.NET/commons

2.  Media Type介紹。 http://www.iteye.com/topic/1127120

spring MVC中如何設置應答體的content type呢?

spring MVC中如何設置返回類型呢?

我們知道response 的content type主要有:

text/html

text/plain

application/json;charset=UTF-8

application/octet-stream

等

先舉一個例子,spring mvc中可以通過如下方式返回json字符串:

Java代碼  

1. @ResponseBody  
2.     @RequestMapping(value = "/upload")  
3.     public String upload(HttpServletRequest request, HttpServletResponse response,String contentType2)  
4.             throws IOException {  
5.         String content = null;  
6.         Map map = new HashMap();  
7.         ObjectMapper mapper = new ObjectMapper();  
8.   
9.         map.put("fileName", "a.txt");  
10.         try {  
11.             content = mapper.writeValueAsString(map);  
12.             System.out.println(content);  
13.         } catch (JsonGenerationException e) {  
14.             e.printStackTrace();  
15.         } catch (JsonMappingException e) {  
16.             e.printStackTrace();  
17.         } catch (IOException e) {  
18.             e.printStackTrace();  
19.         }  
20.           
21.         return content;  
22.   
23.     }  

 雖然訪問時返回的確實是json字符串,但是response 的content type是"

text/html

"這不是我們期望的,我們期望的response content type是"application/json"或者"application/json;charset=UTF-8",那麼如何實現呢?

通過註解@RequestMapping 中的produces

用法如下:

Java代碼  

1. @RequestMapping(value = "/upload",produces="application/json;charset=UTF-8")  

 spring MVC官方文檔:

Producible Media Types

You can narrow the primary mapping by specifying a list of producible media types. The request will be matched only if the Accept request header matches one of these values. Furthermore, use of the produces condition ensures the actual content type used to generate the response respects the media types specified in the producescondition. For example:

@Controller@RequestMapping(value = "/pets/{petId}", method = RequestMethod.GET, produces="application/json")@ResponseBodypublic Pet getPet(@PathVariable String petId, Model model) {    // implementation omitted}

Just like with consumes, producible media type expressions can be negated as in !text/plain to match to all requests other than those with an Accept header value oftext/plain.

Tip

The produces condition is supported on the type and on the method level. Unlike most other conditions, when used at the type level, method-level producible types override rather than extend type-level producible types.