lucenenet

Willkommen bei Apache Lucene.NET

Leistungsstarke Volltextsuche für .NET

Apache Lucene.NET ist eine in C# geschriebene Open-Source-Volltextsuchbibliothek. Es handelt sich um eine Portierung des beliebten Java Apache Lucene-Projekts.

Apache Lucene.NET ist eine .NET-Bibliothek, die leistungsstarke Indizierungs- und Suchfunktionen sowie Rechtschreibprüfung, Trefferhervorhebung und erweiterte Analyse-/Tokenisierungsfunktionen bietet.

Lucene.NET Version 4.8 (noch in der Betaphase) läuft überall dort, wo .NET läuft, einschließlich Windows, Unix, MacOS, Android und iOS.

Die Apache Lucene.NET-Website finden Sie unter: http://lucenenet.apache.org

Unterstützte Frameworks

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-Standard 2.1
• .NET-Standard 2.0
• .NET Framework 4.6.2

Status

Neueste Release-Version: Lucene.NET 3.0.3

Wir arbeiten an Lucene.NET 4.8.0 (derzeit in der BETA-Phase)

• Die Beta-Version ist äußerst stabil
• Hat mehr als 7800 Unit-Tests bestanden
• Lässt sich gut mit .NET 8.0 und .NET 6.0 (sowie anderen nicht unterstützten Versionen) integrieren.
• Unterstützt .NET Standard 2.1 und .NET Standard 2.0
• Unterstützt .NET Framework 4.6.2+
• Einige Entwickler nutzen es bereits in Produktionsumgebungen

Herunterladen

Lucene.NET 3.0.3

Kernbibliothek

 PM> Install-Package Lucene.Net

Alle Pakete

• Lucene.Net – Kernbibliothek
• Lucene.Net.Contrib – Verschiedene vom Benutzer bereitgestellte Funktionen und Extras
• Lucene.Net.Contrib.Spatial – Geodatensuche
• Lucene.Net.Contrib.Spatial.NTS – Geodatensuche mit Unterstützung für NetTopologySuite.

Lucene.NET 4.8.0

Kernbibliothek

 PM> Install-Package Lucene.Net -Pre

Alle Pakete

• Lucene.Net – Kernbibliothek
• Lucene.Net.Analysis.Common – Analysatoren zur Indizierung von Inhalten in verschiedenen Sprachen und Domänen
• Lucene.Net.Analysis.Kuromoji – Japanischer morphologischer Analysator
• Lucene.Net.Analysis.Morfologik – Analysator für Wörterbuchstammanalyse, integriertes polnisches Wörterbuch
• Lucene.Net.Analysis.OpenNLP – OpenNLP-Bibliotheksintegration
• Lucene.Net.Analysis.Phonetic – Analysator zur Indizierung phonetischer Signaturen (für die Suche nach Lauten)
• Lucene.Net.Analysis.SmartCn – Analysator zur Indizierung von Chinesisch
• Lucene.Net.Analysis.Stempel - Analysator zur Indizierung von Polnisch
• Lucene.Net.Benchmark – System zum Benchmarking von Lucene
• Lucene.Net.Classification – Klassifizierungsmodul für Lucene
• Lucene.Net.Codecs – Lucene-Codecs und Posting-Formate
• Lucene.Net.Expressions – Dynamisch berechnete Werte zum Sortieren/Facettenisieren/Suchen basierend auf einer austauschbaren Grammatik
• Lucene.Net.Facet – Facettierte Indizierungs- und Suchfunktionen
• Lucene.Net.Grouping – Collectors zum Gruppieren von Suchergebnissen
• Lucene.Net.Highlighter – Hebt Suchbegriffe in den Ergebnissen hervor
• Lucene.Net.ICU – Spezialisierte ICU-Analysatoren und Textmarker (International Components for Unicode).
• Lucene.Net.Join – Indexzeit- und Abfragezeit-Joins für normalisierte Inhalte
• Lucene.Net.Memory – Implementierung eines In-Memory-Index für ein einzelnes Dokument
• Lucene.Net.Misc – Indexierungstools und anderer verschiedener Code
• Lucene.Net.Queries – Filter und Abfragen, die den Kern von Lucene ergänzen
• Lucene.Net.QueryParser – Text-to-Query-Parser und Parsing-Framework
• Lucene.Net.Replicator Dienstprogramm zur Dateireplikation
• Lucene.Net.Sandbox – Verschiedene Beiträge Dritter und neue Ideen
• Lucene.Net.Spatial – Geodatensuche
• Lucene.Net.Suggest – Unterstützung für automatische Vorschläge und Rechtschreibprüfung
• Lucene.Net.TestFramework – Framework zum Testen von Lucene-basierten Anwendungen

