Spring RestTemplate: мастерство GET-запросов для Java-разработчиков

RestTemplate restTemplate = new RestTemplate();

HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
factory.setConnectTimeout(5000); // таймаут соединения – 5 секунд
factory.setReadTimeout(5000); // таймаут чтения – 5 секунд
RestTemplate restTemplate = new RestTemplate(factory);

// Получаем объект пользователя по ID
User user = restTemplate.getForObject("https://api.example.com/users/{id}", User.class, 42);

// Если нужно передать несколько параметров, можно использовать Map
Map<String, String> params = new HashMap<>();
params.put("id", "42");
params.put("format", "json");
User user = restTemplate.getForObject("https://api.example.com/users/{id}?format={format}", User.class, params);

// Получаем полный ответ с метаданными
ResponseEntity<User> response = restTemplate.getForEntity("https://api.example.com/users/{id}", User.class, 42);

// Проверяем статус ответа
HttpStatus status = response.getStatusCode();
if (status == HttpStatus.OK) {
User user = response.getBody();
// Обрабатываем пользователя
} else if (status == HttpStatus.NOT_FOUND) {
// Пользователь не найден
}

// Получаем заголовки ответа
HttpHeaders headers = response.getHeaders();
List<String> contentType = headers.get(HttpHeaders.CONTENT_TYPE);

// Создаем заголовки запроса
HttpHeaders headers = new HttpHeaders();
headers.set("API-Key", "your-api-key");
headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON));

// Создаем HTTP-сущность
HttpEntity<?> entity = new HttpEntity<>(headers);

// Выполняем запрос с полной настройкой
ResponseEntity<User> response = restTemplate.exchange(
"https://api.example.com/users/{id}",
HttpMethod.GET,
entity,
User.class,
42
);

User user = response.getBody();

// Получение списка пользователей
ResponseEntity<List<User>> response = restTemplate.exchange(
"https://api.example.com/users",
HttpMethod.GET,
null,
new ParameterizedTypeReference<List<User>>() {}
);

List<User> users = response.getBody();

// Вариант 1: Передача параметров в виде varargs
String url = "https://api.example.com/users/{id}/posts/{status}";
User user = restTemplate.getForObject(url, User.class, "123", "published");

// Вариант 2: Использование Map для именованных параметров
Map<String, String> urlParams = new HashMap<>();
urlParams.put("id", "123");
urlParams.put("status", "published");
User user = restTemplate.getForObject(url, User.class, urlParams);

// Динамическое построение URL с параметрами запроса
UriComponentsBuilder builder = UriComponentsBuilder.fromHttpUrl("https://api.example.com/users")
.queryParam("page", 1)
.queryParam("size", 10)
.queryParam("sort", "lastName,asc");

// Можно добавлять параметры условно
if (searchTerm != null) {
builder.queryParam("search", searchTerm);
}

// Получаем готовый URL
URI uri = builder.build().encode().toUri();

List<User> users = restTemplate.getForObject(uri, List.class);

UriTemplate template = new UriTemplate("https://api.example.com/users/{id}/roles/{role}");
URI uri = template.expand("42", "admin");

User user = restTemplate.getForObject(uri, User.class);

// Создаем объект с заголовками
HttpHeaders headers = new HttpHeaders();

// Добавляем заголовок авторизации
headers.setBearerAuth("your-jwt-token");
// или
headers.set("Authorization", "Bearer your-jwt-token");

// Указываем, какой формат ответа мы ожидаем
headers.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON));

// Добавляем кастомные заголовки
headers.set("API-Version", "2.1");
headers.set("Trace-ID", UUID.randomUUID().toString());

// Создаем HttpEntity с заголовками
HttpEntity<?> entity = new HttpEntity<>(headers);

// Выполняем запрос с заголовками
ResponseEntity<User> response = restTemplate.exchange(
"https://api.example.com/users/{id}",
HttpMethod.GET,
entity,
User.class,
42
);

// Создаем интерцептор для добавления заголовков
ClientHttpRequestInterceptor headerInterceptor = (request, body, execution) -> {
HttpHeaders headers = request.getHeaders();
headers.add("API-Key", "your-api-key");
headers.add("Client-ID", "your-client-id");
return execution.execute(request, body);
};

