基于Rascal-MPL生成Java代码库CPG及图查询的技术咨询

环境准备 #

• 安装Rascal-MPL：可选择Eclipse的Rascal插件或独立Rascal Shell，确保本地Java环境为JDK 8及以上（Rascal依赖该版本）
• 导入Java核心分析库：在Rascal代码中导入import lang::java::jdt::m3::Core;，该库基于Eclipse JDT实现，是提取Java代码元数据、构建CPG的基础

生成Java代码属性图(CPG) #

Rascal的M3模型已包含Java代码的核心结构与关系（类、方法、调用、继承等），只需将其映射为CPG的节点-边结构即可：

1. 加载Java项目
   使用loadProject函数加载目标项目，生成M3模型：

   import lang::java::jdt::m3::Core;
   
   // 替换为你的Java项目路径
   M3 m3 = loadProject("/path/to/your/java/project");
   

   若项目有外部依赖，可通过第二个参数指定classpath：loadProject("/path/to/project", ["lib/*.jar"])

2. 构建CPG结构
   用Rascal的graph类型定义CPG的节点（类、方法、调用等）和边（调用、继承等）：

   import util::graph::Graph;
   
   alias Node = str;
   alias Edge = tuple[Node source, Node target, str label];
   
   graph[Node, Edge] cpg = ();
   
   // 添加类节点与继承边
   for (clazz <- m3.classes) {
       cpg += node(clazz, label="Class", name=clazz.name, line=clazz.location.begin.line);
       if (clazz.extends != void) {
           cpg += edge(clazz, clazz.extends, label="EXTENDS");
       }
   }
   
   // 添加方法节点与调用边
   for (call <- m3.calls) {
       cpg += node(call.source, label="MethodCall", name=call.name, line=call.location.begin.line);
       cpg += node(call.target, label="Method", name=call.target.name, line=call.target.location.begin.line);
       cpg += edge(call.source, call.target, label="CALLS");
   }
   

   可根据需求扩展节点属性（如访问修饰符、返回类型）或边类型（如变量引用、字段赋值）。

导出到Neo4J #

利用Rascal的Neo4J集成工具完成导出：

1. 导入Neo4J库：

   import util::neo4j::Graph;
   

2. 连接本地Neo4J服务（确保服务已启动）：

   Neo4jGraph neo = openNeo4j("bolt://localhost:7687", "neo4j", "your-password");
   

3. 批量导入CPG数据：

   // 导入节点
   for (n <- nodes(cpg)) {
       createNode(neo, n.label, n.attributes);
   }
   // 导入边
   for (e <- edges(cpg)) {
       srcNode = getNodeByAttribute(neo, "name", e.source.name);
       tgtNode = getNodeByAttribute(neo, "name", e.target.name);
       createEdge(neo, srcNode, tgtNode, e.label);
   }
   

导出到TinkerPop（Gremlin） #

通过Rascal的TinkerPop集成连接Gremlin Server：

1. 导入TinkerPop库：

   import util::tinkerpop::Graph;
   

2. 连接Gremlin Server（确保服务已启动）：

   TinkerPopGraph tg = openTinkerPop("ws://localhost:8182/gremlin");
   

3. 导入CPG数据：

   // 添加顶点
   for (n <- nodes(cpg)) {
       addVertex(tg, n.label, n.attributes);
   }
   // 添加边
   for (e <- edges(cpg)) {
       srcVertex = g.V().has("name", e.source.name).next();
       tgtVertex = g.V().has("name", e.target.name).next();
       addEdge(tg, srcVertex, tgtVertex, e.label);
   }
   

查询示例 #

Neo4J（Cypher） #

查询所有方法调用关系及调用行号：

MATCH (caller:MethodCall)-[:CALLS]->(callee:Method)
RETURN caller.name AS 调用方, callee.name AS 被调用方, caller.line AS 调用行号

TinkerPop（Gremlin） #

查询所有继承自java.lang.Object的类：

g.V().hasLabel("Class").out("EXTENDS").has("name", "java.lang.Object").in("EXTENDS").values("name")

内容的提问来源于stack exchange，提问作者bruce_wayne