JAX-RS入门 九： 内容约定（1）

通常一个SOA的应用都需要足够的灵活，以便于各种不同的客户端或平台进行集成与交互。 RESTful 服务在这方面相当有优势，因为大部分的程序语言都能够与HTTP协议间相互通信。

 

不过这还不够，为了高效的运行，不同的用户可能有不同的需求。例如Java用户端更多的希望他们的数据是xml格式的；Ajax用户端则更喜欢JSON格式；Ruby用户需要想要YAML格式。另外，有时他们还希望这些数据是经过的国际化的，这样他们可以提供翻译好的信息给不同的，例如英语、中文、日文、西班牙文或法文用户。最后，随着RESTful应用的不断发展，老用户也需要一个简单的方法来与新版本的服务进行交互。

 

HTTP协议有很多手段可以帮助解决这些集成问题。一个最强大的功能就是用户可以告诉服务器他们希望的返回格式，客户端和服务器可以约定好消息体的内容格式，例如：它是怎么编码的；它需要返回哪种语言格式等。这种协议被称为HTTP Content Negotiation（HTTP内容约定），简称conneg。 这节主要介绍conneg是怎么工作的，JAX-RS怎么支持它以及在你的应用中协调这些特性有多重要。

 

一、Conneg

 

* Media Type

  

当请求服务端信息时，用户可以指定他们希望的返回的Media Type，这是通过客户端设置的Accept 请求头来实现的，其中Accept的主体部分以逗号分隔。例如：

GET http://example.com/stuff
Accept: application/xml, application/json

上例中，客户端要求服务端以XML或JSON的格式返回对/stuff的请求。如果服务器不能提供期望的返回格式，则会得到一个406（Not Acceptable）响应码；否则服务器端选择其中的一种返回格式，将响应结果发回给客户端。

 

在Accept中还支持通配符和Media Type属性，例如：

GET http://example.com/stuff
Accept: text/*, text/html;level=1

text/*表示任何text格式。

 

* Media Type优先级

 

HTTP协议有隐式和显式选择返回的Media Type规则。

 

        > 隐式规则

隐式规则就是越具体的Media Type总是优先于越宽泛的规则，例如：

 

GET http://example.com/stuff
Accept: text/*, text/html;level=1, */*, application/xml

服务器端会假设客户端总是想要一个具体的，而不是宽泛的响应类型，因此以上Accept的Media Types的顺序如下：

1. text/html;level=1
2. application/xml
3. text/*
4. */*

因为text/html;level=1最具体的，因为排第一；然后是application/xml，因为它没有任何属性定义；然后是text/*和*/*都是宽泛定义，但是相对*/*来说，text/*更具体一些。

 

        > 显式规则

客户端也可以通过使用MIME type的q属性来指定优先顺序，q的值域为0.0到1.0，如果未指定，则缺省值被假设为1.0。例如：

 

 

GET http://example.com/stuff
Accept: text/*;q=0.9, */*;q=0.1, audio/mpeg, application/xml;q=0.5

如上的顺序为：

1. audio/mpeg
2. text/*
3. application/xml
4. */*

二、语言约定

 

客户端使用Accept-Language头来指定他们需要接收哪个语种，例如：

GET http://example.com/stuff
Accept-Language: en-us, es, fr

这里用户希望响应内容为英语、西班牙语或法语。Accept-Lauguage头使用编码格式来指定，以两个字母代码表示某种语言，其中这些代码与语言的映射在ISO-639*标准中定义；除此之处，还可以增加两个字母更具体的指定是哪个国家的那种语言，例如en-US表示美国英语。

 

另外Accept-Language头也支持q参数来指定优先级，例如：

GET http://example.com/stuff
Accept-Language: fr;q=1.0, es;q=1.0, en=0.1

对于服务器端的响应，则使用： Content-Language 。来告诉客户端返回内容的语种。 

 

 

三、压缩约定

 

为了节省带宽，HTTP协议也支持内容压缩。最通用的压缩算法就是GZIP。客户端可以指定Accept-Encoding头来指定他们支持哪种压缩算法，例如：

 

GET http://example.com/stuff
Accept-Encoding: gzip, deflate

这里客户端说他希望响应内容是以gzip压缩或者干脆是不压缩的。

 

Accept-Encoding也支持q参数，来指定选择的优先级：

 

GET http://example.com/stuff
Accept-Encoding: gzip;q=1.0, compress;0.5; deflate;q=0.1

对于服务器端的响应，则使用： Content-Encoding 。来告诉客户端返回内容的压缩算法。