Tartalomjegyzék

< Java fejlesztő környezet kialakítása

Java - Visual Studio Code

Bevezetés

A Visual Studio Code, néha röviden VSCode, egy nyílt forráskódú szövegszerkesztő.

A Programozás > Programok névtérben is van egy Visual Studo Code leírás:

Telepítés

Töltsük le az alábbi helyről:

Felület

Az oldalsáv nézeteket tartalmazhat.

Az EXPLORER estén alapértelmezetten a következő nézetek jelennek meg:

Ha megnyitunk egy .java kiterjesztésű állományt, akkor lesz egy JAVA PROJECTS nézetünk is:

A nézetek a „>” karakterre (ikonra) kattintva lenyithatók.

Java projects nézet

Bővítmények

Microsoft megoldások

Az Extension Pack tartalmazza mindezeket:

Teszteléshez opcionálisan letölthető még:

Oracle megoldás

A bővítmény neve egyszerűen Java:

Előbb be kell állítani a Java helyét. Tegyük fel, hogy a Java a következő helyen található:

Új projekt kezdése:

Java

A Visual Studio Code képes használni az előtelepített Java keretrendszereket, de le is tudja azokat tölteni.

Java JDK az Oracle-től:

Java JDK választás

Hívjuk meg a VSCode parancspaneljét, például az F1 billentyűvel, majd keressük meg:

Ott kattintsunk a ceruza ikonra:

Láthatóvá válnak a telepített Java JDK verziók:

Válasszuk ki a kívánt változatot.

Ellenőrzésként írassuk ki milyen Java verzióval működik a megírt programunk:

Java választás tárolása

A beállítás a következő helyen tárolódik

Windowson:

Linuxon:

Lehetséges tartalom: 

{
    "window.zoomLevel": 2,
    "java.configuration.runtimes": [
        {
            "name": "JavaSE-17",
            "path": "C:\\Program Files\\Java\\jdk-17.0.2",
            "default": true
        },
        {
            "name": "JavaSE-1.8",
            "path": "C:\\Program Files\\Java\\jdk1.8.0_211"
        }
    ]
}

Projekt kezdés

Az egyes lehetőségekhez megfelelő bővítmény lehet szükséges.

Tesztelés

Bővítmény:

Ez fel is veszi a használható könyvtárak közzé.

Vegyük fel a test könyvtárat a forráskönyvtárak közzé. Szerkesszük a .vscode/settings.json 

{
    "java.project.sourcePaths": ["src", "test"],
    "java.project.outputPath": "bin"
}

A tesztosztály és a tesztmetódus tetszőleges nevű lehet.

AppTest
import static org.junit.jupiter.api.Assertions.assertEquals;
import org.junit.jupiter.api.Test;
 
 
class AppValami {
    @Test
    public void calcAreaAssertion() {
 
        assertEquals(525.0, App.calcArea(30, 35 ));
    }
}

Futtatáshoz az akciósávon kémcső.

További tesztírás:

Beállítások törlése

rm ~/.config/Code/User/

Windows PowerShell: 

rm C:\Users\user\AppData\Roaming\Code\User\

GitHub kijelentkezés

GitHub VSCode-ban

A GitHub VSCode-ban való használatához telepíteni kell a következő bővítményt:

Forrás: https://code.visualstudio.com/docs/sourcecontrol/github (2023)

Automatikus mentés

Az automatikus mentés ki/be kapcsolása:

Újratervezés

Az F2 helyzetérzékeny. Az oldalsávon az EXPLORER-ben használhatjuk a kijelölt fájlok és könyvtárak átnevezésre.

A szerkesztőben, különböző szimbólumokra állva (változók, metódusok stb) azok átnevezése kezdeményezhető.

JAR fájl készítés

Az oldalsávon, kinyitjuk a Java project összetevőt:

