Java for Beginner

@Filter в Hibernate

Аннотация @Filter позволяет динамически применять условия фильтрации к сущностям или коллекциям на уровне базы данных. Она используется для ограничения выборки данных в зависимости от заданных параметров. Находится в пакете org.hibernate.annotations.

Параметры и настройки

Аннотация @Filter имеет следующие атрибуты:

name (обязательный, String):
Уникальное имя фильтра, которое используется для его активации/деактивации в сессии.
Пример: @Filter(name = "activeUserFilter").

condition (необязательный, String):
SQL-условие, которое добавляется в запрос при активации фильтра.
Может содержать параметры (например, :param), которые задаются во время выполнения.
Пример: @Filter(name = "activeUserFilter", condition = "is_active = :activeStatus").

deduceAliasInjectionPoints (необязательный, boolean, default = true):
Определяет, должен ли Hibernate автоматически подставлять алиасы таблиц в условие.
Если false, условие должно содержать явные алиасы.

Жизненный цикл фильтра

Объявление фильтра:
Фильтр определяется на уровне класса сущности (@Entity) или коллекции (@ElementCollection, @OneToMany и др.).

Пример:

@Entity
@FilterDef(name = "activeUserFilter", 
           condition = "is_active = :activeStatus", 
           parameters = @ParamDef(name = "activeStatus", type = boolean.class))
@Filter(name = "activeUserFilter")
public class User { ... }

Активация фильтра в сессии:
Фильтр не активен по умолчанию, его нужно включать явно в Session или EntityManager.

Пример:

session.enableFilter("activeUserFilter")
       .setParameter("activeStatus", true);

Применение в запросах:
После активации фильтр автоматически добавляет условие ко всем запросам, связанным с сущностью.
Для @OneToMany и других коллекций фильтр применяется при загрузке ассоциаций.

Деактивация фильтра:
Фильтр можно отключить:

session.disableFilter("activeUserFilter");

Механизмы Hibernate и Spring, связанные с @Filter

1. @FilterDef и @ParamDef
@FilterDef определяет фильтр и его параметры.
@ParamDef задает тип параметра (например, String, boolean).
Должен быть указан на уровне класса (обычно на @Entity или в package-info.java).

2. Интеграция с Spring Data JPA
Фильтры можно активировать в Spring-репозиториях через EntityManager:

@Repository
public class UserRepository {
    @PersistenceContext
    private EntityManager em;

    public List<User> findActiveUsers() {
        em.unwrap(Session.class)
          .enableFilter("activeUserFilter")
          .setParameter("activeStatus", true);
        return em.createQuery("FROM User", User.class).getResultList();
    }
}

3. Глобальная настройка фильтров в Spring Boot
Можно автоматически включать фильтры для всех запросов через @PostConstruct:

@Component
public class HibernateFilterConfig {
    @PersistenceContext
    private EntityManager em;

    @PostConstruct
    public void init() {
        Session session = em.unwrap(Session.class);
        session.enableFilter("activeUserFilter")
               .setParameter("activeStatus", true);
    }
}

Варианты настройки и применения

1. Фильтрация коллекций

@Entity
public class Department {
    @OneToMany(mappedBy = "department")
    @Filter(name = "activeUserFilter", condition = "is_active = :activeStatus")
    private List<User> users;
}

2. Множественные фильтры

@Entity
@FilterDef(name = "activeFilter", condition = "is_active = :active")
@FilterDef(name = "roleFilter", condition = "role = :roleName")
@Filter(name = "activeFilter")
@Filter(name = "roleFilter")
public class User { ... }

3. Динамическое управление фильтрами

// Включение разных параметров в runtime
session.enableFilter("activeUserFilter")
       .setParameter("activeStatus", true);
session.enableFilter("roleFilter")
       .setParameter("roleName", "ADMIN");

#Java #Training #Hard #Spring #Hibernate #Filter #FilterDef

143 views14:59

About

Blog

Apps

Platform