Add io.avaje.http.api @Valid Annotation to support custom validators (#195)

* valid

* ignore BeanField

* Revert "ignore BeanField"

This reverts commit bd70d8a.

* Update MethodReader.java

* Update README.md

* Update README.md

Author: SentryMan

README.md

@@ -80,16 +80,16 @@ The annotation processor will generate controller adapters that can register rou
 There isn't a hard requirement to use Avaje for dependency injection. In the absence of avaje-inject the generated class will use `@jakarta.inject.Singleton` or `@javax.inject.Singleton` depending on what's on the classpath. Any DI library that can find and wire the generated @Singleton beans can be used. You can even use Dagger2 or Guice to wire the controllers if you so desire. 
 
 To force the AP to generate with `@javax.inject.Singleton`(in the case where you have both jakarta and javax on the classpath), use the compiler arg `-AuseJavax=true` 
-```
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-compiler-plugin</artifactId>
-				<configuration>
-					<compilerArgs>
-						<arg>-AuseJavax=true</arg>
-					</compilerArgs>
-				</configuration>
-			</plugin> 
+```xml
+<plugin>
+  <groupId>org.apache.maven.plugins</groupId>
+  <artifactId>maven-compiler-plugin</artifactId>
+  <configuration>
+    <compilerArgs>
+      <arg>-AuseJavax=true</arg>
+    </compilerArgs>
+  </configuration>
+</plugin>
 ```
 
 ### Usage with Javalin

http-api/src/main/java/io/avaje/http/api/Valid.java

@@ -0,0 +1,23 @@
+package io.avaje.http.api;
+
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.PARAMETER;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.SOURCE;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ *
+ * Add @Valid annotation on a controller/method/BeanParam that we want bean validation to be included for.
+ * When we do this controller methods that take a request payload will then have the request bean
+ * (populated by JSON payload or form parameters) validated before it is passed to the controller
+ * method.
+ *
+ * When trying to validate a @BeanParam bean, this will need to be placed on the BeanParam type
+
+ */
+@Retention(SOURCE)
+@Target({METHOD, TYPE, PARAMETER})
+public @interface Valid {}

http-generator-core/src/main/java/io/avaje/http/generator/core/ControllerReader.java

@@ -162,6 +162,7 @@ private boolean initDocHidden() {
   private boolean initHasValid() {
 
     return findAnnotation(JavaxValidPrism::getOptionalOn).isPresent()
+        || findAnnotation(JakartaValidPrism::getOptionalOn).isPresent()
         || findAnnotation(ValidPrism::getOptionalOn).isPresent();
   }
 

http-generator-core/src/main/java/io/avaje/http/generator/core/ElementReader.java

@@ -129,7 +129,9 @@ private boolean useValidation() {
     }
     final var elementType = typeElement(rawType);
     return elementType != null
-        && (ValidPrism.isPresent(elementType) || JavaxValidPrism.isPresent(elementType));
+        && (ValidPrism.isPresent(elementType)
+            || JavaxValidPrism.isPresent(elementType)
+            || JakartaValidPrism.isPresent(elementType));
   }
 
   private void readAnnotations(Element element, ParamType defaultType) {

http-generator-core/src/main/java/io/avaje/http/generator/core/MethodReader.java

@@ -92,6 +92,7 @@ private Javadoc buildJavadoc(ExecutableElement element) {
   private boolean initValid() {
     return findAnnotation(ValidPrism::getOptionalOn).isPresent()
         || findAnnotation(JavaxValidPrism::getOptionalOn).isPresent()
+        || findAnnotation(JakartaValidPrism::getOptionalOn).isPresent()
         || superMethodHasValid();
   }
 

http-generator-core/src/main/java/io/avaje/http/generator/core/package-info.java

@@ -26,12 +26,13 @@
 @GeneratePrism(value = io.avaje.http.api.OpenAPIResponse.class, publicAccess = true)
 @GeneratePrism(value = io.avaje.http.api.OpenAPIResponses.class, publicAccess = true)
 @GeneratePrism(value = io.swagger.v3.oas.annotations.Hidden.class, publicAccess = true)
-@GeneratePrism(value = javax.validation.Valid.class, name = "JavaxValidPrism", publicAccess = true)
-@GeneratePrism(value = jakarta.validation.Valid.class, publicAccess = true)
 @GeneratePrism(value = org.jetbrains.annotations.NotNull.class, publicAccess = true)
 @GeneratePrism(value = io.avaje.http.api.Client.class, publicAccess = true)
 @GeneratePrism(value = io.avaje.http.api.Client.Import.class, publicAccess = true)
 @GeneratePrism(value = io.avaje.http.api.RequestTimeout.class, publicAccess = true)
+@GeneratePrism(value = javax.validation.Valid.class, name = "JavaxValidPrism")
+@GeneratePrism(value = jakarta.validation.Valid.class, name = "JakartaValidPrism")
+@GeneratePrism(value = io.avaje.http.api.Valid.class)
 package io.avaje.http.generator.core;
 
 import io.avaje.prism.GeneratePrism;

tests/test-javalin-jsonb/src/main/java/org/example/myapp/web/HelloController.java

@@ -8,8 +8,6 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.Executors;
 
-import javax.validation.Valid;
-
 import org.example.myapp.service.MyService;
 
 import io.avaje.http.api.BeanParam;
@@ -23,6 +21,7 @@
 import io.avaje.http.api.Post;
 import io.avaje.http.api.Produces;
 import io.avaje.http.api.QueryParam;
+import io.avaje.http.api.Valid;
 import io.javalin.http.Context;
 import io.swagger.v3.oas.annotations.Hidden;
 import jakarta.inject.Inject;