af7e15b8e6
This commit introduces support to access resources via projections, which means naming a dedicated set of properties of the entity to be exposed and being able to refer to that set through a request parameter.
## General usage
Projections are defined as interfaces that mimic the properties of the domain class to be exported:
@Projection(types = Customer.class, name = "summary")
interface Summary {
String getFirstname();
String getLastname();
AddressSummary getAddress();
}
interface AddressSummary() {
String getZipCode();
}
The projection interface can be annotated with @Projection to be auto-discovered. We scan all packages in which we find domain types to be exported for projection types and auto-register them. For manual registration, use RepositoryRestConfiguration.projectionDefinitionConfiguration().addProjection(…) and manually register them.
If a projection is registered for a given type, this will be indicated via a "projection" template variable in the URI pointing to resources with projections. The name of the variable can also be configured on ProjectionDefinitionConfiguration.
## Internals
The projection interfaces are consider bean property delegates by default. This means, that for the above interfaces we will lookup the firstname, lastname and address property of the projection target. In the case of address we re-project the result of the proxy target invocation with a sub-projection onto AddressSummary.
For more advanced use-cases you can annotate a method of the projection interface with @Value and use a SpEL expression to invoke further functionality and return that to be rendered:
interface MyProjection {
@Value("#{@myBean.someMethod(target)}")
SubProjection getValue();
}
This projection would call the someMethod(…) method on a Spring bean named myBean handing the proxy target to the method. The result will be projected in turn onto a type called SubProjection.
As the projection objects are exposed to Jackson as is, they can be annotated with Jackson annotations to further customize the representation.
71 lines
1.9 KiB
XML
71 lines
1.9 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
|
|
|
<modelVersion>4.0.0</modelVersion>
|
|
|
|
<artifactId>spring-data-rest-core</artifactId>
|
|
|
|
<name>Spring Data REST - Core</name>
|
|
<description>Spring Data REST - Core</description>
|
|
|
|
<parent>
|
|
<groupId>org.springframework.data</groupId>
|
|
<artifactId>spring-data-rest-parent</artifactId>
|
|
<version>2.1.0.BUILD-SNAPSHOT</version>
|
|
<relativePath>../pom.xml</relativePath>
|
|
</parent>
|
|
|
|
<properties>
|
|
<spring.hateoas>0.10.0.BUILD-SNAPSHOT</spring.hateoas>
|
|
<springplugin>1.0.0.RELEASE</springplugin>
|
|
<evoinflector>1.0.1</evoinflector>
|
|
</properties>
|
|
|
|
<dependencies>
|
|
|
|
<dependency>
|
|
<groupId>org.springframework</groupId>
|
|
<artifactId>spring-tx</artifactId>
|
|
</dependency>
|
|
|
|
<dependency>
|
|
<groupId>org.springframework.hateoas</groupId>
|
|
<artifactId>spring-hateoas</artifactId>
|
|
<version>${spring.hateoas}</version>
|
|
</dependency>
|
|
|
|
<dependency>
|
|
<groupId>org.springframework.data</groupId>
|
|
<artifactId>spring-data-commons</artifactId>
|
|
<version>${springdata.commons}</version>
|
|
</dependency>
|
|
|
|
<dependency>
|
|
<groupId>org.springframework.plugin</groupId>
|
|
<artifactId>spring-plugin-core</artifactId>
|
|
<version>${springplugin}</version>
|
|
</dependency>
|
|
|
|
<dependency>
|
|
<groupId>org.atteo</groupId>
|
|
<artifactId>evo-inflector</artifactId>
|
|
<version>${evoinflector}</version>
|
|
</dependency>
|
|
|
|
<dependency>
|
|
<groupId>joda-time</groupId>
|
|
<artifactId>joda-time</artifactId>
|
|
<version>${jodatime}</version>
|
|
<optional>true</optional>
|
|
</dependency>
|
|
|
|
<dependency>
|
|
<groupId>com.fasterxml.jackson.core</groupId>
|
|
<artifactId>jackson-annotations</artifactId>
|
|
<version>${jackson}</version>
|
|
</dependency>
|
|
|
|
</dependencies>
|
|
|
|
</project>
|