1. Поисковая библиотека Lucene
Курс «Базы данных»
Андреев Герман Андреевич
Computer Science Center
18 ноября 2013 г.
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
1 / 59
7. Задача поиска
Примеры
Примеры
Поиск по документу
Хорошо изучен
Множество алгоритмов
Готовые библиотеки
Можно реализовать самому
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
7 / 59
8. Задача поиска
Примеры
Примеры
Поиск регулярных выражений:
Хорошо изучен
Множество алгоритмов
Готовые библиотеки
Сложно реализовать самому
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
8 / 59
10. Задача поиска
Примеры
Примеры
Различия между примерами:
Количество документов
Функция поиска
Ранжирование
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
10 / 59
11. Lucene
Библиотека Lucene
Библиотека Lucene
Особенности:
Реализована на Java
Достаточно компактна: lucene-core - 2.1 Mb
Богатая функциональность
Высокая скорость работы
Высокая скорость индексации
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
11 / 59
13. Lucene
Библиотека Lucene
Библиотека Lucene
История развития:
Появилась в 1999: жила на SourceForge
В 2001 переместилась в Apache
В 2005 стала top-level проектом в рамках Apache
Претерпела 4 мажорных релиза
Активно развивается: последняя версия 4.5.1
выпущена 24 октября
8 релизов только за этот год
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
13 / 59
14. Lucene
Модель данных
Модель данных
Модель данных:
Основные объекты: Document, Field
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
14 / 59
15. Lucene
Модель данных
Модель данных
Field:
Пара ключ-значение
Ключ: произвольная ненулевая строка
Значение: произвольная ненулевая строка
В 4.0.0 версии появилась возможность хранить
типизированные значения
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
15 / 59
16. Lucene
Модель данных
Модель данных
Field:
У каждого поля есть специальные атрибуты
Indexed
Stored
Tockenized
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
16 / 59
17. Lucene
Модель данных
Модель данных
Indexed Field:
Будет ли построен индекс по этому полю
По этим полям осуществляется поиск
По этим полям можно сортировать
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
17 / 59
18. Lucene
Модель данных
Модель данных
Stored Field:
Попадет ли поле в хранильще документов
Нужно ли это значение при поиске
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
18 / 59
19. Lucene
Модель данных
Модель данных
Tockenized Field:
Требуется ли дополнительная обработка значения
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
19 / 59
20. Lucene
Модель данных
Модель данных
Document:
Содержит список Field
Нет ограничения на повторяемость имени
При построении индекса каждому документу
назначается docId
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
20 / 59
21. Lucene
Построение индекса
Построение индекса
Directory:
Абстракция над файловой системой
Есть несколько реализаций
SimpleFSDirectory: простая реализация
NIOFSDirectory: реализация с использованием
NIO
MMapDirectory: реализация на основе memory
mapped файлов
RAMDirectory: все содержимое хранится в памяти
Важно! Не используйте RAMDirectory для
крупных индексов
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
21 / 59
23. Lucene
Построение индекса
Построение индекса
Построение индекса:
IndexWriterConfig: настройки индексации
IndexWriter: управляет созданием индекса
indexWriter.addDocument(...): добавление
документа в индекс
Одновременно записывать может только один
IndexWriter
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
23 / 59
24. Lucene
Построение индекса
Построение индекса
Хранилище документов:
Попадают все Stored поля
Часть исходного документа в результатах поиска
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
24 / 59
27. Lucene
Построение индекса
Построение индекса
Пример
Построение документа
1
2
3
4
5
Document doc = new Document();
Field name = new StringField("name", country.getName(),
Field.Store.YES);
doc.add(name);
Field population = new LongField("population",
country.getPopulation(), Field.Store.YES);
doc.add(population);
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
27 / 59
28. Lucene
Построение индекса
Построение индекса
Пример
Неиндексируемое поле
1
2
3
4
5
6
7
8
9
FieldType TYPE_NOT_INDEXED = new FieldType();
TYPE_NOT_INDEXED.setIndexed(false);
TYPE_NOT_INDEXED.setOmitNorms(true);
TYPE_NOT_INDEXED.setIndexOptions(IndexOptions.DOCS_ONLY);
TYPE_NOT_INDEXED.setTokenized(false);
TYPE_NOT_INDEXED.freeze();
...
Field currency = new Field("currency",
country.getCurrency(), TYPE_NOT_INDEXED);
doc.add(currency);
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
28 / 59
29. Lucene
Построение индекса
Построение индекса
Пример
Создание индекса
1
2
3
4
5
Directory dir = FSDirectory.open(new File(indexPath));
Analyzer analyzer = new
StandardAnalyzer(Version.LUCENE_40);
IndexWriterConfig iwc = new
IndexWriterConfig(Version.LUCENE_40, analyzer);
iwc.setOpenMode(OpenMode.CREATE);
IndexWriter writer = new IndexWriter(dir, iwc)
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
29 / 59
30. Lucene
Построение индекса
Построение индекса
Пример
Добавление документа
1
2
3
4
5
6
7
8
...
IndexWriter writer = new IndexWriter(dir, iwc);
for (Country country: countries) {
Document doc = new Document();
...
writer.addDocument(doc);
}
writer.close();
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
30 / 59
31. Lucene
Поиск по индексу
Поиск по индексу
Поиск по индексу:
За чтение отвечает IndexReader
За поиск - IndexSearcher
Lucene позволяет читать из индекса
одновременно с записью
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
31 / 59
32. Lucene
Поиск по индексу
Поиск по индексу
Поиск по индексу:
Для поиска indexSearcher.search(query, ...)
Все запросы - наследники Query
В простейшем случае
indexSearcher.search(query, n)
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
32 / 59
33. Lucene
Поиск по индексу
Поиск по индексу
Поиск по индексу:
TopDocs: результат поиска
totalHits: всего найденных документов
scoreDocs: список docId для найденных
документов
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
33 / 59
34. Lucene
Поиск по индексу
Поиск по индексу
Запросы:
Запросы бывают разных типов
TermQuery: наличие токена в документе
BooleanQuery: условие на основе других Query
TermRangeQuery: диапазон текстовых токенов
NumericRangeQuery: числовой диапозон
Несколько других типов
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
34 / 59
35. Lucene
Поиск по индексу
Поиск по индексу
Результаты поиска:
За результаты отвечает Collector
Чаще всего используется TopScoreDocCollector
Можно реализовать свой Collector
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
35 / 59
36. Lucene
Поиск по индексу
Поиск по индексу
Сортировка результатов:
В indexSearch.search можно передать Sort
Содержит список полей для сортировки
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
36 / 59
37. Lucene
Поиск по индексу
Поиск по индексу
Ранжирование:
Альтернатива сортировке
Задается через класс Similarity
Должно совпадать при индексировании и поиске
Нужно для полнотекстового поиска
Vector Space Model - на основе tf-idf
BM25
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
37 / 59
38. Lucene
Поиск по индексу
Поиск по индексу
Пример
Чтение индекса
1
2
3
4
Directory dir = FSDirectory.open(new File(indexPath));
Analyzer analyzer = new
StandardAnalyzer(Version.LUCENE_40);
DirectoryReader reader = DirectoryReader.open(dir);
IndexSearcher searcher = new IndexSearcher(reader);
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
38 / 59
39. Lucene
Поиск по индексу
Поиск по индексу
Пример
Построение запроса
1
2
3
4
BooleanQuery bq = new BooleanQuery();
TermQuery tq = new TermQuery(new Term("name", "Russia"));
NumericRangeQuery<Long> nrq =
NumericRangeQuery.newLongRange(
"population", 140_000_000L, Long.MAX_VALUE, true, false);
5
6
7
bq.add(tq, BooleanClause.Occur.MUST_NOT);
bq.add(nrq, BooleanClause.Occur.MUST);
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
39 / 59
40. Lucene
Поиск по индексу
Поиск по индексу
Пример
Поиск документов
1
2
3
4
TopDocs topDocs = indexSearcher.search(bq, 10);
for (ScoreDoc scoreDoc: topDocs.scoreDocs) {
Document foundDoc = indexSearcher.doc(scoreDoc.doc);
}
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
40 / 59
41. Lucene
Поиск по индексу
Поиск по индексу
Поиск документов:
foundDoc отличается от doc
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
41 / 59
42. Внутреннее устройство
Индекс на диске
Индекс на диске
Индекс разбит на сегменты
После создания сегмент не меняется
Содержит диапазон документов
Периодически выполняется merge
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
42 / 59
43. Внутреннее устройство
Индекс на диске
Индекс на диске
DocId внутри сегмента уникальны
При удалении могут появится пропуски
Merge удаляет пропуски
Merge может изменить docId
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
43 / 59
44. Внутреннее устройство
Индекс на диске
Индекс на диске
Файлы индекса:
write.lock: лок на запись
segments.gen, segments_N: commit point
Файлы сегмента начинаются на _N
.fnm: методанные полей
.fdx, .fdt: Stored поля документа
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
44 / 59
45. Внутреннее устройство
Индекс на диске
Индекс на диске
Файлы индекса:
.tim, .tip: словарь Term
.doc: список документов, содержащих Term
.tvx, .tvd, .tvf: Term Vector
.nvd, .nvm, .dvd, .dvm: нормы и данные для
ранжирования
.del: удаленные документы
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
45 / 59
46. Внутреннее устройство
Индекс на диске
Индекс на диске
Файлы индекса:
Возможно включить "склеивание"файлоф
.cfs, .cfe: составные файлы индекса
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
46 / 59
47. Внутреннее устройство
Индекс на диске
Индекс на диске
Новый сегмент создается в момент операции flush
Можно вызвать программно, обычно вызывается
автоматически
Настройки:
IndexWriterConfig.setMaxBufferedDocs:
IndexWriterConfig.setRAMBufferSizeMB
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
47 / 59
48. Внутреннее устройство
Устройиство поиска
Устройиство поиска
IndexReader: содержит списко сегментов
Поиск по каждому сегменту независим
Выполняется последовательно по списку
сегментов
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
48 / 59
49. Внутреннее устройство
Устройиство поиска
Устройиство поиска
Инвертированный индекс состоит из:
Списка Term для каждого поля
Упорядоченного списка docId для каждого Term
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
49 / 59
50. Внутреннее устройство
Устройиство поиска
Устройиство поиска
TermQuery порождают объект, умеющий:
Проверяет есть ли нужный Term для поля
Находит соответствующему списку docId
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
50 / 59
51. Внутреннее устройство
Устройиство поиска
Устройиство поиска
Query порождают объект, отвечающий за:
Хранение текущего найденного docId
Поиск следующего подходящего docId
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
51 / 59
52. Внутреннее устройство
Устройиство поиска
Устройиство поиска
BooleanQuery
Композиция из Query
Опращивает дочернии Query по очереди
Документ найден, если все дочерние Query
передвинулись на один и тотже docId
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
52 / 59
53. Внутреннее устройство
Устройиство поиска
Устройиство поиска
Большинство объектов - потоко-безопасно:
IndexReader
IndexSearcher
Query: после создания можно искать из
нескольких потоков
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
53 / 59
54. Пример использования
Пример использования
Пример использования
Размер документа: 14 полей
Одно из полей мультизначное: до 10 значений
Все поля Indexed, некоторые Stored
Порядка 100000 объектов
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
54 / 59
55. Пример использования
Пример использования
Пример использования
Размер индекса: несколько десятков мегабайт
Время построения: быстро
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
55 / 59
56. Пример использования
Пример использования
Пример использования
Жесткие требования по скорость работы
Нагрузка порядка 25 RPS
Несколько тысяч найденных объектов
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
56 / 59
57. Пример использования
Пример использования
Пример использования
Первая попытка
Оказалась неудовлетворительной
Получение документа - дорогая операция
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
57 / 59
58. Пример использования
Пример использования
Пример использования
Вторая попытка
Избавится от Stored полей
Все документы хранить в памяти
Lucene - только для поиска
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
58 / 59
59. Пример использования
Пример использования
Пример использования
Вторая попытка
Успех!
Максимальная нагрузка - сотни RPS
98% запросов - 5 ms
99.5% запросов - 25 ms
Андреев Г. А. (CompSciCenter)
Поисковая библиотека Lucene
18 ноября 2013 г.
59 / 59