Aktivieren der Volltextsuche mit Laravel Scout (2023)

ZehnLaravel-FrameworkEs ist zu einer wichtigen Ressource für Entwickler geworden, die Webdienste erstellen.

Als Open-Source-Tool bietet Laravel eine Reihe großartiger Funktionen, die es Entwicklern ermöglichen, leistungsstarke und funktionale Anwendungen zu erstellen.

Dazu gehört auchLaravel-Scout, eine Bibliothek zum Verwalten von Anwendungssuchindizes. Seine Flexibilität ermöglicht es Entwicklern, die Konfiguration zu optimieren und sie auf Algolia, Meilisearch, MySQL oder auszuführenPostgres-TreiberWählen Sie einen Speicherindex aus.

In diesem Artikel werfen wir einen genaueren Blick auf dieses Tool und zeigen Ihnen, wie Sie den Treiber verwenden, um Ihrer Laravel-App eine Volltextsuche hinzuzufügen. Sie konfigurieren eine Laravel-Demo-App zum Speichern von Modelleisenbahnnamen und fügen dann mit Laravel Scout eine Suche zur App hinzu.

Benötigen

Zur Anmeldung müssen Sie mitbringen:

• Auf Ihrem Computer sollte ein PHP-Compiler installiert sein. Dieses Tutorial verwendet PHP Version 8.1.
• Installieren Sie Docker Engine oder Docker Desktop auf Ihrem Computer
• EINSAlgolia-云-KontoSie können kostenlos erstellen

So installieren Sie Scout in einem Laravel-Projekt

Um Scout nutzen zu können, müssen Sie zunächst eine Laravel-Anwendung erstellen und die Suchfunktion darin integrieren. Das Laravel-Scout-Bash-Skript enthält Befehle zum Erstellen von Laravel-Anwendungen in einem Docker-Container. Durch die Verwendung von Docker müssen Sie keine zusätzliche Backend-Software wie die MySQL-Datenbank installieren.

Das Laravel-Crawl-Skript verwendet die Bash-Skriptsprache, daher müssen Sie es in einer Linux-Umgebung ausführen. Wenn Sie Windows verwenden, benötigen Sie das Windows-Subsystem für Linux (WSL).Aufbau.

Wenn Sie WSL verwenden, führen Sie den folgenden Befehl im Terminal aus, um Ihre bevorzugte Linux-Distribution festzulegen.

wsl -s kostenlos

Navigieren Sie dann zu dem Speicherort auf Ihrem Computer, an dem Sie das Projekt speichern möchten. Das Laravel-Crawl-Skript erstellt hier ein Projektverzeichnis. Im folgenden Beispiel wird das Laravel-Crawl-Skript auf dem ausgeführtDesktop-Verzeichniserstellen.

CD/Kanzel

Führen Sie den folgenden Befehl aus, um das Laravel-Erkennungsskript auszuführen. Es wird eine Docker-Anwendung mit dem erforderlichen Mustercode erstellt.

curl -s https://laravel.build/laravel-scout-app | ich schreie

Seitdem hast du dich verändertCD Laravel-Scout-Appin Ihrem Verzeichnis. Führen Sie dann den Befehl auswegsegelnStarten Sie den Docker-Container für Ihre Anwendung im Projektordner.

Vorsicht:Bei vielen Linux-Distributionen müssen Sie möglicherweise den folgenden Befehl ausführenSudoLaufen Sie, um mehr Privilegien zu erhalten.

./vendor/bin/ Segel setzen

Möglicherweise erhalten Sie eine Fehlermeldung:

Um dies zu beheben, verwenden Sie eine VariableAnwendungsportauf dem Port im Befehlwegsegelnangeben:

APP_PORT=3001 ./vendor/bin/sail up

Führen Sie dann den folgenden Befehl aus, um die Anwendung über Artisan auf dem PHP-Server auszuführen.

PHP-Crafting-Service

Navigieren Sie in Ihrem Browser zu der Anwendung, die unter http://127.0.0.1:8000 ausgeführt wird. Die Anwendung zeigt die Laravel-Willkommensseite über den Standardpfad an.

So fügen Sie Laravel Scout zu Ihrer App hinzu

