lucenenet

Добро пожаловать в Apache Lucene.NET

Мощный полнотекстовый поиск для .NET

Apache Lucene.NET — это библиотека полнотекстового поиска с открытым исходным кодом, написанная на C#. Это порт популярного проекта Java Apache Lucene.

Apache Lucene.NET — это библиотека .NET, предоставляющая мощные функции индексирования и поиска, а также проверку орфографии, выделение совпадений и возможности расширенного анализа/токенизации.

Lucene.NET версии 4.8 (все еще находится в бета-версии) работает везде, где работает .NET, включая Windows, Unix, MacOS, Android и iOS.

Веб-сайт Apache Lucene.NET находится по адресу: http://lucenenet.apache.org.

Поддерживаемые платформы

Lucene.NET 3.0.3

• .NET Framework 4.0
• .NET Framework 3.5

Lucene.NET 4.8.0

• .NET 8.0
• .NET 6.0
• .NET Стандарт 2.1
• .NET Стандарт 2.0
• .NET Framework 4.6.2

Статус

Последняя версия выпуска: Lucene.NET 3.0.3.

Работа над Lucene.NET 4.8.0 (в настоящее время находится в БЕТА-версии)

• Бета-версия чрезвычайно стабильна
• Имеет более 7800+ пройденных модульных тестов.
• Хорошо интегрируется с .NET 8.0 и .NET 6.0 (а также с другими неподдерживаемыми версиями).
• Поддерживает .NET Standard 2.1 и .NET Standard 2.0.
• Поддерживает .NET Framework 4.6.2+.
• Некоторые разработчики уже используют его в производственных средах.

Скачать

Lucene.NET 3.0.3

Основная библиотека

 PM> Install-Package Lucene.Net

Все пакеты

• Lucene.Net — Основная библиотека
• Lucene.Net.Contrib — различные функции и дополнительные возможности, предоставленные пользователями.
• Lucene.Net.Contrib.Spatial — Геопространственный поиск
• Lucene.Net.Contrib.Spatial.NTS — геопространственный поиск с поддержкой NetTopologySuite.

Lucene.NET 4.8.0

Основная библиотека

 PM> Install-Package Lucene.Net -Pre

Все пакеты

• Lucene.Net — Основная библиотека
• Lucene.Net.Analysis.Common — анализаторы для индексации контента на разных языках и в разных доменах.
• Lucene.Net.Anaанализ.Kuromoji - Японский морфологический анализатор
• Lucene.Net.Analysis.Morfologik - Анализатор словарной основы, встроенный польский словарь
• Lucene.Net.Analysis.OpenNLP — интеграция библиотеки OpenNLP
• Lucene.Net.Analysis.Phonetic - Анализатор для индексации фонетических сигнатур (для поиска по звукам)
• Lucene.Net.Analysis.SmartCn - Анализатор индексации китайского языка
• Lucene.Net.Analysis.Stempel - Анализатор индексации польского языка
• Lucene.Net.Benchmark — Система для бенчмаркинга Lucene
• Lucene.Net.Classification — модуль классификации для Lucene
• Lucene.Net.Codecs — кодеки Lucene и форматы сообщений.
• Lucene.Net.Expressions — динамически вычисляемые значения для сортировки/фасетирования/поиска на основе подключаемой грамматики.
• Lucene.Net.Facet — возможности фасетного индексирования и поиска.
• Lucene.Net.Grouping — Сборщики для группировки результатов поиска.
• Lucene.Net.Highlighter — выделяет ключевые слова поиска в результатах.
• Lucene.Net.ICU — специализированные анализаторы и маркеры ICU (международные компоненты для Unicode)
• Lucene.Net.Join — соединения во время индексирования и времени запроса для нормализованного контента.
• Lucene.Net.Memory — реализация индекса в памяти для одного документа.
• Lucene.Net.Misc — инструменты индексирования и другой различный код.
• Lucene.Net.Queries — фильтры и запросы, которые добавляются к ядру Lucene.
• Lucene.Net.QueryParser — анализаторы текста в запросах и платформа синтаксического анализа
• Lucene.Net.Replicator Утилита репликации файлов
• Lucene.Net.Sandbox — различные вклады третьих сторон и новые идеи.
• Lucene.Net.Spatial — Геопространственный поиск
• Lucene.Net.Suggest — поддержка автоматического предложения и проверки орфографии.
• Lucene.Net.TestFramework — платформа для тестирования приложений на основе Lucene.

