Station D Logo

Hibernate Interceptor & StatementInspector

Công Nghệ
Hibernate Interceptor & StatementInspector
Bài viết được sự cho phép của tác giả Giang Phan 1. Hibernate Interceptor 1.1. Hibernate Interceptor là gì? Interceptor là một tính năng rất hữu ích cho ứng dụng để kiểm soát đối tượng với các sự kiện nhất định xảy ra bên trong Hibernate. Một đối tượng đi qua các giai đoạn khác nhau trong lifecycle của nó. Interface Interceptor trong Hibernate cung cấp các phương thức có thể được gọi ở các giai đoạn khác nhau, để thực hiện một số nhiệm vụ được yêu cầu. Các Interceptor được đăng ký dưới dạng callback và cung cấp các liên kết liên lạc giữa session và application của Hibernate. Với một callback như vậy, một ứng dụng có thể kiểm tra và thay đổi các thuộc tính của một đối tượng persistent trước khi nó được save, update, delete or load. Hibernate là gì? Sao phải dùng nó thay JDBC? Kiểm tra tính hợp lệ của dữ liệu đầu vào form Spring Web MVC bởi Hibernate Validator Có 2 cách để tạo một Interceptor: Implement org.hibernate.Interceptor interface. extend org.hibernate.EmptyInterceptor class. Nếu không có yêu cầu đặc biệt, chúng ta nên extends class EmptyInterceptor và chỉ override các phương thức được yêu cầu. Interface org.hibernate.Interceptor bao gồm các phương thức sau: instantiate() : Phương thức này được gọi khi một lớp persistent được khởi tạo. onLoad() : Phương thức này được gọ khi một đối tượng được load từ database và khởi tạo. onSave() : Phương thức này được gọ khi một đối tượng được lưu. onDelete() : Phương thức này được gọi khi một đối tượng bị xóa. preFlush() : Phương thức này được gọi trước khi flush. postFlush() : Phương thức này được gọi sau khi flush và một đối tượng đã được update trong bộ nhớ....

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

1. Hibernate Interceptor

1.1. Hibernate Interceptor là gì?

Interceptor là một tính năng rất hữu ích cho ứng dụng để kiểm soát đối tượng với các sự kiện nhất định xảy ra bên trong Hibernate.

Một đối tượng đi qua các giai đoạn khác nhau trong lifecycle của nó. Interface Interceptor trong Hibernate cung cấp các phương thức có thể được gọi ở các giai đoạn khác nhau, để thực hiện một số nhiệm vụ được yêu cầu.

Các Interceptor được đăng ký dưới dạng callback và cung cấp các liên kết liên lạc giữa session và application của Hibernate. Với một callback như vậy, một ứng dụng có thể kiểm tra và thay đổi các thuộc tính của một đối tượng persistent trước khi nó được save, update, delete or load.

Có 2 cách để tạo một Interceptor:

  • Implement org.hibernate.Interceptor interface.
  • extend org.hibernate.EmptyInterceptor class.

Nếu không có yêu cầu đặc biệt, chúng ta nên extends class EmptyInterceptor và chỉ override các phương thức được yêu cầu.

Interface org.hibernate.Interceptor bao gồm các phương thức sau:

  • instantiate() : Phương thức này được gọi khi một lớp persistent được khởi tạo.
  • onLoad() : Phương thức này được gọ khi một đối tượng được load từ database và khởi tạo.
  • onSave() : Phương thức này được gọ khi một đối tượng được lưu.
  • onDelete() : Phương thức này được gọi khi một đối tượng bị xóa.
  • preFlush() : Phương thức này được gọi trước khi flush.
  • postFlush() : Phương thức này được gọi sau khi flush và một đối tượng đã được update trong bộ nhớ.
  • isUnsaved() : Phương thức này được gọi khi một đối tượng được truyền vào phương thức saveOrUpdate() .
  • findDirty() : Phương thức này được gọi khi phương thức flush() được gọi trên một đối tượng Session.
  • onFlushDirty() : Phương thức này được gọi khi Hibernate phát hiện ra rằng một đối tượng là dirty (tức là đã được thay đổi) trong quá trình flush.
  • Ngoài ra còn nhiều phương thức khác, các bạn tham khảo thêm Hibernate Interceptor javadoc.

Một Interceptor có thể được sử dụng ở: Session hoặc SessionFactory scope.

1.2. Ví dụ sử dụng Hibernate Interceptor

1.2.1. Create Interceptor

package com.gpcoder;