Geben Sie im Terminal do einKomponistAktivieren Sie den PHP-Paketmanager und fügen Sie Laravel Scout zu Ihrem Projekt hinzu.

Komponist benötigt Laravel/Scout

Anschließend veröffentlichen Sie die Scout-Konfigurationsdatei mit dem Befehl „vendor:publish“. Dieser Befehl erstellt eine Konfigurationsdateiscout.phpIch binKonfigurationsverzeichnisVeröffentlichen Sie es in Ihrer App.

Handwerkeranbieter php:publish --provider="Laravel\Scout\ScoutServiceProvider"

Wechseln Sie nun die Kesselplatte.envdamit sie einen angemessenen Wert habenScout-WarteschlangeMach es an.

WertScout-WarteschlangeErmöglicht Scout, Vorgänge in die Warteschlange zu stellen, was zu schnelleren Reaktionszeiten führt. Ohne diesen Wert würde sich der Crawler-Treiber wie folgt verhaltenschöne SucheNeue Dateien nicht sofort anzeigen.

SCOUT_QUEUE=true

Ändern Sie auch die VariableDatenbankhostinnen.env-Dateisodass es zum Herunterladen auf Ihren lokalen Host verweistMySQL-DatenbankWird in Docker-Containern verwendet.

DB_HOST=127.0.0.1

So markieren Sie Modelle und erstellen Indizes

Standardmäßig durchsucht Scout das Datenmodell nicht. Sie müssen das Modell explizit als durchsuchbar kennzeichnen, indem Sie das Modell eingebenLaravel\Scout\SearchableNutzung von Immobilien.

Zuerst erstellen Sie ein Datenmodell für einenZugDemo-App und markieren Sie sie als durchsuchbar.

So erstellen Sie ein Modell

für den EinsatzZugSie möchten für jeden verfügbaren Datenverkehr einen Platzhalternamen speichern.

Führen Sie den folgenden Artisan-Befehl aus, um die Migration zu erstellen und zu benennenTabelle create_train.

php artisan make:migrate create_trains_table

Migrationen werden in einer Datei erstellt, deren Name aus dem angegebenen Namen und dem aktuellen Zeitstempel besteht.

Öffnen Sie die Migrationsdatei, die sich im Verzeichnis befindetDatenbank/Migration/ausschlafen

Um eine Kopfspalte hinzuzufügen, fügen Sie nach der Spalte den folgenden Code einAUSWEIS()in Zeile 17. Dieser Code fügt eine Kopfspalte hinzu.

$table->string('Titel');

Führen Sie den folgenden Befehl aus, um die Migration anzuwenden.

PHP-Craft-Migration

Nachdem Sie die Datenbankmigration durchgeführt haben, erstellen Sie eine Datei mit dem Namentrain.phpin der RegistryApp/Modelle/.

So fügen Sie das LaravelScoutSearchable-Attribut hinzu

Wählen Sie ein Modell ausZugum mithilfe von Attributen zu suchenLaravel\Scout\Searchableim Modell wie unten gezeigt.

Darüber hinaus müssen Sie den Suchindex konfigurieren, indem Sie die Methode aufrufendurchsuchbarDurch das Überschreiben des standardmäßigen Scout-Verhaltens wird das Modell so geändert, dass es mit dem Namen des Modellarrays übereinstimmt.

Fügen Sie der Datei also den folgenden Code hinzutrain.phpUnten ist der Code aus dem vorherigen Block.

/** * Ruft den Modellindexnamen ab. * * @return string */ public function searchableAs() { return 'trains_index'; }}

So verwenden Sie Algolia in Scout

Für Ihre erste Volltextsuche mit Laravel Scout verwenden SieAlgerischer Reiseführerverwenden. Algolia ist eine Software-as-a-Service (SaaS)-Plattform für Big Data Mining. Es bietet ein webbasiertes Dashboard, mit dem Entwickler ihre Suchindizes verwalten können, sowie eine leistungsstarke API, auf die über ein Software Development Kit (SDK) mit Ihrer bevorzugten Programmiersprache zugegriffen werden kann.

In einer Laravel-Anwendung jaAlgolia-Client-Paketdla php.

So richten Sie Algerien ein