Az egeret ezen rész felé viszem. Ekkor megjelenik egy ehhez hasonló alakzat: |→ Jobbra mutató nyíl talppal.

Ekkor megkérdezi, melyik a fő osztály, és készül a .jar fájl a projekt gyökér könyvtárában.

Code Runner

A Code Runner egy bővítmény, amely lehetővé teszi többféle programozási nyelven készült program futtatását, ha csak egy fájl van önmagában projekt nélkül.

Néha zavaró lehet ha projektet készítőt is használunk.

2023-10-08-i kiadás a következő nyelveket támogatja:

C, C++, Java, JavaScript, PHP, Python, Perl, Perl 6, Ruby, Go, Lua, Groovy, PowerShell, BAT/CMD, BASH/SH, F# Script, F# (.NET Core), C# Script, C# (.NET Core), VBScript, TypeScript, CoffeeScript, Scala, Swift, Julia, Crystal, OCaml Script, R, AppleScript, Elixir, Visual Basic .NET, Clojure, Haxe, Objective-C, Rust, Racket, Scheme, AutoHotkey, AutoIt, Kotlin, Dart, Free Pascal, Haskell, Nim, D, Lisp, Kit, V, SCSS, Sass, CUDA, Less, Fortran, Ring, Standard ML, Zig, Mojo

Debug

Legyen telepítve a „Debugger for Java” bővítmény.

Írjunk egy rövid kódot:

App.java
public class App {
    public static void main(String[] args) {
        String a = "valami";
        System.out.println(a);
 
    }
}

A public static felett megjelenik két szöveg, ami nem a kód része. A VSCode része: 

Run | Debug

Kattintsunk a Debug-ra.

Formázás mentéskor

Ne rendezze egy sorba a forráskódot: A VSCode beállításainál:

Forráskód formázása

Bővítmény:

A parancspanelon kezdjük el írni: 

Format

Két lehetőségünk lesz:

Maven projekt

Archetype alatt, alkalmazás sablont értünk.

Az első helyeken két archetype található:

Ha archetype quickstart-t választunk egy Java projekt létrehozása során, a VSCode rákérdez a projekt több tulajdonságára is.

Nélküle csak a csomag nevét kérdezi meg, a projekt helye és neve mellett. Egy minimális pom.xml jön létre.

Sablon használata

Szükséges bővítmény:

Ha telepítve van a Code Runner, érdemes letiltani.

Projekt létrehozása:

  1. Parancs panel indítása (Ctrl+Shift+p)
  2. Elkezdjük írni: Java
  3. Választás: Maven create from archetype
  4. Választás: maven-archetype-quickstart
  5. Választás: 1.4
  6. Javítjuk: com.exeple helyett: lan.zold
  7. Javítjuk: demo helyett: projekt01
  8. Kiválasztjuk a könyvtárat - Ezen a könyvtáron belül jön létre egy projekt01 könyvtár

Parancssorban:

  1. Define value for preperty 'version' 1.0-SNAPSHOT: : <Enter>
  2. Y: : <Enter>

A VSCode egy darabig eldolgozik

Projekt futtatása: F5

Sablon nélkül

A No Archetype az újabb VSCode verziókban jelent meg, 2023-ban.

Forrás: https://github.com/microsoft/vscode-maven/issues/869

Kiírja hol hozta létre a projektet.

Tesztelés

A baloldali „akció sávon” megjelenik egy kémcső. Ha erre kattintunk, tőle jobbra az „oldal sávon” tesztelési lehetőségek jelennek meg.

Ha Maven projektet hoztunk létre (nem No Archetype), akkor lesz a projektnek egy AppTest része. Alapból van egy tesztünk is benne. Futtassuk.

Az AppTest felé visszük az egeret, ekkor megjelenik egy lejátszógomb.

TODO

Két hasznos bővítmény:

A szerkesztő beállításai

A kódszerkesztőt minden projekthez a következő helyen állíthatjuk be: 