Dokumentation

Wir haben eine vorläufige Dokumentation für Lucene.NET 4.8.0 auf der Lucene.NET-Website.

Die API ähnelt Java Lucene 4.8.0, dessen Überprüfung für Sie möglicherweise ebenfalls hilfreich sein könnte.

HINWEIS: Wir arbeiten an der Behebung von Problemen mit der Dokumentation, könnten aber mehr Hilfe gebrauchen, da es sich um ein umfangreiches Projekt handelt. Siehe #206.

Legacy-Versionen

• Lucene.Net 3.0.3 API-Dokumentation
• Lucene.Net 2.9.4 API-Dokumentation

Demos und Tools

Es gibt mehrere Demos, die als einfache Konsolenanwendungen implementiert sind und in Visual Studio kopiert und eingefügt oder in der Befehlszeile im Lucene.Net.Demo-Projekt kompiliert werden können.

Auf NuGet ist auch ein Dotnet-Befehlszeilentool verfügbar. Es enthält alle Demos sowie Tools zur Verwaltung Ihres Lucene.NET-Index, einschließlich Vorgängen wie Teilen, Zusammenführen, Auflisten von Segmentinformationen, Korrigieren, Löschen von Segmenten, Aktualisieren usw. Stellen Sie immer sicher, dass Sie Ihren Index sichern, bevor Sie Befehle ausführen dagegen!

• Voraussetzung: .NET 8.0 Runtime oder höher

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

HINWEIS: Die von Ihnen installierte Version der CLI sollte mit der von Ihnen verwendeten Version von Lucene.NET übereinstimmen.

Nach der Installation können Sie die verfügbaren Befehle und Optionen erkunden, indem Sie den Befehl lucene eingeben.

lucene-cli-Dokumentation

So können Sie einen Beitrag leisten

Wir freuen uns über Beiträge! Lesen Sie unseren Beitragsleitfaden oder lesen Sie weiter, um zu erfahren, wie Sie helfen können.

Treten Sie Mailinglisten bei

So treten Sie Mailinglisten bei

Eine Frage stellen

Wenn Sie eine allgemeine Frage zur Vorgehensweise haben oder Hilfe von der Lucene.NET-Community benötigen, abonnieren Sie bitte die user -Mailingliste, indem Sie eine E-Mail an [email protected] senden und befolgen Sie dann die Anweisungen zur Bestätigung Ihrer E-Mail-Adresse . Beachten Sie, dass Sie sich nur einmal anmelden müssen.

Nachdem Sie sich in die Mailingliste eingetragen haben, senden Sie Ihre Nachricht per E-Mail an [email protected].

Alternativ können Sie Hilfe über die aktive Community von StackOverflow erhalten.

Bitte senden Sie keine allgemeinen Fragen zur Vorgehensweise an GitHub. Verwenden Sie GitHub nur für Fehlerberichte und Aufgaben.

Melden Sie einen Fehler

Um einen Fehler zu melden, verwenden Sie bitte den GitHub Issue Tracker.

HINWEIS: In der Vergangenheit verwendete das Lucene.NET-Projekt den JIRA-Issue-Tracker, der nun veraltet ist. Wir lassen es jedoch aktiv, um ältere Probleme zu verfolgen. Bitte senden Sie alle neuen Probleme an GitHub.

Starten Sie eine Diskussion

Um eine Entwicklungsdiskussion über die technischen Funktionen von Lucene.NET zu starten, senden Sie bitte eine E-Mail an die dev -Mailingliste an [email protected] und folgen Sie dann den Anweisungen zur Bestätigung Ihrer E-Mail-Adresse. Beachten Sie, dass Sie sich nur einmal anmelden müssen.

Nachdem Sie sich in die Mailingliste eingetragen haben, senden Sie Ihre Nachricht per E-Mail an [email protected].

Senden Sie eine Pull-Anfrage

Bevor Sie mit der Arbeit an einer Pull-Anfrage beginnen, lesen Sie bitte unseren Beitragsleitfaden.

Bauen und Testen

Befehlszeile

Voraussetzungen

1. PowerShell 5.0 oder höher (sehen Sie sich diese Frage an, um Ihre PowerShell-Version zu überprüfen)
2. .NET 8.0 SDK oder höher

Ausführung

HINWEIS: Wenn das Projekt in Visual Studio geöffnet ist, kann die Hintergrundwiederherstellung diese Befehle beeinträchtigen. Es wird empfohlen, vor der Ausführung alle Instanzen von Visual Studio zu schließen, in denen Lucene.Net.sln geöffnet ist.

