基于Lucene的Compass

Compass是基于Lucene的JAVA搜索引擎开源框架。 

1.2、Compass相关网上资源 

1、官方网站1: http://www.opensymphony.com 

2、官方网站2：[url] http://www.compass-project.org[/url] 

3、官方社区：http://forum.compass-project.org 

1.3、相关文章 
1、《Compass指南》 作者：江南白衣 

http://wiki.springside.org.cn/display/springside/Compass 

2、《Compass开放源码JAVA搜索引擎框架》 作者：Tekin 

http://blog.163.com/tekin@126/blog/static/26089593200752810139533/ 

3、《Compass--在Lucene之上作了什么增强?(Pragmatic系列)》 作者：江南白衣 

http://dev.csdn.net/author/calvinxiu/996525d97f0846ba85ede2a12d2e06bf.html 

4、《Compass: 在你的应用中集成搜索功能》 作者：Shay Banon 翻译：周刚 

http://www.infoq.com/cn/articles/compass-search-tutorial 

5、《Compass 2.0：简化、集成及性能提升》作者：Ryan Slobojan 翻译：沙晓兰 

http://www.infoq.com/cn/news/2008/05/compass 

下面我们运用注释方式开发一个入门的小程序： 

以下是实体类User.java 

import org.compass.annotations.Index; import org.compass.annotations.Searchable; import org.compass.annotations.SearchableId; import org.compass.annotations.SearchableProperty; import org.compass.annotations.Store; @Searchable public class Post { private int id; private String title; private String content; private Date postTime; private String authorName; // --- constructors public Post() { } public Post(int id) { this.id = id; } // --- getter and setter @SearchableId public int getId() { return id; } // 学习compass的使用 //TOKENIZED分词索引UN_TOKENIZED非分词索引 Store是否存储 //@SearchableProperty把此属性作为索引保存到索引库中 @SearchableProperty(index = Index.TOKENIZED, store = Store.YES, boost = 3f) public String getTitle() { return title; } @SearchableProperty(index = Index.TOKENIZED, store = Store.YES) public String getContent() { return content; } @SearchableProperty(index = Index.UN_TOKENIZED, store = Store.YES) public Date getPostTime() { return postTime; } @SearchableProperty(index = Index.TOKENIZED, store = Store.YES) public String getAuthorName() { return authorName; } public void setId(int id) { this.id = id; } public void setTitle(String title) { this.title = title; } public void setContent(String content) { this.content = content; } public void setPostTime(Date postTime) { this.postTime = postTime; } public void setAuthorName(String authorName) { this.authorName = authorName; } @Override public int hashCode() { final int prime = 31; int result = 1; result = prime * result + id; return result; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (getClass() != obj.getClass()) return false; final Post other = (Post) obj; if (id != other.id) return false; return true; } @Override public String toString() { SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS"); return "id=" + id + ", title=" + title + ", postTime=" + sdf.format(postTime) + ", authorName=" + authorName + ", content=" + content; } }  

 

下面是实现搜索等功能的类SearchManager.java 

import java.util.ArrayList; import java.util.List; import org.compass.core.Compass; import org.compass.core.CompassCallback; import org.compass.core.CompassException; import org.compass.core.CompassHits; import org.compass.core.CompassSession; import org.compass.core.CompassTemplate; import org.compass.core.CompassTransaction; import org.compass.core.config.CompassConfiguration; import cn.senta.entity.User; public class SearchManager { protected Compass compass; /** * 初始化 */ public void init() { CompassConfiguration cfg = new CompassConfiguration(); cfg.setConnection("e:/test"); cfg.setSetting( "compass.engine.highlighter.default.formatter.simple.pre", "<font color='red'>"); cfg.setSetting( "compass.engine.highlighter.default.formatter.simple.post", "</font>"); cfg.addClass(User.class); compass = cfg.buildCompass(); } /** * 创建索引 */ public void createIndex(User user) { CompassSession session = compass.openSession(); CompassTransaction tx = null; try { tx = session.beginTransaction(); session.create(user); tx.commit(); } catch (Exception e) { if (tx != null) { tx.rollback(); } } finally { if (session != null) { session.close(); } } } /** * 删除一条索引记录 */ public void delete(User user) { CompassTemplate ct = new CompassTemplate(compass); ct.delete(user); } /** * 更新（重新创建）一条索引记录 */ public void update(final User user) { CompassTemplate ct = new CompassTemplate(compass); CompassCallback<Object> action = new CompassCallback<Object>() { public Object doInCompass(CompassSession session) throws CompassException { session.delete(user); session.create(user); return null; } }; ct.execute(action); } /** * 查询 */ public List<User> find(final String key) { CompassTemplate ct = new CompassTemplate(compass); return ct.execute(new CompassCallback<List<User>>() { public List<User> doInCompass(CompassSession session) throws CompassException { List<User> result = new ArrayList<User>(); CompassHits hits = session.find(key); for (int i = 0; i < hits.length(); i++) { User user = (User) hits.data(i); result.add(user); } return result; } }); } /** * 含有高亮的查询 */ public List<User> find(final String key, final int first, final int max) { CompassTemplate ct = new CompassTemplate(compass); return ct.execute(new CompassCallback<List<User>>() { public List<User> doInCompass(CompassSession session) throws CompassException { List<User> result = new ArrayList<User>(); CompassHits hits = session.find(key); int start = first; int end = first + max > hits.length() ? hits.length() : first + max; for (int i = 0; i < hits.length(); i++) { User user = (User) hits.data(i); String hit = hits.highlighter(i).fragment("userName"); if (hit != null) { user.setUserName(hit); } String hc = hits.highlighter(i).fragment("address"); if (hc != null) { user.setAddress(hc); } String hx = hits.highlighter(i).fragment("sex"); if (hx != null) { user.setSex(hx); } result.add(user); } return result; } }); } }  

 

运用JUnit进行测试的类TestSearch.java 

import java.util.List; import org.junit.Before; import org.junit.Test; import cn.senta.entity.User; public class TestSearch { private SearchManager searchManager; @Before public void setup() { searchManager = new SearchManager(); searchManager.init(); } @Test public void insert() { User user = new User(); user.setId(1); user.setUserName("吴琼"); user.setAge(20); user.setSex("女"); user.setAddress("北京"); User user2 = new User(); user2.setId(2); user2.setUserName("张舒"); user2.setAge(20); user2.setSex("女"); user2.setAddress("北京"); searchManager.createIndex(user); searchManager.createIndex(user2); } @Test public void insert2() { User user = new User(); user.setId(1); user.setUserName("吴琼"); user.setAge(20); user.setSex("女"); user.setAddress("北京"); User user2 = new User(); user2.setId(2); user2.setUserName("张舒"); user2.setAge(20); user2.setSex("女"); user2.setAddress("哈尔滨"); User user3 = new User(); user3.setId(2); user3.setUserName("张舒"); user3.setAge(20); user3.setSex("女"); user3.setAddress("哈尔滨"); searchManager.createIndex(user); searchManager.createIndex(user2); searchManager.createIndex(user3); } @Test public void delete() { User user = new User(1); searchManager.delete(user); } @Test public void search() { String key = "哈"; List<User> users = searchManager.find(key, 0, 10); for (User user : users) { System.out.println(user.toString()); } } }