Skip to content

Latest commit

 

History

History
564 lines (512 loc) · 24.2 KB

README.md

File metadata and controls

564 lines (512 loc) · 24.2 KB

PROGETTO DI OOP

Applicazione in JAVA con SpringBoot per recuperare informazioni ed effettuare statistiche sulla Serie A

Introduzione

Il progetto è una applicazione completamente in Java che utilizza le API fornite da Football-data.org
per scaricare (in formato JSON) informazioni sul campionato italiano, le sue squadre e i suoi marcatori,
ed effettuare statistiche e filtri.

Indice

  1. Glossario
  2. Installazione
  3. Diagrammi UML
    1. Casi d'uso
    2. Classi
    3. Interazioni
  4. Funzionamento
  5. Struttura
  6. Utilizzo
    1. Rotte
    2. Statistiche
    3. Filtri
  7. Esempi
  8. JavaDoc
  9. Test
  10. Software e Risorse utilizzate
  11. Sviluppatori

Glossario

Spiegazione dei termini chiave maggiormente utilizzati in questo progetto.

Termine utilizzato Significato
Competition Evento calcistico composto da più partite nella sua definizione più generale (Campionato, Coppe, ecc...)
League Tipo di Competition, caratterizzato da un numero predefinito di partite (giornate), giocato da un numero di Team che non possono essere squalificati
Area Luogo geografico di svolgimento di una Competition
Team Insieme di Players, fa parte di una League e compete con altri Team, ha varie caratteristiche come nome lungo, nome corto, ID, nome abbreviato, Url del logo societario, numero di telefono, indirizzo email, indirizzo web, indirizzo stradale della sede, anno di fondazione, colori societari.
Season Rappresenta l'intervallo temporale in cui si svolge una Competition, e la squadra vincente di quella edizione di Competition (se esiste)
WinnerTeam Team che ha vinto l'ultima Season di una Competition
Player Componente di una squadra, ha varie caratteristiche come nome, cognome, nome completo, data di nascita, nazionalità, posizione.
Scorer Sottoclasse di player, rappresenta un player che ha segnato almeno un gol
Young Scorer Scorer con età minore di 28 anni
Position Ruolo di un giocatore (Attacker, Midfielder, Defender o Goalkeeper)
Nazionalità L'appartenenza a una nazione come entità etnica
Venue Luogo di svolgimento delle partite "in casa" di un Team (stadio)
Short Name Il nome di una squadra "corto" (esempio: "Inter")
Long Name Il nome di una squadra "lungo" (esempio: "FC Internazionale Milano")

Installazione

  • Clonare il repository (o scaricare e scompattare lo zip) 
    $ git clone https://github.com/leonardoman9/programmoggetti
  • Importare il progetto con Eclipse

File --> Import --> Existing Maven Project

  • Avviare DemoSpringBootActivationApplication.java come Spring Boot App

  • Eseguire le richieste sotto elencate all'indirizzo http://localhost:8080.

3. UML

I file dei diagrammi UML sono localizzati in programmoggetti/src/main/resources/UML, e riportati qui di seguito.

Diagramma dei casi d'uso

Casi d'uso

Diagramma delle classi

Main

Package Controller

Package Model

Package Utilities

Package Exceptions

Diagramma delle interazioni

/league

/team

/leagueScorers

/teamScorers

/countNationalities

/foundedAfter

/teamNationalities

/teamsForEachVenue

/venues

/youngScorers

/foundedIn

/nationalitiesForTeam

/scorersForPosition

/startsWith

Funzionamento

Il programma, per prima cosa, effettua un download delle risorse necessarie tramite richieste GET:

  • Vengono effettuate richieste alle API per ottenere dei JSON contenenti informazioni riguardanti la "League" Serie A e gli "Scorers" della serie A:
    Dato l'url dell'API a cui effettuare la richiesta, tramite la classe Dataset si effettua il download in formato .json.
    Queste due richieste sono effettuate ogni volta che l'applicazione viene lanciata, così da avere ogni volta un dataset
    aggiornato su cui poi applicare statistiche e filtri.
  • L'applicazione effettua una connessione col server utilizzando la nostra auth-key gratuita:
    Ciò comporta delle limitazioni nel DataSet: utilizzando un account gratuito, non è possibile
    avere alcuni dati necessari per le specifiche del progetto (tutti i player di un team): per ovviare
    a questo problema, abbiamo effettuato le statistiche e i filtri non su i Player, ma sugli Scorer,
    che invece venivano forniti integralmente nonostante la nostra autenticazione gratuita.
  • Le string JSON recuperate dalle API vengono salvati in due file league.json e scorers.json,
    presenti nella directory src/main/resources/data/ dell'applicazione.
  • Successivamente vengono parsati i due file json in due classi opportunamente create
    per memorizzare i dati e lavorarci in modo più semplice ed efficiente (ed evitare di lanciare una richiesta a football-data.org ad ogni statistica o filtro).
  • Il risultato dell'avvio del programma saranno quindi due file:
    1. league.json, che contiene informazioni sulla League Serie A e un array di Team partecipanti;
    2. scorers.json, che contiene informazioni su tutti i marcatori della Serie A
  • Una volta ottenuti i due json, inizia l'effettiva interazione dell'utente con l'applicazione, che,
    tramite applicazioni come Postman che permettono di effettuare chiamate API (o comuni browser), può
    seguire una delle rotte predefinite, visualizzabili più avanti in questo Readme (o nella documentazione Javadoc).
  • Le richieste effettuabili sono contenute nelle classi del package Requests, divise tra Requests, Stat e Filters.
  • L'utente potrà scegliere, a piacere, quale statistica o filtro effettuare, inserendo i parametri necessari come indicato nella tabella sottostante (vedi Utilizzo).

