Использование raw SQL в Spring Data Repository: руководство

Быстрый ответ

Конечно, это вполне возможно. Для того чтобы использовать прямые SQL-запросы в Spring, можно применять аннотацию @Query с установленным параметром nativeQuery=true. Возьмем за пример следующий код:

public interface MyRepository extends JpaRepository<MyEntity, Long> {
  
  @Query(value = "SELECT * FROM my_table WHERE my_column = :value", nativeQuery = true)
  List<MyEntity> findByColumn(@Param("value") String value);
}

И тут мы видим, что с помощью аннотации @Query выполнен нативный SQL-запрос.

Верное использование инструментов: Сценарии применения чистого SQL

Spring Data Repositories предлагает обширные возможности для выполнения стандартных операций. Но иногда возникают ситуации, когда требуется работать непосредственно с SQL.

Создание представлений: Использование проекций

Для создания специальных представлений данных моделей применяются проекции:

public interface MyEntityProjection {
  String getMyColumn();
}

Проекция в репозитории используется следующим образом:

public interface MyRepository extends JpaRepository<MyEntity, Long> {
  
  @Query(value = "SELECT my_column as myColumn FROM my_table", nativeQuery = true)
  List<MyEntityProjection> findProjectedBy();
}

Подробнее об этом расскажет наш спикер на видео

Прямой доступ с EntityManager

Если требуется более глубокий контроль, можно использовать EntityManager:

@Autowired
private EntityManager entityManager;

public List<MyEntity> customQueryMethod() {
  return entityManager.createNativeQuery("SELECT * FROM my_table", MyEntity.class).getResultList();
}

Пользовательский вывод: Маппинг массивов и классов ответов

Результаты SQL-запросов можно маппировать в массивы:

List<Object[]> results = query.getResultList();
for(Object[] result : results){
  // Обработка результатов
}

Или может быть создан специальный класс для хранения результатов:

public class CustomResponse {
  private String columnValue; // значение поля может быть любым
  
  // геттеры и сеттеры
}

List<CustomResponse> customResponses = entityManager
  .createNativeQuery("SELECT my_column FROM my_table", CustomResponse.class)
  .getResultList();

Безопасность превыше всего: Безопасность и принципы хорошей практики

Очень важно обезопасить SQL-запросы, используя параметризацию:

@Query(value = "SELECT * FROM my_table WHERE my_column = :value", nativeQuery = true)
List<MyEntity> findByColumn(@Param("value") String value);

Проверка пользовательского ввода

Всегда защищайте себя от SQL-инъекций:

try {
  // Запрос
} catch (PersistenceException e) {
  // Обработка исключения
}

Анализ производительности

Не забывайте контролировать эффективность запросов:

SELECT * FROM my_table WHERE my_column = :value LIMIT 10

Визуализация

Инструменты под рукой – это Spring Data Repositories:

🔨🔧🔩 (Базовый инструментарий)

Правила использования – это непосредственно SQL:

📜 (Инструкции)

Сочетая их, можно добиться нужных результатов:

🔨🔧🔩 + 📜 = 🏗️ (Построение индивидуальных решений)

Публикация через API-точки доступа

Ваши SQL-запросы могут быть опубликованы через API:

@RestController
public class MyController {

  @Autowired
  private MyRepository myRepository;

  @GetMapping("/search")
  public List<MyEntity> search(@RequestParam String value) {
    return myRepository.findByColumn(value);
  }
}

Полезные материалы

1. Официальное руководство по использованию аннотации @Query в Spring Data JPA.
2. Документация по интеграции Spring Framework с JDBC.
3. Расширения Spring Data JDBC, включая возможности Oracle RAC.
4. Официальная документация по работе с проекциями в Spring Data JPA.
5. Руководство по основам работы с JPA в Spring.