我有一个CXF RESTful服务,它同时返回XML和Json格式.我需要在RESTful服务中添加自定义http标头.这是一个示例代码片段.
@GET
@Path("/test")
@Produces("application/xml")
public Response test(
@QueryParam("p") String var
{
TestRequest req = new TestRequest();
req.setVar(var);
TestResponse res = p.getData(req);
return Response.ok(res).header("Result", res.getResult()).build();
}
上面的代码显示了设置自定义http标头“ Result”的XML响应.我可以在响应标头中看到新的http标头.到现在为止还挺好.
现在,这是Json版本,该版本在内部调用testService()方法以获取结果,然后使用google Gson API将结果发送回.一直运行良好,直到我决定返回新的标头.这是代码片段.
@GET
@Path("/test/jsonp")
public String testJSONP(
@QueryParam("p") String var,
@QueryParam("cb") String callBack
{
Response resp = test(var);
XStream xs = new XStream(new JsonHierarchicalStreamDriver());
xs.setMode(XStream.NO_REFERENCES);
xs.alias("TestResponse", TestResponse.class);
StringBuilder sb = new StringBuilder();
sb.append(callBack);
sb.append("(");
GsonBuilder gb = new GsonBuilder();
gb.registerTypeAdapter(XMLGregorianCalendar.class, new XMLGregorianCalenderSerializer());
gb.setPrettyPrinting();
Gson gson = gb.create();
sb.append(gson.toJson(resp));
sb.append(")");
return sb.toString();
}
我无法在Json响应中看到http标头.
任何反馈将不胜感激.
-谢谢
更新
我在Json方法中添加了以下代码以进行测试.
@GET
@Path("/test/jsonp")
public String testJSONP(
@QueryParam("p") String var,
@QueryParam("cb") String callBack
{
Response resp = test(var);
XStream xs = new XStream(new JsonHierarchicalStreamDriver());
xs.setMode(XStream.NO_REFERENCES);
xs.alias("TestResponse", TestResponse.class);
StringBuilder sb = new StringBuilder();
sb.append(callBack);
sb.append("(");
GsonBuilder gb = new GsonBuilder();
gb.registerTypeAdapter(XMLGregorianCalendar.class, new XMLGregorianCalenderSerializer());
gb.setPrettyPrinting();
Gson gson = gb.create();
sb.append(gson.toJson(resp));
sb.append(")");
return Response.ok(sb.toString(), MediaType.APPLICATION_JSON).header("Result", "50").build();
}
这样可以正确设置标头值,但问题是Json响应格式似乎已更改.由于这是一项现有服务,因此不允许这样做.
这是现有的回复格式
null({
"status": "Completed",
"totalResult": "252",
"bin": [
{
"type": "source",
"value": "documentation",
"ndocs": "243"
},
{
"type": "source",
"value": "wikihelp",
"ndocs": "6"
},
"entries": {
"item": [
{
"url": "http://test.com/test.htm",
"title": "XREF",
"snippet": " Test data.",
"source": "documentation",
"type": "html",
"shortDescription": "Starts the TEST command.",
"category": [
"User"
],
"publishDate": "2012-02-05T12:00:00-0500",
"lastUpdateDate": "2012-03-14T12:00:00-0400",
"topicId": "GUID-7DD70C3C-B8AD-40F1-8A69-5D1EECEAB013"
}
]
}
})
这是添加此更改后的响应
null({
"status": 200,
"entity": {
"status": "Completed",
"totalResult": "252",
"bin": [
{
"type": "source",
"value": "documentation",
"ndocs": "243"
},
{
"type": "source",
"value": "wikihelp",
"ndocs": "6"
}
],
"entries": {
"item": [
{
"url": "http://test.com/test.htm",
"title": "XREF",
"snippet": " Test data.",
"source": "documentation",
"type": "html",
"shortDescription": "Starts the TEST command.",
"category": [
"User"
],
"publishDate": "2012-02-05T12:00:00-0800",
"lastUpdateDate": "2012-03-14T12:00:00-0700",
"topicId": "GUID-7DD70C3C-B8AD-40F1-8A69-5D1EECEAB013"
}
]
}
},
"metadata": {
"Result": {
}
}
})
解决方法:
您需要更改方法的签名,以返回Response
class的实例(而不是String),然后手动构建响应.
@Path("/example")
public ExampleResource {
@GET
public Response getSomething() {
return Response.ok(/* some entity */).header("CustomHeader", "CustomValue").build();
}
}
更新资料
您还可以使用@Context注释将HttpServletResponse注入处理程序,如下所示:
@Path("/example")
public class Welcome {
@GET
public String getSomething(
@QueryParam("p1") String param1,
@QueryParam("p2") String param2,
@Context HttpServletResponse response) {
response.addHeader("CustomHeader", "CustomValue");
return "my awesome response";
}
}
请注意,有一个CXF-1498
bug in versions prior to 2.1
导致未注入HttpServletResponse,因此您需要更新的CXF版本.