Erstellen eines Projekts (und eines GitHub-Repositorys) mit Java und Gradle mit IntelliJ IDEA
Überblick
Dies ist das Verfahren vom Erstellen eines Repositorys auf GitHub bis zur Entwicklung auf IntelliJ IDEA in einem Java-Anwendungsprojekt mit Gradle.
Was zu verwenden
- GitHub
- IntelliJ IDEA
--Dieser Artikel verwendet 2018.1.
- Gradle
--Dieser Artikel verwendet Version 4.8
- JUnit
--Dieser Artikel verwendet JUnit5
Inhaltsverzeichnis
- Erstellen Sie ein GitHub-Repository
- Erstellen Sie ein Projekt mit IntelliJ IDEA
- Gradle Build-Dateieinstellungen
- Java-Quelle erstellen
- Bauen Sie mit Gradle
- Verwenden Sie JUnit 5 für Gradle-Tests
Erstellen eines GitHub-Repositorys
- Öffnen Sie den Bildschirm zum Erstellen des Repositorys
- Geben Sie die Repository-Informationen ein
- Geben Sie Ihren Lieblingsnamen ein
- Die hier festgelegte Erklärung wird automatisch in README.md beschrieben
- Überprüfen Sie, wer es braucht
- initialize this repository with a README
- Es wird empfohlen, im Grunde zu überprüfen
- Add .gitignore
--Wählen Sie Java, aber es kann vorhanden sein oder nicht, da es mit dem unten beschriebenen .gitignore-Inhalt überschrieben wird.
- Wenn Sie es erstellen, müssen Sie keine neue Datei erstellen.
- Add a license
--Wählen Sie, ob Sie eine Lizenz erwerben möchten
- Klicken Sie zum Abschluss auf die Schaltfläche Repository erstellen
Erstellen Sie ein Projekt mit IntelliJ IDEA
Was ist hier zu tun?
- Erstellen Sie ein IntelliJ IDEA-Projekt, während Sie das GitHub-Repository klonen
- Überprüfen Sie, ob das Projekt mit der Gradle-Funktion in IntelliJ IDEA verknüpft ist
- Erstellen Sie .gitignore
Was passiert, wenn Sie es tun?
- Die Build-Einstellungen von Radle werden jederzeit im Projekt angezeigt, und IntelliJ IDEA importiert automatisch Abhängigkeitsbibliotheken usw.
--Direktoren und Dateien, die vom Betriebssystem, der IDE und Build-Tools erstellt wurden und nicht vom Repository verwaltet werden, sind nicht mehr in den Repository-Änderungen enthalten.
Verfahren
- Öffnen Sie den Intellij IDEA-Startbildschirm
- Klicken Sie in der Versionskontrolle auf Auschecken
- Wählen Sie Git und klonen Sie das Repository
- Kopieren Sie die Klon-URL des oben erstellten Repositorys in die Zwischenablage und fügen Sie sie in das Feld URL: ein.
- Im Feld Verzeichnis: wird automatisch der Repository-Name eingegeben. Ändern Sie ihn daher bei Bedarf.
- Klicken Sie auf die Schaltfläche Klonen
- Ein Dialogfeld mit der Meldung Auschecken aus der Versionskontrolle wird angezeigt. Klicken Sie zur Bestätigung auf die Schaltfläche Ja.
- Erstellen Sie ein Projekt, das vom Klonbildschirm zur Projekterstellung wechselt
- Der Bildschirm Projekt importieren wird geöffnet
- Projekteinstellungen
- Projekt aus vorhandenen Quellen erstellen und Projekt aus externem Modell importieren kann ausgewählt werden, aber Projekt importieren ... ist ausgewählt.
- Eclipse, Gradle, Maven ... sind verfügbar, wählen Sie jedoch Gradle
- Klicken Sie auf die Schaltfläche Weiter
- Gradle-Einstellungen
- Use auto-import
- Wenn Sie es überprüfen, können Sie es automatisch importieren, aber es kann schwerer werden, wenn das Projekt wächst.
- Es wird empfohlen, dies zu überprüfen
- Create directories for empty content root automatically
- Wenn diese Option aktiviert ist, werden beim Erstellen des Projekts die erforderlichen Verzeichnisse wie der Quellordner erstellt.
- Es wird empfohlen, dies zu überprüfen
- Group modules
- Festlegen des Umgangs mit Modulen in IntelliJ IDEA unter Berücksichtigung des in Java9 angezeigten Modulsystems
- Verwenden expliziter Modulgruppen: Geben Sie Gruppen explizit an
- Verwenden qualifizierter Namen: Geben Sie eine Gruppe aus qualifizierten Namen an
――Das spielt keine Rolle, abhängig vom Inhalt des Projekts
- Create separate module per source set
- Wenn diese Option standardmäßig aktiviert ist, können Sie für jedes Teilprojekt ein Modul erstellen.
- Wenn Sie ein Gradle-Teilprojekt haben, wird empfohlen, es zu deaktivieren
――Ich versuche es zu deaktivieren
- Überall in Gradle
- Use default gradle wrapper (not configured for the current project)
- Use gradle "wrapper" task configuration
- Use local gradle distribution
――Ich persönlich mache das, weil es leicht zu verstehen ist, Gradle home direkt in der dritten ...
- Gradle home
- Erforderlich, wenn Lokale Gradle-Verteilung verwenden ausgewählt ist
- Legen Sie den absoluten Pfad zu libexec im Gradle-Verzeichnis fest, z. B. / ~ / gradle / 4.8 / libexec
- Gradle JVM
--Stellen Sie die JVM-Version ein, wenn Sie Gradle ausführen
- Keine Verwirrung in Kombination mit der im Projekt verwendeten JVM
- Project format
--Wählen Sie .idea (verzeichnisbasiert), es sei denn, Sie sind besonders darüber informiert
- Klicken Sie zum Abschluss auf die Schaltfläche Fertig stellen
- Möchten Sie die folgende Datei zu Git hinzufügen?
- Das .idea-Verzeichnis und die Dateien darunter werden erstellt. Fragen Sie also, ob Sie es dem Git-Repository hinzufügen möchten.
--Wählen Sie Nein, da das Verzeichnis .idea so eingestellt ist, dass es von .gitignore ignoriert wird.
- Der Projektbildschirm wird geöffnet
- Überprüfen Sie, ob das Projekt mit der Gradle-Funktion verknüpft ist
- Überprüfen Sie die Projektmotivation und den erfolgreichen Build auf dem Bildschirm des Build-Tools am unteren Rand des Fensters
--Projektname: Erfolgreich synchronisiert wird in der ersten Zeile angezeigt
- Run Build ist erfolgreich
- Ein grünes Symbol wird an jede Zeile angehängt, wenn sie erfolgreich ist, und ein rotes Symbol wird angehängt, wenn sie nicht erfolgreich ist.
- Das Gradle-Menü des Projekts wird auf dem Gradle-Werkzeugbildschirm auf der rechten Seite des Fensters angezeigt.
- Es wird als Projektname angezeigt (Auto-Import aktiviert) usw.
- Erstellen Sie .gitignore
--Erstellen Sie .gitignore direkt unter dem Projektverzeichnis mit den unten beschriebenen Inhalten
- Schließen Sie unnötige Verzeichnisse und Dateien vom Commit aus
.gitignore Inhalt
Es basiert auf RxJavas .gitignore und bietet persönlich Unterstützung für jede IDE und jedes Build-Tool. Ich denke, es ist besser, es von Anfang an festzulegen.
#Erstellen Sie nur die Ergebnisdatei
*.com
*.class
*.dll
*.exe
*.o
*.so
#Ergebnispaketdatei erstellen
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip
#Logdatei
*.log
#Vom Betriebssystem generiert
.DS_Store*
ehthumbs.db
Icon?
Thumbs.db
#Datei wird bearbeitet
*~
*.swp
#Erstellt von Gradle
.gradle
.gradletasknamecache
.m2
!gradle-wrapper.jar
#Wird vom Build-Tool generiert
target/
build/
#Generiert von IntelliJ IDEA
out
.idea
*.ipr
*.iws
*.iml
atlassian-ide-plugin.xml
#Erstellt von Eclipse
.classpath
.project
.settings
.metadata
bin/
#Generiert von NetBeans
.nbattrs
/.nb-gradle/profiles/private/
.nb-gradle-properties
#Scala Beziehung
*.cache
/.nb-gradle/private/
#Erstellt von PMD
.pmd
.ruleset
Einstellungen für Gradle-Build-Dateien
Was ist hier zu tun?
- Erstellen Sie build.gradle
- Bestätigungsbeschreibung in build.gradle
Was passiert, wenn Sie es tun?
- Wenn Sie den Inhalt zu build.gradle hinzufügen, wird die Änderung in IntelliJ IDEA erkannt und die Abhängigkeitsbibliothek und der Build werden automatisch ausgeführt.
Verfahren
- Erstellen Sie eine build.gradle-Datei direkt unter dem Projektverzeichnis
- Geben Sie zur Bestätigung eine Mindestbeschreibung in build.gradle ein
- Fügen Sie den Bestätigungstext build.gradle unten ein
- Build: Sync funktioniert mit Änderungen an build.gradle
- Vergewissern Sie sich, dass die Abhängigkeitsbibliotheken zum Pfad hinzugefügt wurden (Externe Bibliotheken auf dem Bildschirm des Projektwerkzeugs auf der linken Seite des Fensters).
- OK, wenn Junit5 hinzugefügt wird
Bestätigen Sie build.gradle
apply plugin: 'java'
repositories {
mavenCentral()
}
dependencies {
testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.2.0'
testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.2.0'
testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-params', version: '5.2.0'
}
test {
useJUnitPlatform()
}
Java-Quelle erstellen
Was ist hier zu tun?
- Erstellen Sie ein Verzeichnis mit Java-Quellen und -Ressourcen für Produkte / Tests
- Legen Sie in den Moduleinstellungen die Rolle (Markieren als) des erstellten Verzeichnisses fest.
- Stellen Sie sicher, dass Sie die Java-Quelle für Ihr Produkt erstellen und ausführen können
- Stellen Sie sicher, dass Sie die Test-Java-Quelle erstellen und ausführen können
Was passiert, wenn Sie es tun?
- Sie können Java-Quellen auf IntelliJ IDEA erstellen, erstellen und ausführen.
--Tests können mit IntelliJ IDEA ausgeführt werden
Verfahren
- Öffnen Sie den Moduleinstellungsbildschirm
- Klicken Sie mit der rechten Maustaste auf den Bildschirm des Projektwerkzeugs
- Klicken Sie auf Moduleinstellungen öffnen
- Wählen Sie Module
- Wählen Sie ein offenes Projekt aus
- Erstellen Sie ein Verzeichnis und setzen Sie Markieren als auf der Registerkarte Quellen
- Erstellen Sie jedes Verzeichnis
- src/main/java
- src/main/resources
- src/test/java
- src/test/resources
- Als Einstellungen markieren
--src / main / java: Wählen Sie Quellen
--src / main / resources: Wählen Sie Ressourcen
--src / test / java: Wählen Sie Tests
--src / test / resources: Wählen Sie Test Resources
- Legen Sie auf der Registerkarte Pfade das Ausgabezielverzeichnis für Builds auf IntelliJ IDEA fest
- Wählen Sie Modulkompilierungsausgabepfad für Compilerausgabe verwenden
- Legen Sie den Ausgabepfad fest: zum Projektverzeichnis / out / Production / classes
- Legen Sie das Projektverzeichnis / out / test / classes im Testausgabepfad fest:
- Erstellen Sie eine Produkt-Java-Quelle zur Überprüfung
- Erstellen Sie ein geeignetes Programm in src / main / java
- Stellen Sie sicher, dass Sie IntelliJ IDEA erstellen und ausführen können, während Sie die Hauptmethode schreiben
- Klicken Sie zum Ausführen mit der rechten Maustaste auf die Quelle und klicken Sie auf Run'class name.method name () '.
- Das Ergebnis wird auf dem Bildschirm "Werkzeug ausführen" von IntelliJ IDEA ausgegeben.
- Erstellen einer Test-Java-Quelle zur Überprüfung
- Erstellen Sie ein geeignetes Programm in src / test / java
- Erstellen Sie eine Testklasse mit dem Namen ~ Test
- Erstellen Sie eine Testmethode mit der Methode mit @Test (Import wird bestanden, da JUnit5 in der Abhängigkeitsbibliothek festgelegt ist).
- Testlauf
- Um den Test auszuführen, klicken Sie mit der rechten Maustaste auf die Quelle und klicken Sie auf Run'class name '(Wenn Sie mit der rechten Maustaste auf die Methode klicken, Run'method name ()')
- Die Testergebnisse werden auf dem Bildschirm "Tool ausführen" von IntelliJ IDEA ausgegeben
- Die Testklasse und die Testmethode sind im Ergebnis enthalten
Java-Quelle zur Bestätigung
Produkt
Main.java
public class Main {
public static void main(String[] args) {
System.out.println("test product");
}
}
Prüfung
MainTest.java
import org.junit.jupiter.api.Test;
public class MainTest {
@Test
public void test(){
System.out.println("test test");
}
}
Bauen Sie mit Gradle
Was ist hier zu tun?
- Fügen Sie die Hauptklasse zu build.gradle hinzu
- Erstellen und testen Sie mit der Gradle-Ausführungsfunktion auf IntelliJ IDEA
- Stellen Sie sicher, dass das Testergebnis in HTML ausgegeben wird
Was passiert, wenn Sie es tun?
- Sie können sehen, dass das Ausführen von Gradle über IntelliJ IDEA verschiedene Funktionen ausführen kann, z. B. das Erstellen, Ausführen und Testen der Quelle im Projekt.
- Sie können sehen, dass Sie Tests mit JUnit 5 mit Gradle ausführen und die Ergebnisse in HTML ausgeben können.
- Als Ergebnis wurde festgestellt, dass die Verknüpfung von IntelliJ IDEA und Gradle kein Problem darstellt und die Projekt- und Gradle-Einstellungen abgeschlossen wurden.
Verfahren
- Zu build.gradle hinzugefügt
//Geben Sie das Anwendungs-Plug-In an, um die ausführbare Klasse und die Klasse mit der ausführbaren Hauptmethode anzugeben.
apply plugin: 'application'
//Geben Sie die Ausführungszielklasse an
mainClassName = '<Java-Quellklasse für Produkt>'
//Wenn Sie dem Beispiel folgen, mainClassName= 'Main'
- Erstellen Sie mit Gradle über IntelliJ IDEA
- Öffnen Sie den Gradle-Werkzeugbildschirm
- Führen Sie den Build des Build-Elements aus
- Erfolgreicher Build auf dem Bildschirm "Ausführen"
- Die Ergebnisdatei, z. B. die Klassendatei, wird ausgegeben, um direkt unter dem Projektverzeichnis erstellt zu werden.
- Führen Sie die Hauptklasse von Gradle über IntelliJ IDEA aus
- Öffnen Sie den Gradle-Werkzeugbildschirm
- Führen Sie das Anwendungselement ausführen aus
- Auf dem Bildschirm Tool ausführen wird das Ausführungsergebnis der Java-Quellklasse für das Produkt angezeigt.
- In der Lage sein, von Gradle über JUnit 5 bis IntelliJ IDEA zu testen
- Öffnen Sie den Gradle-Werkzeugbildschirm
- Führen Sie einen Test des Überprüfungselements durch
- Auf dem Bildschirm Tool ausführen wird das Testergebnis der zu testenden Java-Quelle angezeigt.
- Klicken Sie im Bildschirm Ausführen des Werkzeugs auf das Symbol mit einem Pfeil auf der Gradle-Markierung, um das Testergebnis im Browser zu überprüfen.
- Das im Browser angezeigte Testergebnis zeigt die Anzahl der in der Testklasse beschriebenen Testverdauungen.
Was ist am Ende los?
Projektverzeichnisstruktur
.gradle
.idea
build
out
production
classes
Main.class
test
classes
MainTest.class
src
main
java
Main
resources
test
java
MainTest
resources
.gitignore
build.gradle
README.md
.gitignore
Das gleiche wie oben.
build.gradle
//Geben Sie das Java-Plug-In an, um main bzw. test zu erstellen
apply plugin: 'java'
//Geben Sie das zu verwendende Repository an
repositories {
//Verwenden Sie das Maven-Repository
mavenCentral()
}
dependencies {
// JUnit
// https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-api
testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.2.0'
// https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-engine
testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.2.0'
// https://mvnrepository.com/artifact/org.junit.jupiter/junit-jupiter-params
testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-params', version: '5.2.0'
}
//Testlaufeinstellungen in Gradle
test {
//Einstellungen für die Ausführung von Junit5 mit Gradle, Gradle4.Kann beschrieben werden, weil Gradle Junit 5 von 6 nativ unterstützt
useJUnitPlatform()
}
//Geben Sie das Anwendungs-Plug-In an, um die ausführbare Klasse und die Klasse mit der ausführbaren Hauptmethode anzugeben.
apply plugin: 'application'
//Geben Sie die Ausführungszielklasse an
mainClassName = 'Main'
Andere
- Wenn Sie den Build-Setup-Wrapper von Gradle ausführen, wird Folgendes erstellt
- Das Gradle-Verzeichnis und die Dateien, die sich auf den Gradle-Wrapper beziehen, werden darunter erstellt.
--gradlew wird erstellt
--gradlew.bat wird erstellt