<dependency>
<groupId>de.rweisleder</groupId>
<artifactId>archunit-spring</artifactId>
<version>1.2.0</version>
<scope>test</scope>
</dependency>The library expects that the required dependencies for Spring and ArchUnit are already declared.
Given the following class:
@RestController
class HelloRestController {
@GetMapping("/hello")
String hello() {
return "Hello World";
}
}You can write architecture rules like this:
import static de.rweisleder.archunit.spring.SpringAnnotationPredicates.springAnnotatedWith;
methods()
// "that are annotated with @RequestMapping" (or @GetMapping, @PostMapping etc.)
.that(are(springAnnotatedWith(RequestMapping.class)))
// "should be declared in classes that are annotated with @Controller" (or @RestController etc.)
.should().beDeclaredInClassesThat(are(springAnnotatedWith(Controller.class)));Unlike other rule libraries focused on architecture, this one encourages Spring-specific best practices and helps detect subtle bugs and antipatterns.
How about this?
@RestController("/hello")
class HelloRestController {
@GetMapping
String hello() {
return "Hello World";
}
}Noticed the issue?
A request to GET /hello would return HTTP 404.
Spring does not use the bean name in @RestController("…") as a path mapping.
The developer probably intended to write:
@RestController
@RequestMapping("/hello")
class HelloRestController {
// ...
}With the predefined rule SpringControllerRules.ControllerNameWithoutRequestMapping we’ve got you covered.
import de.rweisleder.archunit.spring.framework.SpringControllerRules;
@ArchTest
ArchRule ControllerNameWithoutRequestMapping = SpringControllerRules.ControllerNameWithoutRequestMapping;Please refer to the complete documentation here for detailed information.