IT序号网

hibernate search例子知识解答

wyy 2021年07月15日 程序员 123 0

1. 概念介绍

Hibernate Search是Hibernate的子项目,把数据库全文检索能力引入到项目中,并通过"透明"(不影响既有系统)的配置,提供一套标准的全文检索接口。这一章我们就来学习这块内容。

1.2. 全文检索

在进入正文之前,有必要介绍一下全文检索的概念。简单来说,Google就是一个全文检索引擎。全文检索允许用户输入一些关键字,从数据层中查找到 所需要的信息。此外全文检索和数据库"LIKE"语句相比,没有数据库开销或是数据库的开销非常小,因为检索过程全部从通过检索文件完成,因此效率非常 高。此外,全文检索引擎可以提供的还远不止"LIKE"语句这么多。在全文检索领域,用户输入的搜索信息叫做关键字,而全文检索系统把海量信息按照这些关 键字进行结构化处理,把文章打散成段落、文字,最后,按关键字对文章的数据进行分类。这个处理后的数据文本叫做检索文件,检索文件往往比实际数据小得多, 但它的数据所包含的信息量损失却非常小。当用户输入一个关键字时,全文检索引擎可以很快地定位到相关文本。

1.3. Lucene

Lucene是一个开源的全文检索引擎,目前已经成为了Apache基金会赞助项目。Lucene是Java社区非常流行的全文检索引擎,功能强 大。它不仅可以检索一般的数据文本,还可以检索PDF、HTML及微软的Word文件等。此外,Lucene成功的原因之一是它开放的框架,几乎框架的每 一部分都可以扩展。它的文本分析器可以定制,检索文件存储方式可以定制,查询引擎也有不同的可选方案,如果愿意,还可以自已定制。此外,它提供一套非常强 大的API接口,使客户用起来很方便。此外,Lucene除支持非结构化检索\footnote{用户输入一个关键字,全文检索引擎去匹配任何字段包含该 关键字的数据条目。}外,还支持结构化检索(用户可以指定具体搜索的model类、字段名以及搜索条件)。这章的重点不是Lucene,但做为 Hibernate Search的核心,您有必要对它的基本概念有所了解。下面介绍一些Lucene中的基本概念:

Document:在Lucene中,一个Document即一个搜索单元。举例来说:如果对一个用户表做检索,那么每条用户信息就是一个Document。
Field:每一个Document都包含一或多个Field,每一个Field都是key-value数据对。
Analyzer:分析器/断字器。这是全文检索引擎的心脏,如何将一篇文章打散成一些关键字,并能够不丢失信息量,这是一门单独的学科。Lucene提供多种Analyzer,并提供开放的接口让社区的专家提供新的Analyzer。
Index:系统生成的检索信息,这里面存储了Document。
IndexSearcher:IndexSearcher负责检索Index内容负责给出检索结果。
IndexWriter:IndexWriter负责调用Analyzer,分析后生成Index。
Lucene、Hibernate Search及Hibernate的联系

如果在项目中直接使用Lucene,将不得不面临一些问题。因为项目是基于数据库的,因此,当数据库中的数据发生变化时,就必须手工触发 Lucene,让它随之更新检索文件中的内容,使之与数据库中的实际数据保持一致。这也就意味着dao中的每一个函数都要插入一段Lucene的代码,这 样做有违OCP原则,这一层面应被提取到单独的逻辑层。此外model类别如何映射到全文检索引擎中,这也是一个问题,必须要手工处理这种映射关系,这样 使用Lucene的代价就大大增加了。为了解决这些使用上的问题,Hibernate Search应运而生。
Hibernate+Hibernate Search位于全文检索数据目录及实际数据库中间。一方面,Hibernate处理与数据库相关的事宜,另一方面Hibernate Search会根据数据库中实际数据的情况,自动触发更新全文检索数据目录。此外Hibernate Search自动完成model层数据类对Lucene检索文件结构的映射。

2. 实例

