6.19 Handling Form Data

To make data binding model customizations consistent between form data and JSON, Micronaut uses Jackson to implement binding data from form submissions.

The advantage of this approach is that the same Jackson annotations used for customizing JSON binding can be used for form submissions.

In practice this means that to bind regular form data, the only change required to the previous JSON binding code is updating the MediaType consumed:

Binding Form Data to POJOs

@Controller("/people")
public class PersonController {
    Map<String, Person> inMemoryDatastore = new ConcurrentHashMap<>();
    @Post
    public HttpResponse<Person> save(@Body Person person) {
        inMemoryDatastore.put(person.getFirstName(), person);
        return HttpResponse.created(person);
    }
}

Binding Form Data to POJOs

@Controller("/people")
class PersonController {
    Map<String, Person> inMemoryDatastore = new ConcurrentHashMap<>()
    @Post
    HttpResponse<Person> save(@Body Person person) {
        inMemoryDatastore.put(person.getFirstName(), person)
        HttpResponse.created(person)
    }
}

Binding Form Data to POJOs

@Controller("/people")
class PersonController {
    internal var inMemoryDatastore: MutableMap<String, Person> = ConcurrentHashMap()
    @Post
    fun save(@Body person: Person): HttpResponse<Person> {
        inMemoryDatastore[person.firstName] = person
        return HttpResponse.created(person)
    }
}

Alternatively, instead of using a POJO you can bind form data directly to method parameters (which works with JSON too!):

Binding Form Data to Parameters

@Controller("/people")
public class PersonController {
    Map<String, Person> inMemoryDatastore = new ConcurrentHashMap<>();
    @Post("/saveWithArgs")
    public HttpResponse<Person> save(String firstName, String lastName, Optional<Integer> age) {
        Person p = new Person(firstName, lastName);
        age.ifPresent(p::setAge);
        inMemoryDatastore.put(p.getFirstName(), p);
        return HttpResponse.created(p);
    }
}

Binding Form Data to Parameters

@Controller("/people")
class PersonController {
    Map<String, Person> inMemoryDatastore = new ConcurrentHashMap<>()
    @Post("/saveWithArgs")
    HttpResponse<Person> save(String firstName, String lastName, Optional<Integer> age) {
        Person p = new Person(firstName, lastName)
        age.ifPresent({ a -> p.setAge(a)})
        inMemoryDatastore.put(p.getFirstName(), p)
        HttpResponse.created(p)
    }
}

Binding Form Data to Parameters

@Controller("/people")
class PersonController {
    internal var inMemoryDatastore: MutableMap<String, Person> = ConcurrentHashMap()
    @Post("/saveWithArgs")
    fun save(firstName: String, lastName: String, age: Optional<Int>): HttpResponse<Person> {
        val p = Person(firstName, lastName)
        age.ifPresent { p.age = it }
        inMemoryDatastore[p.firstName] = p
        return HttpResponse.created(p)
    }
}

As you can see from the example above, this approach lets you use features such as support for Optional types and restrict the parameters to be bound. When using POJOs you must be careful to use Jackson annotations to exclude properties that should not be bound.