import com.gpcoder.entities.Tag;
import lombok.extern.log4j.Log4j2;
import org.hibernate.EmptyInterceptor;
import org.hibernate.type.Type;

import java.io.Serializable;
import java.util.Arrays;
import java.util.Iterator;

@Log4j2
public class LoggingInterceptor extends EmptyInterceptor {

@Override
public String onPrepareStatement(String sql) {
log.debug("onPrepareStatement: {}", sql);
return super.onPrepareStatement(sql);
}

@Override
public boolean onSave(Object entity, Serializable id, Object[] state, String[] propertyNames, Type[] types) {
log.debug("onSave: {}", entity);
return super.onSave(entity, id, state, propertyNames, types);
}

@Override
public void preFlush(Iterator entities) {
log.debug("preFlush: {}", entities.next());
super.preFlush(entities);
}

@Override
public void postFlush(Iterator entities) {
log.debug("postFlush: {}", entities.next());
super.postFlush(entities);
}
}

1.2.2. Register Interceptor

Cấu hình Interceptor ở mức Session:

Session session = sessionFactory
.withOptions()
.interceptor(new LoggingInterceptor() )
.openSession();

Trường hợp muốn cấu hình Interceptor ở mức SessionFactory, nghĩa là tất cả Session đều áp dụng Interceptor này:

package com.gpcoder.utils;

import com.gpcoder.LoggingInterceptor;
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()
.applyInterceptor( new LoggingInterceptor() ) // Register interceptor
.build();
}

public static SessionFactory getSessionFactory() {
return sessionFactory;
}

public static void close() {
getSessionFactory().close();
}
}

Trong trường hợp muốn đảm bảo thread-safe, chúng ta cần xác định session context trong file hibernate.cfg.xml:

<property name="current_session_context_class">org.hibernate.context.internal.ThreadLocalSessionContext</property>

1.2.3. Tạo lớp ứng dụng

package com.gpcoder;

import com.gpcoder.entities.Tag;
import com.gpcoder.utils.HibernateUtils;
import lombok.extern.log4j.Log4j2;
import org.hibernate.Session;
import org.hibernate.SessionFactory;

@Log4j2
public class HibernateInterceptorExample {

public static void main(String[] args) {
try (SessionFactory sessionFactory = HibernateUtils.getSessionFactory();
Session session = sessionFactory
.withOptions()
.interceptor(new LoggingInterceptor()) // Register interceptor
.openSession();
) {

session.getTransaction().begin();

Tag tag = new Tag();
tag.setName("Hibernate Interceptor");
session.persist(tag);

session.getTransaction().commit();
}
}
}

Output:

2020-Apr-02 22:41:38 PM [main] DEBUG com.gpcoder.LoggingInterceptor - onPrepareStatement: select nextval ('tag_id_seq')
2020-Apr-02 22:41:38 PM [main] DEBUG org.hibernate.SQL - select nextval ('tag_id_seq')
2020-Apr-02 22:41:38 PM [main] DEBUG com.gpcoder.LoggingInterceptor - onSave: Tag(id=43, name=Hibernate Interceptor)
2020-Apr-02 22:41:38 PM [main] DEBUG com.gpcoder.LoggingInterceptor - preFlush: Tag(id=43, name=Hibernate Interceptor)
2020-Apr-02 22:41:38 PM [main] DEBUG com.gpcoder.LoggingInterceptor - onPrepareStatement: insert into Tag (name, id) values (?, ?)
2020-Apr-02 22:41:38 PM [main] DEBUG org.hibernate.SQL - insert into Tag (name, id) values (?, ?)
2020-Apr-02 22:41:38 PM [main] TRACE org.hibernate.type.descriptor.sql.BasicBinder - binding parameter [1] as [VARCHAR] - [Hibernate Interceptor]
2020-Apr-02 22:41:38 PM [main] TRACE org.hibernate.type.descriptor.sql.BasicBinder - binding parameter [2] as [BIGINT] - [43]
2020-Apr-02 22:41:38 PM [main] DEBUG com.gpcoder.LoggingInterceptor - postFlush: Tag(id=43, name=Hibernate Interceptor)

2. Hibernate StatementInspector

Một tính năng Hibernate rất hữu ích nhưng ít được biết đến là khả năng chặn (Interceptor) và sửa đổi bất kỳ câu lệnh SQL nào được tạo tự động bằng tiện ích Hibernate StatementInspector. Trong phần tiếp theo của bài viết này, chúng ta sẽ xem cơ chế Hibernate StatementInspector hoạt động như thế nào.

2.1. Create StatementInspector

