用于公开Neo4j节点的REST接口实现

时间:2013-06-20 14:45:30

标签: java spring rest spring-mvc neo4j

我将我的节点表示为域实体。我想通过REST接口公开我的节点,使用GET通过id查询,POST保存一个节点及其相关节点和PUT来更新节点及其相关节点。 GET工作正常,但我有一个关于POST和PUT案例的实现问题。让我来说明这个问题,因为代码经常说的不仅仅是单词。

在此示例中,有两个相关的节点类型表示为域实体。协作可以包含多个标记,标记可以属于多个协作。所以我们有很多关系。它们共享相同的基类NodeBacked 它基本上用作底层节点的包装器。

NodeBacked

abstract class NodeBacked {

    private Node node;

    public NodeBacked(final Node node) {
        this.node = node;
    }

    public Long getId() {
        return this.node.getId();
    }

    @Override
    public int hashCode() {
        return this.node.hashCode();
    }   

    @JsonIgnore
    public Node getNode() {
        return this.node;
    }

}

协作

public class Collaboration extends NodeBacked {

    public Collaboration(final Node node) {
        super(node);
    }

    // Leaving out some properties for clearness

    @JsonProperty(NAME_JSON)
    public String getName() {
        return (String) getNode().getProperty(NAME);
    }   

    @JsonProperty(TAGS_JSON)
    public Iterable<Tag> getTags() {
        return new IterableWrapper<Tag, Path>(Traversal.description().breadthFirst()
                .relationships(Relationships.HAS, Direction.OUTGOING).uniqueness(Uniqueness.NODE_GLOBAL)
                .evaluator(Evaluators.atDepth(1)).evaluator(Evaluators.excludeStartPosition()).traverse(getNode())) 

{
            @Override
            protected Tag underlyingObjectToObject(final Path path) {
                return new Tag(path.endNode());
            }
        };
    }

    public void setName(final String name) {
        final Index<Node> index = getNode().getGraphDatabase().index().forNodes(Indexes.NAMES);
        getNode().setProperty(NAME, name);
        if (StringUtils.isNotEmpty(getName())) {
            index.remove(getNode(), NAME, name);
        }
        index.add(getNode(), NAME, name);
    }

    public void addTag(final Tag tag) {
        if (!Traversal.description().breadthFirst().relationships(Relationships.HAS, Direction.OUTGOING)
                .uniqueness(Uniqueness.NODE_GLOBAL).evaluator(Evaluators.atDepth(1))
                .evaluator(Evaluators.excludeStartPosition())
                .evaluator(Evaluators.includeWhereEndNodeIs(tag.getNode())).traverse(getNode()).iterator().hasNext

()) {
            getNode().createRelationshipTo(tag.getNode(), Relationships.HAS);
        }
    }

    @Override
    public boolean equals(final Object o) {
        return o instanceof Collaboration && getNode().equals(((Collaboration) o).getNode());
    }

}

代码

public class Tag extends NodeBacked {

    public Tag(final Node node) {
        super(node);
    }

    @JsonProperty(NAME_JSON)
    public String getName() {
        return (String) getNode().getProperty(NAME);
    }

    public void setName(final String name) {
        final Index<Node> index = getNode().getGraphDatabase().index().forNodes(Indexes.NAMES);
        getNode().setProperty(NAME, name);
        if (StringUtils.isNotEmpty(getName())) {
            index.remove(getNode(), NAME, name);
        }
        index.add(getNode(), NAME, name);
    }

    @JsonProperty(COLLABORATIONS_JSON)
    @JsonSerialize(using = SimpleCollaborationSerializer.class)
    private Iterable<Collaboration> getCollaborations(int depth) {
        return new IterableWrapper<Collaboration, Path>(Traversal.description().breadthFirst()
                .relationships(Relationships.HAS, Direction.INCOMING).uniqueness(Uniqueness.NODE_GLOBAL)
                .evaluator(Evaluators.atDepth(1)).evaluator(Evaluators.excludeStartPosition()).traverse(getNode())) 

{
            @Override
            protected Collaboration underlyingObjectToObject(final Path path) {
                return new Collaboration(path.endNode());
            }
        };
    }

