JAX-RS Post複数のオブジェクト
メソッドがあります。
@POST
@Path("test")
@Consumes(MediaType.APPLICATION_JSON)
public void test(ObjectOne objectOne, ObjectTwo objectTwo)
これで、1つのオブジェクトをjson形式で投稿でき、それを本体に入れるだけです。しかし、複数のオブジェクトを実行することは可能ですか？もしそうなら、どのように？
答えはnoです。
理由は簡単です：メソッドで受け取ることができるパラメーターに関するこれ。それらはリクエストに関連している必要があります。右？そのため、ヘッダーまたはCookie、クエリパラメーター、マトリックスパラメーター、パスパラメーター、またはrequest bodyのいずれかでなければなりません。 （完全なストーリーを伝えるために、コンテキストと呼ばれる追加のタイプのパラメーターがあります）。
これで、リクエストでJSONオブジェクトを受け取ると、request bodyで受け取ります。リクエストにはいくつのボディがありますか？唯一無二。したがって、受信できるJSONオブジェクトは1つだけです。
できない Tarlogで正しく述べられているように、このようなメソッドを使用します。
ただし、これを行うことができます。
@POST
@Path("test")
@Consumes(MediaType.APPLICATION_JSON)
public void test(List<ObjectOne> objects)
またはこれ：
@POST
@Path("test")
@Consumes(MediaType.APPLICATION_JSON)
public void test(BeanWithObjectOneAndObjectTwo containerObject)
さらに、メソッドをGETパラメーターといつでも組み合わせることができます。
@POST
@Path("test")
@Consumes(MediaType.APPLICATION_JSON)
public void test(List<ObjectOne> objects, @QueryParam("objectTwoId") long objectTwoId)
OPが何をしようとしているのかを見ると、彼/彼女は2つの（おそらく無関係の）JSONオブジェクトをポストしようとしています。まず、1つの部分をボディとして、1つの部分を他のパラメーターであるIMOとして送信しようとするソリューションは、horribleソリューションです。 POSTデータは本文に入れる必要があります。機能しているという理由だけで何かをするのは正しくありません。回避策の中には、基本的なREST原則に違反するものがあります。
いくつかの解決策があります
- Application/x-www-form-urlencodedを使用します
- マルチパートを使用する
- それらを単一の親オブジェクトにラップするだけです
1. application/x-www-form-urlencodedを使用します
別のオプションは、application/x-www-form-urlencodedを使用することです。実際にJSON値を持つことができます。例えば
curl -v http://localhost:8080/api/model \
-d 'one={"modelOne":"helloone"}' \
-d 'two={"modelTwo":"hellotwo"}'
public class ModelOne {
public String modelOne;
}
public class ModelTwo {
public String modelTwo;
}
@Path("model")
public class ModelResource {
@POST
@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
public String post(@FormParam("one") ModelOne modelOne,
@FormParam("two") ModelTwo modelTwo) {
return modelOne.modelOne + ":" + modelTwo.modelTwo;
}
}
これを機能させるために必要なことの1つは、これを機能させるためのParamConverterProviderです。以下は、Jersey TeamのMichal Gadjosによって実装されたものです（ ここに説明あり があります）。
@Provider
public class JacksonJsonParamConverterProvider implements ParamConverterProvider {
@Context
private Providers providers;
@Override
public <T> ParamConverter<T> getConverter(final Class<T> rawType,
final Type genericType,
final Annotation[] annotations) {
// Check whether we can convert the given type with Jackson.
final MessageBodyReader<T> mbr = providers.getMessageBodyReader(rawType,
genericType, annotations, MediaType.APPLICATION_JSON_TYPE);
if (mbr == null
|| !mbr.isReadable(rawType, genericType, annotations, MediaType.APPLICATION_JSON_TYPE)) {
return null;
}
// Obtain custom ObjectMapper for special handling.
final ContextResolver<ObjectMapper> contextResolver = providers
.getContextResolver(ObjectMapper.class, MediaType.APPLICATION_JSON_TYPE);
final ObjectMapper mapper = contextResolver != null ?
contextResolver.getContext(rawType) : new ObjectMapper();
// Create ParamConverter.
return new ParamConverter<T>() {
@Override
public T fromString(final String value) {
try {
return mapper.reader(rawType).readValue(value);
} catch (IOException e) {
throw new ProcessingException(e);
}
}
@Override
public String toString(final T value) {
try {
return mapper.writer().writeValueAsString(value);
} catch (JsonProcessingException e) {
throw new ProcessingException(e);
}
}
};
}
}
リソースとプロバイダーをスキャンしていない場合は、このプロバイダーを登録するだけで、上記の例が機能するはずです。
2.マルチパートを使用する
誰も言及していない解決策の1つは、 multipart を使用することです。これにより、リクエスト内の任意の部分を送信できます。各リクエストには1つのエンティティ本体のみを含めることができるため、エンティティ本体の一部として異なる部分（独自のコンテンツタイプ）を持つことができるため、マルチパートが回避策となります。
Jerseyを使用した例を次に示します（公式ドキュメント here を参照）
依存
<dependency>
<groupId>org.glassfish.jersey.media</groupId>
<artifactId>jersey-media-multipart</artifactId>
<version>${jersey-2.x.version}</version>
</dependency>
MultipartFeatureを登録します
import javax.ws.rs.ApplicationPath;
import org.glassfish.jersey.media.multipart.MultiPartFeature;
import org.glassfish.jersey.server.ResourceConfig;
@ApplicationPath("/api")
public class JerseyApplication extends ResourceConfig {
public JerseyApplication() {
packages("stackoverflow.jersey");
register(MultiPartFeature.class);
}
}
リソースクラス
import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.glassfish.jersey.media.multipart.FormDataParam;
@Path("foobar")
public class MultipartResource {
@POST
@Consumes(MediaType.MULTIPART_FORM_DATA)
public Response postFooBar(@FormDataParam("foo") Foo foo,
@FormDataParam("bar") Bar bar) {
String response = foo.foo + "; " + bar.bar;
return Response.ok(response).build();
}
public static class Foo {
public String foo;
}
public static class Bar {
public String bar;
}
}
現在、一部のクライアントの扱いにくい部分は、上記の動作に必要なContent-Typeを各身体部分に設定する方法がないことです。マルチパートプロバイダーは、各パートのタイプに基づいてメッセージ本文リーダーを検索します。 application/jsonまたはタイプに設定されていない場合、FooまたはBarにリーダーがある場合、これは失敗します。ここではJSONを使用します。追加の設定はありませんが、リーダーを利用できます。ジャクソンを使います。以下の依存関係では、クラスパススキャンを通じてプロバイダーが検出されるため、他の構成は必要ありません。
<dependency>
<groupId>org.glassfish.jersey.media</groupId>
<artifactId>jersey-media-json-jackson</artifactId>
<version>${jersey-2.x.version}</version>
</dependency>
今テスト。 cURL を使用します。 typeで各パーツにContent-Typeを明示的に設定していることがわかります。 -Fは、異なる部分を示します。 （リクエスト本文が実際にどのように見えるかのアイデアについては、投稿の一番下を参照してください。）
curl -v -X POST \ -H "Content-Type:multipart/form-data" \ -F "bar={\"bar\":\"BarBar\"};type=application/json" \ -F "foo={\"foo\":\"FooFoo\"};type=application/json" \ http://localhost:8080/api/foobar
結果：FooFoo; BarBar
結果は予想どおりです。リソースメソッドを見ると、2つのJSONオブジェクトから収集されたこの文字列foo.foo + "; " + bar.barを返すだけです。
以下のリンクで、いくつかの異なるJAX-RSクライアントを使用したいくつかの例を見ることができます。また、これらの異なるJAX-RS実装からのサーバー側の例もいくつか表示されます。各リンクには、その実装の公式ドキュメントへのリンクが含まれている必要があります
他にもJAX-RS実装がありますが、自分でドキュメントを見つける必要があります。上記の3つだけが私が経験したものです。
Javascriptクライアントに関しては、私が見る例のほとんど（たとえば これらのいくつか は、Content-Typeをundefined/falseに設定することを含み（FormDataを使用）、ブラウザにハンドルさせます。しかし、ブラウザは各部分にContent-Typeを設定しないため、これは機能しません。デフォルトのタイプはtext/plainです。
各パーツのタイプを設定できるライブラリは確かにありますが、手動で行う方法を示すために、例を投稿します（ here 。Angularを使用しますが、エンティティボディを作成する面倒な作業は単純で古いJavascriptになります。
<!DOCTYPE html>
<html ng-app="multipartApp">
<head>
<script src="js/libs/angular.js/angular.js"></script>
<script>
angular.module("multipartApp", [])
.controller("defaultCtrl", function($scope, $http) {
$scope.sendData = function() {
var foo = JSON.stringify({foo: "FooFoo"});
var bar = JSON.stringify({bar: "BarBar"});
var boundary = Math.random().toString().substr(2);
var header = "multipart/form-data; charset=utf-8; boundary=" + boundary;
$http({
url: "/api/foobar",
headers: { "Content-Type": header },
data: createRequest(foo, bar, boundary),
method: "POST"
}).then(function(response) {
$scope.result = response.data;
});
};
function createRequest(foo, bar, boundary) {
var multipart = "";
multipart += "--" + boundary
+ "\r\nContent-Disposition: form-data; name=foo"
+ "\r\nContent-type: application/json"
+ "\r\n\r\n" + foo + "\r\n";
multipart += "--" + boundary
+ "\r\nContent-Disposition: form-data; name=bar"
+ "\r\nContent-type: application/json"
+ "\r\n\r\n" + bar + "\r\n";
multipart += "--" + boundary + "--\r\n";
return multipart;
}
});
</script>
</head>
<body>
<div ng-controller="defaultCtrl">
<button ng-click="sendData()">Send</button>
<p>{{result}}</p>
</div>
</body>
</html>
興味深い部分はcreateRequest関数です。ここで、マルチパートを構築し、各パートのContent-Typeをapplication/jsonに設定し、文字列化されたfooおよびbarオブジェクトを各パートに連結します。なじみのないマルチパート形式の場合 詳細はこちらをご覧ください 。他の興味深い部分はヘッダーです。 multipart/form-dataに設定します。
以下がその結果です。 Angularでは、$scope.result = response.dataを使用して、結果をHTMLで表示するために使用しました。表示されるボタンは、リクエストを行うためのものです。 firebug にリクエストデータも表示されます。
3.単一の親オブジェクトにラップするだけです
他の人がすでに述べたように、このオプションは自明であるべきです。
次のアプローチは通常、このような場合に適用されます。
TransferObject {
ObjectOne objectOne;
ObjectTwo objectTwo;
//getters/setters
}
@POST
@Path("test")
@Consumes(MediaType.APPLICATION_JSON)
public void test(TransferObject object){
// object.getObejctOne()....
}
Tarlogで説明されているように、2つの個別のオブジェクトを1つのPOST呼び出しに入れることはできません。
とにかく、最初の2つのオブジェクトを含む3番目のコンテナーオブジェクトを作成し、その1つをPOS呼び出し内で渡すことができます。
私もこれらの問題に直面しました。たぶんこれが役立つでしょう。
@POST
@Path("/{par}")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public Object centralService(@PathParam("par") String operation, Object requestEntity) throws JSONException {
ObjectMapper objectMapper=new ObjectMapper();
Cars cars = new Cars();
Seller seller = new Seller();
String someThingElse;
HashMap<String, Object> mapper = new HashMap<>(); //Diamond )))
mapper = (HashMap<String, Object>) requestEntity;
cars=objectMapper.convertValue(mapper.get("cars"), Cars.class);
seller=objectMapper.convertValue(mapper.get("seller"), Seller.class);
someThingElse=objectMapper.convertValue(mapper.get("someThingElse"), String.class);
System.out.println("Cars Data "+cars.toString());
System.out.println("Sellers Data "+seller.toString());
System.out.println("SomeThingElse "+someThingElse);
if (operation.equals("search")) {
System.out.println("Searching");
} else if (operation.equals("insertNewData")) {
System.out.println("Inserting New Data");
} else if (operation.equals("buyCar")) {
System.out.println("Buying new Car");
}
JSONObject json=new JSONObject();
json.put("result","Works Fine!!!");
return json.toString();
}
*******CARS POJO********@XmlRootElement for Mapping Object to XML or JSON***
@XmlRootElement
public class Cars {
private int id;
private String brand;
private String model;
private String body_type;
private String fuel;
private String engine_volume;
private String horsepower;
private String transmission;
private String drive;
private String status;
private String mileage;
private String price;
private String description;
private String picture;
private String fk_seller_oid;
} // Setters and Getters Omitted
*******SELLER POJO********@XmlRootElement for Mapping Object to XML or JSON***
@XmlRootElement
public class Seller {
private int id;
private String name;
private String surname;
private String phone;
private String email;
private String country;
private String city;
private String paste_date;
}//Setters and Getters omitted too
*********************FRONT END Looks Like This******************
$(function(){
$('#post').on('click',function(){
console.log('Begins');
$.ajax({
type:'POST',
url: '/ENGINE/cars/test',
contentType: "application/json; charset=utf-8",
dataType: "json",
data:complexObject(),
success: function(data){
console.log('Sended and returned'+JSON.stringify(data));
},
error: function(err){
console.log('Error');
console.log("AJAX error in request: " + JSON.stringify(err, null, 2));
}
}); //-- END of Ajax
console.log('Ends POST');
console.log(formToJSON());
}); // -- END of click function POST
function complexObject(){
return JSON.stringify({
"cars":{"id":"1234","brand":"Mercedes","model":"S class","body_type":"Sedan","fuel":"Benzoline","engine_volume":"6.5",
"horsepower":"1600","transmission":"Automat","drive":"Full PLag","status":"new","mileage":"7.00","price":"15000",
"description":"new car and very Nice car","picture":"mercedes.jpg","fk_seller_oid":"1234444"},
"seller":{ "id":"234","name":"Djonotan","surname":"Klinton","phone":"+994707702747","email":"[email protected]", "country":"Azeribaijan","city":"Baku","paste_date":"20150327"},
"someThingElse":"String type of element"
});
} //-- END of Complex Object
});// -- END of JQuery - Ajax
これは、POSTメソッドをオブジェクトの配列を受け入れるように宣言することで実現できます。このような例
T[] create(@RequestBody T[] objects) {
for( T object : objects ) {
service.create(object);
}
}
@Consumes（MediaType.APPLICATION_JSON）を@Consumes（{MediaType.APPLICATION_FORM_URLENCODED}）に変更すると、複数のオブジェクトを本文に配置できます