Struttura

  • Main

    1. Main: L'entry point dell'applicazione

  • Controller

    1. SimpleRestController: Controller dell'applicazione, contiene le funzioni che gestiscono le rotte dell'applicazione.

  • Model

    1. Competition: Classe per mappare le informazioni di una Competition
    2. Area: Classe per rappresentare la zona dove si svolge una Competition
    3. Season: Classe per rappresentare la durata temporale di una Competition
    4. Team: Classe per rappresentare un partecipante di una Competition
    5. League: Classe per mappare le informazioni di una League
    6. DateOfBirth: Classe per rappresentare una data di nascita e convertire date di nascita da Stringhe a oggetti DateOfBirth
    7. Player: Classe per rappresentare un elemento di un Team
    8. Scorer: Sottoclasse di Player, che abbia effettuato almeno un goal
    9. Scorers: Classe che rappresenta tutti gli scorers di una League
    10. WinnerTeam: Sottoclasse di Team, che ha vinto una Competition

  • Requests

    1. Directories: Interfaccia per memorizzare le directories dove salvare i .json scaricati
    2. Requests: Classe che implementa Directories, utilizzata per effettuare il download delle risorse richieste e ritornare un oggetto League o Scorers
    3. Stat: Classe per effettuare statistiche sulle risorse scaricate
    4. Filters: Classe per effettuare filtri sulle risorse scaricate

  • Utilities

    1. Dataset: Dato un url, ritorna in una stringa il contenuto in esso memorizzato
    2. JsonParser: Data la directory della risorsa scaricata, ritorna un oggetto deserializzato dei tipo League, Scorers o Team.
    3. UrlConnection: Dato un url, apre una connessione utilizzando un token di autenticazione predefinito
    4. FileInputOutput: Classe per gestire la lettura e la scrittura di/in file, nelle directory indicate dall'interfaccia Directories.
    5. AgeCalculator: Classe per passare da una stringa nel formato "yyyy-MM-dd" ad un oggetto DateOfBirth
    6. Nationalities: Classe che contiene memorizzate tutte le nazionalità, per effettuare controlli e verificare che una nazionalità inserita dall'utente sia effettivamente esistente.
    7. Positions: Classe che contiene memorizzati tutti i ruoli, per effettuare controlli e verificare che una posizione inserita dall'utente sia effettivamente esistente

  • Exceptions

    1. MissingTeamException: Eccezione per gestire l'assenza di una squadra ricercata o l'errato inserimento del nome di una squadra
    2. MissingNationalityException: Eccezione lanciata nel caso in cui l'utente faccia una richiesta contenente una nazionalità inesistente.

Utilizzo

Una volta avviata l'applicazione, ad ogni diversa rotta corrisponde una statistica o un filtro, o una richiesta da visualizzare a video.
Inoltre, nella root del progetto, è disponibile una Collection Postman contenente tutte le richieste che è possibile effettuare. Per utilizzare la Collection, da Postman:

File --> Import --> Upload --> .../Postman Collection/Progetto.postman_collection.json

Selezionare la richiesta desiderata tra quelle visualizzate ed inserire i parametri necessari (o utilizzare quelli di default).

La collection di Postman utilizzabile per effettuare richieste

Le richieste vanno effettuate all'indirizzo localhost:8080 alla rotta desiderata. Tutte le richieste sono di tipo GET.

Rotte

In questo caso, il tipo di ritorno sarà un Oggetto diverso da una Stringa. Utilizzare lo Short Name di una squadra come parametro da passare.