2.1. maven配置

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 
	<modelVersion>4.0.0</modelVersion> 
 
	<groupId>com.wisdombud.chzhao</groupId> 
	<artifactId>hibernate-search</artifactId> 
	<version>0.0.1-SNAPSHOT</version> 
	<packaging>jar</packaging> 
 
	<name>hibernate-search</name> 
	<url>http://maven.apache.org</url> 
 
	<properties> 
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 
		<slf4j.version>1.6.2</slf4j.version> 
		<log4j.version>1.2.14</log4j.version> 
		<commons-lang.version>2.6</commons-lang.version> 
		<commons-logging.version>1.1.1</commons-logging.version> 
	</properties> 
 
	<dependencies> 
		<dependency> 
			<groupId>junit</groupId> 
			<artifactId>junit</artifactId> 
			<version>4.5</version> 
			<scope>test</scope> 
		</dependency> 
		<dependency> 
			<artifactId>hibernate-search</artifactId> 
			<groupId>org.hibernate</groupId> 
			<version>3.4.2.Final</version> 
		</dependency> 
		<dependency> 
			<groupId>commons-logging</groupId> 
			<artifactId>commons-logging</artifactId> 
			<version>${commons-logging.version}</version> 
		</dependency> 
		<dependency> 
			<groupId>log4j</groupId> 
			<artifactId>log4j</artifactId> 
			<version>${log4j.version}</version> 
		</dependency> 
		<dependency> 
			<groupId>org.slf4j</groupId> 
			<artifactId>slf4j-log4j12</artifactId> 
			<version>${slf4j.version}</version> 
		</dependency> 
		<dependency> 
			<groupId>org.slf4j</groupId> 
			<artifactId>slf4j-api</artifactId> 
			<version>${slf4j.version}</version> 
		</dependency> 
		<dependency> 
			<groupId>mysql</groupId> 
			<artifactId>mysql-connector-java</artifactId> 
			<version>5.1.6</version> 
		</dependency> 
		<dependency> 
			<groupId>javassist</groupId> 
			<artifactId>javassist</artifactId> 
			<version>3.12.1.GA</version> 
		</dependency> 
	</dependencies> 
</project> 
 

2.2. java po代码

package com.wisdombud.chzhao.hibernate_search; 
 
import javax.persistence.Column; 
import javax.persistence.Entity; 
import javax.persistence.Id; 
import javax.persistence.Table; 
 
import org.hibernate.search.annotations.Field; 
import org.hibernate.search.annotations.Index; 
import org.hibernate.search.annotations.Indexed; 
import org.hibernate.search.annotations.Store; 
 
@Entity 
@Table(name = "book", catalog = "WISDOMHR", uniqueConstraints = {}) 
@Indexed(index = "indexes/book") 
public class BookPo implements java.io.Serializable { 
	/** 
	 *  
	 */ 
	private static final long serialVersionUID = 1L; 
	@Column(name = "id") 
	@Id 
	private String id; 
	@Column(name = "name") 
 
	private String name; 
 
	@Column(name = "author") 
	private String author; 
	@Column(name = "publish") 
	private String publish; 
 
	public String getId() { 
		return id; 
	} 
 
	public void setId(String id) { 
		this.id = id; 
	} 
	@Field(name="name", index=Index.TOKENIZED, store=Store.YES) 
	public String getName() { 
		return name; 
	} 
 
	public void setName(String name) { 
		this.name = name; 
	} 
	@Field(name="author", index=Index.TOKENIZED, store=Store.YES) 
	public String getAuthor() { 
		return author; 
	} 
 
	public void setAuthor(String author) { 
		this.author = author; 
	} 
	@Field(name="publish", index=Index.TOKENIZED, store=Store.YES) 
	public String getPublish() { 
		return publish; 
	} 
 
	public void setPublish(String publish) { 
		this.publish = publish; 
	} 
 
} 
 

注意:

Hibernate Search相关的Annotation主要有两个:
@Indexed 标识需要进行索引的对象,
属性 index 指定索引文件的路径
@Field 标注在类的get属性上,标识一个索引的Field
属性 index 指定是否索引,与Lucene相同
store 指定是否索引,与Lucene相同
name 指定Field的name,默认为类属性的名称
analyzer 指定分析器

2.3. hibernate配置文件

<?xml version='1.0' encoding='UTF-8'?> 
<!DOCTYPE hibernate-configuration PUBLIC 
          "-//Hibernate/Hibernate Configuration DTD 3.0//EN" 
          "http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd"> 
 
<hibernate-configuration> 
 