Zuerst müssen Sie Algolia bauenPHP-Suchclient-PaketFür Ihre App installieren.

Führen Sie dazu den folgenden Befehl aus.

Composer benötigt algolia/algoliasearch-client-php

Komm schon, du musst.env-DateiErstellen.

Gehen Sie über Ihren Browser zum Algolia-Dashboard, um Ihre Anwendungs-ID und Ihren API-Schlüssel zu erhalten.

Klicken Sie unten in der linken Seitenleiste auf das SymbolIdee"beiseite legen"Idee"nehmen.

Klicken Sie auf der Seite „Einstellungen“ auf die SchaltflächeGruppen und ZugriffexistiertAPI-SchlüsselSehen Sie sich Ihren Algolia-Kontoschlüssel an.

Speichern Sie auf der Seite „API-Schlüssel“.AnmeldenummerICHAdmin-API-SchlüsselMit diesen Anmeldeinformationen authentifizieren Sie die Verbindung zwischen Ihrer Laravel-Anwendung und Algolia.

Fügen Sie mit dem Code-Editor den folgenden Code zur .env-Datei hinzu und ersetzen Sie die Platzhalter durch das entsprechende Algolia-API-Geheimnis.

ALGOLIA_APP_ID=APPLICATION_IDALGOLIA_SECRET=ADMIN_API_KEY

Ersetzen Sie auch die VariablePfadfinderführerDer aus dem folgenden Code erhaltene WertsuchenexistiertSchmerzÄndern. Wenn Sie diesen Wert ändern, verwendet Scout den Algolia-Treiber.

SCOUT_DRIVER=Algoien

So erstellen Sie einen Anwendungscontroller

Erstellung im Verzeichnisapplication/http/controllers/jedes DokumentTrainSearchController.phpSpeichern Sie den Controller für die Anwendung. Der Controller zeigt die Daten an und fügt sie dem Modell hinzuZugErgänzen.

Fügen Sie der Datei den folgenden Codeblock hinzuTrainSearchController.phpErstellen Sie einen Controller.

has('αναζήτηση τίτλου')){ $trains = Train::search($request->αναζήτηση τίτλου) ->paginate(6) ; }else{ $trains = Train::paginate(6); } return view('Zugsuche',compact('trains')); } /** * 获取模型的索引名称. * * @return string */ public function create(Request $request) { $this->validate($request,['title'=>'required']); $trains = Train::create($request->all());返回（）； }}

So erstellen Sie Anwendungspfade

In diesem Schritt erstellen Sie die zur Anzeige verwendeten Strecken und fügen neue Züge zur Datenbank hinzu.

Öffnen Sie Ihre Dateitrasy/web.phpund ersetzen Sie den vorhandenen Code durch den folgenden Block.

name('listy-item');Route::post('create-item', [TrainSearchController::class, 'create']) -> name('create-item');

Der obige Code definiert zwei Routen zur Anwendung. BenötigenIch bekommefür Routen/ZuglisteListe aller gespeicherten Zugdaten. BenötigenPost-für Routen/Projekt erstellenErstellen Sie neue Zugdaten.

So erstellen Sie App-Ansichten

Erstellen Sie Dateien im VerzeichnisRessourcen / Ausblick /und nenne sietrain search.blade.phpDiese Datei zeigt die Benutzeroberfläche für die Suchfunktion.

Fügen Sie den Inhalt des folgenden Codeblocks in die Datei eintrain search.blade.phpErstellen Sie eine Seite für die Suchfunktion.

  
 
Laravel-Volltextsuche mit Scout

 
@if(Anzahl($Fehler))
 UPS!In Ihrem Eintrag ist ein Fehler aufgetreten.
 
@foreach($errors->all() ως $error)
{{$error}}
@endforeach
 
@end wenn 
 
 
  {{$bugs->first('title') }} 
 
 
 
 einen neuen Zug erstellen 
 
 
 
 
 
Zugmanagement
 
 
 
 
 
  
 
 
 
 suchen 
 
 
  @if($trains->number()) @foreach($trains ως $key => $position)@endforeach @else@end wenn
 
 
Ausweis
 
Zugtitel
 
Erstelldatum
 
AKTUALISIERT
 
 
 