Um die Quelle zu erstellen, klonen Sie das Repository oder laden Sie es herunter und entpacken Sie es. Laden Sie für bestimmte Versionen die Datei .src.zip von der Download-Seite der jeweiligen Version herunter und entpacken Sie sie. Führen Sie im Repository oder im Distributionsstammverzeichnis den Build -Befehl über eine Eingabeaufforderung aus und fügen Sie die gewünschten Optionen aus der Build-Optionstabelle unten hinzu:

Windows

 > build [options]

Linux oder macOS

 ./build [options]

HINWEIS: Der build Datei muss vor der ersten Ausführung die Berechtigung zum Ausführen mit dem Befehl chmod u+x build erteilt werden.

Build-Optionen

Bei den folgenden Optionen wird die Groß-/Kleinschreibung nicht beachtet. Für jede Option gibt es sowohl eine Kurzform, die durch ein einzelnes - gekennzeichnet ist, als auch eine Langform, die durch -- gekennzeichnet ist. Den Optionen, die einen Wert erfordern, muss ein Leerzeichen und dann der Wert folgen, ähnlich wie beim Ausführen der Dotnet-CLI.

Kurz	Lang	Beschreibung	Beispiel
‑config	--Konfiguration	Die Build-Konfiguration („Release“ oder „Debug“).	build ‑‑configuration Debug
‑mp	‑‑maximum-parallele-jobs	Die maximale Anzahl paralleler Jobs, die während des Tests ausgeführt werden sollen. Wenn nicht angegeben, ist der Standardwert 8.	build ‑t ‑mp 10
‑pv	‑‑Paketversion	Die NuGet-Paketversion. Wenn nicht angegeben, wird die Version aus der Datei Version.proj verwendet.	build ‑pv 4.8.0‑beta00001
-T	--prüfen	Führt die Tests nach dem Erstellen aus. Für diese Option ist kein Wert erforderlich. Beachten Sie, dass das Testen bei 8 parallelen Jobs normalerweise etwa 40 Minuten dauert.	bauen ‑t
‑fv	‑‑Dateiversion	Die Version der Assemblydatei. Wenn nicht angegeben, wird standardmäßig der Wert --package-version verwendet (ausgenommen etwaige Vorabversionsbezeichnungen). Die Assemblyversion wird von der Hauptversionskomponente des übergebenen Werts abgeleitet, mit Ausnahme der Neben-, Build- und Revisionskomponenten.	build ‑pv 4.8.0 ‑beta00001 ‑fv 4.8.0

Der folgende Befehl erstellt beispielsweise einen Release-Build mit der NuGet-Paketversion 4.8.0-ci00015 und der Dateiversion 4.8.0. Die Assemblyversion wird von der Hauptversionskomponente des übergebenen Werts abgeleitet, mit Ausnahme der Neben-, Build- und Revisionskomponenten (in diesem Fall 4.0.0).

Windows

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

Linux oder macOS

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

Im obigen Beispiel verwenden wir „ci“ in der Paketversion, um anzugeben, dass es sich nicht um eine öffentlich veröffentlichte Betaversion handelt, sondern um die Ausgabe eines Continuous-Integration-Builds vom Master, der nach beta00014, aber vor der Veröffentlichung von beta00015 erfolgte.

NuGet-Pakete werden vom Build im Verzeichnis /_artifacts/NuGetPackages/ ausgegeben. Testergebnisse (falls zutreffend) werden im Verzeichnis /_artifacts/TestResults/ ausgegeben.

Sie können Visual Studio so einrichten, dass die NuGet-Pakete wie jeder NuGet-Feed gelesen werden, indem Sie die folgenden Schritte ausführen:

1. Klicken Sie in Visual Studio mit der rechten Maustaste auf die Lösung im Projektmappen-Explorer und wählen Sie „NuGet-Pakete für Lösung verwalten“ aus.
2. Klicken Sie auf das Zahnradsymbol neben der Dropdown-Liste „Paketquellen“.
3. Klicken Sie auf das + -Symbol (zum Hinzufügen).
4. Geben Sie der Quelle einen Namen, z. B. Lucene.Net Local Packages
5. Klicken Sie auf die Schaltfläche ... neben dem Feld „Quelle“ und wählen Sie den Ordner /src/_artifacts/NuGetPackages auf Ihrem lokalen System aus.
6. Klicken Sie auf OK

Dann müssen Sie nur noch den Lucene.Net Local Packages -Feed aus der Dropdown-Liste (im NuGet Package Manager) auswählen und können die NuGet-Pakete genauso suchen, installieren und aktualisieren wie mit jedem internetbasierten Feed.

Visual Studio

Voraussetzungen

1. Visual Studio 2022 oder höher
2. .NET 8.0 SDK oder höher

