Hibernate Query Language (HQL)

Bài viết được sự cho phép của tác giả Giang Phan

Hibernate cung cấp một vài cách để thao tác dữ liệu với database như Hibernate Query Language (HQL), Hibernate Criteria Queries, Native Queries, … Trong bài viết này, tôi sẽ giới thiệu với các bạn Hibernate Query Language (HQL), trong các bài viết tiếp theo chúng ta sẽ lần lượt tìm hiểu các cách còn lại.

Hibernate là gì? Sao phải dùng nó thay JDBC?

Hibernate Cache

Giới thiệu Hibernate Query Language (HQL)

Hibernate Query Language (HQL) là một ngôn ngữ truy vấn hướng đối tượng (OOP), tương tự như SQL (Structured Query Language) nhưng thay vì làm việc trên các bảng và cột, HQL làm việc với các đối tượng persistent và các thuộc tính của chúng. Các truy vấn HQL được đổi bởi Hibernate thành các truy vấn SQL thông thường, lần lượt thực hiện các công việc trên cơ sở dữ liệu. Nhờ vậy mà nó là một ngôn ngữ truy vấn độc lập cơ sở dữ liệu, không phụ thuộc vào bất kỳ database nào.

Mặc dù, ta có thể sử dụng các câu lệnh SQL trực tiếp với Hibernate bằng cách sử dụng Native SQL. Nhưng chúng ta nên sử dụng HQL bất cứ khi nào có thể để tránh sự phức tạp về tính linh hoạt của cơ sở dữ liệu và tận dụng chiến lược generation và caching của Hibernate.

HQL sử dụng các từ khoá của SQL như FROM và WHERE, … nên chúng ta sẽ dễ dàng tìm hiểu HQL nếu đã có kiến thức về SQL.

Đặc điểm của HQL

Case Sensitivity: HQL không phân biệt hoa thường, ngoại trừ các thuộc tính như tên class, thuộc tính, tên biến có phân biệt chữ hoa chữ thường. Chẳng hạn: SeLeCT, SELECT, select là như nhau. Tuy nhiên, com.gpcoder.entities.User và com.gpcoder.entities.USER là khác nhau.

HQL From: mệnh đề From trong HQL có ý nghĩa tương đương với SQL, chúng ta cũng có thể đặt alias cho nó. Chẳng hạn: From User u, là tương đương với SELECT * From User as u.

HQL Join: HQL hỗ trợ tất cả loại join trong SQL như INNER JOIN, LEFT JOIN, RIGHT JOIN, FULL JOIN.

Aggregate Function: hỗ trợ rất nhiều aggregate function như count(*), count(distinct x), min(), max(), avg() and sum().

Expressions: chúng ta có thể sử dụng các biểu thức so sánh, tính toán trong HQL như: arithmetic expressions (+, -, *, /), omparison operators (=, >=, <=, <>, !=, like), omparison operators (=, >=, <=, <>, !=, like), …

Ngoài ra, HQL còn hỗ trợ:

Order by, group by, having, Sub-query, … tương tự như SQL.
DM (Ngôn ngữ Thao tác Dữ liệu – Data Manipulation Language): INSERT, UPDATE và DELETE là các câu lệnh DML.
DDL (Ngôn ngữ Định nghĩa Dữ liệu – Data Definition Language): CREATE, ALTER, DROP, RENAME là các câu lệnh DDL.
Thực thi store procedure.

Ví dụ sử dụng HQL

Cơ sở dữ liệu

Chúng ta sẽ sử dụng lại database ở các bài viết trước.

Tạo các Entity và các mapping

Các Entity tương ứng:

Role.java

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.ManyToMany;
import javax.persistence.Table;
import lombok.Data;
@Data
@Entity
@Table
public class Role {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    @Column
    private String name;
    
    @ManyToMany(fetch = FetchType.LAZY, mappedBy = "roles")
    private Set<User> users;
}

User.java

import java.util.Date;
import java.util.Set;
import javax.persistence.CascadeType;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.JoinTable;
import javax.persistence.ManyToMany;
import javax.persistence.OneToMany;
import javax.persistence.OneToOne;
import javax.persistence.OrderBy;
import javax.persistence.Table;
import javax.persistence.Temporal;
import javax.persistence.TemporalType;
import javax.persistence.Transient;
import lombok.Data;
@Data
@Entity(name = "User")
@Table(name = "user")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    @Column
    private String fullname;
    @Column(nullable = false, length = 255, unique = true)
    private String username;
    @Column(nullable = false)
    private String password;
    @Column(name = "created_at")
    @Temporal(value = TemporalType.TIMESTAMP)
    private Date createdAt;
    @Column(name = "modified_at")
    @Temporal(value = TemporalType.TIMESTAMP)
    private Date modifiedAt;
    @Transient
    private String additionalPropery;
    
    @OneToOne(fetch = FetchType.LAZY, mappedBy = "user", cascade = CascadeType.ALL)
    private UserProfile userProfile;
    @OneToMany(fetch = FetchType.LAZY, mappedBy = "user")
    @OrderBy("title")
    private Set<Post> posts;
    
    @ManyToMany(fetch = FetchType.LAZY, cascade = CascadeType.ALL)
    @JoinTable(name = "user_roles", 
        joinColumns = { @JoinColumn(name = "user_id", nullable = false, updatable = false) }, 
        inverseJoinColumns = { @JoinColumn(name = "role_id", nullable = false, updatable = false) })
    @OrderBy("name")
    private Set<Role> roles;
}

