@BodyParam

Adds support for @BodyParam annotation within Spring Boot web controllers to allow controller methods to use request body values directly as method parameter values without having to use the @RequestBody annotation and define an accompanying request body DTO class.

Currently the request body parser supports the following HTTP media types :

• application\json
• application\xml

Please refer to the relevant data format section for details on how the various data formats are supported.

Installation

To use the @BodyParam annotation you first have to add the library to your project. You can do so by copying the snippets below into your Maven pom.xml or Gradle build.gradle or equivalent files.

Maven

<dependency>
    <groupId>org.remonvv</groupId>
    <artifactId>bodyparam</artifactId>
    <version>1.0.2-SNAPSHOT</version>
</dependency>

Gradle

dependencies {
    implementation "org.remonvv:bodyparam:1.0.2-SNAPSHOT"
}

Getting Started

Once you added the library as a dependency to your project you can use the @BodyParam annotation in your Spring web controllers. Simply add the annotation in front of any method parameter and the library will attempt to find that value in the request body and inject that value into your method parameter.

JSON	XML
{"username":"William123"}	<ignoredtest2

This allows your Spring application to use the @BodyParam annotation in your web controllers. Make sure you update your projects in your IDE if needed to ensure the @BodyParam library dependency is in your classpath.

Usage

JSON

{
    "exampleString":"value"
    "exampleNumber":1
}

XML

<root><!--Arbitrary name for root node-->
    <exampleString>value</exampleString>
    <exampleNumber>1</exampleNumber>
</root>

Java Code

@PostMapping
void testMethod(
	@BodyParam(path = "exampleString") String stringValue,
	@BodyParam(path = "exampleNumber") int integerValue) {
	System.out.println("string = " + stringValue);
	System.out.println("number = " + integerValue);
}

JSON

{
    "parent": {
    	"child":"value"
    }
}

Java Code

@PostMapping
void testMethod(@BodyParam(path = "parent.child") String value) {
	System.out.println("string = " + value);
}

JSON

{
    "requiredValue": "required"
}

Java Code

@PostMapping
void testMethod(
	@BodyParam(path = "requiredValue") String requiredValue,
	@BodyParam(path = "optionalValue", required = false) String optionalValue) {
	System.out.println("value = " + value);
	System.out.println("optional value provided? = " + (optionalValue != null));
}

JSON

{
    "optionalValue": "required"
}

Java Code

@PostMapping
void testMethod(@BodyParam(path = "optionalValue", defaultValue = "default") String optionalValue) {
	System.out.println("optional value = " + optionalValue);
}

If the code is compiled with the javac parameter -parameters the compiler will add method parameter names to the class files. In that case @BodyParam is able to use that parameter name as the default path for @BodyParam annotation method parameters. This allows for the following simplification :
JSON

{
    "field":"value"
}

Note below that no explicit path is defined. The parameter name resolver will attempt to get the parameter name (field in this example) directly from the compiled class file and use that name to search for a value in the request body. Java Code

@PostMapping
void testMethod(
	@BodyParam String field) {
	System.out.println("field value = " + field);
}