Interface StatementInspector chỉ gồm 1 phương thức duy nhất inspect(String sql). Phương thức  nhận một câu lệnh SQL mà Hibernate sắp thực hiện và cho phép bạn sửa đổi câu lệnh SQL và trả nó về Hibernate tiếp tục thực thi.

Ví dụ: tạo SqlCommentStatementInspector để remove các auto comment của Hiberate.

package com.gpcoder;

import lombok.extern.log4j.Log4j2;
import org.hibernate.resource.jdbc.spi.StatementInspector;

import java.util.regex.Pattern;

@Log4j2
public class SqlCommentStatementInspector implements StatementInspector {

private static final Pattern SQL_COMMENT_PATTERN = Pattern.compile("/*.*?*/s*");

@Override
public String inspect(String sql) {
log.debug("Executing SQL query: {}", sql);
String sqlAfterRemovedComment = SQL_COMMENT_PATTERN.matcher(sql).replaceAll("");
log.debug("After removed: {}", sqlAfterRemovedComment);
return sqlAfterRemovedComment;
}
}

2.2. Register StatementInspector

Để đăng ký một implment của StatementInspector, mở file hibernate.cfg.xml và thêm cấu hình sau:

<!-- Enable SQL comment --> <property name="use_sql_comments">true</property> <!-- egister an implementation of the StatementInspector interface --> <property name="session_factory.statement_inspector">com.gpcoder.SqlCommentStatementInspector</property>

Lưu ý:

  • use_sql_comments : enable option này lên để cho phép Hibernate auto generate comment để minh hoạ cho ví dụ của chúng ta. Trong ứng dụng thực tế không cần enable option này cho StatementInspector cụ thể.

Một cách khác để đăng ký là thông qua SessionFactoryBuilder:

package com.gpcoder.utils;

import com.gpcoder.LoggingInterceptor;
import com.gpcoder.SqlCommentStatementInspector;
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()
.applyStatementInspector( new SqlCommentStatementInspector() ) // Register StatementInspector
.applyInterceptor( new LoggingInterceptor() ) // Register interceptor
.build();
}

public static SessionFactory getSessionFactory() {
return sessionFactory;
}

public static void close() {
getSessionFactory().close();
}
}

2.3. Tạo lớp ứng dụng

package com.gpcoder;

import com.gpcoder.entities.Tag;
import com.gpcoder.utils.HibernateUtils;
import lombok.extern.log4j.Log4j2;
import org.hibernate.Session;
import org.hibernate.SessionFactory;

@Log4j2
public class HibernateInterceptorExample {

public static void main(String[] args) {
try (SessionFactory sessionFactory = HibernateUtils.getSessionFactory();
Session session = sessionFactory.openSession();
) {

session.getTransaction().begin();

Tag tag = new Tag();
tag.setName("Hibernate Interceptor");
session.persist(tag);

session.getTransaction().commit();
}
}
}

Output:

2020-Apr-02 23:33:44 PM [main] DEBUG com.gpcoder.SqlCommentStatementInspector - Executing SQL query: select nextval ('tag_id_seq')
2020-Apr-02 23:33:44 PM [main] DEBUG com.gpcoder.SqlCommentStatementInspector - After removed: select nextval ('tag_id_seq')
2020-Apr-02 23:33:44 PM [main] DEBUG org.hibernate.SQL - select nextval ('tag_id_seq')
2020-Apr-02 23:33:44 PM [main] DEBUG com.gpcoder.LoggingInterceptor - onSave: Tag(id=50, name=Hibernate Interceptor)
2020-Apr-02 23:33:44 PM [main] DEBUG com.gpcoder.LoggingInterceptor - preFlush: Tag(id=50, name=Hibernate Interceptor)
2020-Apr-02 23:33:44 PM [main] DEBUG com.gpcoder.SqlCommentStatementInspector - Executing SQL query: /* insert com.gpcoder.entities.Tag */ insert into Tag (name, id) values (?, ?)
2020-Apr-02 23:33:44 PM [main] DEBUG com.gpcoder.SqlCommentStatementInspector - After removed: insert into Tag (name, id) values (?, ?)
2020-Apr-02 23:33:44 PM [main] DEBUG org.hibernate.SQL - insert into Tag (name, id) values (?, ?)
2020-Apr-02 23:33:44 PM [main] TRACE org.hibernate.type.descriptor.sql.BasicBinder - binding parameter [1] as [VARCHAR] - [Hibernate Interceptor]
2020-Apr-02 23:33:44 PM [main] TRACE org.hibernate.type.descriptor.sql.BasicBinder - binding parameter [2] as [BIGINT] - [50]
2020-Apr-02 23:33:44 PM [main] DEBUG com.gpcoder.LoggingInterceptor - postFlush: Tag(id=50, name=Hibernate Interceptor)

