Chat applikasjon Documentation

Chat applikasjon

Chat applikasjon med RESTful Java backend (JAX-RS).

Innhold

• Hvordan kjøre prosjektet lokalt
• JavaDocs
• Mappestruktur
• Endepunkter
• Databasemodell
• Docker og Maven
• Informasjon om backend
• Informasjon om frontend
• Informasjon om tester
• Systemet som helhet
• Porter

Hvordan kjøre prosjektet lokalt

For å kjøre prosjektet lokalt trenger man Maven på maskinen. Det kan lastes ned her. Pakk ut Maven og les README som følger med for å innstallere Maven.

For at meldingsapplikasjonen skal funke trenger man en tilkobling til database for lokal kjøring. Fyll ut påloggingsdetaljer til database i java klassen Database.

Når Maven er innstallert, og databasetilkobling er satt opp kan prosjektet kjøres med følgende kommando:

mvn jetty:run

Meldingsapplikasjonen er nå tilgjengelig på http://localhost:8080. Endringer som gjøres i prosjektet lokalt blir automatisk oppdatert. For å stoppe kjøring av prosjektet trykk på Ctrl+C.

JavaDocs

Ved hjelp av Gitlab-CI og Doxygen genereres JavaDocs automatisk hver gang nye endringer blir pushet til master. Deretter blir det automatisk hostet på Gitlab Pages:

JavaDocs

Mappestruktur

devops/
├── docs/
|   └── Doxyfile
|
├── gatling/
|   ├── chat/
|   |   └── ChatSimulation.scala
|   |   
|   └── usernames.csv
|
├── sql/
|   └── myChat.sql
|
├── src/
|   ├── main/
|   |   ├── java/
|   |   |   ├── dao/
|   |   |   |   ├── Database.java
|   |   |   |   ├── GroupChatDAO.java
|   |   |   |   ├── MessageDAO.java
|   |   |   |   └── UserDAO.java
|   |   |   | 
|   |   |   ├── data/
|   |   |   |   ├── GroupChat.java
|   |   |   |   ├── Message.java
|   |   |   |   └── User.java
|   |   |   |  
|   |   |   ├── resources/
|   |   |   |   ├── CalculatorResource.java
|   |   |   |   ├── GroupChat.java
|   |   |   |   ├── GroupChatResource.java
|   |   |   |   ├── Message.java
|   |   |   |   ├── MessageResource.java
|   |   |   |   ├── User.java
|   |   |   |   └── UserResource.java
|   |   |   |   
|   |   |   └── websockets/
|   |   |       └── Websocket.java
|   |   |       
|   |   └── webapp/
|   |       ├── css/
|   |       |   ├── app.css
|   |       |   ├── index.css
|   |       |   ├── popupform.css
|   |       |   └── settings.css
|   |       |
|   |       ├── js/
|   |       |   ├── calculator.js
|   |       |   ├── createElements.js
|   |       |   ├── groupchat.js
|   |       |   ├── index.js
|   |       |   ├── message.js
|   |       |   ├── responsive.js
|   |       |   ├── settings.js
|   |       |   ├── user.js
|   |       |   └── websocket.js
|   |       |
|   |       ├── WEB-INF/
|   |       |   └── web.xml
|   |       |
|   |       ├── app.html
|   |       ├── index.html
|   |       └── settings.html
|   |
|   └── test/
|       └── java/
|           ├── CalculatorResourceTest.java
|           ├── GroupChatDAOTest.java
|           ├── GroupChatResourceTest.java
|           ├── MessageDAOTest.java
|           ├── MessageResourceTest.java
|           ├── UserDAOTest.java
|           └── UserResourceTest.java      
|
├── .gitignore
├── .gitlab-ci.yml
├── database.png
├── Dockerfile
├── Jenkinsfile
├── docker-compose-logging.yaml
├── docker-compose-test.yaml
├── docker-compose.yaml
├── glances.conf
├── installGatling
├── pom.xml
├── README.md
├── runGatling
├── runLogging
└── setupJenkins

Endepunkter

Endepunkt	Verb	Hva	Type
/	GET	Loginside	HTML
/app.html	GET	Applikasjonside	HTML
/settings.html	GET	Innstillingside	HTML
/user	GET	Hent alle brukere	Data
	POST	Legge til bruker	Data