Документация

У нас есть предварительная документация для Lucene.NET 4.8.0 на веб-сайте Lucene.NET.

API аналогичен Java Lucene 4.8.0, ознакомление с которым также может оказаться полезным.

ПРИМЕЧАНИЕ. Мы работаем над исправлением проблем с документацией, но нам нужна дополнительная помощь, поскольку это масштабный проект. См. № 206.

Устаревшие версии

• Документация по API Lucene.Net 3.0.3
• Документация по API Lucene.Net 2.9.4

Демо и инструменты

Существует несколько демонстраций, реализованных в виде простых консольных приложений, которые можно скопировать и вставить в Visual Studio или скомпилировать из командной строки в проекте Lucene.Net.Demo.

На NuGet также доступен инструмент командной строки dotnet. Он содержит все демонстрационные версии, а также инструменты, поддерживающие ваш индекс Lucene.NET, включая такие операции, как разделение, слияние, перечисление информации о сегменте, исправление, удаление сегментов, обновление и т. д. Всегда обязательно делайте резервную копию индекса перед выполнением каких-либо команд. против этого!

• Предварительное условие: среда выполнения .NET 8.0 или выше.

 dotnet tool install lucene-cli -g --version 4.8.0-beta00015

ПРИМЕЧАНИЕ. Версия устанавливаемого интерфейса командной строки должна соответствовать используемой вами версии Lucene.NET.

После установки вы можете изучить доступные команды и параметры, введя команду lucene .

Документация lucene-cli

Как внести свой вклад

Нам нравится получать пожертвования! Прочтите наше Руководство для участников или узнайте, как вы можете помочь.

Присоединяйтесь к спискам рассылки

Как присоединиться к спискам рассылки

Задать вопрос

Если у вас есть общие вопросы или вам нужна помощь сообщества Lucene.NET, подпишитесь на список рассылки user , отправив электронное письмо на адрес [email protected], а затем следуйте инструкциям, чтобы подтвердить свой адрес электронной почты. . Обратите внимание, что вам нужно подписаться только один раз.

После того как вы подписались на список рассылки, отправьте свое сообщение по адресу [email protected].

Кроме того, вы можете получить помощь через активное сообщество StackOverflow.

Пожалуйста, не отправляйте общие практические вопросы на GitHub, используйте GitHub только для отчетов об ошибках и выполнения задач.

Сообщить об ошибке

Чтобы сообщить об ошибке, используйте трекер проблем GitHub.

ПРИМЕЧАНИЕ. Раньше проект Lucene.NET использовал систему отслеживания проблем JIRA, которая сейчас устарела. Однако мы оставляем его активным для отслеживания устаревших проблем. Пожалуйста, отправляйте любые новые проблемы на GitHub.

Начать обсуждение

Чтобы начать обсуждение технических особенностей Lucene.NET, отправьте электронное письмо в список рассылки dev по адресу [email protected], а затем следуйте инструкциям, чтобы подтвердить свой адрес электронной почты. Обратите внимание, что вам нужно подписаться только один раз.

После того как вы подписались на список рассылки, отправьте свое сообщение по адресу [email protected].

Отправить запрос на извлечение

Прежде чем приступить к работе над запросом на включение, прочтите наше руководство по участию.

Сборка и тестирование

Командная строка

Предварительные условия

1. PowerShell 5.0 или выше (см. этот вопрос, чтобы проверить свою версию PowerShell)
2. .NET 8.0 SDK или более поздняя версия