{{ ++$key }}
 
{{ $position->title }}
 
{{ $item->created_at }}
 
{{ $item->updated_at }}
 
 
Es gibt keine Informationen über die Züge
 
 
{{ $trains->links() }}
 

Der obige HTML-Code enthält ein Formularelement mit einem Dateneingabefeld und einer Schaltfläche zur Eingabe des Zugtitels vor dem Speichern in der Datenbank. Der Code enthält auch eine HTML-Tabelle, die enthältAusweis, ZehnTitel, ZehnErstellungszeitpunktICHUpdatezeitRegistrieren eines Zuges in der Datenbank.

So verwenden Sie die Algolia-Suchmaschine

Um auf diese Seite zuzugreifen, navigieren Sie mit Ihrem Browser dorthinhttp://127.0.0.1:8000/ trainlist.

Die Datenbank ist derzeit leer. Geben Sie daher den Titel des Testzugs in das Textfeld ein und klicken SieErstellen Sie einen neuen ZugKlicken Sie, um es zu speichern.

Um die Suchfunktion zu nutzen, geben Sie das Schlüsselwort aus dem Titel des gespeicherten Zuges in das Textfeld einGeben Sie einen Suchtitel eineingeben und klickenSuchen.

Wie im Bild unten gezeigt, werden nur Suchanfragen angezeigt, die das Schlüsselwort im Titel enthalten.

Schöne Suche mit Laravel Scout

Meilisearch ist eine Open-Source-Suchmaschine, die sich auf Geschwindigkeit, Effizienz und ein verbessertes Entwicklererlebnis konzentriert. Es teilt einige Funktionen mit Algolia und nutzt dieselben Algorithmen, Datenstrukturen und Forschungsergebnisse – wenn auch auf unterschiedliche WeiseEine Programmiersprache.

Entwickler können Meilisearch-Instanzen in ihrer lokalen Infrastruktur oder in der Cloud erstellen und hosten. Meilisearch bietet auch ein Beta-Cloud-Produkt ähnlich wie Algolia für Entwickler an, die das Produkt ohne Infrastrukturmanagement nutzen möchten.

Für dieses Tutorial verfügen Sie bereits über eine lokale Instanz von Merit Search auf Ihrem ComputerDocker-ContainerAktion. Sie erweitern nun die Funktionalität von Laravel Scout, um Meilisearch-Instanzen zu verwenden.

Um Beautiful Search zu Ihrer Laravel-Anwendung hinzuzufügen, führen Sie den folgenden Befehl in Ihrem Projektterminal aus.

Der Compiler benötigt meilisearch/meilisearch-php

muss als nächstes dran sein.env-DateiÄndern Sie, um sie zu konfigurieren.

ErsatzvariablePfadfinderführer,MEILISEARCH_HOSTICHMEILISEARCH_KEYinnen.env-DateiÜbergeben Sie die folgenden Variablen.

SCOUT_DRIVER=meilisearchMEILISEARCH_HOST=http://127.0.0.1:7700MEILISEARCH_KEY=Klucz blokady

TastePfadfinderführerGibt den Treiber an, den Scout verwenden sollMEILISEARCH_HOSTEine Domain, die in Ihrem Namen eine schöne Suchinstanz ausführt. Während der Entwicklung nicht erforderlich, aber für die Produktion empfohlenMEILISEARCH_KEYPlus.

Vorsicht:Kommentieren Sie Algolia ID und Secret aus, wenn Sie Meilisearch als bevorzugten Treiber verwenden.

nach Deinem Tod.env-KonfigurationWenn Sie fertig sind, verwenden Sie den folgenden Artisan-Befehl, um die bereits vorhandenen Datensätze zu indizieren.

php artisan scout: importuj „App\Models\Train“

Laravel Scout mit einer Datenbank-Engine

SchimmelDatenbank-EngineScout eignet sich am besten für Anwendungen, die kleinere Datenbanken verwenden oder kleinere Arbeitslasten verwalten. Derzeit unterstützte Datenbank-EnginesPostgreSQL oder MySQL.

Die Engine verwendet Where-Klauseln und Volltextindizes bestehender Datenbanken, um die relevantesten Suchergebnisse zu finden. Wenn Sie eine Datenbank-Engine verwenden, müssen Ihre Datensätze nicht indiziert werden.

