E kūlia i ka nu’u. Strive to reach the highest.
1. Introduction to Hawaii
The Hawaii Framework is a Java framework for developing Spring based applications.
It provides production-ready features and integrations based best practices and experience to boost projects.
The Hawaii Framework is developed internally at QNH and is used in projects for medium and large enterprise customers.
1.1. Spring Boot
Combining Spring Boot and the Hawaii production-ready features and auto configuration brings even more power and simplicity to developers, without sacrificing flexibility.
The Hawaii Framework also provides various Spring Boot Starters to automatically include the needed dependencies and trigger the auto configuration of the Hawaii production-ready features.
But it is important to mention that most of the Hawaii features can also used without using Spring Boot. In that case the desired features need to be configured manually by defining the appropriate Spring beans inside the application’s context.
3. Hawaii Features
TODO.
3.1. Environments
TODO.
3.3. Logging
TODO.
3.4. Hawaii Time
HawaiiTime is not merely a convenient wrapper to instantiate new java.time date and time objects.
It provides an application wide java.time.Clock reference which is particular useful for unit testing.
It is similar to Joda’s DateTimeUtils which also allows setting a fixed current time.
However it is important to note that Joda’s DateTimeUtils uses a static variable to store the current time.
HawaiiTime does not take this approach. Instead the HawaiiTime bean needs to be injected in any class that needs to instantiate new date
and time objects. This approach is more flexible and e.g. has the benefit that unit tests can be run in parallel. See example usage below.
public class MyClass {
private HawaiiTime hawaiiTime;
public MyClass(HawaiiTime hawaiiTime) { (1)
this.hawaiiTime = hawaiiTime;
}
public void doSomethingWithDate() {
ZonedDateTime dateTime = this.hawaiiTime.zonedDateTime(); (2)
// ...
}
}
public class MyClassTests {
@Test
public void testDoSomethingWithDate() {
long millis = System.currentTimeMillis();
HawaiiTime hawaiiTime = new HawaiiTime();
hawaiiTime.useFixedClock(millis); (3)
MyClass myClass = new MyClass(hawaiiTime);
myClass.doSomethingWithDate();
// ...
}
}| 1 | Inject the HawaiiTime bean. |
| 2 | Use the injected HawaiiTime bean to instantiate new date and time objects. |
| 3 | In unit tests a fixed clock can be used to manipulate and predict the exact current time. |
Another benefit of using HawaiiTime is that a fixed time can be used in a running application to test how it behaves on a given date or
time.
Third-party libraries being used by the application do not use HawaiiTime and probably instantiate date and time objects based on
the System time.
|
Hawaii uses UTC as default timezone but this can be changed by setting the hawaii.time.timezone configuration property. The provided
value will be parsed by java.time.ZoneId#of(String zoneId) and supports different timezone formats like UTC, Europe/Amsterdam and
GMT+1.
The creation of the HawaiiTime bean can also be disabled by setting hawaii.time.enabled to false.
3.5. Validation
Hawaii’s validation mechanism can be used to validate any object. It basically validates values, collects validation errors and stores them in a validation result. These validation errors are simple field / error code combinations.
Hawaii’s Validator is inspired on Spring’s org.springframework.validation.Validator mechanism. However Hawaii’s validator mechanism
uses it’s own ValidationResult instead of Spring’s org.springframework.validation.Errors. The main difference is that Hawaii’s
ValidationResult does not bind directly the object being validated. This also gives the possibility to add errors for specific keys that
are not direct properties of the object being validated.
Hawaii’s validation mechanism also provides additional sugar like Hamcrest matcher support to write human readable validating code,
the capability to validate and automatically throw a ValidationException in case of errors etc.
Like Spring’s validation mechanism the Hawaii validation mechanism also supports the notion of nested error paths which also stimulates to re-use validators.
Let’s take an example. Imagine a Customer object with common name, e-mail, and address fields. A validation result could for example
contain the following field / error code combinations:
first_name = required (1)
last_name = max_length_exceeded
email = invalid
addresses = primary_address_required (2)
addresses[0].type = invalid (3)
addresses[0].street_name = max_length_exceeded
addresses[0].postal_code = invalid
addresses[0].city = max_length_exceeded
addresses[0].country_code = required| 1 | The field first_name has an required error code. |
| 2 | The field adresses (an array in this case) has primary_address_required error code. |
| 3 | The field type of the first address in the addresses array has a invalid error code. |
The example demonstrates simple field errors (like first_name) but also storing errors for arrays and nested paths (addresses[0].type).
In theory a field could also have multiple error codes if needed.
Implementors should typically only implement the org.hawaiiframework.sample.validator.Validator#validate(Object, ValidationResult) method
as the other methods in the interface are already implemented using the interface’s default methods.
A generic EmailValidator would look like:
import org.hawaiiframework.validation.ValidationResult;
import org.hawaiiframework.validation.Validator;
import org.springframework.stereotype.Component;
import java.util.regex.Pattern;
@Component
public class EmailValidator implements Validator<String> { (1)
public static final String EMAIL_PATTERN = "^[_A-Za-z0-9-\\+]+(\\.[_A-Za-z0-9-]+)*@[A-Za-z0-9-]+(\\.[A-Za-z0-9]+)*(\\.[A-Za-z]{2,})$";
private Pattern pattern;
public EmailValidator() {
this.pattern = Pattern.compile(EMAIL_PATTERN);
}
@Override
public void validate(String email, ValidationResult validationResult) { (2)
if (!pattern.matcher(email).matches()) {
validationResult.rejectValue("invalid"); (3)
}
}
}| 1 | Implement the Validator (in this case a String). |
| 2 | Override the Validator#validate(Object, ValidationResult) method. |
| 3 | In case the e-mail is invalid, reject the value with error code invalid and store it in the validation result. |
The CustomerValidator would look like:
import org.apache.commons.lang3.StringUtils;
import org.hawaiiframework.sample.validator.EmailValidator;
import org.hawaiiframework.validation.ValidationResult;
import org.hawaiiframework.validation.Validator;
import org.springframework.stereotype.Component;
import java.util.List;
import static org.hamcrest.Matchers.greaterThan;
@Component
public class CustomerInputValidator implements Validator<CustomerInput> { (1)
private final EmailValidator emailValidator;
private final AddressValidator addressValidator;
public CustomerInputValidator(final EmailValidator emailValidator,
final AddressValidator addressValidator) { (2)
this.emailValidator = emailValidator;
this.addressValidator = addressValidator;
}
@Override
public void validate(CustomerInput customer, ValidationResult validationResult) { (3)
// first name validation
String firstName = customer.getFirstName();
if (StringUtils.isBlank(firstName)) {
validationResult.rejectValue("first_name", "required");
} else {
validationResult.rejectValueIf(firstName.length(), greaterThan(25), "first_name",
"max_length_exceeded");
}
// last name validation
String lastName = customer.getLastName();
if (StringUtils.isBlank(lastName)) {
validationResult.rejectValue("last_name", "required");
} else {
validationResult.rejectValueIf(lastName.length(), greaterThan(25), "last_name",
"max_length_exceeded");
}
// e-mail validation
String email = customer.getEmail();
if (StringUtils.isBlank(email)) {
validationResult.rejectValue("email", "required");
} else if (email.length() > 100) {
validationResult.rejectValue("email", "max_length_exceeded");
} else {
validationResult.pushNestedPath("email");
emailValidator.validate(email, validationResult);
validationResult.popNestedPath();
}
// adresses validation
List<Address> addresses = customer.getAddresses();
if (addresses == null || addresses.size() == 0) {
validationResult.rejectValue("addresses", "required");
} else {
// addresses array validations
long primaries = addresses.stream()
.filter(address -> address.getType() == AddressType.PRIMARY)
.count();
if (primaries == 0) {
validationResult.rejectValue("addresses", "primary_address_required");
} else if (primaries > 1) {
validationResult.rejectValue("addresses", "only_1_primary_address_allowed");
}
if (addresses.size() > 3) {
validationResult.rejectValue("addresses", "max_array_length_exceeded");
}
// address validations
for (int i = 0; i < addresses.size(); i++) {
validationResult.pushNestedPath("addresses", i);
addressValidator.validate(addresses.get(i), validationResult);
validationResult.popNestedPath();
}
}
}
}| 1 | Implement the Validator (in this case a Customer). |
| 2 | Inject other validators (EmailValidator, AddressValidator) to be re-used. |
| 3 | Override the Validator#validate(Object, ValidationResult) method. |
5. Deployment
TODO.
Appendices
Appendix A: Hawaii application properties
Various properties can be specified inside your application.properties/application.yml file or as command line switches.
This section provides a list of available Hawaii application properties.
# ===================================================================
# HAWAII PROPERTIES
#
# This sample file is provided as a guideline. Do NOT copy it in its
# entirety to your own application. ^^^
# ===================================================================
# HAWAII SPRING BOOT DEFAULTS
spring:
jackson:
date-format: com.fasterxml.jackson.databind.util.ISO8601DateFormat
property-naming-strategy: CAMEL_CASE_TO_LOWER_CASE_WITH_UNDERSCORES
serialization:
indent-output: false
write-dates-as-timestamps: false
write-date-timestamps-as-nanoseconds: false
logging:
file: log/hawaii.log
level:
org.hawaiiframework: INFO
org.springframework: INFO
# HAWAII TIME
hawaii:
time:
enabled: true # Enable creation of the `HawaiiTime` bean.
timezone: UTC # The timezone to use like `UTC`, `Europe/Amsterdam` or `GMT+1`.
---
spring:
profiles: dev
jackson:
serialization.indent-output: true
logging:
level:
org.hawaiiframework: DEBUG
---
spring:
profiles: test
---
spring:
profiles: prod