<session-factory> 
    <property name="hibernate.dialect"> 
        org.hibernate.dialect.MySQLDialect 
    </property> 
    <property name="hibernate.connection.url"> 
        jdbc:mysql://192.168.163.36:3306/WISDOMHR 
    </property> 
    <property name="hibernate.connection.username">wisdomhr</property> 
    <property name="hibernate.connection.password">wisdomhr</property> 
    <property name="hibernate.connection.driver_class"> 
        com.mysql.jdbc.Driver 
    </property> 
 
    <property name="hibernate.search.default.directory_provider"> 
        org.hibernate.search.store.FSDirectoryProvider 
    </property> 
    <property name="hibernate.search.default.indexBase">/Users/chunhuizhao/Workspace/hibernate-search/index</property> 
     
    <mapping class="com.wisdombud.chzhao.hibernate_search.BookPo" /> 
</session-factory> 
 
</hibernate-configuration> 

2.4. 测试代码

package com.wisdombud.chzhao.hibernate_search; 
import static org.junit.Assert.assertNotNull; 
import static org.junit.Assert.assertTrue; 
 
import java.util.List; 
import java.util.UUID; 
 
import org.apache.lucene.analysis.Analyzer; 
import org.apache.lucene.analysis.StopAnalyzer; 
import org.apache.lucene.analysis.standard.StandardAnalyzer; 
import org.apache.lucene.queryParser.ParseException; 
import org.apache.lucene.queryParser.QueryParser; 
import org.apache.lucene.search.IndexSearcher; 
import org.apache.lucene.util.Version; 
import org.hibernate.Query; 
import org.hibernate.Session; 
import org.hibernate.SessionFactory; 
import org.hibernate.Transaction; 
import org.hibernate.cfg.AnnotationConfiguration; 
import org.hibernate.search.FullTextSession; 
import org.hibernate.search.Search; 
import org.hibernate.search.query.dsl.QueryBuilder; 
import org.junit.After; 
import org.junit.Before; 
import org.junit.BeforeClass; 
import org.junit.Test; 
public class BookTest { 
	private static SessionFactory sf = null; 
    private static Session session = null; 
    private static Transaction tx = null; 
 
    @BeforeClass 
    public static void setupBeforeClass() throws Exception { 
        sf = new AnnotationConfiguration().configure("hibernate.cfg.xml").buildSessionFactory(); 
    } 
 
    @Before 
    public void setUp() throws Exception { 
        session = sf.openSession(); 
        tx = session.beginTransaction(); 
        tx.begin(); 
    } 
 
    @After 
    public void tearDown() throws Exception { 
        tx.commit(); 
        session.close(); 
    } 
     
    @Test 
    public void testAddBook() throws Exception { 
        BookPo book = new BookPo(); 
         
        book.setAuthor("lz"); 
        book.setName("jvm"); 
        book.setId(UUID.randomUUID().toString()); 
        book.setPublish("china"); 
        session.save(book); 
    } 
     
     
    @Test 
    public void testIndex() throws Exception { 
        FullTextSession fullTextSession = Search.getFullTextSession(session); 
        assertNotNull(fullTextSession); 
        QueryBuilder qb = fullTextSession.getSearchFactory() 
                .buildQueryBuilder().forEntity(BookPo.class).get(); 
              org.apache.lucene.search.Query query = qb 
                .keyword() 
                .onFields("name") 
                .matching("jvm") 
                .createQuery(); 
/* 
        QueryParser parser = new QueryParser(Version.LUCENE_CURRENT, "author", new StopAnalyzer(Version.LUCENE_CURRENT)); 
        org.apache.lucene.search.Query luceneQuery = parser 
                .parse("author:lz"); 
       */ 
        Query hibQuery = fullTextSession.createFullTextQuery(query, 
                BookPo.class); 
 
        List list = hibQuery.list(); 
        System.out.println(list.size()); 
        assertTrue(list.size() > 0); 
    } 
     
} 
 

3.参考资料

hibernate-search


发布评论

分享到:

IT序号网

微信公众号号:IT虾米 (左侧二维码扫一扫)欢迎添加!

Hibernate入门(1)-第一个Hibernate程序知识解答
你是第一个吃螃蟹的人
发表评论

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。