Rivalry2

HTML Diff

0 added 0 removed

Original 2026-01-01

Modified 2026-03-10

1 Теги: spring, spring framework, personrepository, json, ajax, jackson, spring boot, spring security, persondto, доменный класс person, аннотация @jsontest, аннотация @webmvctest, personcontroller.class, mockmvc, matсher, dao/repository

2 С появлениемSpring Bootпоявилась масса возможностей для тестирования различных слоёв. Итак, у нас есть приложение c backend и UI. UI использует backend, а backend содержит следующий код:

3 // DTO для Jackson public class PersonDto { private int id; private String name; // No args constructor, getters, setters public static PersonDto toDto(Person person) { return new PersonDto() {{ setId(person.getId()); setName(person.getName()); }}; } public Person toDomain() { return new Person(id, name); } } // PersonController @RestController public class PersonController { private final PersonRepository repository; // constructor @GetMapping("/person/{id}") public PersonDto getById(@PathVariable("id") int id) { return PersonDto.toDto(personRepository.getById(id)); } @PutMapping("/person") public void update(@RequestBody PersonDto personDto) { personRepository.update(PersonDto.toDomain(personDto)); } }Данный код содержитREST контроллер, который получает и изменяет объекты Person, используяPersonRepository. Этот контроллер возвращает/принимает JSON и он будет использовать UI приложения с помощьюAJAX.

4 Также присутствует специальный классPersonDto, который будет маппиться в JSON. Этот класс нужен для того, чтобы зафиксировать формат JSON и можно было править доменный классPersonнезависимо и не изменять форматJSON, который используется на UI приложения.

5 В нашем коде не предусмотрено никакогоSpring Securityи методы должны возвращаться вне зависимости от аутентификации и авторизации.

6 <h2>Что же мы хотим протестировать и для чего?</h2>

7 Есть несколько кейсов, где тесты действительно нужны, итак: 1. Контроллер отправляет и принимаетPersonDto, а работает с доменными сущностямиPerson. Эти преобразования осуществляются с помощью статических методовPersonDtoи должны быть покрыты тестами просто по правилам приличия. 2. КонкретныйPersonDtoпреобразуется в JSON в методе получения и используется на UI. Нам хочется зафиксировать формат JSON, который будет возвращаться, чтобы при исправлениях в backend приложения мы не изменили этот формат и не поломали UI. 3. JSON с данными оPersonтакже отправляется c UI на backend, плюс хочется также проверить, что отправляемые сейчас данные будут корректно приниматься backend-ом. 4. Контроллер по идее возвращает 200 OK всегда при существующих данных, поэтому хочется зафиксировать данное поведение при каждом запросе.

8 <h2>Поехали?</h2>

9 Для тестирования статических методов, никакогоSpringBootи не надо!

10 public class PersonDtoTest { @Test public void testToDto() { PersonDto dto = PersonDto.toDto(new Person(42, "Ivan")); assertEquals(42, dto.getId()); assertEqulas("Ivan", dto.getName()); } @Test public void testToDomain() { Person domain = PersonDto.toDomain(new PersonDto() {{ setId(42); setName("Ivan"); }}; assertEquals(42, domain.getId()); assertEqulas("Ivan", domain.getName()); } }Зафиксируем теперь форматJSON, в который превращается DTO. Вот здесь и помогает SpringBoot - в данном случае аннотация@JsonTestинициализирует контекст и включаетJacksonв той конфигурации, что используется в проекте.

11 @JsonTest class PersonDtoTest { // старые методы, конечно остаются @Autowired private JacksonTester<PersonDto> json; @Test void testSerializePerson() throws Exception { Person domain = PersonDto.toDomain(new PersonDto() {{ setId(42); setName("Ivan"); }}; assertThat(this.json.write(dto)) .isStrictlyEqualToJson("simple-person.json"); } }А вот теперь пришла пора проверить, как десериализуетсяJSON. В случае сложных DTO и различных по виду запросов стоит такие фикстуры создать для каждого более-менее отличного запроса, желательно реального, взятого из браузера или из логов.

12 @JsonTest class PersonDtoTest { // старые методы, конечно остаются @Test void testDeserializePerson() throws Exception { PersonDto dto = this.json.read("person-john-smith.json").getObject(); assertEquals(123, dto.getId()); assertEquals("John smith", dto.getId()); } }А теперь осталось написать Unit-тест на контроллер. На самом деле не так просто определить зону ответственности контроллера, т. е. какой функционал покрыть тестами. Основная задача контроллера - это иметь дело с HTTP-запросами и ответами и правильно вызывать бизнес-метод. Именно это и протестируем, оставив формат зафиксированным в тесте на DTO.

13 ВSpring Bootимеется аннотация@WebMvcTest, которая позволяет писать как раз такие unit-тесты:

14 @RunWith(SpringRunner.class) @WebMvcTest(PersonController.class) public class PersonControllerTest { @MockBean private PersonRepository repository; @Autowired private MockMvc mockMvc; @Test public void testReturn200() throws Exception { given(repository.getById(any())).willReturn(new Person(42, "Ivan")); mockMvc.perform(get("/person/42") .andExpect(status().isOk()) .andExpect(content() .contentTypeCompatibleWith(MediaType.APPLICATION_JSON)); varify } }<ol><li>Здесь Spring Boot c помощью@WebMvcTest(PersonController.class) создаёт фейковое окружение с настроеннымSpring MVCи входящим в негоJackson, причём именно в том виде, в каком они настроены в реальном приложении.</li>

15 <li>Далее мы создаём запрос с помощьюmockMvc, кстати, его можно настраивать.</li>

16 <li>А далее мы пишем наборmatсher-ов, которые проверяют запрос, здесь можно проверить также и контент, и HTTP-заголовки.</li>

17 </ol>Вот такими манипуляциями можно проверить иView-слой SpringBoot приложения. А как проверитьDAO/Repository-слой, мы узнаем в следующей заметке.

18 Есть вопрос? Пишите комментарий!