Spring Data Rest学习篇----@Projection

Spring Data Rest---projection    （投射，投影）

对应spring-data-rest-reference 的第8.1章

当一个实体类含有另一个实体类的对象时

@Entity
public class Person{
    @Id 
    @GeneratedValue
    private Long id;
    private String firstName, lastName;
    @OneToOne
    private Address address;
    …
}

接口：

interface PersonRepository extends CrudRepository<Person, Long> {}

address相当于一个链接，连接到另外一个名为Adrress的表，

但是在使用到Person的对象时，不一定能识别到address属性，Rest中有两种方法让address能被识别：

   第一种，和Person一样增加一个Address的Repository

interface AddressRepository extends CrudRepository<Address, Long> {}

这种情况下，Person会把address当作一个子链接，链接到当前Person对象的address属性对应的Address表中的对象。ex.

{
    "firstName" : "Frodo",
    "lastName" : "Baggins",
    "_links" : {
        "self" : {
        "href" : "http://localhost:8080/persons/1"
    },
    "address" : {
        "href" : "http://localhost:8080/persons/1/address"
    }
}
}

这里可以看到address属性内容是一个链接，此链接是person链接的子链接，在浏览器输入此链接访问时就可以直接访问到此person的address内容。

   第二种，如果没有定义Address自己的Repository，那么Person会把address的内容嵌入到Person的address属性中，作为person对象的一个字段内容。

{
 "firstName" : "Frodo",
 "lastName" : "Baggins",
 "address" : {
 "street": "Bag End",
 "state": "The Shire",
 "country": "Middle Earth"
 },
 "_links" : {
    "self" : {
        "href" : "http://localhost:8080/persons/1"
    }
}
}

那么问题来了：

问题1--如果我在person中不想要address的具体内容呢？

也就是说在Person类中有address这个属性，但是并不想要它的内容，那就要用到Projection了，如

@Projection(name= "noAddresses",types= { Person.class }) ①
interface NoAddresses{ ②
    String getFirstName(); ③
    String getLastName(); ④
}

① 这里的name属性是Projection的名字，types表示这个Projection只提供给Person类型的对象，在访问的时候也只能通过Person对象访问到这个Projection。

NoAddresses接口中只只有FirstName和LastName的getter方法，说明它不会提供任何address的信息。假如现在你定义了一个Address的Repository，Rest提供的Person对象的内容会有所不同，如下：

{
    "firstName" : "Frodo",
    "lastName" : "Baggins",
    "_links" : {
    "self" : {
	"href" : "http://localhost:8080/persons/1{?projection}", ①
	"templated" : true
    },
    "address" : {
	"href" : "http://localhost:8080/persons/1/address"
    }
}
}

可以看到这里的链接发生了变化，这里多加的一个条件是{?projection}，说明可以添加projection的方式去访问此对象，比如：

 http://localhost:8080/persons/1?projection=noAddresses

这里的projection的值noAddresses要和@Projection(name = "noAddress")中的name值要相同。

问题2--那一个Person类可以有多个@Projection吗？

答案是：可以的！可以设置多个@Projection

问题3--Spring Data Rest怎么寻找@Projection注解？

答案是：和实体类在同一个包下或者子包下的 @Projection都会被扫描到，并注册到Bean中。另外，也可以人工注册@Projection，这样的方式是通过

RepositoryRestConfiguration.projectionConfiguration().addProjection(…).

实现的。

不管是哪种情况，必须要在接口中添加@Projection注解。