Chapter 2: Annotations - @JsonTest

@JsonTest是Spring Boot提供的方便测试JSON序列化反序列化的测试工具，在Spring Boot的文档中有一些介绍。

需要注意的是@JsonTest需要Jackson的ObjectMapper，事实上如果你的Spring Boot项目添加了spring-web的Maven依赖，JacksonAutoConfiguration就会自动为你配置一个：

  1. <dependency>
  2.   <groupId>org.springframework.boot</groupId>
  3.   <artifactId>spring-boot-autoconfigure</artifactId>
  4. </dependency>
  6. <dependency>
  7.   <groupId>org.springframework</groupId>
  8.   <artifactId>spring-web</artifactId>
  9. </dependency>

这里没有提供关于日期时间的例子，关于这个比较复杂，可以看我的另一篇文章：Spring Boot Jackson对于日期时间类型处理的例子。

例子1：简单例子

源代码见SimpleJsonTest：

  1. @SpringBootTest(classes = SimpleJsonTest.class)
  2. @JsonTest
  3. public class SimpleJsonTest extends AbstractTestNGSpringContextTests {
  5.   @Autowired
  6.   private JacksonTester<Foo> json;
  8.   @Test
  9.   public void testSerialize() throws Exception {
  10.     Foo details = new Foo("Honda", 12);
  11.     // 使用通包下的json文件测试结果是否正确
  12.     assertThat(this.json.write(details)).isEqualToJson("expected.json");
  13.     // 或者使用基于JSON path的校验
  14.     assertThat(this.json.write(details)).hasJsonPathStringValue("@.name");
  15.     assertThat(this.json.write(details)).extractingJsonPathStringValue("@.name").isEqualTo("Honda");
  16.     assertThat(this.json.write(details)).hasJsonPathNumberValue("@.age");
  17.     assertThat(this.json.write(details)).extractingJsonPathNumberValue("@.age").isEqualTo(12);
  18.   }
  20.   @Test
  21.   public void testDeserialize() throws Exception {
  22.     String content = "{\"name\":\"Ford\",\"age\":13}";
  23.     Foo actual = this.json.parseObject(content);
  24.     assertThat(actual).isEqualTo(new Foo("Ford", 13));
  25.     assertThat(actual.getName()).isEqualTo("Ford");
  26.     assertThat(actual.getAge()).isEqualTo(13);
  28.   }
  30. }

例子2: 测试@JsonComponent

@JsonTest可以用来测试@JsonComponent。

这个例子里使用了自定义的@JsonComponent FooJsonComponent：

  1. @JsonComponent
  2. public class FooJsonComponent {
  4.   public static class Serializer extends JsonSerializer<Foo> {
  5.     @Override
  6.     public void serialize(Foo value, JsonGenerator gen, SerializerProvider serializers)
  7.         throws IOException, JsonProcessingException {
  8.       // ...
  9.     }
  11.   }
  13.   public static class Deserializer extends JsonDeserializer<Foo> {
  15.     @Override
  16.     public Foo deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
  17.       // ...
  18.     }
  20.   }
  22. }

测试代码JsonComponentJsonTest：

  1. @SpringBootTest(classes = { JsonComponentJacksonTest.class, FooJsonComponent.class })
  2. @JsonTest
  3. public class JsonComponentJacksonTest extends AbstractTestNGSpringContextTests {
  5.   @Autowired
  6.   private JacksonTester<Foo> json;
  8.   @Test
  9.   public void testSerialize() throws Exception {
  10.     Foo details = new Foo("Honda", 12);
  11.     assertThat(this.json.write(details).getJson()).isEqualTo("\"name=Honda,age=12\"");
  12.   }
  14.   @Test
  15.   public void testDeserialize() throws Exception {
  16.     String content = "\"name=Ford,age=13\"";
  17.     Foo actual = this.json.parseObject(content);
  18.     assertThat(actual).isEqualTo(new Foo("Ford", 13));
  19.     assertThat(actual.getName()).isEqualTo("Ford");
  20.     assertThat(actual.getAge()).isEqualTo(13);
  22.   }
  24. }

例子3: 使用@ContextConfiguration

事实上@JsonTest也可以配合@ContextConfiguration一起使用。

源代码见ThinJsonTest：

  1. @JsonTest
  2. @ContextConfiguration(classes = JsonTest.class)
  3. public class ThinJsonTest extends AbstractTestNGSpringContextTests {
  5.   @Autowired
  6.   private JacksonTester<Foo> json;
  8.   @Test
  9.   public void testSerialize() throws Exception {
  10.     // ...
  11.   }
  13.   @Test
  14.   public void testDeserialize() throws Exception {
  15.     // ...
  16.   }
  18. }

参考文档