Forelæsning Uge 14 Mandag Defensiv programmering Metoder og konstruktører bør tjekke de parameterværdier, som de kaldes med Derved kan man ofte undgå ulovlige handlinger, såsom at dividere med nul eller tilgå et element, som ikke eksisterer (i en arrayliste eller et array) Exceptions Sprogkonstruktion til rapportering af fejl En kaldt metode kan kaste en exception, som så efterfølgende gribes (behandles) på det sted hvor metoden blev kaldt Assertions Sprogkonstruktion til beskrivelse af betingelser, som man forventer vil være opfyldt på bestemte steder i programmet Brugt i jeres progression tests (via metoderne assertequals, asserttrue og assertfalse) Fil-baseret input/output Hvordan læser og skriver man en fil? Område, hvor der let kan ske fejl (forkert filnavn, disk full, no permission, netværksfejl, osv.) Sådanne fejl håndteres elegant ved hjælp af exceptions Afleveringsopgave: Computerspil 5 Input/output og exception handling
Defensiv programmering Lad os betragte et program, der implementerer en adressebog Systemet har tre klasser AddressBookGUI implementerer programmets grafiske brugergrænseflade AddressBook implementerer programmets øvrige funktionalitet. Klassen indeholder metoder til at tilføje, ændre, fjerne og søge i kontaktinformation ContactDetails indeholder kontaktinformationen, der består af navn, telefonnummer og adresse AddressBook gemmer kontaktinformation i en Map, hvor de kan findes ved at bruge enten navnet eller telefonnummeret som nøgle Et AddressBook objekt er et typisk eksempel på en server Objektet gør intet på egen hånd Det er reaktivt og handler kun når en klient (GUI-objektet) anmoder om det 2
To mulige strategier To mulige strategier for programmering af servere Vi kan antage, at klienterne ved, hvad de gør,og kun foretager fornuftige og veldefinerede serverkald Vi kan antage, at klienterne indeholder fejl eller med vilje forsøger at udføre illegale serverkald Ovenstående inducerer fire spørgsmål Skal serveren tjekke om de parametre den modtager fra klienterne har rimelige værdier? Hvordan og til hvem rapporterer serveren eventuelle fejl? Hvordan kan en klient forudse/foregribe at dets serverkald fejler? Hvad bør en klient gøre, når et af dens serverkald fejler? 3
removedetails metoden i AddressBook Parameterværdien bruges til at finde et sæt ContactDetails, hvis indgange derefter fjernes fra Map'en public void removedetails(string key) { ContactDetails details = book.get(key); book.remove(details.getname()); book.remove(details.getphone()); numberofentries--; Hvis den angivne nøgle ikke er i brug, vil metodekaldet book.get(key) returnere null Det betyder at metodekaldet details.getname() fejler med en NullPointerException Ovenstående er ikke nødvendigvis forkert Men det er en farlig fremgangsmåde specielt hvis man ikke selv har kontrol over, hvordan klienterne programmeres 4
Tjek af parametre Servere er særligt sårbare, når deres konstruktører og metoder modtager værdier via deres parametre Det er essentielt at vide, om man kan stole på, at disse parameterværdier er fornuftige Når det er tilfældet, er der ingen grund til at spilde tid på at teste dem I mange tilfælde har man dog ingen eller kun ringe indflydelse på, hvordan klienter programmeres Når det er tilfældet, bør alle parameterværdier tjekkes Derved kan man ofte undgå ulovlige handlinger, såsom at dividere med nul, kalde en metode på en variabel, der er lig null, eller tilgå et element som ikke eksisterer (i en arrayliste eller et array) Vi har nu "pakket" de fire sætninger ind i en if sætning Hvis nøglen er i brug gøres det samme som før Ellers gør man ingen ting public void removedetails(string key) { if( keyinuse(key) ) { ContactDetails details = book.get(key); book.remove(details.getname()); book.remove(details.getphone()); numberofentries--; 5
Rapportering af fejl Hvad bør serveren gøre, når den finder en illegal parameter? Serveren kan blot undlade at udføre det foretagne request Det gjorde vi for removedetails metoden Serveren kan rapportere fejlen til brugeren Serveren kan printe en fejlmeddelelse eller bringe en dialogboks op på skærmen Begge dele har kun effekt, hvis der er en bruger til at se beskeden, og selv da vil de fleste brugere ikke vide hvad de skal gøre Hvad vil du gøre, hvis en bankautomat fortæller dig, at der er en NullPointerException? Serveren kan rapportere fejlen til klienten Hvis metoden har returtypen void kan denne ændres til boolean, således at succesfulde requests returnerer true og illegale requests returnerer false Hvis metoden har en non-void returtype kan man returnere en speciel værdi, der ikke er i brug (f.eks. null, 0, eller en negativ værdi) Serveren kan kaste en exception (det kommer vi tilbage til) 6
Forskellige strategier til at rapportere fejl Returtypen er ændret fra void til boolean Brug af exception Det tjekkes om parameterværdien er null Hvis det er tilfældet skabes et exception objekt, og dette kastes ved hjælp af det reserverede ord throw Exception objektets type beskriver fejlen Herudover kan der være en tekststreng med yderligere information om fejlen Brug af returtype If sætningen er ændret til en if-else sætning Returværdien angiver om operationen lykkedes eller ej public boolean removedetails(string key) { if(key == null){ throw new IllegalArgumentException( "Null key in removedetails"); if( keyinuse(key) ) { ContactDetails details = book.get(key); book.remove(details.getname()); book.remove(details.getphone()); numberofentries--; return true; else { return false; Klienter kan undlade at tjekke returværdien Men de kan ikke ignorere exceptions Derfor er exceptions i mange tilfælde bedst 7
Exceptions Exceptions tillader klienter at forsøge at overleve/reparere fejl, som rapporteres fra servere Exceptions kastes af serveren (throw) og gribes af klienten (catch) Nedenstående klassediagram viser det hierarki som exceptions indgår i Errors er alvorlige fejl, som et program ikke med fornuft kan forsøge at overleve(f.eks. en assertion errors, som vi kender fra progression tests) Exceptions opdeles i RuntimeExceptions Throwable og øvrige exceptions Subklasser af RuntimeExceptions er Error Exception unchecked, hvilket betyder at oversætteren ikke tvinger programmøren til at håndtere dem MyCheckedException Øvrige exceptions er checked, hvilket betyder at oversætteren protesterer, MyUncheckedException hvis de ikke håndteres (gribes eller videresendes) RuntimeException sta us 8
Unchecked versus checked exceptions Unchecked exceptions bruges i situationer, hvor fejlen bør føre til at programmet stopper Typisk fordi programmøren har lavet en logisk fejl, såsom at dividere med nul, kalde en metode på en variabel, der er lig null, eller tilgå et element som ikke eksisterer (i en arrayliste eller et array) Sådanne fejl kan undgås hvis programmøren er kompetent og omhyggelig Checked exceptions bruges i situationer, hvor det giver mening, at klienten forsøge at reparere fejlen Throwable Hvis brugeren har angivet et filnavn som ikke eksisterer, kan man lade brugeren vælge/indtaste et nyt Error Exception Hvis systemet ikke kan skrive en fil, fordi disken er fuld, eller brugeren har manglende permissions, kan man lade MyCheckedException brugeren angive et nyt sted at placere filen RuntimeException sta us MyUncheckedException 9
Når en exception kastes Metoden (der kaster en exception) stopper øjeblikkeligt Der udføres ikke flere sætninger (statements) Heller ikke for at returnere et resultat Oversætteren protesterer ikke over, at metoden har en sti (via throw sætningen) som ikke returnerer en værdi Den vil derimod protestere, hvis der umiddelbart efter throw sætningen indsættes en return sætning, idet denne aldrig vil kunne blive udført. public boolean removedetails(string key) { if(key == null){ throw new IllegalArgumentException( "Null key in removedetails"); if( keyinuse(key) ) {... return true; else { return false; 10
Check af parameterværdier Unchecked exceptions bruges ofte til at standse programmet, hvis der anvendes en ulovlig parameterværdi Der gøres intet forsøg på at gribe exception I stedet rettes den logiske fejl i programmet, således at der ikke fremover kastes denne slags exceptions Det tjekkes om parameteren er null Det tjekkes om parameteren er den tomme eller en blank streng Hvis alt er ok, bruges nøglen til at hente de ønskede kontaktinformationer public ContactDetails getdetails(string key) { if(key == null) { throw new IllegalArgumentException( "Null key in getdetails"); if(key.trim().length() == 0) { throw new IllegalArgumentException( "Empty key in getdetails"); return book.get(key); 11
Check af parameterværdier i konstruktør Konstruktører kan også modtage illegale parameterværdier Det tjekkes om en eller flere parameterværdier er null. I så fald sættes de til den tomme streng Feltvariablerne initialiseres Hvis både name og phone er den tomme streng, kastes en exception Her kan exceptions forhindre, at der skabes "sære" objekter public ContactDetails(String name, String phone, String address) { if(name == null) { name = ""; if(phone == null) { phone = ""; if(address == null) { address = ""; this.name = name.trim(); this.phone = phone.trim(); this.address = address.trim(); if(this.name.isempty() && this.phone.isempty() { throw new IllegalStateException( "Either name or phone must be non-blank"); Det giver ikke mening at oprette objektet, idet man ikke har nogen nøgle, hvormed det kan tilgås (i Map'en) 12
Checked exceptions En metode, der kan kaste en checked exception, skal angive dette i sin header ved hjælp af det reserverede ord throws Det er også tilladt at anvende throws for unchecked exceptions men dette anbefales ikke public void savetofile(string destinationfile) throws IOException {... Når man kalder en metode, der kan kaste en checked exception, skal man være parat til at gribe denne Dette gøres ved at placere kaldet i et try-delen af en try-catch sætning catch blokken indeholder de sætninger, der skal udføres for at reparere situationen, dvs. gribe den kastede exception try { addressbook.savetofile(filename); successful = true; catch( IOException e ) { Metodekald Den exception som kan kastes, og som skal fanges System.out.println("Unable to save to " + filename); successful = false; Når der kastes en exception, overføres kontrollen fra try-delen til catch-delen 13
Try sætning try-catch sætningen kan indeholde flere catch blokke I så fald søges catch blokkene igennem forfra (som i en switch sætning) Den første catch blok, hvor exception typen matcher, udføres Rækkefølgen af catch blokkene er vigtig Hvis catch blokken med IOException flyttes op foran de to andre, vil disse aldrig kunne udføres, og vi vil få en compile-time fejl try-catch sætningen kan også indeholde en finally blok Denne er placeret efter catch blokkene Sætninger i en finally blok udføres altid uanset om, der kastes en exception eller ej (under udførelsen af try blokken) try {... object-reference.method(...);... catch(eofexception e) { // Handle end of file exception... catch(filenotfoundexception e) { // Handle file not found exception...... catch(ioexception e) { // Hnadle Handle other IOExceptions...... finally { // Any actions common to whether or // not an exception is raised... 14
Eksempel på unyttig try sætning Checked exceptions er kun nyttige, hvis programmøren (på kaldsstedet) forsøger at reparere situationen Nedenstående try sætning er ikke nyttig Metodekaldet book.search kan rejse en exception Når dette sker udskriver den kaldende metode en fejlmeddelelse ContactDetails details = null; try { details = book.search(...); catch(exception e ) { System.out.println("Error " + e); String phone = details.getphone(); Herefter fortsætter man ufortrødent Men details er stadig null Kaldet af getphone giver derfor ikke mening, og vil rejse en NullPointerException 15
Eksempel på nyttig try sætning Erklæring af to lokale variabler til kontrol af den efterfølgende løkke do-while løkke Forsøg at gemme på en fil Hvis det ikke lykkes rejses en exception I catch-delen beder man brugeren specificere et alternativt filnavn Kroppen udføres indtil, det lykkes at gemme eller man har forsøgt mange gange // Try to save the address book boolean successful = false; int attempts = 0; do { try { contacts.savetofile(filename); successful = true; catch(ioexception e) { System.out.println("Unable to save to " + filename); attempts++; filename = get alternative filename from user; while(!successful && attempts < MAX_ATTEMPTS); if(!successful) { report the problem and give up; Rapporter at man opgiver 16
Videresendelse af exceptions (propagering) I stedet for at gribe en exception, kan den videresendes til omgivelserne (propagering) Den kaldende metode indeholder så ikke længere en try sætning til at gribe den kastede exception I stedet har den en throws clause i sin header (signatur) Dette indikerer, at den kastede exception videresendes til omgivelserne, dvs. til den metode, der har kaldt metoden med throws sætningen Videresendelse bruges når en metode er ude af stand til selv at reparere situationen normalt kun for checked exceptions Når en metode kan kaste en checked exception, tjekker oversætteren, at alle kaldende metoder, enten indeholder en try-catch sætning, der beskytter kaldet og specificerer, hvordan det gribes, eller throws clause, der videresender den kastede exception til omgivelserne 17
Erklæring af nye exception klasser Man kan definere sine egne exception klasser Dette gøres ved at lave en subklasse af en eksisterende exception klasse Hvis klassen er en subklasse af RuntimeException, vil dens exceptions være unchecked, ellers vil de være checked Der er intet nyt eller mærkeligt ved erklæringen Checked exceptions Feltvariabel Konstruktør Accessor metode tostring metode public class NoMatchingDetailsException extends Exception { private String key; public NoMatchingDetailsException(String key) { this.key = key; public String getkey() { return key; public String tostring() { return "No details matching: " + key + " were found"; 18
Assertions Vi har ofte en forventning om at visse betingelser er opfyldt på bestemte steder i vores program Efter udførelsen af removedetails metoden vil vi forvente, at nøglen, der blev anvendt som parameterværdi, ikke længere forekommer i adressebogen størrelsen af adressebogen er konsistent, dvs. at værdien af feltvariablen numberofentries er lig med, antallet af kontaktinformationer Dette tjekkes ved hjælp af to assertions indeholdende det reserverede ord assert public void removedetails(string key) { if(key == null){ throw new IllegalArgumentException( "Null key in removedetails"); if( keyinuse(key) ) { ContactDetails details = book.get(key); book.remove(details.getname()); book.remove(details.getphone()); numberofentries--; assert!keyinuse(key); assert consistentsize() : "Inconsistent book size in removedetails"; et boolske udtryk som skal testes en (optional) tekststreng som beskriver, hvad der gik galt 19
Metoderne keyinuse and consistentsize Den første metode er simpel Brug containskey metoden fra Map interfacet private boolean keyinuse(string key) { return book.containskey(key); Den anden metode er lidt mere kompleks Lokal variabel indeholdende værdierne fra AddressBook Værdierne kopieres over i en mænge (Set), hvorved dubletter elimineres Find størrelsen af mængden private boolean consistentsize() { Collection<ContactDetails> allentries = book.values(); Set<ContactDetails> uniqueentries = new HashSet<>(allEntries); int actualcount = uniqueentries.size(); return numberofentries == actualcount; Tjek at størrelsen er lig med numberofentries 20
Brug af assertions En assertion sætning opfylder to formål Den beskriver en betingelse, som vi forventer er opfyldt på det sted, hvor assertion sætningen er indsat (en sådan betingelse kaldes en invariant) Under programudførelsen kan det tjekkes, at betingelsen virkelig er opfyldt, og hvis dette ikke er tilfældet kastes en AssertionError (subklasse af Error) Assertions kan let slås til og fra de vil typisk være slået til mens programmet udvikles og testes fra når programmet anvendes af brugere (produktionsmode) I BlueJ er assertions integreret med JUnit tests Når JUnit tests er slået til, vises assertion errors i test vinduet sammen med de fejl, der genereres af assertions i JUnit testene 21
Fil-baseret input/output Hvordan læser og skriver man en fil? Område, hvor der let kan ske fejl (forkert filnavn, disk full, no permission, netværksfejl, osv.) Sådanne fejl håndteres ved hjælp af exceptions Java's oprindelige support for i/o findes i pakken java.io Denne indeholder en lang række subklasser, som supporter input/output operationer Herudover definerer den IOException, som er en checked exception Vigtige subklasser er FileNotFoundException and EOFException (EOF end of file) Senere versioner af Java API'en har introduceret pakken java.nio Java.nio har en række tilhørende pakker såsom java.nio.file og java.nio.charset Klasserne i nio hierarkiet erstatter delvis klasserne i java.io pakken 22
Files og streams Input/ouput opdeles i Tekstfiler Indeholder tegn-baseret information i en form, som kan læses og forstås af mennesker f.eks. html filer, programfiler og dokumentationsfiler Baseret på char typen Håndteres ved hjælp af readers og writers såsom FileReader og FileWriter Streams Indeholder binær information såsom billeder eller eksekverbare programmer Baseret på byte typen Streams håndteres ved hjælp af stream handlers Bemærk at disse streams intet har med de streams at gøre, som vi mødte i afsnittet om funktionel programmering 23
File klassen og Path interfacet En fil er ikke blot et navn og noget indhold Filer ligger i foldere (directories) De indeholder information om størrelse, hvem der ejer dem, og hvem der kan tilgå/modificere dem De kan være skjulte (hidden) Osv. Klassen File i java.io indeholder en lang række metoder til at understøtte ovenstående Et File objekt i et program indeholder information om en fils egenskaber (men indeholder ikke filen selv) Ved hjælp af et File objekt kan man f.eks. undersøge om en fil eksisterer, og på den måde undgå at fremprovokere en FileNotFoundException Tilsvarende indeholder java.nio.file pakken interfacet Path og Files klassen (som er mere moderne) 24
File output består af tre skridt Åben filen Skriv data Luk filen Håndtering af fejl try { FileWriter writer = new FileWriter("file name"); while(there is more text to write) {... writer.write(next piece of text);... writer.close(); catch(ioexception e) { something went wrong with accessing the file; Alle tre skridt kan fejle af forskellige grunde Mange af disse er fuldstændig udenfor programmørens kontrol (såsom en disk, der er fuld eller ødelagt) Disse fejl håndteres ved hjælp af IOExceptions Læs detaljer i BlueJ bogen (de egner sig ikke til en forelæsning) 25
File input består af de samme tre skridt Åben filen Karaktersæt Filens sti (navn + placering i folder hierarkiet) Læs data Håndter fejl Charset charset = Charset.forName("US-ASCII"); Path path = Paths.get("file name"); try( BufferedReader reader = Files.newBufferedReader(path, charset)) { String line = reader.readline(); while( line!= null ) { do something with line line = reader.readline(); catch(filenotfoundexception e) { deal with the exception; catch(ioexception e) { deal with the exception; Filen åbnes ved hjælp af en klassemetode i Files klassen Ved at placere åbningen i en parentes efter nøgleordet try, sikrer man, at filen automatisk lukkes efter læsningen Læs detaljer i BlueJ bogen (de egner sig ikke til en forelæsning) 26
Scanning af input Scanner klassen indeholder metoder til at opbryde en tekst i delkomponenter nextline, nextint, nextdouble, nextboolean, osv. hasnextline, hasnextint, hasnextdouble, hasnextboolean, osv. Files klassen indeholder klassemetoden lines Tager en parameter af typen Path Returnerer en Stream<String> (som kendt fra afsnittet om funktionel programmering) Denne kan behandles som en (funktionel) stream eller konverteres til et array eller en arrayliste På denne måde kan man helt undgå at bruge klassen BufferedReader 27
System klassen System klassen Indeholder tre klassevariabler in af typen InputStream standard input stream out af type PrintStream standard output stream err af type PrintStream standard error output stream I BlueJ er alle tre knyttet til terminalvinduet Input via System.in Output via System.out Errors via System.err I kan skrive i denne del af terminalvinduet via System.err.println(" ") Welcome to the DodgySoft Technical Support System. Please tell us about your problem. We will assist you with any problem you might have. Please type 'bye' to exit our system. > My web browser crashes each morning Well, it never crashes on our system. It must have something to do with your system. Tell me more about your configuration. > Windows 7 This is a known bug to do with the Windows operating system. Please report it to Microsoft. There is nothing we can do about this. > Errors written to System.err is shown here 28
Computerspil 5 I den femte og sidste delaflevering skal I bruge nogle af de ting, som I har lært om exceptions og fil-baseret input/output Programmet kan allerede gemme de træk, der laves og afspille disse igen (ved brug af et Log objekt og et LogPlayer objekt) Det er nu jeres opgave at implementere metoder/konstruktører til at: skabe et Log objekt ud fra dets String repræsentation konvertere et Log objekt til dets String repræsentation indlæse en tekstfil fra operativsystemet og starte afspilning af det spil, der er gemt på filen gemme et logget spil på en tekstfil i operativsystemet Herudover skal I (som sædvanlig) rette gamle fejl og mangler holde jeres dokumentation opdateret, herunder tilføje dokumentation for nye programdele I behøver ikke at lave regression tests for de nye metoder De testes via to testmetoder, som vi har udviklet til jer 29
Opsummering Defensiv programmering Servere bør (i de fleste tilfælde) tjekke de parameterværdier, som de modtager fra deres klienter i kald af metoder/konstruktører Derved kan man ofte undgå ulovlige handlinger, såsom at dividere med nul eller tilgå et element, som ikke eksisterer (i en arrayliste eller et array) Exceptions Sprogkonstruktion til rapportering af fejl En kaldt metode kan kaste en exception, som så efterfølgende gribes (behandles) på det sted hvor metoden blev kaldt Assertions Sprogkonstruktion til beskrivelse af betingelser, som man forventer vil være opfyldt på bestemte steder i programmet (invarianter) Betingelserne kan testes under programudførelsen Fil-baseret input/output Hvordan læser og skriver man en fil? Område, hvor der let kan ske fejl (forkert filnavn, disk full, no permission, osv.) Sådanne fejl håndteres elegant ved hjælp af exceptions Afleveringsopgave: Computerspil 5 Input/output og exception handling 30
Det var alt for nu.. spørgsmål 31