指定服务返回字段的最佳方法

我们使用 Java EE 7 和 WildFly 9 来开发移动/Web 应用程序的自定义后端。后端是一个经典的三层系统，具有通信逻辑（JAX-RS）、业务逻辑（Session EJB）和持久层（Hibernate）。

业务逻辑层由一组服务组成，每个服务都由一个接口和一个 EJB 实现定义。我们假设

public interface IPostService {
    List<PostDTO> getAllPosts();
}

and

@Stateless
public class PostService implements IPostService {
    List<PostDTO> getAllPosts(){
    // retrieving my Posts through Hibernate
    }

having

public class PostDTO {

    private Long id;
    private String title;
    // UserDTO is a VEEERY big object
    private UserDTO author;

    // getters and setters
}

让我们假设，有时，客户只对帖子感兴趣id and title。 API端点将接收一个查询参数，其中包含要获取的字段列表。因此，JSON 序列化的 DTO 应该只包含 postid and title。目标是避免为了加载非常大的数据而进行不必要的处理UserDTO不需要时对象。

一个简单的解决方案是添加自定义List<String> desiredFields参数为getAllPosts()。这不太让我信服，因为我们需要将此参数添加到几乎every服务方法。

这样做的最佳实践是什么？是否有用于此目的的 Java EE 对象？

我的回答做了一些额外的假设：

• 使用 JPA 2.1，您可以利用实体​​图有条件地获取实体的部分内容，无论是惰性的还是急切的。
• 将 JAX-RS 与 Jackson JSON 提供程序一起使用，您可以使用@JsonView执行相同的操作将对象渲染为 JSON。

考虑以下示例：用户具有一组角色。默认情况下，角色是惰性获取的，不需要以 JSON 形式呈现。但在某些情况下，您希望立即获取它们，因为您希望它们以 JSON 格式呈现。

@Entity
@NamedQueries({
    @NamedQuery(name = "User.byName", query = "SELECT u FROM User u WHERE u.name = :name"),
    @NamedQuery(name = "Users.all", query = "SELECT u FROM User u ORDER BY u.name ASC")
})
@NamedEntityGraph(name = "User.withRoles", attributeNodes = {
    @NamedAttributeNode("roles") // make them fetched eager
})
public class User implements Serializable {

    public static interface WithoutRoles {}
    public static interface WithRoles extends WithoutRoles {}

    @Id
    private Long id;

    @Column(unique = true, updatable = false)
    private String name;

    @ManyToMany // fetched lazy by default
    @JoinTable(/* ... */)
    private Set<Role> roles;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    // include in JSON only when "@JsonView(WithRoles.class)" is used:
    @JsonView(WithRoles.class)
    public Set<Role> getRoles() {
        if (roles == null)
            roles = new HashSet<>();
        return roles;
    }

    public void setRoles(Set<Role> roles) {
        this.roles = roles;
    }

}

@Entity
public class Role implements Serializable {
    /* ... */
}

以下是加载用户的代码，无论是否具有角色：

public User getUser(String name, boolean withRoles) {
    TypedQuery<User> query = entityManager.createNamedQuery("User.byName", User.class)
        .setParameter("name", name);

    if (withRoles) {
        EntityGraph<User> graph = (EntityGraph<User>) entityManager.createEntityGraph("User.withRoles");
        query.setHint("javax.persistence.loadgraph", graph);
    }

    try {
        return query.getSingleResult();
    } catch (NoResultException e) {
        return null;
    }
}

public List<User> getAllUsers() {
    return entityManager.createNamedQuery("Users.all", User.class)
        .getResultList();
}

现在是 REST 资源：

@RequestScoped @Path("users")
public class UserResource {

    private @Inject UserService userService;

    // user list - without roles
    @GET @Produces(MediaType.APPLICATION_JSON)
    @JsonView(User.WithoutRoles.class)
    public Response getUserList() {
        List<User> users = userService.getAllUsers();
        return Response.ok(users).build();
    }

    // get one user - with roles
    @GET @Path("{name}") @Produces(MediaType.APPLICATION_JSON)
    @JsonView(User.WithRoles.class)
    public Response getUser(@PathParam("name") String name) {
        User user = userService.getUser(name, true);
        if (user == null)
            throw new NotFoundException();

        return Response.ok(user).build();
    }

}

因此，在持久性方面（JPA、Hibernate）您可以使用延迟获取来防止加载实体的某些部分，而在 Web 层（JAX-RS、JSON）您可以使用@JsonView决定在实体的（反）序列化中应处理哪些部分。