Rotta Parametri Output
/league ?showTeams=true o ?showTeams=false (default: true) Mostra informazioni riguardanti la Serie A, showTeams=true per mostrare anche le squadre, ?showTeams=false altrimenti.
/leagueScorers Nessuno Mostra tutti i marcatori della Serie A
/team ?name={name} default: Roma Mostra informazioni riguardo alla squadra indicata (utilizzare lo short name)

Statistiche

In questo caso, il tipo di ritorno sarà una Stringa. Utilizzare il Long Name di una squadra come parametro da passare.

Rotta Parametri Output
/venues Nessuno Mostra i nomi degli stadi delle partite di Serie A.
/teamsForEachVenue Nessuno Mostra tutti gli stadi e il numero di squadra che giocano in ognuno di essi le partite "in casa"
/foundedAfter ?year={year} default: 1800 Mostra tutte le squadre fondate dopo un certo anno
/teamScorers ?team={longName} default: FC Internazionale Milano Mostra tutti i marcatori di una certa squadra
/teamNationalities ?team={longName} default: FC Internazionale Milano Mostra tutte le nazionalità di cui fanno parte i marcatori di una squadra
/countNationalities ?team={longName} default: FC Internazionale Milano Conta tutte le nazionalità di cui fanno parte i marcatori di una squadra
/youngScorers ?team={longName} default: FC Internazionale Milano Mostra tutti i marcatori di una squadra con età minore di 28 anni

Filtri

In questo caso, il tipo di ritorno sarà una Stringa. Utilizzare il Long Name di una squadra come parametro da passare.

Rotta Parametri Output
/startsWith ?letter={letter} default: f Mostra tutte le squadre il cui nome completo inizia per una certa lettera
/foundedIn ?year={year} default: 1902 Mostra tutte le squadre fondate in un certo anno
/nationalitiesForTeam ?team={longName}&?nationality={nationality} default: FC Internazionale Milano Mostra tutti i giocatori di una o più nazionalità di una squadra, a scelta dell'utente.
/scorersForPosition ?team={longName}&?position={position} default: FC Internaizonale Milano, Attacker Mostra tutti i marcatori di un ruolo di una squadra a scelta dell'utente

Esempi

