假设我们的服务包含以下合同:
public interface CategoryService {
public int createNew(String languageCode, String name, String descriptionMarkdown, Integer parentCategoryID, String createdByUserName) throws ServiceException;
};
如何映射int
返回类型以生成如下所示的JSON值?
PS:我知道createNew
方法必须是HTTP POST请求(注释@POST
)。假设有注释。我只需要回复表示。
{"id": 1}
答案 0 :(得分:1)
不确定这是不是一个好主意。如果您要创建新的JAX-RS资源并指定实体类来响应,那将会更好 尽管如此,如果您想将编组与模型混合,您可以编写自己的MessageBodyWriter。例如:
@Produces("application/json")
public class IntWriter implements MessageBodyWriter<Integer> {
@Override
public boolean isWriteable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
boolean intAsID = false;
for (Annotation a : annotations) {
if (a.annotationType().getCanonicalName().equals("com.blabla.IntAsID")) {
intAsID = true;
break;
}
}
return intAsID && (type == Integer.class);
}
@Override
public long getSize(Integer integer, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
return 0;
}
@Override
public void writeTo(Integer integer, Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String, Object> httpHeaders, OutputStream entityStream) throws IOException, WebApplicationException {
JsonGenerator generator = Json.createGenerator(entityStream);
generator.writeStartObject()
.write("id", integer)
.writeEnd()
.flush();
}
}
这里有几个关键点 1.
不要忘记在您的配置中注册此作者。
public class ServerConfig extends Application {
private static final Set<Class<?>> classes
= new HashSet<>();
static {
//register your resources
classes.add(Test.class);
//register message body writer
classes.add(IntWriter.class);
}
@Override
public Set<Class<?>> getClasses() {
return classes;
}
}
2
如果您不想使用此编写器,则返回每个返回int的资源。为您的资源创建一些特殊注释(例如IntAsID)。
@Retention(RetentionPolicy.RUNTIME)
public @interface IntAsID {}
不要忘记设置正确的保留政策。并在isWriteable
方法中检查此注释的存在。就像我在我的例子中所做的那样
是的,将此注释添加到您的资源中:
public interface CategoryService {
@IntAsID
public int createNew(String languageCode, String name, String descriptionMarkdown, Integer parentCategoryID, String createdByUserName) throws ServiceException;
};
3
使用@Produces
注释。这将有助于您的JAX-RS提供商在案例中不检查该作者,然后资源不应该生成JSON,而是生成其他内容。
4
不要关心getSize()
方法。它的结果现在被忽略了(至少在泽西岛)。
5
请勿entityStream
方法关闭writeTo
。