Как использовать Джексона в качестве поставщика JSON в Джерси, пользовательский объектный картограф Джексона, пользовательский картограф исключений JSON, проверить ответ JSON и т. Д.
Создайте несколько конечных точек в Джерси, и Джексон обработает преобразование объекта из/в JSON.
4.1 Создайте следующие конечные точки и верните ответ JSON.
GET /json/ , возвращает строку JSON.
ПОЛУЧИТЬ /json/{имя} , возвращает Пользователь объект, содержащий {имя} в строке JSON.
ПОЛУЧИТЬ /json/все , возвращает список Пользовательских объектов в строке JSON.
СООБЩЕНИЕ /json/создать , принимает данные JSON и возвращает статус 201 .
package com.mkyong.json;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import jakarta.ws.rs.*;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import java.util.Arrays;
import java.util.List;
@Path("/json")
public class JsonResource {
private static final ObjectMapper mapper = new ObjectMapper();
@GET
@Produces(MediaType.APPLICATION_JSON)
public Response hello() {
// create a JSON string
ObjectNode json = mapper.createObjectNode();
json.put("result", "Jersey JSON example using Jackson 2.x");
return Response.status(Response.Status.OK).entity(json).build();
}
// Object to JSON
@Path("/{name}")
@GET
@Produces(MediaType.APPLICATION_JSON)
public User hello(@PathParam("name") String name) {
return new User(1, name);
}
// A list of objects to JSON
@Path("/all")
@GET
@Produces(MediaType.APPLICATION_JSON)
public List helloList() {
return Arrays.asList(
new User(1, "mkyong"),
new User(2, "zilap")
);
}
@Path("/create")
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public Response create(User user) {
ObjectNode json = mapper.createObjectNode();
json.put("status", "ok");
return Response.status(Response.Status.CREATED).entity(json).build();
}
}
4.2 Ниже приведен объект User ; позже Джексон преобразует этот объект в/из строки JSON.
package com.mkyong.json;
public class User {
private int id;
String name;
public User() {
}
public User(int id, String name) {
this.id = id;
this.name = name;
}
// getters and setters
}
5. Запустите приложение Джерси
Запускает приложение Джерси по адресу http://localhost:8080 .
package com.mkyong;
import com.mkyong.json.JsonResource;
import org.glassfish.grizzly.http.server.HttpServer;
import org.glassfish.jersey.grizzly2.httpserver.GrizzlyHttpServerFactory;
import org.glassfish.jersey.server.ResourceConfig;
import java.io.IOException;
import java.net.URI;
import java.util.logging.Level;
import java.util.logging.Logger;
public class MainApp {
public static final URI BASE_URI = URI.create("http://localhost:8080");
// Starts Grizzly HTTP server
public static HttpServer startHttpServer() {
final ResourceConfig config = new ResourceConfig();
config.register(JsonResource.class);
// JacksonFeature for JAXB/POJO, for pure JSON, no need this JacksonFeature
// config.register(JacksonFeature.class);
return GrizzlyHttpServerFactory.createHttpServer(BASE_URI, config);
}
public static void main(String[] args) {
try {
final HttpServer server = startHttpServer();
server.start();
// shut down hook
Runtime.getRuntime().addShutdownHook(new Thread(server::shutdownNow));
System.out.println(
String.format("Application started.%nStop the application using CTRL+C"));
// block and wait shut down signal, like CTRL+C
Thread.currentThread().join();
} catch (InterruptedException | IOException ex) {
Logger.getLogger(MainApp.class.getName()).log(Level.SEVERE, null, ex);
}
}
}
6. ДЕМОНСТРАЦИЯ
Запускает Основное приложение и использует инструмент cURL для простого тестирования.
$ curl http://localhost:8080/json
{"result":"Jersey JSON example using Jackson 2.x"}
$ curl http://localhost:8080/json/mkyong
{"id":1,"name":"mkyong"}
$ curl http://localhost:8080/json/all
[{"id":1,"name":"mkyong"},{"id":2,"name":"zilap"}]
# send a POST request with JSON data
$ curl -H "Content-Type: application/json"
-X POST -d "{\"id\" : 1,\"name\" : \"mkyong\"}" http://localhost:8080/json/create
{"status":"ok"}
7. Пользовательский картограф объектов Джексона в Джерси
В приведенной выше демонстрации ответ JSON находится в компактном режиме, поведение по умолчанию Jackson ObjectMapper ; и мы можем создать пользовательское приложение Jackson ObjectMapper в Джерси, реализовав класс JAX RS ContextResolver .
7.1 Включите режим печати Jackson pretty
Ниже приведен пример, создайте пользовательский файл Jackson ObjectMapper , чтобы включить режим красивой печати.
package com.mkyong.json;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import jakarta.ws.rs.ext.ContextResolver;
import jakarta.ws.rs.ext.Provider;
// enable Jackson pretty print
@Provider
public class CustomJacksonMapperProvider
implements ContextResolver {
final ObjectMapper mapper;
public CustomJacksonMapperProvider() {
// enable pretty print
mapper = new ObjectMapper()
.enable(SerializationFeature.INDENT_OUTPUT);
}
@Override
public ObjectMapper getContext(Class type) {
return mapper;
}
}
7.2 Зарегистрируйте пользовательский сопоставитель объектов Джексона в ResourceConfig
public static HttpServer startHttpServer() {
final ResourceConfig config = new ResourceConfig();
config.register(JsonResource.class);
// register the custom Jackson mapper
config.register(CustomJacksonMapperProvider.class);
return GrizzlyHttpServerFactory.createHttpServer(BASE_URI, config);
}
7.3 Демонстрация с включенной симпатичной печатью
Снова запускает Основное приложение , и теперь ответ JSON находится в красивой строке печати.
8.2 Зарегистрируйте пользовательское исключение JsonMappingException в ResourceConfig
public static HttpServer startHttpServer() {
final ResourceConfig config = new ResourceConfig();
config.register(JsonResource.class);
config.register(CustomJacksonMapperProvider.class);
// custom ExceptionMapper
config.register(CustomJsonExceptionMapper.class);
return GrizzlyHttpServerFactory.createHttpServer(BASE_URI, config);
}
8.3 ДЕМОНСТРАЦИЯ с пользовательским исключением JsonMappingException
Снова запускает Основное приложение , и мы ОТПРАВЛЯЕМ нераспознанное поле в /json/создаем снова, и теперь Джерси вернет ваш пользовательский ответ в формате JSON.