Come usare VSCode
per Spring e non solo!
Creato da Simone Benedetto, AA 20/21
PERCHÉ NON Possiamo usare due parametri di avvio:
(Compatibili con molte altre app Electron)
SUDDIVIDERE --extensions-dir "<DIR>"
L’EDITOR IN --user-data-dir "<DIR>"
BASE ALL’ Es: creiamo un collegamento a:
AMBIENTE "C:\Program Files\Microsoft VS Code\[Link]"
--extensions-dir "C:\VSCodeEnv\Spring\ext"
CHE --user-data-dir "C:\VSCodeEnv\Spring\usr"
(Se code non si trova in programmi, controllare
VOGLIAMO "%localappdata%\Programs\Microsoft VS Code"
Se [Link] è nel PATH, possiamo omettere il
USARE? percorso intero e usare "code")
Estensioni consigliate per Spring Boot
(A parte quelle di default per Java)
Altre estensioni utili, ma non fondamentali
• REST Client per non usare Postman
• Java Code Generators per generare
(tramite tasto destro, Java Generator:GUI)
getters, setters e constructors
• MySQL per gestire le connessioni a DB
MySQL e MariaDB
Inizializzare un progetto
Dopo aver installato le estensioni consigliate, aprire la command palette (View, Command
Palette.."), digitare:
INITIALIZR
E scegliere Create a Maven Project. Seguire tutti i passi necessari (Aggiungere le
dipendenze consigliate dal prof) e scegliere la cartella di destinazione del nuovo progetto.
Cliccare su open per aprire subito il progetto.
Se si dimentica qualche starter o si vuole aggiungere successivamente, si può digitare
nuovamente "initializr" e scegliere "Spring Initializr: Add Starters"
Se dovesse spuntare questo popup dopo aver aperto il progetto premere SI.
Altri due popup potrebbero comparire.
Uno vi chiederà se volete usare Maven. Accettate.
L'altro potrebbe comparire se si apre per la prima volta un file .java. L'editor vi sta
consigliando delle estensioni utili. Premere INSTALLA.
Per altri dubbi: [Link]
Snippets 1/3
"Spring boot snippets" aiuta nella creazione del file
[Link].
Scrivendo "spring-" compariranno alcuni suggerimenti.
Visto che il tipo di DB che abbiamo scelto di usare è MySQL,
usiamo spring-mysql.
Il codice pre-generato non è però sufficiente. E'
necessario decommentare (Rimuovere il #) dalla riga 4,
e aggiungere le due righe (7 e 8) manualmente.
A riga 7 si può personalizzare la porta di ascolto
dell'applicazione (E conseguentemente, del REST server)
Snippets 2/3
"Spring boot snippets" offre un enorme aiuto fornendo alcuni
"snippets", interi pezzi di codice generati automaticamente
scrivendo delle parole chiave.
Creiamo un file .java e rendiamolo vuoto.
Scriviamo "spring-".
Spring-entity genera una classe mock-up per un'entità.
Consiglio l'uso di spring-jparepo invece che di spring-crudrepo.
Jparepo è un'interfaccia che estende crudrepo aggiungendo il
supporto al Sorting e all'uso di Example. (Vedi wiki)
Spring-crudctrl crea una classe controller con alcuni metodi
all'interno. Gli altri spring-ctrl sono mock-up di singoli metodi
Una volta scelto lo snippet usare il tasto TAB per compilare i
campi dello snippet (Quelli illuminati).
Il campo dopo "package" è buggato, lasciare il valore di default
e modificarlo dopo.
Snippets 3/3 {
"Spring service": {
"scope": "java",
"prefix": "spring-service",
"Spring boot snippets" purtroppo non è provvisto di "body": [
"spring-service". "package packageName;",
"",
Possiamo fare tre cose: "import [Link];",
"import [Link];",
• Imparare a memoria come creare un service "",
"import [Link];",
"",
• Non creare un service e implementare altri eventuali metodi "@Service",
dentro la classe controller "public class ${1:EntityName}Service {",
"",
"\t@Autowired",
• Creare uno snippet nostro "\tprivate ${2:RepoName} repository;",
"",
Per creare uno snippet nostro: aprire la command palette "\tpublic $1 add$1($1 e) {",
"\t\treturn [Link](e);",
(View -> command palette) e seguire i passi qui descritti: "\t}",
"",
"\tpublic Optional<$1> get$1(${3:EntityIDType} id) {",
"\t\treturn [Link](id);",
"\t}",
"",
"\tpublic $1 update$1($1 e) {",
"\t\treturn [Link](e);",
"\t}",
"",
"\tpublic void delete$1($3 id) {",
"\t\[Link](id);",
"\t}",
"$0",
"}"
]
}
}
Incolliamo il testo qui accanto. Per info su come creare snippets:
[Link]
Idee per MySQL
1. Installare solo MySQL/MariaDB (Rinunciando a PhpMyAdmin)
2. Installare uno stack LAMP manualmente (Su linux o su WSL)
3. Installare uno xAMP one-click
(Attenzione: l'account usato per loggare automaticamente in
PhpMyAdmin, potrebbe non è root, ma pma. Questo a volte
può dare problemi. Inoltre tra gli utenti già definiti potrebbe
essere presente l'account senza nome che potrebbe avere
priorità rispetto ad altri utenti).
Esempi:
• EasyPHP
• XAMPP
Oppure…
Su windows è fortemente consigliato/necessario
usare WSL2.
Docker! Una volta installato docker (O docker desktop su
windows/Mac),
Digitare da linea di comando:
• docker volume create mysqlData
• docker run -p "3306:3306" -p "3380:80" -v
mysqlData:\var\lib\mysql
mattrayner/lamp:latest
Legenda: in blu il nome del volume, in verde le
porte host, in arancio le porte del container
Abbiamo installato: localhost:3380/phpmyadmin
N.B. "root" non ha password ma non è utilizabile
da PhpMyAdmin per motivi di sicurezza.
In fase di run, in console spunterà un account
"admin" e una password casuale. Admin è
utilizzabile anche da remoto.
Usare l'estensione 'MySQL' su VSCode
Si può scegliere di creare a priori l'utente che userà il
progetto, ad esempio usando PhpMyAdmin, oppure da
linea di comando con:
CREATE USER 'portal'@'%' IDENTIFIED BY 'portal';
CREATE DATABASE IF NOT EXISTS 'portal';
GRANT ALL PRIVILEGES ON 'portal'.* TO 'portal'@'%';
A questo punto, possiamo usare questo nuovo account.
In alternativa, si può scegliere di usare qualsiasi altro
account, come l'account admin o root*, esponendo però il
DB a "rischi".
Seguire l'immagine per definire una nuova connessione.
*(In alcune installazioni l'account di root è utilizzabile solo tramite password e/o
localhost)
Usare l'estensione ' Java Code Generators ' su VSCode
Grazie a Java Code Generators possiamo
generare automaticamente costruttori,
getters e setters.
Per farlo, definire gli attributi,
cliccare sulla riga in cui vogliono inserire i metodi,
tasto destro,
Java Generator GUI,
spuntare gli attributi di cui si vogliono generare i
metodi,
cliccare il tasto corrispondente ai metodi
desiderati, ad esempio, Getters() and Setters()
Come eseguire e testare il WS creato
Una volta che tutti i componenti sono stati creati (Entity,
Repository e Controller (Service a scelta)), possiamo avviare il
WS dalla dashboard, cliccando l'icona "play".
Se tutto andrà bene, l'icona vicino il nome del progetto
("demo" nella figura) resterà verde.
Adesso possiamo usare postman per provare le interfacce API
create. Se invece non vogliamo spostarci da VSCode, possiamo
usare l'estensione REST Client.
Creiamo un file con estensione .http, e scriviamo qui
la richiesta. Per richieste di tipo POST è necessario aggiungere:
• content-type: application/json
• una riga vuota (riga 3)