/user/{userId}	PUT	Endre bruker	Data
/message/{userId1}/{userId2}	GET	Hent meldinger mellom to brukere	Data
/message	POST	Legge til ny melding	Data
/groupchat	POST	Legge til ny gruppechat	Data
/groupchat/{groupChatId}	GET	Hent ut et gruppechat objekt	Data
/groupchat/{groupChatId}/message	GET	Hent ut meldinger til en gruppechat	Data
	POST	Legge til ny melding	Data
/groupchat/user/{userId}	GET	Hent ut alle gruppechatter for en bruker	Data
/calculator	POST	Send inn regnestykke til kalkulatorbot	Data

Databasemodell

Databasemodell

Docker og Maven

Dette systemet bruker Maven. Maven er et verktøy som hjelper til å håndtere dependencies i systemet. Ved å bruke Maven forsikrer man at alle bruker samme versjon av depencies, og at man lett kan endre de på kun et sted, dersom det endres hva som trengs for å kjøre systemet. I tillegg brukes Maven både til å kompilere systemet og kjøre tester. Dependencies deklareres i filen pom.xml. Filen web.xml brukes for å sette URLer i den ferdig kompilerte applikasjonen.

Docker er et verktøy som lar oss kjøre forskjellige programmer i egne konteinere for kjøring av systemet. Dette er blant annet database, testdatabase, databaseclient og server som kan kjøre chat applikasjonen. Filene som brukes til dette er Dockerfile og docker-compose. Dockerfile er en fil med oppskrift til hvordan en enkelt konteiner skal bygges. Filene som starter med docker-compose er oppsett av flere konteinere i samme miljø. Her er også en av fordele at man lett kan bytte verktøy som brukes, eller versjoner av verktøyene. Ved hjelp av docker kan utviklerene enkelt levere kode og dockerfiler til drifterene, som kun trenger å bruke dockerfilene for å kjøre og rulle ut systemet.

Informasjon om backend

Backend består av fire mapper:

• dao
• data
• resources
• websocket

DAO står for Data Access Object, og brukes av systemet for å kommunisere med databasen. I dao mappa finner vi også klassen Database, som er filen som sørger for tilkobling til databasen. Ved hjelp av dao klassene kan vi bruke java objekter til å kommunisere med databasen.

I data mappa finner vi objektklassene som brukes i systemet. Vi har GroupChat, Message og User.

Resources er filene som brukes for kommunikasjon mellom frontend og backend. Her brukes rammeverket JAX-RS for å lage webtjenester som er RESTful. I resource filene brukes det følgende annoteringer:

• @Path
• @GET
• @POST
• @PUT
• @Consumes
• @Produces

@Path bestemmer hvilke adresse ressursene skal være tilgjengelige på. @GET, @POST og @PUT sette hvilke HTTP verb metoden svarer til. @Consumes og @Produces definerer hva metodene tar inn, og returnerer.

Websocket er nødvendig for å hente inn nye chatmeldinger etterhvert som de skrives. Alternativet til websockets er å hele tiden sende forespørsler for å sjekke om det er noen nye meldinger tilgjengelig.

Informasjon om frontend

Frontend består av tre forskjellige typer filer:

• HTML
• CSS
• JS

HTML filene er innholdet. CSS filene er utseende og utformingen. JavaScript er filene som bestemmer hvordan de forskjellige elementene på siden reagerer på brukerinteraskjon, og brukes også til å endre innholdet på siden. Endringer kan for eksempel være nye brukere som logger på, som må legges til i brukerlista.

Informasjon om tester

Til testing brukes testrammeverket JUnit. I tillegg settes det opp en testdatabase med docker, slik at testene kan kjøres opp mot denne. Når testene kjøres blir databasen slettet, og opprettet på nytt. Dette forsikrer at resultatet av testene ikke er avhengig av innholdet på databasen, og at den andre databasen ikke fylles opp av testdata.

Testene kan kjøres lokalt med kommando:

mvn clean test

Dette krever at Maven er innstallert på maskinen. Alternativt kan testene også kjøres i IDE.

Systemet som helhet

Frontend bruker endepunkter for å kommunisere med backend. På backend peker de forskjellige endepunktene på metoder i resource klassene. Resource klassene bruker DAO klassene for å kommunisere med databasen. For å sende data til og motta data fra databasen bruker DAO klassene objektklasser. For å varsle andre brukere om nye hendelser i sanntid, brukes websockets.

Porter

Port	Hva
80	Chat applikasjon
3306	Test database
8070	Adminer (Databaseklient)
8080	Jenkins