Gitignore-Datei für Java

  2. How-To's
  3. Java-Howtos
  4. Gitignore-Datei für Java
MD Aminul Islam 20 Juni 2023
Java Java Git
  1. Übersicht der .gitignore-Datei für Java
  2. Zu befolgende Regeln zum manuellen Erstellen der .gitignore-Datei
  3. Beispiel der .gitignore-Datei in Java
Gitignore-Datei für Java

Das heutige Tutorial behandelt die .gitignore-Datei für Java anhand eines Beispiels und listet die Regeln auf, die beim manuellen Erstellen von .gitignore zu befolgen sind.

Übersicht der .gitignore-Datei für Java

In Git wird der Begriff Ignorieren verwendet, um Dateien nicht zu verfolgen, die Git ignorieren sollte, und es wirkt sich nicht auf die anderen Dateien aus, die bereits verfolgt werden. Beispielsweise möchten wir manchmal bestimmte Dateien nicht an den Git-Dienst wie Github senden.

Es gibt eine Datei namens .gitignore, durch die wir die Dateien angeben können, die ignoriert werden müssen. Im Allgemeinen wird diese Datei maschinell generiert. Einige häufig angegebene Dateien in .gitignore sind unten aufgeführt:

  • Die Abhängigkeit von Caches.
  • Kompilierte Codes.
  • Erstellen Sie Ausgabeverzeichnisse wie /bin, /out oder /target.
  • Generierte Laufzeitdatei wie .log, .lock oder .tmp.
  • Versteckte Systemdateien, wie Thumbs.db oder .DS_Store.
  • Ihre IDE config-Dateien.

Zu befolgende Regeln zum manuellen Erstellen der .gitignore-Datei

Wenn wir versuchen, eine .gitignore-Datei manuell zu erstellen, müssen Sie die folgenden Regeln befolgen:

  • Git ignoriert die mit # beginnenden Zeilen oder die Leerzeilen.
  • Sollte nur the Standard glob patterns folgen und rekursiv anwenden.
  • Um Rekursionen zu vermeiden, können wir die Muster mit einem / beginnen.
  • Um ein Verzeichnis anzugeben, können wir die Muster mit / beenden.
  • Um ein Muster zu negieren, müssen wir es mit einem ! beginnen.

Beispiel der .gitignore-Datei in Java

Unten ist ein Beispiel für eine .gitignore, die speziell für die Intellij-IDE-Projekte generiert wurde. Lass uns einen Blick darauf werfen.

### Intellij ###
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm, and Rider
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839

# User-specific stuff
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
.idea/**/dictionaries
.idea/**/shelf

# AWS User-specific
.idea/**/aws.xml

# Generated files
.idea/**/contentModel.xml

# Sensitive or high-churn files
.idea/**/dataSources/
.idea/**/dataSources.ids
.idea/**/dataSources.local.xml
.idea/**/sqlDataSources.xml
.idea/**/dynamic.xml
.idea/**/uiDesigner.xml
.idea/**/dbnavigator.xml

# Gradle
.idea/**/gradle.xml
.idea/**/libraries

# Gradle and Maven with auto-import
# When using Gradle or Maven with auto-import, you should exclude module files,
# since they will be recreated and may cause churn.
Uncomment if using
# auto-import.
# .idea/artifacts
# .idea/compiler.xml
# .idea/jarRepositories.xml
# .idea/modules.xml
# .idea/*.iml
# .idea/modules
# *.iml
# *.ipr

# CMake
cmake-build-*/

# Mongo Explorer plugin
.idea/**/mongoSettings.xml

# File-based project format
*.iws

# IntelliJ
out/

# mpeltonen/sbt-idea plugin
.idea_modules/

# JIRA plugin
atlassian-ide-plugin.xml

# Cursive Clojure plugin
.idea/replstate.xml

# SonarLint plugin
.idea/sonarlint/

# Crashlytics plugin (for Android Studio and IntelliJ)
com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties
fabric.properties

# Editor-based Rest Client
.idea/httpRequests

# Android studio 3.1+ serialized cache file
.idea/caches/build_file_checksums.ser

### Intellij Patch ###
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721

# *.iml
# modules.xml
# .idea/misc.xml
# *.ipr

# Sonarlint plugin
# https://plugins.jetbrains.com/plugin/7973-sonarlint
.idea/**/sonarlint/

# SonarQube Plugin
# https://plugins.jetbrains.com/plugin/7238-sonarqube-community-plugin
.idea/**/sonarIssues.xml

# Markdown Navigator plugin
# https://plugins.jetbrains.com/plugin/7896-markdown-navigator-enhanced
.idea/**/markdown-navigator.xml
.idea/**/markdown-navigator-enh.xml
.idea/**/markdown-navigator/

# Cache file creation bug
# See https://youtrack.jetbrains.com/issue/JBR-2257
.idea/$CACHE_FILE$

# CodeStream plugin
# https://plugins.jetbrains.com/plugin/12206-codestream
.idea/codestream.xml

# Azure Toolkit for IntelliJ plugin
# https://plugins.jetbrains.com/plugin/8053-azure-toolkit-for-intellij
.idea/**/azureSettings.xml

### Java ###
# Compiled class file
*.class

# Log file
*.log

# BlueJ files
*.ctxt

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.nar
*.ear
*.zip
*.tar.gz
*.rar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
replay_pid*

# End of https://www.toptal.com/developers/gitignore/api/java,intellij

Die .gitignore-Datei muss sich in einem root-Verzeichnis befinden.

Autor: MD Aminul Islam
MD Aminul Islam avatar MD Aminul Islam avatar

Aminul Is an Expert Technical Writer and Full-Stack Developer. He has hands-on working experience on numerous Developer Platforms and SAAS startups. He is highly skilled in numerous Programming languages and Frameworks. He can write professional technical articles like Reviews, Programming, Documentation, SOP, User manual, Whitepaper, etc.

LinkedIn