REST/Java'da iyi uygulamalar

Question

Şu anda REST'de ve özellikle "iyi" Rest, hipermedia ve onunla birlikte gelen tüm iyi uygulamalarda beceriler edinmeye çalışıyorum.

Bunu yapmak için, seçimimden veri içeren bir prototip REST sunucusu geliştirmem ve daha sonra gelen gerçek bir projede kullanmak zorunda olduğum herşeyi hayata geçirmem istendi. Bu yüzden json kullanımı için Spring boot ve Jackson kullanarak bir sunucu yaptım.

Benim veri mimarisi bu yakındır: Ben kusursuz

{ "name":"Ariane V","country":"Europe","firstFlight":null,"GTO_Payload":1.0,"LEO_Payload":2.3,"weight":136.0 } 

şey JSON nesnesi alabilir Ariane V Falcon 9, vb gibi (Boşluğu = D gibi) LaunchVehicle bir koleksiyona sahip Benim LaunchVehicle'ımın içinde, bazı Dizeleri ve Şamandıraları içeren bir nesne olacak bir "uzay ajansı" alanı eklemek istiyorum. Ancak, istemci bir LaunchVehicle aldığında, onun tam SpaceAgency nesnesini almasını istemiyorum, sadece adın adı. Buradan, uzay ajansının bağlantısını, alacağı yanıtta yer alan bir hiper medya bağlantısıyla takip edebilecekti.

Bunu nasıl yapabilirim? Şu anda yalnızca SpaceAgency nesnesi ve tüm alanları ile tam LaunchVehicle nesnesini istemciye gönderebiliyorum. İstediğimi yapan herhangi bir ek açıklama var mı? Teşekkürler;)

public class LaunchVehicle { 


    private String name; 
    private String country; 
    private Date firstFlight; 
    private Map<String, Float> characteristics; 
    private SpaceAgency spaceAgency; 

    @JsonCreator 
    constructor... 

    @JsonProperty(required=false) 
    getters and setters... 

} 

Çok teşekkür ederim, yeterince hassas veya anlaşılır değilse tereddüt etmeyin.

Answer 1

sınıf düzeyinde @JsonIgnoreProperties ek açıklama deneyin. Bu size istediğiniz özelliği sağlamalıdır. Aksi takdirde, yanıt modelinizi oluşturmak için her zaman bir çeşit DTO nesnesi kullanabilirsiniz ve yalnızca API katmanında kullanılacak alanlar vardır.

API katmanınız için uygun bir DTO/ApiModel kullanıp JSON ek açıklamaları içeren tam bir etki alanı nesnesine sahip olmayı tercih ederim.

Answer 2

Eğer SpaceAgency sınıfınız sadece serileştirmek için gereksinim duyduğunuz özellikleri tanımlarsa, Jackson bunları sadece yeniden seri hale getirecektir. Eşlenmemiş özellikleri unutacak.

Answer 3

Bu

JsonParser parser = new JsonParser(); 
JsonObject obj = parser.parse(spaceAgency).getAsJsonObject(); 
String agencyName = obj.get("agencyName").getAsString(); 

Answer 4

deneyin jax-ws-rs için GSON API kullanabilirsiniz! Java'da standart bir REST uygulaması.

Oracle docs

Very good tutorial by Mkyong

Answer 5

Uzay ajansına bir köprü olarak başvurmanız gerektiğini düşünüyorum. Eğer veri aktarım nesnesi bağlantıyı belirtmek gerekir

{ "name":"Ariane V", 
    "country":"Europe", 
    < other fields omitted > 
    "_links": { 
    "agency": { "href": "agencies/ESA" }, 
    < other links omitted > 
    } 
} 

Bunu başarmak için: gibi

Yani JSON bakacağız. Bunu, bu türden bir nesneye gönderme yapmayın - bunu yapmak, istemciyi istemese bile bu nesneyi doldurmak anlamına gelir.

Bunu nasıl başardığınız, kullandığınız teknolojiye göre değişir.Jersey'de "gerçek" DİNLENME tüm hakkında ne olduğunu böyle Bağlama

public class LaunchVehicle { 
    ... 
    @InjectLink(resource=AgencyResource.class) 
    URI agencyLink; 
    ... 
} 

https://jersey.java.net/documentation/latest/declarative-linking.html

bu. Ancak, gerçek dünyadaki birçok çözümün aslında hiper bağlantıları kullanmadan REST yaptığını iddia ettiğini unutmayın. JSON'nuzda String agencyId alanına sahip olmak daha kolay bir çözüm olacaktır. Bu, ajans ayrıntılarını almak için bir URL şablonuna yerleştirilebilir.