在上一篇文章中 ，我們研究了使用MOXy的功能來(lái)控制特定實(shí)體的數(shù)據(jù)輸出級(jí)別。 這篇文章著眼于Jersey 2.x提供的抽象，它允許您定義一組自定義的批注以具有相同的效果。

與之前一樣，我們幾乎沒(méi)有什么瑣碎的資源可以返回Jersey將為我們轉(zhuǎn)換為JSON的對(duì)象，請(qǐng)注意，目前此代碼中沒(méi)有任何內(nèi)容可以進(jìn)行過(guò)濾-我不會(huì)將注釋傳遞給
Response對(duì)象，如Jersey示例中所示：

import javax.ws.rs.GET; import javax.ws.rs.Path; import javax.ws.rs.Produces;@Path("hello") public class SelectableHello {@GET@Produces({ "application/json; level=detailed", "application/json; level=summary", "application/json; level=normal" })public Message hello() {return new Message();} }

在我的設(shè)計(jì)中，我將定義四個(gè)注釋： NoView ， SummaryView ， NormalView和DetailedView 。 所有根對(duì)象都必須實(shí)現(xiàn)NoView注釋，以防止暴露未注釋的字段-您可能覺(jué)得在設(shè)計(jì)中沒(méi)有必要。 所有這些類(lèi)看起來(lái)都一樣，所以我只顯示一個(gè)。 請(qǐng)注意，創(chuàng)建AnnotationLiteral的工廠方法必須優(yōu)先于創(chuàng)建動(dòng)態(tài)代理以具有相同效果的工廠使用。 2.5中有代碼，將忽略由java.lang.reflect.Proxy對(duì)象實(shí)現(xiàn)的任何注釋，其中包括您可能從類(lèi)中檢索到的所有注釋。 我正在為此提交修復(fù)程序。

import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target;import javax.enterprise.util.AnnotationLiteral;import org.glassfish.jersey.message.filtering.EntityFiltering;@Target({ ElementType.TYPE, ElementType.METHOD, ElementType.FIELD }) @Retention(RetentionPolicy.RUNTIME) @Documented @EntityFiltering public @interface NoView {/*** Factory class for creating instances of the annotation.*/public static class Factory extends AnnotationLiteral<NoView> implements NoView {private Factory() {}public static NoView get() {return new Factory();}}}

現(xiàn)在我們可以快速瀏覽一下Message Bean，這比我以前的示例稍微復(fù)雜一點(diǎn)，以非常簡(jiǎn)單的形式顯示子圖的過(guò)濾。 正如我之前說(shuō)過(guò)的那樣，在類(lèi)的根部使用NoView注釋進(jìn)行注釋–這應(yīng)該意味著privateData不會(huì)返回給客戶端，因?yàn)樗鼪](méi)有特別地注釋。