// Применяем интерцептор к RestTemplate
RestTemplate restTemplate = new RestTemplate();
restTemplate.setInterceptors(Collections.singletonList(headerInterceptor));

// Теперь каждый запрос будет содержать заданные заголовки
User user = restTemplate.getForObject("https://api.example.com/users/{id}", User.class, 42);

// Способ 1: С помощью заголовков
HttpHeaders headers = new HttpHeaders();
headers.setBasicAuth("username", "password");

// Способ 2: Через URI
String encodedCredentials = Base64.getEncoder().encodeToString("username:password".getBytes());
URI uri = UriComponentsBuilder.fromHttpUrl("https://api.example.com/secured")
.header("Authorization", "Basic " + encodedCredentials)
.build()
.toUri();

// Способ 3: Через RestTemplateBuilder
RestTemplate restTemplate = new RestTemplateBuilder()
.basicAuthentication("username", "password")
.build();

// Простое преобразование JSON в объект
User user = restTemplate.getForObject("https://api.example.com/users/42", User.class);
System.out.println(user.getName()); // Объект уже десериализован

// Для списков и коллекций нужен ParameterizedTypeReference
ResponseEntity<List<User>> response = restTemplate.exchange(
"https://api.example.com/users",
HttpMethod.GET,
null,
new ParameterizedTypeReference<List<User>>() {}
);
List<User> users = response.getBody();

// Модель данных с аннотациями Jackson
public class UserResponse {
private List<User> users;
private Pagination pagination;

@JsonProperty("data")
public List<User> getUsers() {
return users;
}

// Вложенный класс для пагинации
public static class Pagination {
private int totalPages;
private int currentPage;

@JsonProperty("total_pages")
public int getTotalPages() {
return totalPages;
}

@JsonProperty("current")
public int getCurrentPage() {
return currentPage;
}

// Сеттеры опущены для краткости
}

// Сеттеры опущены для краткости
}

// Использование
ResponseEntity<UserResponse> response = restTemplate.getForEntity(
"https://api.example.com/users?page=1",
UserResponse.class
);

UserResponse result = response.getBody();
List<User> users = result.getUsers();
int totalPages = result.getPagination().getTotalPages();

// Создаем RestTemplate с настроенными конвертерами
RestTemplate restTemplate = new RestTemplate();

// Получаем существующие конвертеры
List<HttpMessageConverter<?>> converters = restTemplate.getMessageConverters();

// Добавляем новый конвертер (например, для XML)
converters.add(new MappingJackson2XmlHttpMessageConverter());

// Или настраиваем существующий конвертер JSON
for (HttpMessageConverter<?> converter : converters) {
if (converter instanceof MappingJackson2HttpMessageConverter) {
MappingJackson2HttpMessageConverter jsonConverter = (MappingJackson2HttpMessageConverter) converter;
ObjectMapper objectMapper = jsonConverter.getObjectMapper();

// Настраиваем ObjectMapper по необходимости
objectMapper.setPropertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE);
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
break;
}
}

ResponseEntity<String> response = restTemplate.getForEntity("https://api.example.com/users/42", String.class);
String json = response.getBody();

// Теперь можно обработать JSON вручную
ObjectMapper mapper = new ObjectMapper();
JsonNode rootNode = mapper.readTree(json);
String name = rootNode.path("name").asText();
int age = rootNode.path("details").path("age").asInt();

try {
User user = restTemplate.getForObject("https://api.example.com/users/{id}", User.class, 42);
// Обработка успешного ответа
} catch (HttpClientErrorException ex) {
// Обработка клиентских ошибок (4xx)
HttpStatus statusCode = ex.getStatusCode();
if (statusCode == HttpStatus.NOT_FOUND) {
log.error("Пользователь не найден: {}", ex.getResponseBodyAsString());
} else if (statusCode == HttpStatus.UNAUTHORIZED) {
log.error("Ошибка авторизации: {}", ex.getResponseBodyAsString());
// Возможно, обновить токен и повторить запрос
}
} catch (HttpServerErrorException ex) {
// Обработка серверных ошибок (5xx)
log.error("Серверная ошибка: {}", ex.getStatusCode());
// Возможно, повторить запрос позже
} catch (ResourceAccessException ex) {
// Обработка сетевых проблем
log.error("Ошибка сети при обращении к API: {}", ex.getMessage());
}