Như bạn thấy, comment của hibernate /* insert com.gpcoder.entities.Tag */ đã được loại bỏ một cách tự động nhờ vào StatementInspector.

Một số trường hợp khác có thể sử dụng StatementInspector: capture tất cả câu lệnh SQL được call bởi Hibernate, quản lý số lần SQL được gọi để phục vụ cho testing, reporting, …

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 Developer hấp dẫn trên Station D

Bạn có thể quan tâm

Đọc thêm

Thị trường EdTech Vietnam- Nhiều tiềm năng nhưng còn bị bỏ ngỏ tại Việt Nam
Bộ cài đặt Laravel Installer đã hỗ trợ tích hợp Jetstream
Principle thiết kế của các sản phẩm nổi tiếng
Applicant Tracking System là gì? ATS hoạt động ra sao
Lập TrìnhCông nghệ

Bài viết liên quan

Bộ cài đặt Laravel Installer đã hỗ trợ tích hợp Jetstream
Công Nghệ

Bộ cài đặt Laravel Installer đã hỗ trợ tích hợp Jetstream

Bài viết được sự cho phép của tác giả Chung Nguyễn Hôm nay, nhóm Laravel đã phát hành một phiên bản chính mới của “ laravel/installer ” bao gồm hỗ trợ khởi động nhanh các dự án Jetstream. Với phiên bản mới này khi bạn chạy laravel new project-name , bạn sẽ nhận được các tùy chọn Jetstream. Ví dụ: API Authentication trong Laravel-Vue SPA sử dụng Jwt-auth Cách sử dụng Laravel với Socket.IO laravel new foo --jet --dev Sau đó, nó sẽ hỏi bạn thích stack Jetstream nào hơn: Which Jetstream stack do you prefer? [0] Livewire [1] inertia > livewire Will your application use teams? (yes/no) [no]: ... Nếu bạn đã cài bộ Laravel Installer, để nâng cấp lên phiên bản mới bạn chạy lệnh: composer global update Một số trường hợp cập nhật bị thất bại, bạn hãy thử, gỡ đi và cài đặt lại nha composer global remove laravel/installer composer global require laravel/installer Bài viết gốc được đăng tải tại chungnguyen.xyz Có thể bạn quan tâm: Cài đặt Laravel Làm thế nào để chạy Sql Server Installation Center sau khi đã cài đặt xong Sql Server? Quản lý các Laravel route gọn hơn và dễ dàng hơn Xem thêm Tuyển dụng lập trình Laravel hấp dẫn trên Station D

By stationd
Principle thiết kế của các sản phẩm nổi tiếng
Công Nghệ

Principle thiết kế của các sản phẩm nổi tiếng

Tác giả: Lưu Bình An Phù hợp cho các bạn thiết kế nào ko muốn làm code dạo, design dạo nữa, bạn muốn cái gì đó cao hơn ở tầng khái niệm Nếu lập trình chúng ta có các nguyên tắc chung khi viết code như KISS , DRY , thì trong thiết kế cũng có những nguyên tắc chính khi làm việc. Những nguyên tắc này sẽ là kim chỉ nam, nếu có tranh cãi giữa các member trong team, thì cứ đè nguyên tắc này ra mà giải quyết (nghe hơi có mùi cứng nhắc, mình thì thích tùy cơ ứng biến hơn) Tìm các vị trí tuyển dụng designer lương cao cho bạn Nguyên tắc thiết kế của GOV.UK Đây là danh sách của trang GOV.UK Bắt đầu với thứ user cần Làm ít hơn Thiết kế với dữ liệu Làm mọi thứ thật dễ dàng Lặp. Rồi lặp lại lần nữa Dành cho tất cả mọi người Hiểu ngữ cảnh hiện tại Làm dịch vụ digital, không phải làm website Nhất quán, nhưng không hòa tan (phải có chất riêng với thằng khác) Cởi mở, mọi thứ tốt hơn Bao trừu tượng luôn các bạn, trang Gov.uk này cũng có câu tổng quát rất hay Thiết kế tốt là thiết kế có thể sử dụng. Phục vụ cho nhiều đối tượng sử dụng, dễ đọc nhất nhất có thể. Nếu phải từ bỏ đẹp tinh tế – thì cứ bỏ luôn . Chúng ta tạo sản phẩm cho nhu cầu sử dụng, không phải cho người hâm mộ . Chúng ta thiết kế để cả nước sử dụng, không phải những người đã từng sử dụng web. Những người cần dịch vụ của chúng ta nhất là những người đang cảm thấy khó sử dụng dịch...