Richiesta /league 
{
   "count":20,
   "filters":{
      
   },
   "competition":{
      "id":2019,
      "area":{
         "id":2114,
         "name":"Italy"
      },
      "name":"Serie A",
      "code":"SA",
      "plan":"TIER_ONE",
      "lastUpdated":"2021-04-17T07:19:44Z"
   },
   "season":{
      "id":638,
      "startDate":"2020-09-20",
      "endDate":"2021-05-23",
      "currentMatchday":38,
      "winner":{
         "id":108,
         "name":"FC Internazionale Milano",
         "shortName":"Inter",
         "tla":"INT",
         "crestUrl":"https://crests.football-data.org/108.svg"
      }
   },
   "teams":[
      {
         "id":98,
         "area":{
            "id":2114,
            "name":"Italy"
         },
         "name":"AC Milan",
         "shortName":"Milan",
         "tla":"MIL",
         "crestUrl":"https://crests.football-data.org/98.svg",
         "address":"Via Filippo Turati 3 Milano 20121",
         "phone":"+39 (02) 62281",
         "website":"http://www.acmilan.com",
         "email":null,
         "founded":1899,
         "clubColors":"Red / Black",
         "venue":"Stadio Giuseppe Meazza",
         "lastUpdated":"2020-11-26T02:19:28Z"
      },
      {
         "id":99,
         "area":{
            "id":2114,
            "name":"Italy"
         },
         "name":"ACF Fiorentina",
         "shortName":"Fiorentina",
         "tla":"FIO",
         "crestUrl":"https://crests.football-data.org/99.svg",
         "address":"Viale Manfredo Fanti 4 Firenze 50137",
         "phone":"+39 (055) 5030190",
         "website":"http://www.acffiorentina.it",
         "email":"[email protected]",
         "founded":1926,
         "clubColors":"Purple / White",
         "venue":"Stadio Artemio Franchi",
         "lastUpdated":"2020-11-26T02:23:02Z"
      },
      {
         "id":100,
         "area":{
            "id":2114,
            "name":"Italy"
         },
         "name":"AS Roma",
         "shortName":"Roma",
         "tla":"ROM",
         "crestUrl":"https://crests.football-data.org/100.svg",
         "address":"Via di Trigoria km. 3,600 Roma 00128",
         "phone":"+39 (06) 501911",
         "website":"http://www.asroma.it",
         "email":"[email protected]",
         "founded":1927,
         "clubColors":"Maroon / Orange / White",
         "venue":"Stadio Olimpico",
         "lastUpdated":"2021-04-08T22:27:08Z"
      },
     ... Eccetera per tutte le 20 squadre
   ]
}
Richiesta /leagueScorers 
{
   "count":285,
   "filters":{
      "limit":285
   },
   "competition":{
      "id":2019,
      "area":{
         "id":2114,
         "name":"Italy"
      },
      "name":"Serie A",
      "code":"SA",
      "plan":"TIER_ONE",
      "lastUpdated":"2021-04-17T07:19:44Z"
   },
   "season":{
      "id":638,
      "startDate":"2020-09-20",
      "endDate":"2021-05-23",
      "currentMatchday":38,
      "winner":{
         "id":108,
         "name":"FC Internazionale Milano",
         "shortName":"Inter",
         "tla":"INT",
         "crestUrl":"https://crests.football-data.org/108.svg"
      }
   },
   "scorers":[
      {
         "player":{
            "id":44,
            "name":"Cristiano Ronaldo",
            "firstName":"Cristiano Ronaldo",
            "lastName":null,
            "dateOfBirth":"1985-02-05",
            "countryOfBirth":"Portugal",
            "nationality":"Portugal",
            "position":"Attacker",
            "shirtNumber":null,
            "lastUpdated":"2021-05-26T09:46:02Z"
         },
         "team":{
            "id":109,
            "name":"Juventus FC"
         },
         "numberOfGoals":29
      },
      {
         "player":{
            "id":3662,
            "name":"Romelu Lukaku",
            "firstName":"Romelu",
            "lastName":null,
            "dateOfBirth":"1993-05-13",
            "countryOfBirth":"Belgium",
            "nationality":"Belgium",
            "position":"Attacker",
            "shirtNumber":null,
            "lastUpdated":"2020-11-26T02:19:38Z"
         },
         "team":{
            "id":108,
            "name":"FC Internazionale Milano"
         },
         "numberOfGoals":24
      },
      {
         "player":{
            "id":57,
            "name":"Luis Muriel",
            "firstName":"Luis Fernando",
            "lastName":null,
            "dateOfBirth":"1991-04-16",
            "countryOfBirth":"Colombia",
            "nationality":"Colombia",
            "position":"Attacker",
            "shirtNumber":null,
            "lastUpdated":"2020-09-07T21:10:15Z"
         },
         "team":{
            "id":102,
            "name":"Atalanta BC"
         },
         "numberOfGoals":22
      },
      {
         "player":{
            "id":82002,
            "name":"Dušan Vlahović",
            "firstName":"Dušan",
            "lastName":null,
            "dateOfBirth":"2000-01-28",
            "countryOfBirth":"Serbia",
            "nationality":"Serbia",
            "position":"Attacker",
            "shirtNumber":null,
            "lastUpdated":"2020-09-07T21:10:05Z"
         },
         "team":{
            "id":99,
            "name":"ACF Fiorentina"
         },
         "numberOfGoals":21
      },
      eccetera con tutti i marcatori
   ]
}

Esempio di richiesta /league

Esempio di statistica /foundedIn?year=1904

Esempio di filtro /teamScorers?team=FC Crotone

JavaDoc

Tutte le classi sono state estensivamente commentate, e la documentazione JavaDoc è presente all'interno di questa repository (/doc).

Test

E' presente un package di Testing, la cui classe TestLeague.java è costruita per verificare il corretto funzionamento dei seguenti metodi della classe League:

  • lookForId: Che serve per recuperare l'id di una squadra a partire dal suo nome;
  • countVenues: Che serve per contare i "venues" della Serie A dopo averli raccolti in un HashSet.

Software e Risorse Utilizzate

  • Football-data.org: Football API
  • GitHub Desktop: Client GitHub desktop per il versioning con Git
  • Eclipse IDE: Ambiente di Sviluppo Java
  • Visual Paradigm Per la modellazione dei diagrammi UML
  • Spring Boot: Framework per lo sviluppo di applicazioni Web in Java
  • Postman: Software di sviluppo API, permette di testare, modificare e costruire API, realizzando richieste con diversi metodi, header, autenticazioni, eccetera.
  • Maven: Framework di gestione di progetti software basati su Java, permette di controllare librerie Java e plug-in Maven dai vari repository definiti scaricandoli in locale o in un repository centralizzato lato sviluppo.
  • JUNIT 5: Framework di unit testing per il linguaggio di programmazione Java.
  • JavaDoc: Strumento utilizzato per la generazione automatica di documentazione di codice sorgente JAVA.
  • Markdown Live Preview Per editare questo README.md

Documentazione:

Sviluppatori

Nome Matricola Contributo
Leonardo Mannini 1090620 50%
Luca Ranucci 1089277 50%