Um die Datenbank-Engine verwenden zu können, müssen Sie über Folgendes verfügenPfadfinderführer .envLegen Sie die Variable auf die Datenbank fest.

Offen.env-DateiÄndern Sie den Wert einer Variablen in einer Laravel-AnwendungPfadfinderführer.

SCOUT_DRIVER = Datenbank

Nach der Umstellung des Treibers auf eine Datenbank wechselt Scout zur Verwendung der Datenbank-Engine für die Volltextsuche.

Collector-Engine mit Laravel Scout

Zusätzlich zur Datenbank-Engine bietet Scout auchSammelmaschine.Die Suchmaschine verwendet „Where“-Klauseln und Sammlungsfilter, um die relevantesten Suchergebnisse zu ermitteln.

Im Gegensatz zu Datenbank-Engines unterstützen Sammlungs-Engines alle relationalen Datenbanken, die Laravel unterstützt.

Sie können den Erfassungsmechanismus verwenden, indem Sie eine Umgebungsvariable festlegenPfadfinderführerexistiertsammelnOder geben Sie den Erfassungstreiber manuell in der Scout-Konfigurationsdatei an.

SCOUT_DRIVER = gesetzt

Elasticsearch-Browser

Explorer ist ein moderner Elasticsearch-Treiber für Laravel Scout, der die Leistungsfähigkeit von Elasticsearch-Abfragen nutzt. Es bietet einen kompatiblen Scout-Treiber und bietet den Vorteil, große Datenmengen in Echtzeit zu speichern, zu durchsuchen und zu analysieren. Verwendung von Elasticsearch von Laravel, um Ergebnisse in Millisekunden zurückzugeben.

Um den Elasticsearch Explorer-Treiber in einer Laravel-Anwendung zu verwenden, müssen Sie eine Vorlage herunterladendocker-compose.ymlDie Konfiguration erstellt ein Laravel-Erkennungsskript. Sie fügen zusätzliche Einstellungen für Elasticsearch hinzu und starten den Container neu.

Öffnen Sie Ihre Dateidocker-compose.ymlund ersetzen Sie den Inhalt durch Folgendes.

# Hersteller: https://laravel.com/docs/sailversion: '3'services: laravel.test: build: context: ./vendor/laravel/sail/runtimes/8.1 dockerfile: Dockerfile args: WWWGROUP: '$ {WWWGROUP}' Versionen: sail-8.1/app extra_hosts: - porty 'host.docker.internal:host-gateway': - '${APP_PORT:-80}:80' - '${VITE_PORT:-5173}:$ {VITE_PORT:-5173}' Status:WWWUSER: '${WWWUSER}' LARAVEL_SAIL: 1 XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}' XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG_stternal.-in. .:/var/www/html' Benutzeroberfläche: - Zugriff auf: - mysql - redis - meilisearch - mailhog - selen - pgsql - elasticsearch mysql: image: 'mysql/mysql-server: 8,0' porty: -ARD_D{ :-3306}:3306' 环境:MYSQL_ROOT_PASSWORD:'${DB_PASSWORD}' MYSQL_ROOT_HOST:"%" MYSQL_DATABASE:'${DB_DATABASE}' MYSQL_ROOT_PASSWORD:'${DB_PASSWORD}' MYSQL_ROOT_HOS {DB_PASSWO RD}' MYSQL _ALLOW_EMP TY_PASSWORD: 1: - 'sail-mysql:/var/lib/mysql' - './vendor/laravel/sail/database/mysql/create-testing-database.sh:/docker-entrypoint-initdb.d/10-create - sieci testen- 'database.sh': - Erweiterte Suche: Zugriff: ["CMD", "mysqladmin", "ping", "-p${DB_PASSWORD}"] Version: 3 Monate: 5s Elasticsearch: Version: 'elasticsearch : 7.13 . 4' Status: - Discovery.type=single-node Status: - '9200:9200' - '9300:9300' Status: - 'sailelasticsearch:/usr/share/elasticsearch/data' Versionsnummer: 'kibana:7.13 .4' Status:- elasticsearch.hosts=http://elasticsearch:9200 Parameter:- '5601:5601' Status:- Gespeichert von: - elasticsearch redis:alpine: ： - '${FORWARD_REDIS_PORT:-6379}:6379 ' woluminy: - sieci 'sail-redis:/data': - control stanu żagli: test: ["CMD", "redis-cli", "ping"] Status: 3 POSTGRES_USER: ' ${DB_USERNAME }' POSTGRES_PASSWORD: '${DB_PASSWORD:-secret}' woluminy: - sieci 'sailpgsql:/var/lib/postgresql/data': - Erweiterte Einstellungen: [żaCLA "pg_isready", "- q", "-d", "${DB_DATABASE }", "-U", "${DB_USERNAME}"] ' Sieci: - sprawdzanie stanu żagli: δοκιμή: ["CMD", "wget", "--no-verbose", "--spider", "http : //localhost:7700/health"] Wahrscheinlichkeit: 3 Grenzwerte: 5 Sekunden mailhog: image: 'mailhog/mailhog:latest' Status: - "${FORWARD_MAILHOG_PORT:-1025}:1025" - "${FORWARD_MAILHOG_DASHBOARD_PORT: -8025}: 8025" -gateway' 卷：- '/dev/shm:/dev/shm' 网络络:- Sailnetworks: Sail: Treiber: Bridgevolumes: Sail-Mysql: Treiber: Browser: Sail-Redis: ilisearch: Treiber Typ: Benutzt, Sailpgsql: Benutzt, Benutzt: Benutzt, Sailelasticsearch: Benutzt, Benutzt: Benutzt