UserProfile.java

import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.ForeignKey;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.OneToOne;
import javax.persistence.PrimaryKeyJoinColumn;
import javax.persistence.Table;
import lombok.Data;
@Data
@Entity
@Table(name = "user_profile")
public class UserProfile {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String address;
    private Integer gender;
    @OneToOne(fetch = FetchType.LAZY)
    @PrimaryKeyJoinColumn(name = "user_id", foreignKey = @ForeignKey(name = "fk_user_profile"))
    private User user;
}

Category.java

import java.util.Set;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.OneToMany;
import javax.persistence.OrderBy;
import javax.persistence.Table;
import lombok.Data;
@Data
@Entity
@Table
public class Category {
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    @Column
    private String name;
    @OneToMany(fetch = FetchType.LAZY, mappedBy = "category")
    @OrderBy("title")
    private Set<Post> posts;
}

Post.java

import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.ForeignKey;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.ManyToOne;
import javax.persistence.Table;
import lombok.Data;
@Data
@Entity
@Table
public class Post {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String title;
    private Integer content;
    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "user_id", nullable = false, 
        foreignKey = @ForeignKey(name = "fk_post_user"))
    private User user;
    @ManyToOne(fetch = FetchType.EAGER)
    @JoinColumn(name = "category_id", nullable = false, 
        foreignKey = @ForeignKey(name = "fk_post_category"))
    private Category category;
}

Hibernate Configuration XML

Tạo file hibernate.cfg.xml và đặt nó trong thư mục srcmainresources

<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN" "http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
    <session-factory>
        <!-- Database setting -->
        <property name="connection.driver_class">com.mysql.jdbc.Driver</property>
        <property name="connection.url">jdbc:mysql://192.168.64.2:3306/gp_system?serverTimezone=UTC&amp;useUnicode=true&amp;characterEncoding=utf8</property>
        <property name="connection.username">admin</property>
        <property name="connection.password">1234567</property>
        
        <!-- JDBC connection pool (use the built-in) -->
        <property name="connection.pool_size">4</property>
        <!-- SQL dialect -->
        <property name="dialect">org.hibernate.dialect.MySQL5Dialect</property>
        <!-- Enable Hibernate's automatic session context management -->
        <property name="current_session_context_class">thread</property>
        <!-- Disable the second-level cache -->
        <property name="cache.provider_class">org.hibernate.cache.internal.NoCacheProvider</property>
        <!-- Show all executed SQL to console -->
        <property name="show_sql">true</property>
        <!-- Entity mapping -->
        <mapping class="com.gpcoder.entities.User" />
        <mapping class="com.gpcoder.entities.Role" />
        <mapping class="com.gpcoder.entities.UserProfile" />
        <mapping class="com.gpcoder.entities.Category" />
        <mapping class="com.gpcoder.entities.Post" />
        
    </session-factory>
</hibernate-configuration>

Tạo đối tượng SessionFactory

HibernateUtils.java

package com.gpcoder.utils;
 
import org.hibernate.SessionFactory;
import org.hibernate.boot.Metadata;
import org.hibernate.boot.MetadataSources;
import org.hibernate.boot.registry.StandardServiceRegistryBuilder;
import org.hibernate.service.ServiceRegistry;
 
public class HibernateUtils {
 
    private static final SessionFactory sessionFactory = buildSessionFactory();
 
    private HibernateUtils() {
        super();
    }
 
    private static SessionFactory buildSessionFactory() {
        ServiceRegistry serviceRegistry = new StandardServiceRegistryBuilder() //
                .configure() // Load hibernate.cfg.xml from resource folder by default
                .build();
        Metadata metadata = new MetadataSources(serviceRegistry).getMetadataBuilder().build();
        return metadata.getSessionFactoryBuilder().build();
    }
 
    public static SessionFactory getSessionFactory() {
        return sessionFactory;
    }
 
    public static void close() {
        getSessionFactory().close();
    }
}

Để thao tác với cơ sở dữ liệu, chúng ta cần tạo 1 đối tượng session:

try (Session session = HibernateUtils.getSessionFactory().openSession();) {
    // Begin a unit of work
    session.beginTransaction();
    // HQL
    session.getTransaction().commit();
}

Ví dụ mệnh đề FROM

Lấy danh sách User:

String hql = "FROM User";
List<User> users = session.createQuery(hql, User.class).list();

Lấy 1 user theo id là 1

String hql = "FROM User AS u WHERE u.id = :id";
User user = session.createQuery(hql, User.class).setParameter("id", 1L).uniqueResult();

Lưu ý: từ khoá AS là tuỳ chọn, chúng ta có thể không sử dụng AS để đặt alias.

Ví dụ mệnh đề SELECT