    @Override
    public boolean equals(final Object o) {
        return o instanceof Tag && getNode().equals(((Tag) o).getNode());
    }

}

我通过REST(Spring 3.2)展示协作,如下所示。 MappingJackson2HttpMessageConverter用于将POJO转换为JSON,反之亦然。

@Controller
@RequestMapping(value = CollaborationController.CONTEXT_PATH)
public class CollaborationController {

    public static final String CONTEXT_PATH = "/collaborations";

    @Autowired
    private GraphDatabaseService db;

    @Transactional
    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
    public @ResponseBody Collaboration getCollaboration(final @PathVariable Long id) {
        // should use a service layer but doing this for clearness
        return new Collaboration(db.getNodeById(id));
    }   

}

这很有效。 getters在节点中查询它的属性,并返回一个体面的JSON字符串。 GET /collaborations/1的示例JSON字符串:

{
  "name" : "Dummy Collaboration",
  "tags" : [ {
    "name" : "test",
    "id" : 3
  }, {
    "name" : "dummy",
    "id" : 2
  } ],
  "id" : 1
}

那么,问题是什么呢?想象一下带有JSON主体的POST请求,如下所示:

{
  "name" : "Second collaboration",
  "tags" : [ {
    "name" : "tagged"
  } ]
}

CollaborationController具有以下方法来处理POST请求:

@Transactional
    @RequestMapping(method = RequestMethod.POST, headers = JSON_CONTENT_TYPE)
    public @ResponseBody ResponseEntity<Collaboration> persist(final @RequestBody Collaboration collaboration, 
            final UriComponentsBuilder builder) {
        final Collaboration collab = new Collaboration(db.createNode(Labels.COLLAB));
        // Problem!!
        collab.setName(collaboration.getName());        

        final HttpHeaders headers = new HttpHeaders();
        headers.setLocation(builder.path(CONTEXT_PATH + "/{id}").buildAndExpand(collab.getId()).toUri());
        return new ResponseEntity<Collaboration>(collab, headers, HttpStatus.CREATED);
    }

collab.setName(collaboration.getName());将无效,因为协作类不包含自己的属性,并使用直接查询基础节点的getter。在这种情况下,没有任何节点可用,因为Jackson应使用Spring的MappingJackson2HttpMessageConverter将协作从JSON转换为POJO。没有任何属性,所以没有什么可以设置......

我正在研究解决这个问题的最干净的解决方案,但还没找到。我可以使用POJO(或VO或...)作为持久化方法的传入参数,但这不是真正可维护的。更改属性需要更新Collaboration类以及CollaborationVO(POJO)类。

建议非常欢迎! Spring Data Neo4j主要解决了所有这些问题,但我对它的性能并不满意。这就是我尝试另一种方法的确切原因。

我希望这个解释足够清楚。谢谢你的支持!

使用的框架:

  • Spring 3.2.3.RELEASE
  • Neo4j 2.0.0-M3(嵌入式
  • Jackson 2.2.2

1 个答案:

答案 0 :(得分:1)

你说:

I could use a POJO (or VO or ...) as incoming parameter for the persist method, 
but that's not really maintainable. 

但是我没有看到解决这个问题的方法 - 虽然我同意这看起来很难看,应该有更好的方法;但是,我还没有看到一个。

未讨论的方法的一个方面是它将底层数据库实现暴露给客户端。当然,它被序列化为JSON,但这是否会阻止客户端组合“协作(或标记)”对象? [您的客户端可能是一个javascript客户端,因此这不是问题,但这并不能阻止其他假设的客户端构建您的一个对象。]如果该客户端调用getCollaborations()(或getTags())会发生什么方法?对我来说,这是两个邪恶中更糟糕的。

我会将您现有的域实体更改为ECollaboration / ETag,然后为Collaboration / Tag创建纯POJO。 E类可以知道POJO,但不是其他方式。因此,E类也可以使用诸如“convert()”和“valueOf()”之类的方法实现接口,以在API类和域类之间进行转换。实际上,这些方法也有助于可维护性 - 当某些内容发生变化时,您可以很容易地看到对另一个对象产生影响。