Ausführung

1. Öffnen Sie Lucene.Net.sln in Visual Studio.
2. Wählen Sie das zu testende Zielframework aus, indem Sie .build/TestTargetFramework.props öffnen und das entsprechende <TargetFramework> auskommentieren (und alle anderen auskommentieren).
3. Erstellen Sie ein Projekt oder die gesamte Projektmappe und warten Sie, bis Visual Studio die Tests erkennt. Dies kann mehrere Minuten dauern.
4. Führen Sie die Tests im Test Explorer aus oder debuggen Sie sie, optional unter Verwendung der gewünschten Filter.

HINWEIS: Stellen Sie beim Ausführen von Tests in Visual Studio sicher, dass die Standardprozessorarchitektur auf 64 Bit eingestellt ist, um zu vermeiden, dass bei einigen Tests der virtuelle Speicher knapp wird.

Azure DevOps

Wir haben unsere Datei azure-pipelines.yml mit logischen Standardwerten eingerichtet, sodass jeder mit einem Azure DevOps-Konto Lucene.NET erstellen und die Tests mit minimalem Aufwand ausführen kann. Sogar ein kostenloses Azure DevOps-Konto funktioniert, aber Tests werden viel schneller ausgeführt, wenn das Konto als öffentlich eingerichtet ist, was die gleichzeitige Ausführung von bis zu 10 parallelen Jobs ermöglicht.

Voraussetzungen

1. Ein Azure DevOps-Konto.
2. Ein Fork dieses Repositorys entweder auf GitHub oder Azure DevOps. Der Rest dieser Anweisungen setzt einen GitHub-Fork voraus.

Ausführung

Wenn Sie noch keine Pipeline eingerichtet haben:

1. Erstellen Sie eine Azure DevOps-Organisation. Wenn Sie bereits eines haben, das Sie verwenden möchten, können Sie diesen Schritt überspringen.
2. Erstellen Sie ein Azure DevOps-Projekt. Wir empfehlen, das Projekt Lucene.NET zu nennen. Beachten Sie, dass Sie, wenn Sie ein kostenloses Azure DevOps-Konto verwenden, das Projekt öffentlich machen sollten, um 10 parallele Jobs zu ermöglichen. Wenn Sie das Projekt privat machen, erhalten Sie nur 1 parallelen Job. Stellen Sie außerdem sicher, dass Pipelines aktiviert bleiben, wenn Sie Funktionen deaktivieren.
3. Erstellen Sie eine Azure DevOps-Pipeline.
   • Klicken Sie im linken Menü auf „Pipelines“.
   • Klicken Sie auf die Schaltfläche „Pipeline erstellen“ oder „Neue Pipeline“, je nachdem, ob bereits Pipelines vorhanden sind.
   • Wählen Sie GitHub als Speicherort für die YAML-Datei aus.
   • Wählen Sie den Zweig dieses Repositorys aus, den Sie unter „Voraussetzungen“ erstellt haben. Beachten Sie, dass Sie möglicherweise zusätzliche Berechtigungen für den Zugriff auf Ihr GitHub-Konto einrichten müssen, wenn es sich um ein neues Azure DevOps-Konto handelt.
   • Als Nächstes wird die Seite „Überprüfen Sie Ihr YAML“ mit dem Inhalt von azure-pipelines.yml angezeigt. Oben in der Datei befindet sich eine Dokumentation, die die Variablen angibt, die eingerichtet werden können, um zusätzliche Optionen zu aktivieren. Beachten Sie jedoch, dass in der Standardkonfiguration der Build und alle Tests automatisch ausgeführt werden.
   • Klicken Sie oben rechts auf der Seite auf die Schaltfläche „Ausführen“.

Wenn Sie bereits eine Pipeline eingerichtet haben:

1. Klicken Sie im linken Menü auf „Pipelines“.
2. Wählen Sie die Pipeline aus, die Sie ausführen möchten.
3. Klicken Sie oben rechts auf die Schaltfläche „Warteschlange“.
4. (Optional) Wählen Sie den Zweig aus und überschreiben Sie alle Variablen in der Pipeline für diese Ausführung.
5. Klicken Sie auf die Schaltfläche „Ausführen“.

Beachten Sie, dass das nuget Artefakt nach Abschluss des Builds .nupkg Dateien enthält, die auf Ihren lokalen Computer heruntergeladen werden können, wo Sie einen lokalen Ordner einrichten können, der als NuGet-Feed fungiert.

Es ist auch möglich, eine Azure DevOps-Feed-ID zu einer neuen Variablen namens ArtifactFeedID hinzuzufügen, wir erhalten jedoch aufgrund von Berechtigungsproblemen gemischte Ergebnisse.