...
Ta som eksempel et attributt for et person-navn, som skal være på minst 2 tegn og bare skal kunne inneholde bokstaver, mellomrom og bindestreker (eng: hyphen). Dette kan sjekkes med en valideringsmetode som returnerer en logisk verdi, true for gyldige verdier og false for ugyldige:
| Code Block |
|---|
| language | java |
|---|
| title | Valideringsmetode som returnerer en logisk verdi |
|---|
| String name;
boolean isValidName(String name) {
// no name can be less than two characters
if (name == null || name.length() < 2) {
return false;
}
// a name can only contain letters, spaces and hyphens
for (int i = 0; i < name.length(); i++) {
char c = name.charAt(i);
if (! (Character.isLetter(c) || c == ' ' || c == '-')) {
return false;
}
}
return true;
}
void setName(String name) throws IllegalArgumentException {
if (! isValidName(name)) {
throw new IllegalArgumentException("A name must be at least two characters and can only contain letters, space or |
|
...
hyphens, but was " + name);
}
this.name = name;
} |
|
| PlantUML Macro |
|---|
class Person {
String name
boolean isValidName(String)
void setName(String) throws IllegalArgumentException
} |
|
Problemet med validering er altså delt i to: Valideringsmetoden sjekker gydlighet og setteren kaller valideringsmetoden og utløser et evt. unntaket. Ulempen med denne arbeidsfordelingen er at setteren må angi en melding til unntaksobjektet uten spesifikk kunnskap om hvorfor valideringsmetoden returnerte false. Dermed må feilmelding være generell istedenfor spesfikk for feilen. Et alternativ er derfor å utløse unntaket i valideringsmetoden, istedenfor å returnere true eller false:
| Code Block |
|---|
| language | java |
|---|
| title | Valideringsmetode som utløser unntak |
|---|
| String name;
void checkName(String name) throws IllegalArgumentException {
// no name can be less than two characters
if (name == null || name.length() < 2) {
throw new IllegalArgumentException("The name is too short, it must be at least two characters");
}
// a name can only contain letters, spaces and hyphens
for (int i = 0; i < name.length(); i++) {
char c = name.charAt(i);
if (! (Character.isLetter(c) || c == ' ' || c == '-')) {
throw new IllegalArgumentException("'" + c + "' is an illegal character, a name can only contain letters, space or hyphens");
}
}
}
void setName(String name) {
checkName(name);
this.name = name;
} |
|
| PlantUML Macro |
|---|
class Person {
String name
void checkName(String) throws IllegalArgumentException
void setName(String)
} |
|
Siden valideringsmetoden ikke lenger returnerer boolean, har vi endre navnet fra å begynne med "is", så nå heter den checkName. Og siden den utløser unntaket, kan setteren forenkles: If'en er unødvendig, dersom checkName utløser unntaket vil ikke tilordningen bli utført og vi trenger ingen if-setning. Ulempen med denne varianten er at det kompliserer andre klasser, siden de ikke kan sjekke verdien gyldigheten av et navn uten å måtte bruke try/catch. Under vises to varianter som løser dette problemet. Den venstre varianten lar valideringsmetoden returnere en meldingstekst eller null, dersom alt er ok. Den høyre varianten lar valideringsmetoden ta et ekstra argument som angir om true/false skal returneres istedenfor å utløse et unntak.
| Code Block |
|---|
| language | java |
|---|
| title | Valideringsmetode som returnerer unntaksmelding |
|---|
| String validateName(String name) {
// no name can be less than two characters
if (name == null || name.length() < 2) {
return "The name is too short, it must be at least two characters";
}
// a name can only contain letters, spaces and hyphens
for (int i = 0; i < name.length(); i++) {
char c = name.charAt(i);
if (! (Character.isLetter(c) || c == ' ' || c == '-')) {
return "'" + c + "' is an illegal character, a name can only contain letters, space or hyphens";
}
}
}
void setName(String name) {
String message = validateName(name);
if (message != null) {
throw new IllegalArgumentException(message);
}
this.name = name;
} |
Kode som kaller valideringsmetoden må huske meldingen, siden den skal brukes hvis den ikke er null. |
| Code Block |
|---|
| language | java |
|---|
| title | Valideringsmetode med argument som avgjør om evt. unntak skal utløses |
|---|
| boolean validateName(String name, boolean throwException) {
// no name can be less than two characters
if (name == null || name.length() < 2) {
if (throwException) {
throw new IllegalArgumentException("The name is too short, it must be at least two characters");
}
return false;
}
// a name can only contain letters, spaces and hyphens
for (int i = 0; i < name.length(); i++) {
char c = name.charAt(i);
if (! (Character.isLetter(c) || c == ' ' || c == '-')) {
if (throwException) {
throw new IllegalArgumentException("'" + c + "' is an illegal character, a name can only contain letters, space or hyphens");
}
return false;
}
return true;
}
void setName(String name) {
validateName(name, true);
this.name = name;
} |
Setteren blir enkel, og koden utenfor klassen som ikke ønsker at unntak skal utløses, kaller valideringsmetoden med false som andre argument. |
Spørsmål til ettertanke
- Hva er det som avgjør hvilken av de ulike variantene en bør velge?
- Hvilket hensyn er viktigst, å gjøre koden enkel i klassen en skriver eller å gjøre det enkelt for andre klasser å bruke den?