import javax.xml.bind.annotation.XmlRootElement;@XmlRootElement @NoView public class Message {private String privateData;@SummaryViewprivate String summary;@NormalViewprivate String message;@DetailedViewprivate String subtext;@DetailedViewprivate SubMessage submessage;public Message() {summary = "Some simple summary";message = "This is indeed the message";subtext = "This is the deep and meaningful subtext";submessage = new SubMessage();privateData = "The fox is flying tonight";}// Getters and setters not shown }public class SubMessage {private String message;public SubMessage() {message = "Some sub messages";}// Getters and setters not shown }

如前所述，資源類(lèi)中沒(méi)有代碼可以處理過(guò)濾–我認(rèn)為這是一個(gè)橫切關(guān)注點(diǎn)，因此我將其抽象為WriterInterceptor。 請(qǐng)注意，如果使用的實(shí)體上沒(méi)有NoView批注，則會(huì)拋出該異常。

import java.io.IOException;import java.lang.annotation.Annotation;import java.util.Arrays; import java.util.LinkedHashSet; import java.util.Set;import javax.ws.rs.ServerErrorException; import javax.ws.rs.WebApplicationException; import javax.ws.rs.core.Context; import javax.ws.rs.core.HttpHeaders; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import javax.ws.rs.ext.Provider; import javax.ws.rs.ext.WriterInterceptor; import javax.ws.rs.ext.WriterInterceptorContext;@Provider public class ViewWriteInterceptor implements WriterInterceptor {private HttpHeaders httpHeaders;public ViewWriteInterceptor(@Context HttpHeaders httpHeaders) {this.httpHeaders = httpHeaders;}@Overridepublic void aroundWriteTo(WriterInterceptorContext writerInterceptorContext) throws IOException,WebApplicationException {// I assume this case will never happen, just to be sureif (writerInterceptorContext.getEntity() == null) {writerInterceptorContext.proceed();return;}else{Class<?> entityType = writerInterceptorContext.getEntity().getClass();String entityTypeString = entityType.getName();// Ignore any Jersey system classes, for example wadl//if (entityType == String.class || entityType.isArray() || entityTypeString.startsWith("com.sun") || entityTypeString.startsWith("org.glassfish")) {writerInterceptorContext.proceed();return;}// Fail if the class doesn't have the default NoView annotation // this prevents any unannotated fields from showing up//else if (!entityType.isAnnotationPresent(NoView.class)) {throw new ServerErrorException("Entity type should be tagged with @NoView annotation " + entityType, Response.Status.INTERNAL_SERVER_ERROR);}}// Get hold of the return media type://MediaType mt = writerInterceptorContext.getMediaType();String level = mt.getParameters().get("level");// Get the annotations and modify as required//Set<Annotation> current = new LinkedHashSet<>();current.addAll(Arrays.asList(writerInterceptorContext.getAnnotations()));switch (level != null ? level : "") {default:case "detailed":current.add(com.example.annotation.DetailedView.Factory.get());case "normal":current.add(com.example.annotation.NormalView.Factory.get());case "summary":current.add(com.example.annotation.SummaryView.Factory.get());}writerInterceptorContext.setAnnotations(current.toArray(new Annotation[current.size()]));//writerInterceptorContext.proceed();} }

最后，您必須手動(dòng)啟用EntityFilterFeature，為此，您可以在Application類(lèi)中簡(jiǎn)單地注冊(cè)它

import java.lang.annotation.Annotation;import javax.ws.rs.ApplicationPath;import org.glassfish.jersey.message.filtering.EntityFilteringFeature; import org.glassfish.jersey.server.ResourceConfig;@ApplicationPath("/resources/") public class SelectableApplication extends ResourceConfig {public SelectableApplication() {packages("...");// Set entity-filtering scope via configuration.property(EntityFilteringFeature.ENTITY_FILTERING_SCOPE, new Annotation[] {NormalView.Factory.get(), DetailedView.Factory.get(), NoView.Factory.get(), SummaryView.Factory.get()});register(EntityFilteringFeature.class);}}

一旦一切就緒并運(yùn)行，應(yīng)用程序?qū)⑾褚郧耙粯禹憫?yīng)：

GET .../hello Accept application/json; level=detailed or application/json {"message" : "This is indeed the message","submessage" : {"message" : "Some sub messages"},"subtext" : "This is the deep and meaningful subtext","summary" : "Some simple summary" }GET .../hello Accept application/json; level=normal {"message" : "This is indeed the message","summary" : "Some simple summary" }GET .../hello Accept application/json; level=summary {"summary" : "Some simple summary" }

這是直接使用MOXy批注的更好選擇–使用自定義批注應(yīng)該更容易將應(yīng)用程序移植到過(guò)度實(shí)現(xiàn)中，即使您必須提供自己的過(guò)濾器也是如此。 最后，值得探討的是Jersey擴(kuò)展，它允許基于角色的篩選 ，我認(rèn)為這在安全方面很有用。

參考： 通過(guò)改變內(nèi)容類(lèi)型來(lái)選擇返回的詳細(xì)程度，第二部分來(lái)自我們的JCG合作伙伴 Gerard Davison，位于Gerard Davison的博客博客中。

翻譯自: https://www.javacodegeeks.com/2014/02/selecting-level-of-detail-returned-by-varying-the-content-type-part-ii.html

總結(jié)

以上是生活随笔為你收集整理的选择通过更改内容类型返回的详细程度，第二部分的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。