Führen Sie dann den folgenden Befehl aus, um das neue Elasticsearch-Image zu laden, das dem Archiv hinzugefügt wurdedocker-compose.ymlErgänzen.

Hafenarbeiterlager

Führen Sie dann den folgenden Composer-Befehl aus, um Explorer in Ihrem Projekt zu installieren.

Composer benötigt Jeroen-G/Explorer

Sie müssen außerdem eine Konfigurationsdatei für den Ressourcenverwaltungstreiber erstellen.

Führen Sie den folgenden Artisan-Befehl aus, um die Datei zu erstellenKonfigurationsdatei für die RessourcenverwaltungSpeichern Sie die Konfiguration.

PHP-Artist-Anbieter: post --tag=explorer.config

Die oben erstellten Konfigurationsdateien werden im Verzeichnis gespeichert/Aufbauverfügbar.

in Ihrem Profilconfig/explorer.phpSie können Ihr Modell mit einem Schlüssel entsperrenIndexBericht.

'indiksy' => [ AppModelsTrain::class],

Ändern Sie den Wert der VariablenPfadfinderführerinnen.env-DateiexistiertGummibandKonfigurieren Sie Scout für die Verwendung des Explorer-Treibers.

SCOUT_DRIVER = Flexibel

Sie verwenden derzeit den ExplorerZugModelliert durch Implementierung von Ressourcenmanagementschnittstellen und -methodenabbildbar()Abdeckung

öffne die Dateitrain.phpin der RegistryAnwendungen > ModelleUnd ersetzen Sie den vorhandenen Code durch den folgenden Code.

$this->Id, 'title' => $this->title, ]; }}

Nachdem Sie den obigen Code hinzugefügt haben, können Sie nun den Text im Modell mit dem Explorer durchsuchenZugSuchen.

Für PHP-Entwickler ist das Hinzufügen einer schnellen und leistungsstarken Volltextsuche mit Plugins wie Laravel und Scout ein Kinderspiel. Mit Datenbank-Engines, Sammlungs-Engines sowie Meilisearch- und Elasticsearch-Funktionen können Sie in Millisekunden mit der Datenbank Ihrer Anwendung interagieren und erweiterte Suchmaschinen implementieren.

Durch die nahtlose Datenbankverwaltung und -aktualisierung erhalten Ihre Benutzer die bestmögliche Erfahrung und Ihr Code bleibt sauber und effizient.

Mit unserer LösungAnwendungs- und DatenbankhostingKinsta ist ein One-Stop-Shop für alle Ihre modernen Laravel-Entwicklungsbedürfnisse.Wir übernehmen die ersten 20 $.