// Создаем свой обработчик ошибок
public class CustomErrorHandler implements ResponseErrorHandler {
@Override
public boolean hasError(ClientHttpResponse response) throws IOException {
return response.getStatusCode().is4xxClientError() || 
response.getStatusCode().is5xxServerError();
}

@Override
public void handleError(ClientHttpResponse response) throws IOException {
if (response.getStatusCode().is4xxClientError()) {
// Читаем тело ответа для анализа
String body = new String(response.getBody().readAllBytes(), StandardCharsets.UTF_8);

if (response.getStatusCode() == HttpStatus.NOT_FOUND) {
throw new ResourceNotFoundException("Ресурс не найден: " + body);
} else if (response.getStatusCode() == HttpStatus.UNAUTHORIZED) {
throw new AuthenticationException("Ошибка аутентификации: " + body);
}

throw new ClientApiException("Клиентская ошибка: " + response.getStatusCode() + ", " + body);
} else if (response.getStatusCode().is5xxServerError()) {
throw new ServerApiException("Серверная ошибка: " + response.getStatusCode());
}
}
}

// Применяем обработчик к RestTemplate
RestTemplate restTemplate = new RestTemplate();
restTemplate.setErrorHandler(new CustomErrorHandler());

// Теперь все запросы будут использовать наш обработчик ошибок
try {
User user = restTemplate.getForObject("https://api.example.com/users/{id}", User.class, 42);
} catch (ResourceNotFoundException ex) {
// Обработка отсутствия ресурса
} catch (AuthenticationException ex) {
// Обработка проблем с аутентификацией
}

RestTemplate restTemplate = new RestTemplate();
restTemplate.setErrorHandler(new ResponseErrorHandler() {
@Override
public boolean hasError(ClientHttpResponse response) throws IOException {
// Всегда возвращаем false, чтобы RestTemplate не считал никакие ответы ошибочными
return false;
}

@Override
public void handleError(ClientHttpResponse response) throws IOException {
// Не будет вызван, так как hasError всегда возвращает false
}
});

// Теперь нужно самостоятельно проверять статус ответа
ResponseEntity<User> response = restTemplate.getForEntity("https://api.example.com/users/{id}", User.class, 42);
HttpStatusCode status = response.getStatusCode();
if (status.is2xxSuccessful()) {
User user = response.getBody();
// Обработка успешного ответа
} else if (status == HttpStatus.NOT_FOUND) {
// Обработка отсутствия ресурса
}

// Настройка политики повторов
RetryTemplate retryTemplate = new RetryTemplate();
SimpleRetryPolicy retryPolicy = new SimpleRetryPolicy();
retryPolicy.setMaxAttempts(3);
retryTemplate.setRetryPolicy(retryPolicy);

// Настройка задержек между повторами (экспоненциальная)
ExponentialBackOffPolicy backOffPolicy = new ExponentialBackOffPolicy();
backOffPolicy.setInitialInterval(1000); // 1 секунда
backOffPolicy.setMultiplier(2); // Каждая следующая задержка в 2 раза больше
backOffPolicy.setMaxInterval(10000); // Максимум 10 секунд
retryTemplate.setBackOffPolicy(backOffPolicy);

// Выполнение запроса с повторами
User user = retryTemplate.execute(context -> {
return restTemplate.getForObject(
"https://api.example.com/users/{id}",
User.class,
42
);
});

HttpComponentsClientHttpRequestFactory factory = new HttpComponentsClientHttpRequestFactory();
factory.setConnectTimeout(5000); // Таймаут соединения – 5 секунд
factory.setConnectionRequestTimeout(5000); // Таймаут запроса соединения из пула
factory.setReadTimeout(15000); // Таймаут чтения – 15 секунд

RestTemplate restTemplate = new RestTemplate(factory);