基于JavaLuncene的compass框架说明使用技术文档

Compass技术文档目录一、原理描述：................................................................二、术语解释：................................................................三、下载地址：................................................................四、使用流程: …………………………………………………………………………………….五、基于SSH的compass的实例: …………………………………………………………………一、原理描述：Compass是一流的开放源码JAVA搜索引擎框架，对于你的应用修饰，搜索引擎语义更具有能力。

依靠顶级的Lucene搜索引擎，Compass 结合了，像Hibernate和 Spring的流行的框架，为你的应用提供了从数据模型和数据源同步改变的搜索力.并且添加了2方面的特征,事物管理和快速更新优化.Compass的目标是：把java应用简单集成到搜索引擎中.编码更少，查找数据更便捷 .二、术语解释：三、下载地址：四、使用流程:五、基于SSH的compass的实例:step1在ssh2的基础上开发加入jar包（compass-2.1.2.jar compass-index-patch.jarlucene-analyzers-2.4.0.jar lucene-core-2.4.0.jar lucene-highlighter-2.4.0.jar paoding-analysis.jar）step2先来看下实体bean的编写Java代码1.package .v512.example.model;2.import pass.annotations.*;3./**4.* Product entity.5.*6.* author MyEclipse Persistence Tools7.*/8.Searchable9.public class Product implements java.io.Serializable {10.11. // Fields12.13. SearchableId14. private String id;15. SearchableProperty(name="name",index=Index.ANALYZED,store=Store.YES)16. private String name;17. SearchableProperty(name="price",index=Index.NOT_ANALYZED,store=Store.YES)18. private Double price;19. SearchableProperty(name="brand",index=Index.ANALYZED,store=Store.YES)20. private String brand;21. SearchableProperty(name="description",index=Index.ANALYZED,store=Store.YES)22. private String description;23.24. // Constructors25.26. /** default constructor */27. public Product() {28. }29.30. /** full constructor */31. public Product(String name, Double price, Stringbrand, String description) {32. = name;33. this.price = price;34. this.brand = brand;35. this.description = description;36. }37.38. // Property accessors39.40. public String getId() {41. return this.id;42. }43.44. public void setId(String id) {45. this.id = id;46. }47.48. public String getName() {49. return ;50. }51.52. public void setName(String name) {53. = name;54. }55.56. public Double getPrice() {57. return this.price;58. }59.60. public void setPrice(Double price) {61. this.price = price;62. }63.64. public String getBrand() {65. return this.brand;66. }67.68. public void setBrand(String brand) {69. this.brand = brand;70. }71.72. public String getDescription() {73. return this.description;74. }75.76. public void setDescription(String description) {77. this.description = description;78. }79.80.}step3属性文件Product.hbm.xmlJava代码1.<?xml version="1.0" encoding="utf-8"?>2.<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/HibernateMapping DTD 3.0//EN"3."/hibernate-mapping-3.0.dtd">4.<!--5.Mapping file autogenerated by MyEclipse Persistence Tools6.-->7.<hibernate-mapping>8.<class name=".v512.example.model.Product" table="PRODUCT" >9.<id name="id" type="ng.String">10. <column name="ID" length="40" />11. <generator class="uuid.hex" />12. </id>13. <property name="name" type="ng.String">14. <column name="NAME" length="80" />15. </property>16. <property name="price" type="ng.Double">17. <column name="PRICE" precision="6" />18. </property>19. <property name="brand" type="ng.String">20. <column name="BRAND" length="40" />21. </property>22. <property name="description" type="ng.String">23. <column name="DESCRIPTION" length="2000" />24. </property>25. </class>26.</hibernate-mapping>要使用Compass必须加入一个applicationContext-compass.xml文件，文件名可以自行定义这个就不用说了废话step4applicationContext-compass.xml：Java代码1.<?xml version="1.0" encoding="UTF-8"?>2.3.<beans xmlns="/schema/beans"4.xmlns:xsi="/2001/XMLSchema-instance"5.xsi:schemaLocation=" /schema/beans/schema/beans/spring-beans-2.5.xsd" 6.default-lazy-init="true">7.8.<!-- 配置compass的注解功能-->9.<bean id="annotationConfiguration"10. class="passAnnotationsConfiguration">11. </bean>12.13.14. <bean id="compass" class="pass.spring.LocalCompassBean">15. <!-- 配置需要索引的实体映射文件的路径-->16. <property name="resourceDirectoryLocations">17. <list>18. <value>classpath:/v512/example/model</value>19. </list>20. </property>21. <!-- 设置存放索引的路径-->22. <property name="connection">23. <value>/lucene/indexes</value>24. </property>25.26. <!--配置要搜索的类，作用：会根据以下的类建立索引-->27. <property name="classMappings">28. <list>29. <value>.v512.example.model.Product</value>30. </list>31. </property>32. <property name="compassConfiguration"33. ref="annotationConfiguration" />34.35. <!--compass的一些属性设置-->36. <property name="compassSettings">37. <props>38. <prop key="compass.transaction.factory">39. pass.spring.transaction.SpringSyncTransactionFactory40. </prop>41. <prop key="compass.engine.analyzer.MMAnalyzer.CustomAnalyzer">net.paoding.analysis.analyz er.PaodingAnalyzer </prop>42. </props>43. </property>44. <!--compass的事务管理器-->45. <property name="transactionManager" ref="transactionManager" />46. </bean>47.48.49. <bean id="hibernateGpsDevice"50. class="pass.gps.device.hibernate.HibernateGpsDevice">51. <property name="name">52. <value>hibernateDevice</value>53. </property>54. <property name="sessionFactory" ref="sessionFactory" />55. <property name="mirrorDataChanges">56. <value>true</value>57. </property>58. </bean>59. <!-- 同步更新索引-->60. <bean id="compassGps" class="pass.gps.impl.SingleCompassGps"61. init-method="start" destroy-method="stop">62. <property name="compass" ref="compass" />63. <property name="gpsDevices">64. <list>65. <bean66. class="pass.spring.device.SpringSyncTransactionGpsDeviceWrapper">67. <property name="gpsDevice" ref="hibernateGpsDevice" />68. </bean>69. </list>70. </property>71. </bean>72.73.74. <bean id="compassTemplate"75. class="passTemplate">76. <property name="compass" ref="compass" />77. </bean>78.79. <!-- 定时重建索引(利用quartz)或随Spring ApplicationContext启动而重建索引-->80. <bean id="compassIndexBuilder"81. class="passIndexBuilder"82. lazy-init="false">83. <property name="compassGps" ref="compassGps"/>84. <property name="buildIndex" value="true" />85. <property name="lazyTime" value="10" />86. </bean>87.88.89.90.</beans>中间都有注解就不多解释了下面来编写dao及dao的实现以及severce层step5Java代码1.package .v512.example.dao;2.3.import java.util.List;4.5.import .v512.example.model.Product;6.7.public interface ProductDao {8.public void create(Product p);9.public Product getProduct(String id);10. public List getProducts();11. public void update(Product product);12. public void remove(String id);13.14.}Java代码1.package .v512.example.dao.hibernate;2.3.import java.util.List;4.5.import .v512.example.dao.ProductDao;6.import .v512.example.model.Product;7.import org.springframework.orm.hibernate3.support.HibernateDaoSupport;8.public class ProductDaoHibernate extends HibernateDaoSupport implements ProductDao {9.10. public void create(Product p) {11. getHibernateTemplate().save(p);12.13. }14.15. public Product getProduct(String id) {16. return (Product)getHibernateTemplate().get(Product.class, id);17. }18.19. public List getProducts() {20. return getHibernateTemplate().find("from Product order by id desc");21. }22.23. public void remove(String id) {24. getHibernateTemplate().delete(getProduct(id));25.26. }27.28. public void update(Product product) {29. getHibernateTemplate().saveOrUpdate(product);30.31. }32.33.}serveceJava代码1.package .v512.example.service;2.3.import java.util.List;4.5.import .v512.example.model.Product;6.7.public interface ProductManager {8.public void insertProduct(Product p);9.public Product findProdcut(String id);10. public List searchProducts(String queryString);11.12.13.}servece的实现Java代码1.package .v512.example.service.impl;2.3.import java.util.ArrayList;4.import java.util.List;5.6.import passHits;7.import passSession;8.import passTemplate;9.import passTransaction;10.11.import .v512.example.dao.ProductDao;12.import .v512.example.model.Product;13.import .v512.example.service.ProductManager;14.import pass;15.public class ProductManagerImpl implements ProductManager{16. private ProductDao productDao;17. private CompassTemplate compassTemplate;18.19.20.21.22. public void setCompassTemplate(CompassTemplate compassTemplate){23. passTemplate=compassTemplate;24. }25.26. public void setProductDao(ProductDao productDao){27. this.productDao=productDao;28. }29.30. public Product findProdcut(String id) {31. return productDao.getProduct(id);32. }33.34. public void insertProduct(Product p) {35. productDao.create(p);36. }37.38. public List searchProducts(String queryString) {39. Compass compass = compassTemplate.getCompass();40. CompassSession session=compass.openSession();41. List list = new ArrayList();42. //这里不需要开启事务了，因为在调用这个方法之前就已经开启了事务43. CompassHits hits= session.queryBuilder().queryString("name:"+queryString).toQuery().hits();44. System.out.println("queryString:"+queryString);45. System.out.println("hits:"+hits.getLength());46. for(int i=0;i<hits.length();i++){47. Product hit=(Product)hits.data(i);48. list.add(hit);49. }50.51. return list;52. }53.54.55.56. public CompassTemplate getCompassTemplate() {57. return compassTemplate;58. }59.60.}所有的都做完了现在编写jsp页面step6insertProduct.jspJava代码1.<% page language="java" contentType="text/html; charset=UTF-8"2.pageEncoding="UTF-8"%>3.<% taglib prefix="s" uri="/struts-tags"%>4.<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "/TR/html4/loose.dtd">5.<html>6.<head>7.<meta http-equiv="Content-Type" content="text/html; charset=utf-8">8.<link href="style/oa.css" rel="stylesheet" type="text/css">9.10.<title>添加信息</title>11.</head>12.<body>13.<center>14. <s:form action="insert.action" theme="simple">15.16.<TABLE class="tableEdit" border="0" cellspacing="1" cellpadding="0" style="width:300px;">17. <TBODY>18. <TR>19. <td align="center" class="tdEditTitle">添加商品名称</TD>20. </TR>21. <TR>22. <td>23.24.25.<table class="tableEdit" style="width:300px;" cellspacing="0" border="0" cellpadding="0">26. <tr>27. <td class="tdEditLabel" >商品名称</td>28. <td class="tdEditContent"><s:textfield name="" label="名称" /></td>29. </tr>30.31. <tr>32. <td class="tdEditLabel" >商品品牌</td>33. <td class="tdEditContent"><s:textfield name="product.brand" label="品牌" /></td>34. </tr>35.36. <tr>37. <td class="tdEditLabel" >商品价格</td>38. <td class="tdEditContent"><s:textfield name="product.price" label="价格" /></td>39. </tr>40.41. <tr>42. <td class="tdEditLabel" >商品描述</td>43. <td class="tdEditContent"><s:textarea name="product.description" label="描述" />44. </td>45. </tr>46. <tr>47. <td>&nbsp;48. </td>49. <td><s:submit/>50. <br></td>51. </tr>52.</table>53. </td>54. </TR>55. </TBODY>56.</TABLE>57.</s:form>58.</center>59.</body>60.</html>step7编写actionJava代码1.package .v512.example.action;2.3.import java.util.List;4.5.import .opensymphony.xwork2.ActionSupport;6.import .v512.example.model.Product;7.import .v512.example.service.ProductManager;8.import org.apache.struts2.ServletActionContext;9.10.public class ProductAction extends ActionSupport {11.12. private static final long serialVersionUID = 32L;13. private ProductManager productManager;14. private Product product;15. private String queryString;16.17. public void setQueryString(String queryString){18. this.queryString=queryString;19. }20.21. public Product getProduct() {22. return product;23. }24.25. public void setProduct(Product product) {26. this.product = product;27. }28.29. public void setProductManager(ProductManager productManager){30. this.productManager=productManager;31. }32.33. public String insert(){34. productManager.insertProduct(product);35. return SUCCESS;36. }37. public String search(){38. List results=productManager.searchProducts(queryString);39. System.out.println(results.size());40. ServletActionContext.getRequest().setAttribute("searchresults", results);41. return SUCCESS;42. }43.44.45.}step8关于Struts2的配置文件如下Java代码1.<?xml version="1.0" encoding="UTF-8" ?>2.<!DOCTYPE struts PUBLIC3."-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"4."/dtds/struts-2.0.dtd">5.6.<struts>7.<constant name="struts.objectFactory" value="spring"/>8.9.<include file="struts-default.xml"/>10.11. <package name="product" extends="struts-default"12. namespace="/product">13.14. <!-- 配置Struts2的Action，class值要与applicationContext*.xml中的id的值一致。