com.structurizr.analysis

Class SpringComponentFinderStrategy

java.lang.Object

com.structurizr.analysis.AbstractComponentFinderStrategy

com.structurizr.analysis.AbstractSpringComponentFinderStrategy

com.structurizr.analysis.SpringComponentFinderStrategy

All Implemented Interfaces:

com.structurizr.analysis.ComponentFinderStrategy

public class SpringComponentFinderStrategy
extends AbstractSpringComponentFinderStrategy

This component finder strategy knows how to find the following Spring components:

• Spring MVC controllers (classes annotated @Controller)
• Spring REST controllers (classes annotated @RestController)
• Spring services (classes annotated @Service)
• Spring components (classes annotated @Component)
• Spring repositories (classes annotated @Repository, plus those that extend JpaRepository or CrudRepository)

By default, non-public types will be ignored so that, for example, you can hide repository implementations behind services, as described at Whoops! Where did my architecture go. You can change this behaviour by passing false to AbstractSpringComponentFinderStrategy.setIncludePublicTypesOnly(boolean).

Field Summary

Fields inherited from class com.structurizr.analysis.AbstractSpringComponentFinderStrategy

includePublicTypesOnly, SPRING_COMPONENT, SPRING_MVC_CONTROLLER, SPRING_REPOSITORY, SPRING_REST_CONTROLLER, SPRING_SERVICE, SPRING_WEB_SERVICE_ENDPOINT

Fields inherited from class com.structurizr.analysis.AbstractComponentFinderStrategy

componentFinder, componentsFound, supportingTypesStrategies

Constructor Summary

Constructors

Constructor and Description
SpringComponentFinderStrategy(com.structurizr.analysis.SupportingTypesStrategy... strategies)

Method Summary

Modifier and Type	Method and Description
void	beforeFindComponents()
protected java.util.Set<com.structurizr.model.Component>	doFindComponents()

Methods inherited from class com.structurizr.analysis.AbstractSpringComponentFinderStrategy

findInterfacesForImplementationClassesWithAnnotation, setIncludePublicTypesOnly

Methods inherited from class com.structurizr.analysis.AbstractComponentFinderStrategy

addComponent, addSupportingTypesStrategy, afterFindComponents, findClassesWithAnnotation, findClassesWithAnnotation, findComponents, findDependencies, findSupportingTypes, findTypesAnnotatedWith, getComponentFinder, getDuplicateComponentStrategy, getTypeRepository, setComponentFinder, setDuplicateComponentStrategy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpringComponentFinderStrategy

public SpringComponentFinderStrategy(com.structurizr.analysis.SupportingTypesStrategy... strategies)

Method Detail

beforeFindComponents

public void beforeFindComponents()

Specified by:

beforeFindComponents in interface com.structurizr.analysis.ComponentFinderStrategy

Overrides:

beforeFindComponents in class com.structurizr.analysis.AbstractComponentFinderStrategy

doFindComponents

protected java.util.Set<com.structurizr.model.Component> doFindComponents()

Specified by:

doFindComponents in class com.structurizr.analysis.AbstractComponentFinderStrategy