Исполнение

ПРИМЕЧАНИЕ. Если проект открыт в Visual Studio, его фоновое восстановление может помешать выполнению этих команд. Перед выполнением рекомендуется закрыть все экземпляры Visual Studio, в которых открыт Lucene.Net.sln .

Чтобы собрать исходный код, клонируйте или загрузите и разархивируйте репозиторий. Для определенных выпусков загрузите и разархивируйте файл .src.zip со страницы загрузки конкретной версии. Из корня репозитория или дистрибутива выполните команду сборки из командной строки и включите нужные параметры из таблицы параметров сборки ниже:

Окна

 > build [options]

Линукс или МакОС

 ./build [options]

ПРИМЕЧАНИЕ. Перед первым выполнением файлу build необходимо предоставить разрешение на запуск с помощью команды chmod u+x build .

Варианты сборки

Следующие параметры не чувствительны к регистру. Каждая опция имеет как краткую форму, обозначенную одинарным - , так и полную форму, обозначенную -- . За параметрами, требующими значения, должен следовать пробел, а затем значение, аналогично запуску CLI dotnet.

Короткий	Длинный	Описание	Пример
--config	--конфигурация	Конфигурация сборки («Выпуск» или «Отладка»).	сборка — конфигурация Отладка
‑mp	‑‑максимальные параллельные задания	Максимальное количество параллельных заданий, запускаемых во время тестирования. Если не указано, значение по умолчанию — 8.	сборка ‑t ‑mp 10
‑pv	‑‑версия-пакета	Версия пакета NuGet. Если не указано, будет использоваться версия из файла Version.proj.	сборка ‑pv 4.8.0‑beta00001
-т	--тест	Запускает тесты после сборки. Эта опция не требует значения. Обратите внимание, что тестирование обычно занимает около 40 минут при выполнении 8 параллельных заданий.	построить -t
‑fv	‑‑версия-файла	Версия файла сборки. Если оно не указано, по умолчанию используется значение --package-version (исключая любые метки предварительной версии). Версия сборки будет получена из основного компонента версии переданного значения, исключая второстепенные компоненты, компоненты сборки и версии.	сборка ‑pv 4.8.0‑beta00001 ‑fv 4.8.0

Например, следующая команда создает сборку Release с пакетом NuGet версии 4.8.0‑ci00015 и версией файла 4.8.0. Версия сборки будет получена из основного компонента версии переданного значения, исключая второстепенные компоненты, компоненты сборки и версии (в данном случае 4.0.0).

Окна

 > build ‑‑configuration Release ‑pv 4.8.0‑ci00015 ‑fv 4.8.0

Линукс или МакОС

 ./build ‑‑configuration Release ‑pv 4.8.0‑ci00015 ‑fv 4.8.0

В приведенном выше примере мы используем «ci» в версии пакета, чтобы указать, что это не общедоступная бета-версия, а скорее результат сборки непрерывной интеграции из основной версии, которая произошла после beta00014, но до выпуска beta00015.

Пакеты NuGet выводятся при сборке в каталог /_artifacts/NuGetPackages/ . Результаты тестирования (если применимо) выводятся в каталог /_artifacts/TestResults/ .

Вы можете настроить Visual Studio для чтения пакетов NuGet, как и любого канала NuGet, выполнив следующие действия:

1. В Visual Studio щелкните правой кнопкой мыши решение в обозревателе решений и выберите «Управление пакетами NuGet для решения».
2. Щелкните значок шестеренки рядом с раскрывающимся списком «Источники пакетов».
3. Нажмите значок + (для добавления)
4. Дайте источнику имя, например Lucene.Net Local Packages
5. Нажмите кнопку ... рядом с полем «Источник» и выберите папку /src/_artifacts/NuGetPackages в своей локальной системе.
6. Нажмите «ОК».

