Table of Contents

Semestrální práce

Termín odevzdání je do pondělí večer 12. 6. 23:59.

Hodnocení

Můžete získat nejvýše 30 bodů a to:

Počet bodů Poznámka
10 z testů funkčnosti
10 z testů rychlosti
10 za návrh

Kritéria hodnocení návrhu

Kritérium Max počet bodů
Cache je správně navržená (ukládá správně data, pracuje správně se soft referencí, …) 1
Server je správně navržený (správně navazuje spojení, správně čte request a zapisuje response, správně reaguje na chyby, …) 1
Server je neblokující 1
Řešení používá reaktivní a funkcionální programování 1
Řešení používá reaktivní cache 1
Řešení používá reaktivní server 1
Řešení dodržuje principy správného návrhu, jako DRY, … 1
Kód je čistý podle kritérií definovaných v Checklistu kvality kódu (níže) 1
Řešení používá dependency injection (spring, guice, vlastní řešení, ..). Dávám 0.5 bodu, když nemáte tightly coupled komponenty (tj. závislosti si předáváte konstruktorem) 1
Řešení obsahuje originální a inventivní prvky 1

Celkem tedy lze získat 10 bodů.

Kritéria hodnocení výkonu

Budou jasná jakmile více lidí odevzdá. Zatím mám v plánu použít Apache Benchmark:

Kde najít apache benchmark

Tipy na zvýšení výkonu

Jak profilovat server

* Pro profiling doporučuji používat jvisualvm, který je součástí JDK: “Java\jdk8\bin\jvisualvm.exe”

Zadání

Implementujte jednoduchý statický reaktivní webový server. O tom co reaktivní server je a jak ho vytvořit více na cvičení. Studenti, kteří mají server hotový z minulého běhu předmětu nemusí celý server na reaktivní předělávat a dostanou individuální pokyny.

Požadavky na Vaše řešení:

Checklist funkčnosti

  1. Server stažený z BRUTE lze zkompilovat příkazem “mvn package”
  2. Požadavek “/” (požadavek o root directory) vrací index.html (pokud existuje, jinak HTTP 404)
  3. Požadavek “../../soubor.txt” nevrátí soubor mimo document root serveru
  4. Požadavek “C:\windows\system32\…” nevrátí soubor mimo document root serveru
  5. Server správně posílá obrázky, které se správně zobrazí (tj. Váš server umí binární data)
  6. Na požadavek o neexistující soubor vrátí server HTTP hlavičku 404
  7. Na nesmyslný požadavek, například s metodou NONEXISTING_METHOD vrátí server HTTP 400 (Bad request)
  8. Web server nevrátí uživateli soubor “.htaccess” a bude předstírat, že tento soubor neexistuje, i když existuje
  9. Web server je schopný zpracovat URL encoding

Časté chyby

Odevzdávání

Autentifikace

Server umožní uživateli (administrátorovi webových stránek) prohlásit složku za chráněnou. Use case:

Firma SpringfieldAuto prodává ojeté automobily ve Springfieldu. Má webovou stránku se svou nabídkou, která je veřejná pro všechny uživatele internetu. Pro VIP zákazníky má skrytou sekci webu s nabídkou speciálních automobilů. Tuto sekci má zaheslovanou. Uživatelské jméno a heslo zasílá svým klientům obálkou.

Server bude pokládat složku za chráněnou, pokud bude obsahovat soubor .htaccess, který bude mít následující formát:

user:base64(hashed(salt+password))

Příklad:

webuser1:da39a3ee5e6b4b0d3255bfef95601890afd80709

Kde webuser1 je uživatelské jméno, da39a3ee5e6b4b0d3255bfef95601890afd80709 je hash osaltovaného hesla. Můžete se podívat na příklad hashování v javě [pastebin].

Pokud složka takový soubor obsahuje, webserver musí vyžadovat heslo pro přístup ke všem jejím souborům a souborům v podadresářích.

Prohlížeč posílá přihlašovací údaje ve formě user:pass, které jsou zakódované v base64. Při kontrole hesla tedy musíte přijaté údaje dekódovat a následně heslo zahashovat, abyste ho mohli porovnat s uloženým heslem.

Kontrola kvality kódu

Součástí hodnocení návrhu je také posouzení kvality kódu s použitím maven pluginu findbugs. Abyste si mohli kontrolu zapnut i vy už v průběhu vývoje, přidejte si následující text do pom.xml: 

 <build>
     <plugins>
         <plugin>
             <groupId>org.codehaus.mojo</groupId>
             <artifactId>findbugs-maven-plugin</artifactId>
             <executions>
                 <execution>
                     <id>findbugs-check</id>
                     <phase>compile</phase>
                     <goals>
                         <goal>check</goal>
                     </goals>
                 </execution>
             </executions>
             <configuration>
                 <effort>Max</effort>
             </configuration>
             <version>3.0.0</version>
         </plugin>
         <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-compiler-plugin</artifactId>
             <version>3.2</version>
             <configuration>
                 <source>1.8</source>
                 <target>1.8</target>
             </configuration>
         </plugin>
     </plugins>
 </build>

Po přidání <build> konfigurace do pluginu se kontrola kódu bude spouštět vždy při kompilaci (mvn compile).

Checklist kvality kódu

Na semestrální úlohu máte dostatek času. Ideálním výsledkem je kód, který můžete publikovat, jako součást portfolia své kvalitní práce z dob studií. Nejeden zaměstnavatel po Vás ukázku kvalitního kódu bude chtít. Takový kód by měl být čistý a bez zbytečností. Před odevzdáním semestrální práce prosím projděte seznam níže, pro kontrolu, zdali jste v kódu nenechali něco nechtěného.

  1. parciální funkce mají návratový typ Optional a vrací Optional.empty namísto null (jinými slovy: pokud si potřebujete předat zprávu “žádný výsledek”, vracejte Optional.empty() a ne null).
  2. kód neobsahuje zakomentovaný kód
  3. kód neobsahuje nesmyslné komentáře (např.: “To change this license header, choose License Headers in Project Properties.”)
  4. kód neobsahuje nic neříkající javadoc author (např.: @author SuperMegaMan)
  5. kód je hezky naformátovaný
    1. kód se vejde na běžnou obrazovku (to, že doma máte dva 4k monitory vedle sebe není důvod mít v kódu kilometrové řádky)
  6. kód se čte jako pohádka (důležité metody vysoké abstrakce nahoře, ta nejméně důležitá dole)
  7. kód neobsahuje magic number konstanty
  8. konstanty jsou smysluplně pojmenovány a okomentovány
  9. public metody mají javadoc, který vysvětluje roli dané metody v rámci systému