Entwicklung

Entwicklerhandbuch

• Zielgruppe
• Erforderliche Vorkenntnisse
• Aufbau des Entwicklerhandbuchs
• Schnellstart
• Optionen für die Entwicklungsumgebung
  • Lokale Entwicklungsumgebung
  • Docker-basierte Entwicklungsumgebung
• Häufig gestellte Fragen
  • F: Was sind die Mindestspezifikationen für die Entwicklung?
  • F: Welche IDE sollte ich verwenden?
  • F: Sind Kenntnisse in LastaFlute oder DBFlute erforderlich?
  • F: Wo sollte ich mit meinem ersten Beitrag beginnen?
• Verwandte Ressourcen
  • Offizielle Ressourcen
  • Technische Dokumentation
  • Community
• Nächste Schritte
  • Open-Source-Volltextsuche-Server - Fess Entwicklungsübersicht
    • Übersicht
      • Merkmale von Fess
    • Technologie-Stack
      • Zielversion
      • Haupttechnologien und Frameworks
        • Java 21
        • LastaFlute
        • DBFlute
        • OpenSearch
        • Maven
    • Entwicklungstools
      • Empfohlene Entwicklungsumgebung
        • Eclipse
        • IntelliJ IDEA
        • VS Code
        • Versionskontrolle
    • Erforderliches Wissen
      • Grundkenntnisse
      • Lernressourcen
        • Offizielle Dokumentation
        • Community
        • Quellcode
    • Grundlegender Entwicklungsablauf
    • Überblick über die Projektstruktur
      • Hauptpakete
        • app
        • crawler
        • es
        • helper
        • job
    • Schnellstart der Entwicklungsumgebung
      • Voraussetzungen
      • Schritte
    • Entwicklungstipps
      • Debug-Ausführung
      • Hot Deploy
      • Überprüfung von Logs
      • Betrieb von OpenSearch
    • Community und Support
      • Fragen und Beratung
      • Beitragsmethode
    • Nächste Schritte
    • Referenzmaterialien
      • Offizielle Ressourcen
      • Technische Dokumentation
      • Community
  • Einrichten der Entwicklungsumgebung
    • Systemanforderungen
      • Hardware-Anforderungen
      • Software-Anforderungen
    • Installation der erforderlichen Software
      • Installation von Java
        • Installation von Eclipse Temurin (empfohlen)
        • Überprüfung der Installation
        • Einstellung der Umgebungsvariablen
      • Installation von Maven
        • Download und Installation
        • Einstellung der Umgebungsvariablen
        • Überprüfung der Installation
      • Installation von Git
    • IDE-Einrichtung
      • Im Fall von Eclipse
        • Installation von Eclipse
        • Empfohlene Plugins
        • Importieren des Projekts
        • Konfiguration der Ausführungskonfiguration
      • Im Fall von IntelliJ IDEA
        • Installation von IntelliJ IDEA
        • Importieren des Projekts
        • Konfiguration der Ausführungskonfiguration
      • Im Fall von VS Code
        • Installation von VS Code
        • Installation der erforderlichen Erweiterungen
        • Projekt öffnen
    • Abrufen des Quellcodes
      • Klonen von GitHub
    • Projekt bauen
      • Herunterladen der OpenSearch-Plugins
      • Erster Build
    • Ausführen von Fess
      • Ausführung von der Kommandozeile
      • Ausführung von der IDE
        • Im Fall von Eclipse
        • Im Fall von IntelliJ IDEA
        • Im Fall von VS Code
      • Überprüfung des Starts
      • Ändern der Portnummer
    • Debug-Ausführung
      • Debug-Ausführung in der IDE
        • Im Fall von Eclipse
        • Im Fall von IntelliJ IDEA
        • Im Fall von VS Code
      • Remote-Debugging
    • Nützliche Einstellungen für die Entwicklung
      • Ändern der Log-Ebene
      • Aktivieren von Hot Deploy
      • Betrieb des eingebetteten OpenSearch
      • Verwendung von externem OpenSearch
    • Code-Generierung mit DBFlute
      • Neugenerierung bei Schemaänderungen
    • Fehlerbehebung
      • Build-Fehler
      • Ausführungsfehler
      • Projekt wird in der IDE nicht erkannt
    • Nächste Schritte
    • Ressourcen
  • Architektur und Codestruktur
    • Gesamtarchitektur
      • Beschreibung der Schichten
        • Benutzerschnittstellenschicht
        • Webanwendungsschicht
        • Geschäftslogikschicht
        • Datenzugriffsschicht
        • Datenspeicherschicht
    • Projektstruktur
      • Verzeichnisstruktur
    • Details zu Hauptpaketen
      • app-Paket
        • app.web-Paket
        • app.web.admin-Paket
        • app.service-Paket
      • crawler-Paket (fess-crawler-Bibliothek)
        • crawler-Paket (fess main)
      • opensearch-Paket
        • opensearch.client-Paket
        • opensearch.query-Paket
      • helper-Paket
      • job-Paket
      • entity-Paket
      • mylasta-Paket
        • mylasta.action-Paket
        • mylasta.direction-Paket
    • Entwurfsmuster und Implementierungsmuster
      • MVC-Muster
      • DI-Muster
      • Factory-Muster
      • Strategy-Muster
    • Konfigurationsverwaltung
      • fess_config.properties
      • fess_config.xml
      • fess_message_*.properties
    • Datenfluss
      • Suchablauf
      • Crawl-Ablauf
    • Erweiterungspunkte
      • Hinzufügen benutzerdefinierter Crawler
      • Hinzufügen benutzerdefinierter Transformer
      • Hinzufügen benutzerdefinierter Extractoren
      • Hinzufügen benutzerdefinierter Plugins
    • Referenzmaterialien
      • Frameworks
      • Technische Dokumentation
    • Nächste Schritte
  • Entwicklungsworkflow
    • Grundlegender Entwicklungsablauf
    • Schritt 1: Überprüfung/Erstellung von Issues
      • Überprüfung vorhandener Issues
      • Erstellung eines neuen Issues
        • Issue-Beispielformate
    • Schritt 2: Erstellung eines Branches
      • Branch-Namenskonventionen
      • Schritte zur Branch-Erstellung
    • Schritt 3: Codierung
      • Codierungskonventionen
        • Grundlegender Stil
        • Namenskonventionen
        • Kommentare
        • Umgang mit null
        • Ausnahmebehandlung
        • Logging
      • Tests während der Entwicklung
        • Lokale Ausführung
        • Debug-Ausführung
        • Ausführen von Unit-Tests
    • Schritt 4: Ausführen lokaler Tests
      • Ausführen von Unit-Tests
      • Ausführen von Integrationstests
      • Überprüfung des Code-Formats
      • Ausführen aller Prüfungen
    • Schritt 5: Commit
      • Commit-Nachrichten-Konventionen
      • Commit-Schritte
      • Commit-Granularität
    • Schritt 6: Push
    • Schritt 7: Erstellung eines Pull Requests
      • Schritte zur PR-Erstellung
      • PR-Beispielformat
      • PR-Beschreibung
    • Schritt 8: Code-Review
      • Review-Aspekte
      • Beispiele für Review-Kommentare
    • Schritt 9: Antwort auf Review-Feedback
      • Schritte zur Beantwortung von Feedback
      • Antworten auf Kommentare
    • Schritt 10: Merge
      • Maßnahmen nach dem Merge
    • Häufige Entwicklungsszenarien
      • Funktionserweiterung
      • Fehlerbehebung
      • Refactoring
      • Dokumentationsaktualisierung
    • Entwicklungstipps
      • Effiziente Entwicklung
      • Problemlösung
    • Nächste Schritte
    • Referenzmaterialien
  • Bauen und Testen
    • Übersicht über das Build-System
      • pom.xml
    • Grundlegende Build-Befehle
      • Clean Build
      • Erstellen von Paketen
      • Vollständiger Build
      • Herunterladen von Abhängigkeiten
      • Herunterladen der OpenSearch-Plugins
    • Tests
      • Ausführen von Unit-Tests
        • Alle Unit-Tests ausführen
        • Bestimmte Testklasse ausführen
        • Bestimmte Testmethode ausführen
        • Mehrere Testklassen ausführen
      • Tests überspringen
      • Ausführen von Integrationstests
    • Schreiben von Tests
      • Erstellen von Unit-Tests
        • Platzierung von Testklassen
        • Grundstruktur einer Testklasse
        • Test-Lebenszyklus
        • Assertions
      • Test-Coverage
    • Code-Formatierung
      • Code-Formatter
      • Lizenz-Header
      • Prüfungen vor dem Commit
    • Erstellen von Verteilungspaketen
      • Erstellen von Zip-Paketen
      • Erstellen von RPM-Paketen
      • Erstellen von DEB-Paketen
    • Profile
      • build (Standard)
      • integrationTests
    • CI/CD
      • GitHub Actions
      • Lokale CI-Prüfungen
    • Fehlerbehebung
      • Build-Fehler
      • Test-Fehler
      • Abhängigkeitsprobleme
    • Best Practices für Builds
      • Regelmäßige Clean Builds
      • Ausführen von Tests
      • Code-Formatierung ausführen
      • Aktualisieren von Abhängigkeiten
      • Nutzung des Build-Cache
    • Maven-Befehlsreferenz
      • Häufig verwendete Befehle
    • Nächste Schritte
    • Referenzmaterialien
  • Leitfaden für Beiträge
    • Einführung
    • Möglichkeiten beizutragen
      • Code-Beiträge
      • Dokumentations-Beiträge
      • Issue-Berichterstattung
      • Community-Aktivitäten
    • Erster Beitrag
      • Schritt 1: Das Projekt verstehen
      • Schritt 2: Nach Issues suchen
      • Schritt 3: Entwicklungsumgebung einrichten
      • Schritt 4: Branch erstellen und arbeiten
      • Schritt 5: Pull Request erstellen
    • Codierungskonventionen
      • Java-Codierungsstil
        • Grundstil
        • Namenskonventionen
        • Kommentare
        • Klassen- und Methodendesign
        • Ausnahmebehandlung
        • Umgang mit null
        • Schreiben von Tests
    • Code-Review-Richtlinien
      • Pull-Request-Review-Prozess
      • Review-Aspekte
      • Antworten auf Review-Kommentare
    • Best Practices für Pull Requests
      • Größe der PR
      • PR-Titel
      • PR-Beschreibung
      • Commit-Nachrichten
      • Verwendung von Draft-PRs
    • Community-Richtlinien
      • Verhaltenskodex
      • Kommunikation
      • Dankbarkeit ausdrücken
    • Häufig gestellte Fragen
      • F: Können auch Anfänger beitragen?
      • F: Wie schnell werden Pull Requests überprüft?
      • F: Was passiert, wenn ein Pull Request abgelehnt wird?
      • F: Was passiert, wenn ich gegen Codierungskonventionen verstoße?
      • F: Was ist, wenn ich eine große Funktion hinzufügen möchte?
      • F: Darf ich auf Japanisch fragen?
    • Leitfaden nach Art des Beitrags
      • Verbesserung der Dokumentation
      • Fehlerbericht
      • Feature-Anfrage
      • Code-Review
    • Lizenz
    • Danksagung
    • Nächste Schritte
    • Referenzmaterialien
    • Community-Ressourcen

GitHub

Docker

JavaDoc

XRef

I/F Doc

Roadmap

• Versionierungspolitik
• 15.0

Änderungen

Issue-Tracking