$HOME/.config/Code/User/settings.json

Csak egy projekthez, a projekt könyvtárában a .vscode könyvtárban végezzük el a beállításokat: 

.vscode/settings.json

Ajánlások és paraméterleírások kikapcsolása

Az IntelliSense egy általános kifejezés a különféle kódszerkesztő funkciókra. Szokás kódkiegészítőnek, tartalomsegítőnek vagy kód utalásoknak is hívni.

Az IntelliSense a következő beállításokkal szabályozható.

$HOME/.config/Code/User/settings.json
{
    "editor.quickSuggestions": {
        "other": false,
        "comments": false,
        "strings": false
    },
    "editor.parameterHints.enabled": false,
 
}

Ha zavaró a sok felugró ablak tegyük false értékre, azt ami nem szükséges.

Forrás: https://code.visualstudio.com/docs/editor/intellisense (2023)

settings.json generálás

Ha nincs .vscode/settings.json fájl, de szeretnénk egy beállítást leírni a fájlban, automatikusan legeneráltathatjuk:

A parancs létrehozza fájlt üresen:

.vscode/settings.json
{
}

Írjuk be a beállításunk, például:

.vscode/settings.json
{
  "window.zooomLevel": 4
}

A beállítást megtehetjük a felhasználó profil könyvtárában is. Ekkor a parancspanelon:

A java.awt nem látszik

A java.awt osztályokhoz esetén a kiegészítő nem ajánlja fel a java.awt osztályait.

Megoldás:

A szerkesztő beállításaiba: 

    "java.completion.filteredTypes" : [
        "java.awt.List",
        "com.sun.*"
    ],

Helyben: .vscode/settings.json

Például: 

{
    "java.project.sourcePaths": ["src"],
    "java.project.outputPath": "bin",
    "java.project.referencedLibraries": [
        "lib/**/*.jar"
    ],
    "java.completion.filteredTypes" : [
        "java.awt.List",
        "com.sun.*"
    ],     
}

Forrás:

Fájlok fejléce

Telepítsük a psioniq File Header bővítményt:

A beállítás fájlba másoljuk be:

.vscode/settings.json
//...
    "psi-header.config": {
        "forceToTop": true,
        "blankLinesAfter": 1,
        "license": "Custom"
    },    
    "psi-header.variables": [
        ["company", "Sallai Andras"],
        ["author", "Sallai Andras"],
        ["authoremail", "andrewteki@gmail.com"]
    ],
    "psi-header.changes-tracking": {
        "isActive": true,
        "modAuthor": "Modified By: ",
        "modDate": "Last Modified: ",
        "modDateFormat": "date",
        "include": [],
        "exclude": [
            "markdown",
            "json",
            "jsonc"
        ],
        "excludeGlob": [
            "out/**",
            "src/**/*.xyz"
        ],
        "autoHeader": "manualSave"
    },    
    "psi-header.license-text": [
        "MIT",        
    ],
    "psi-header.templates": [
        {
            "language": "*",
            "template": [
                "File: <<filepath>>",
                "Project: <<projectpath>>",
                "Created Date: <<filecreated('YYYY-MM-DD HH:mm:ss')>>",
                "Author: <<author>>",
                "-----",
                "Last Modified: <<filecreated('YYYY-MM-DD')>>",
                "Modified By: ",
                "-----",
                "Copyright (c) <<year>> <<company>>"
                "",
                "<<licensetext>>",
            ],
            "changeLogCaption": "HISTORY:",
            "changeLogHeaderLineCount": 2,
            "changeLogEntryTemplate": [
                "<<dateformat('YYYY-MM-DD')>>\t<<initials>>\t"
            ]
        },
        }],
}

Csak a helyi projekt beállításaihoz másoljuk, mert másként minden projekt ilyen licencű lesz.

A fejléc beillesztése:

6 üres sor helyett 1 van beállítva.