By stationd
Hiểu về trình duyệt – How browsers work
Công Nghệ

Hiểu về trình duyệt – How browsers work

Bài viết được sự cho phép của vntesters.com Khi nhìn từ bên ngoài, trình duyệt web giống như một ứng dụng hiển thị những thông tin và tài nguyên từ server lên màn hình người sử dụng, nhưng để làm được công việc hiển thị đó đòi hỏi trình duyệt phải xử lý rất nhiều thông tin và nhiều tầng phía bên dưới. Việc chúng ta (Developers, Testers) tìm hiểu càng sâu tầng bên dưới để nắm được nguyên tắc hoạt động và xử lý của trình duyệt sẽ rất hữu ích trong công việc viết code, sử dụng các tài nguyên cũng như kiểm thử ứng dụng của mình. Cách để npm packages chạy trong browser Câu hỏi phỏng vấn mẹo về React: Component hay element được render trong browser? Khi hiểu được cách thức hoạt động của trình duyệt chúng ta có thể trả lời được rất nhiều câu hỏi như: Tại sao cùng một trang web lại hiển thị khác nhau trên hai trình duyệt? Tại sao chức năng này đang chạy tốt trên trình duyệt Firefox nhưng qua trình duyệt khác lại bị lỗi? Làm sao để trang web hiển thị nội dung nhanh và tối ưu hơn một chút?… Hy vọng sau bài này sẽ giúp các bạn có một cái nhìn rõ hơn cũng như giúp ích được trong công việc hiện tại. 1. Cấu trúc của một trình duyệt Trước tiên chúng ta đi qua cấu trúc, thành phần chung và cơ bản nhất của một trình duyệt web hiện đại, nó sẽ gồm các thành phần (tầng) như sau: Thành phần nằm phía trên là những thành phần gần với tương tác của người dùng, càng phía dưới thì càng sâu và nặng về xử lý dữ liệu hơn tương tác. Nhiệm...

By stationd
Thị trường EdTech Vietnam- Nhiều tiềm năng nhưng còn bị bỏ ngỏ tại Việt Nam
Chuyện IT

Thị trường EdTech Vietnam- Nhiều tiềm năng nhưng còn bị bỏ ngỏ tại Việt Nam

Lĩnh vực EdTech (ứng dụng công nghệ vào các sản phẩm giáo dục) trên toàn cầu hiện nay đã tương đối phong phú với nhiều tên tuổi lớn phân phối đều trên các hạng mục như Broad Online Learning Platforms (nền tảng cung cấp khóa học online đại chúng – tiêu biểu như Coursera, Udemy, KhanAcademy,…) Learning Management Systems (hệ thống quản lý lớp học – tiêu biểu như Schoology, Edmodo, ClassDojo,…) Next-Gen Study Tools (công cụ hỗ trợ học tập – tiểu biểu như Kahoot!, Lumosity, Curriculet,…) Tech Learning (đào tạo công nghệ – tiêu biểu như Udacity, Codecademy, PluralSight,…), Enterprise Learning (đào tạo trong doanh nghiệp – tiêu biểu như Edcast, ExecOnline, Grovo,..),… Hiện nay thị trường EdTech tại Việt Nam đã đón nhận khoảng đầu tư khoảng 55 triệu đô cho lĩnh vực này nhiều đơn vị nước ngoài đang quan tâm mạnh đến thị trường này ngày càng nhiều hơn. Là một trong những xu hướng phát triển tốt, và có doanh nghiệp đã hoạt động khá lâu trong ngành nêu tại infographic như Topica, nhưng EdTech vẫn chỉ đang trong giai đoạn sơ khai tại Việt Nam. Tại Việt Nam, hệ sinh thái EdTech trong nước vẫn còn rất non trẻ và thiếu vắng nhiều tên tuổi trong các hạng mục như Enterprise Learning (mới chỉ có MANA), School Administration (hệ thống quản lý trường học) hay Search (tìm kiếm, so sánh trường và khóa học),… Với chỉ dưới 5% số dân công sở có sử dụng một trong các dịch vụ giáo dục online, EdTech cho thấy vẫn còn một thị trường rộng lớn đang chờ được khai phá. *** Vừa qua Station D đã công bố Báo cáo Vietnam IT Landscape 2019 đem đến cái nhìn toàn cảnh về các ứng dụng công...

By stationd