Nếu không có mệnh đề SELECT, HQL sẽ lấy tất cả các field của Entity. Chúng ta có thể giới hạn số lượng cột cần lấy sử dụng mệnh đề SELECT.

Ví dụ lấy username của 1 user

String hql = "SELECT u.username FROM User u WHERE u.id = :id";
String username = session.createQuery(hql, String.class).setParameter("id", 1L).uniqueResult();

Ví dụ mệnh đề WHERE

Tương tự như SQL, nếu bạn muốn giới hạn các đối tượng cụ thể được trả về từ cơ sở dữ liệu, ta sử dụng mệnh đề WHERE.

Ví dụ: lấy danh sách user được tạo trong tháng hiện tại:

String hql = "FROM User u WHERE month(u.createdAt) = month(sysdate())";
List<User> users = session.createQuery(hql, User.class).list();

Ví dụ mệnh đề ORDER BY

Để sắp xếp kết quả truy vấn HQL, ta sẽ sử dụng mệnh đề ORDER BY. Có thể sắp xếp các kết quả theo bất kỳ thuộc tính nào trên các đối tượng trong tập kết quả hoặc tăng dần (ASC) hoặc giảm dần (DESC).

Ví dụ: lấy danh sách user được tạo trong tháng hiện tại và sắp xếp ngảy tạo giảm dần, username tăng dần.

String hql = "FROM User u WHERE month(u.createdAt) = month(sysdate()) ORDER BY u.createdAt DESC, u.username ASC";
List<User> users = session.createQuery(hql, User.class).list();

Ví dụ mệnh đề GROUP BY

Mệnh đề này cho phép HQL lấy thông tin từ cơ sở dữ liệu và phân nhóm chúng dựa trên giá trị của thuộc tính.

Ví dụ đếm số lượng user được tạo theo mỗi tháng của năm hiện tại.

String hql = "SELECT month(createdAt) AS month, COUNT(id) AS numberOfUser FROM User WHERE year(createdAt) = year(sysdate()) GROUP BY month(createdAt) HAVING COUNT(id) > 3";
List<Object[]> result = session.createQuery(hql).list();

Ví dụ mệnh đề UPDATE

Mệnh đề UPDATE có thể được sử dụng để cập nhật một hoặc nhiều thuộc tính của một hoặc nhiều đối tượng.
Chúng ta sử dụng phương thức executeUpdate() để thực hiện các câu lệnh HQL UPDATE hoặc DELETE.

Ví dụ: update thông tin fullname và password của user có id là 1.

String hql = "UPDATE User SET fullname = :fullname, password = :password WHERE id = :id";
Query query = session.createQuery(hql);
query.setParameter("fullname", "GP CODER");
query.setParameter("password", "gpcoder.com");
query.setParameter("id", 1L);
int affectedRows = query.executeUpdate();

Ví dụ mệnh đề DELETE

Mệnh đề DELETE được sử dụng để xóa một hoặc nhiều đối tượng.

Ví dụ: xoá tất cả user được tạo trong tháng 2.

String hql = "DELETE FROM User WHERE month(createdAt) = :month";
Query query = session.createQuery(hql);
query.setParameter("month", 2);
int affectedRows = query.executeUpdate();

Ví dụ mệnh đề INSERT INTO

Mệnh đề INSERT INTO nơi mà các bản ghi có thể được insert từ một đối tượng này sang một đối tượng khác.

Ví dụ: copy tất cả user đang có và insert vào bảng user với user có prefix là “copyOf”.

String hql = "INSERT INTO User(fullname, username, password, createdAt, modifiedAt) SELECT fullname, CONCAT('copyOf', username) , password, sysdate(), sysdate() FROM User";
Query query = session.createQuery(hql);
int affectedRows = query.executeUpdate();

Ví dụ về phân trang

Có hai phương thức của giao tiếp Query cho việc phân trang:

setFirstResult(int startPosition) : xác định hàng đầu tiên trong tập kết quả cần lấy, bắt đầu với hàng 0.
setMaxResults(int maxResult) : xác định số lượng hàngcần lấy.

Ví dụ: lấy 10 user bắt đầu từ user có thứ tự thứ 5.

String hql = "FROM User ORDER BY ";
Query query = session.createQuery(hql, User.class);
query.setFirstResult(5);
query.setMaxResults(10);
List<User> users = query.list();

Ví dụ về JOIN

HQL hỗ trợ các loại JOIN tương tự như SQL.

Ví dụ: lấy thông tin user và user profile. Do thông tin profile có thể có hoặc không, nên chúng ta sẽ sử dụng LEFT JOIN.

String hql = "FROM User u LEFT JOIN u.userProfile p WHERE u.id = :id";
List<Object[]> users = session.createQuery(hql).setParameter("id", 15L).list();

Trên đây là một số giới thiệu cơ bản về HQL, các bạn có thể tham khao thêm ở các link tham khảo bên dưới.

Tài liệu tham khảo:

Bài viết gốc được đăng tải tại gpcoder.com

Có thể bạn quan tâm:

Xem thêm Việc làm IT hấp dẫn trên TopDev