Затем все, что вам нужно сделать, это выбрать канал Lucene.Net Local Packages из раскрывающегося списка (в диспетчере пакетов NuGet), и вы сможете искать, устанавливать и обновлять пакеты NuGet так же, как и с любым веб-каналом.

Визуальная Студия

Предварительные условия

1. Visual Studio 2022 или более поздняя версия
2. .NET 8.0 SDK или более поздняя версия

Исполнение

1. Откройте Lucene.Net.sln в Visual Studio.
2. Выберите целевую платформу для тестирования, открыв .build/TestTargetFramework.props и раскомментировав соответствующий <TargetFramework> (и закомментировав все остальные).
3. Создайте проект или все решение и подождите, пока Visual Studio обнаружит тесты — это может занять несколько минут.
4. Запускайте или отлаживайте тесты в обозревателе тестов, при необходимости используя нужные фильтры.

ПРИМЕЧАНИЕ. При запуске тестов в Visual Studio обязательно установите 64-разрядную архитектуру процессора по умолчанию, чтобы избежать нехватки виртуальной памяти в некоторых тестах.

Azure DevOps

Мы настроили наш файл azure-pipelines.yml с логическими значениями по умолчанию, чтобы любой, у кого есть учетная запись Azure DevOps, мог собрать Lucene.NET и запустить тесты с минимальными усилиями. Даже бесплатная учетная запись Azure DevOps будет работать, но тесты будут выполняться намного быстрее, если учетная запись настроена как общедоступная, что позволяет одновременно выполнять до 10 параллельных заданий.

Предварительные условия

1. Учетная запись Azure DevOps.
2. Ответвление этого репозитория на GitHub или Azure DevOps. Остальные инструкции предполагают форк GitHub.

Исполнение

Если у вас еще не настроен конвейер:

1. Создайте организацию Azure DevOps. Если у вас уже есть тот, который вы хотите использовать, вы можете пропустить этот шаг.
2. Создайте проект Azure DevOps. Мы рекомендуем назвать проект Lucene.NET. Обратите внимание: если вы используете бесплатную учетную запись Azure DevOps, вам следует сделать проект общедоступным, чтобы включить 10 параллельных заданий. Если вы сделаете проект приватным, вы получите только 1 параллельную работу. Кроме того, при отключении функций обязательно оставьте конвейеры включенными.
3. Создайте конвейер Azure DevOps.
   • Нажмите «Трубопроводы» в меню слева.
   • Нажмите кнопку «Создать конвейер» или «Новый конвейер», в зависимости от того, существуют ли уже какие-либо конвейеры.
   • Выберите GitHub в качестве места для поиска файла YAML.
   • Выберите ветвь этого репозитория, созданную вами в разделе «Предварительные требования». Обратите внимание: если это новая учетная запись Azure DevOps, вам может потребоваться настроить дополнительные разрешения для доступа к вашей учетной записи GitHub.
   • Затем отображается страница «Проверка вашего YAML», на которой показано содержимое azure-pipelines.yml . В верхней части файла есть документация, указывающая переменные, которые можно настроить для включения дополнительных опций, но учтите, что конфигурация по умолчанию автоматически запускает сборку и все тесты.
   • Нажмите кнопку «Выполнить» в правом верхнем углу страницы.

Если у вас уже настроен конвейер:

1. Нажмите «Трубопроводы» в левом меню.
2. Выберите конвейер, который вы хотите запустить.
3. Нажмите кнопку «Очередь» в правом верхнем углу.
4. (Необязательно) Выберите ветвь и переопределите все переменные в конвейере для этого запуска.
5. Нажмите кнопку «Выполнить».

Обратите внимание, что после завершения сборки артефакт nuget содержит файлы .nupkg , которые можно загрузить на локальный компьютер, где вы можете настроить локальную папку, которая будет действовать как канал NuGet.

Также можно добавить идентификатор канала Azure DevOps в новую переменную с именем ArtifactFeedID , но мы получаем неоднозначные результаты из-за проблем с разрешениями.