Minden új fájlhoz hozzáfűzi.

MIT licenc hozzáadó

Telepítendő bővítmény:

Indítás:

Bővítmények licenceléshez

Choose A license

Egy licenc fájlt szúr be.

MIT License Adder

MIT licenc fájl szúr be

psioniq File Header

Ez a fájlt kell szerkeszteni: 

.vscode/settings.json

majd:

License Header Manager

Jó lenne, rossz hónapot és napot ír.

Alapértelmezett terminál beállítása

Panel kapcsolása

Panel ki-be kapcsolása:

A panel az alsó rész, ahol a terminál is megjelenik.

Billentyűkombináció

Megjegyzés

Tabulátor

A tabulátor viselkedése a Ctrl + M billentyűkombinációval állítható:

A VSCode-ban a Tab billentyű hatására a szerkesztőben beszúr egy tabulátor a kódba. A Ctrl+M hatására ez a viselkedés megváltozik és a szerkesztő felületén ugrál a VSCode UI elemein. Ha újból megnyomjuk visszakapcsol az eredeti állapotba.

Automatikus kiegészítés

Ha kivétel kezelés szükséges, a sorra állok, majd:

De ha az egeret sorra viszem és kattintok a Quick fix-re, az is jó.

Java fájlok létrehozása

Az oldalsávon Java Projekt alatt jobb egér, osztály létrehozása.

Project Template

Telepítsük a következő bővítményt:

Készítsük el a template-nek szánt projektet.

Az oldalsávon jobb egér gomb, ahol elmenthetjük az új sablont, vagy használhatjuk a már mentett sablont:

A templatek helye

Bővítmény webhely

Template Generátor

Fájlok vagy könyvtárak template-ként használhatók.

A {homedir}/.vscode/templates könyvtárba tesszük azokat a fájlokat és könyvtárakat, amiket sablonként szeretnénk használni.

Jelöljük meg az explolerben milyen könyvtárban szeretnénk a fájl létrehozni.

A template kiválasztása:

Ezt követően megjelennek a {homedir}/.vscode/templates könyvtárban található fájlok. Válasszunk. Rákérdez milyen fájlba szeretnénk tenni, és kész.

Java snippets

Felhasználói snippets

Három lehetőségünk van:

Válasszuk ki kívánt lehetőséget. 

"console.log": {
    "prefix": "log",
        "body": [
        "console.log('$1');",
        "$2"
    ],
    "description": "console.log beszúrása"
}

Lorem ipsum

Megadhatjuk hány szóból álljon a kitöltő szöveg: 

lorem10
lorem50

REST API kliens

Bővítmény:

A bin könyvtár törlés

A bin könyvtár törlése váratlan problémákat okozhat. A kód nem fordul automatikusan újra. Megoldás:

SQLite3

Bővítmény neve:

Az oldalsávon megjelenít egy SQLITE3 EDITOR TABLES nézetet.

Diagram rajzoló

Bővítmény:

Készítsünk egy valami.drawio kiterjesztésű fájlt. Elindul a diagram rajzoló.

Git verziókövető

Ha a VSCode segítségével megnyitott könyvtár egyik szülő könyvtára már tartalmaz Git tárolótakkor figyelmeztetést kapunk:

Java Inlay Hints

A VSCode egy függvény hívásakor utal a paraméterekre. Ez néha zavaró lehet. 

Triangle.calcArea(/* base: */ 30, /* height */ 35);

Beállítás:

Beállítási lehetőségek:

Konfiguráció

Konfiguráció létrehozása:

Ha nincs megnyitva Java fájl, akkor még ki kell választani a „Java” lehetőséget.

Létrejön: 

.vscode/launch.json

Alapértelmezetten két konfiguráció jön létre:

A Current File és más konfiguráció futtatása:

A lejátszógomb mellett, legördülő listadobozból kiválaszthatjuk a kívánt konfigurációt.