Merge pull request #348 from CorvusYe/master

feat: Supporting geometry types.

Author: CorvusYe

CHANGELOG-CN.md

@@ -22,6 +22,15 @@ This source code is licensed under Apache 2.0 License.
 
 ## 新特性
 
+- 支持Geo类型
+
+  字段类型 | 属性类型
+  ---|---
+  geo(point) | org.springframework.data.geo.Box
+  geo(linestring) | org.springframework.data.geo.Point
+  geo(polygon) | org.springframework.data.geo.Polygon
+  geo | Object
+
 - 支持节点的属性对象字段可以与实体对象直接映射
 
   ```java

CHANGELOG.md

@@ -18,8 +18,8 @@ This source code is licensed under Apache 2.0 License.
     - [ ] show metas
     - [ ] create | alter tag & edge type
     - [ ] index
-- [ ] ResultSetUtil more column types support
-  - [ ] Geography
+- [x] ResultSetUtil more column types support
+  - [x] Geography
   - [x] Duration
 
 ## Dependencies upgrade
@@ -43,6 +43,15 @@ This source code is licensed under Apache 2.0 License.
 
 ## Feature
 
+- Supporting geometry types.
+
+  db type | java type
+  ---|---
+  geo(point) | org.springframework.data.geo.Box
+  geo(linestring) | org.springframework.data.geo.Point
+  geo(polygon) | org.springframework.data.geo.Polygon
+  geo | Object
+
 - Supporting props can be directly mapped to entity objects.
 
   ```java

ngbatis-demo/src/main/java/ye/weicheng/ngbatis/demo/pojo/TestGeo.java

@@ -0,0 +1,73 @@
+package ye.weicheng.ngbatis.demo.pojo;
+
+// Copyright (c) 2025 All project authors. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
+
+import javax.persistence.Id;
+import javax.persistence.Table;
+import org.nebula.contrib.ngbatis.annotations.Space;
+import org.springframework.data.geo.Box;
+import org.springframework.data.geo.Point;
+import org.springframework.data.geo.Polygon;
+
+/**
+ * @author yeweicheng
+ * @since 2025-05-17 11:31
+ * <br>Now is history!
+ */
+@Table(name = "test_geo")
+@Space(name = "test")
+public class TestGeo {
+
+  @Id
+  private String id;
+
+  private Point geoPoint;
+
+  private Box geoLine;
+
+  private Polygon geoPolygon;
+
+  private Object geo;
+
+  public String getId() {
+    return id;
+  }
+
+  public void setId(String id) {
+    this.id = id;
+  }
+
+  public Point getGeoPoint() {
+    return geoPoint;
+  }
+
+  public void setGeoPoint(Point geoPoint) {
+    this.geoPoint = geoPoint;
+  }
+
+  public Box getGeoLine() {
+    return geoLine;
+  }
+
+  public void setGeoLine(Box geoLine) {
+    this.geoLine = geoLine;
+  }
+
+  public Polygon getGeoPolygon() {
+    return geoPolygon;
+  }
+
+  public void setGeoPolygon(Polygon geoPolygon) {
+    this.geoPolygon = geoPolygon;
+  }
+
+  public Object getGeo() {
+    return geo;
+  }
+
+  public void setGeo(Object geo) {
+    this.geo = geo;
+  }
+}

ngbatis-demo/src/main/java/ye/weicheng/ngbatis/demo/repository/TestGeoDao.java

@@ -0,0 +1,17 @@
+package ye.weicheng.ngbatis.demo.repository;
+
+// Copyright (c) 2025 All project authors. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
+
+import org.nebula.contrib.ngbatis.proxy.NebulaDaoBasic;
+import ye.weicheng.ngbatis.demo.pojo.TestGeo;
+
+/**
+ * @author yeweicheng
+ * @since 2025-05-17 11:41
+ * <br>Now is history!
+ */
+public interface TestGeoDao extends NebulaDaoBasic<TestGeo, String> {
+
+}

ngbatis-demo/src/main/resources/mapper/TestGeoDao.xml

@@ -0,0 +1,8 @@
+<!--
+    Copyright (c) 2025 All project authors. All rights reserved.
+    
+    This source code is licensed under Apache 2.0 License.
+-->
+<mapper namespace="ye.weicheng.ngbatis.demo.repository.TestGeoDao">
+
+</mapper>

ngbatis-demo/src/test/java/ye/weicheng/ngbatis/demo/repository/TestGeoDaoTest.java

@@ -0,0 +1,57 @@
+package ye.weicheng.ngbatis.demo.repository;
+
+// Copyright (c) 2025 All project authors. All rights reserved.
+//
+// This source code is licensed under Apache 2.0 License.
+
+import com.alibaba.fastjson.JSON;
+import java.util.Date;
+import org.junit.jupiter.api.MethodOrderer.OrderAnnotation;
+import org.junit.jupiter.api.Order;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestMethodOrder;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.data.geo.Point;
+import ye.weicheng.ngbatis.demo.pojo.TestGeo;
+
+/**
+ * @author yeweicheng
+ * @since 2025-05-17 11:42
+ * <br>Now is history!
+ */
+@SpringBootTest
+@TestMethodOrder(OrderAnnotation.class)
+public class TestGeoDaoTest {
+
+  static final int sec = new Date().getSeconds();
+  
+  static final String caseId = "test-geo";
+
+  @Autowired private TestGeoDao dao;
+  
+  @Test
+  @Order(1)
+  public void testInsert() {
+    TestGeo geo = new TestGeo();
+    geo.setId(caseId);
+    geo.setGeoPoint(new Point(sec, sec + 0.1));
+    geo.setGeoLine(new org.springframework.data.geo.Box(
+      new Point(sec, sec + 0.1),
+      new Point(sec + 0.1, sec)
+    ));
+    geo.setGeoPolygon(new org.springframework.data.geo.Polygon(
+      new Point(sec, sec + 0.1),
+      new Point(sec + 0.1, sec),
+      new Point(sec, sec)
+    ));
+    dao.insert(geo);
+  }
+  
+  @Test
+  @Order(2)
+  public void testSelectById() {
+    TestGeo testGeo = dao.selectById(caseId);
+    System.out.println(JSON.toJSONString(testGeo));
+  }
+}

src/main/java/org/nebula/contrib/ngbatis/binding/beetl/functions/ValueFmtFn.java

@@ -10,6 +10,9 @@
 import java.time.Duration;
 import java.util.Date;
 import org.apache.commons.text.StringEscapeUtils;
+import org.springframework.data.geo.Box;
+import org.springframework.data.geo.Point;
+import org.springframework.data.geo.Polygon;
 
 /**
  * 对传递给数据库的值进行不同类型的格式化
@@ -81,6 +84,47 @@ public Object call(Object value, Boolean ifStringLike, Boolean escape) {
             : fn;
       return String.format("%s('%s')", fn, sdf.format(value));
     }
+    
+    //    ST_Point(longitude, latitude)
+    if (value instanceof Point) {
+      Point point = (Point) value;
+      return String.format(
+        "ST_Point(%s, %s)",
+        point.getX(),
+        point.getY()
+      );
+    }
+    
+    //    ST_GeogFromText("LINESTRING(3 8, 4.7 73.23)")
+    if (value instanceof Box) {
+      Box box = (Box) value;
+      Point first = box.getFirst();
+      Point second = box.getSecond();
+      return String.format(
+        "ST_GeogFromText(\"LINESTRING(%s %s, %s %s)\")",
+        first.getX(),
+        first.getY(),
+        second.getX(),
+        second.getY()
+      );
+    }
+    
+    if (value instanceof Polygon) {
+      Polygon polygon = (Polygon) value;
+      StringBuilder sb = new StringBuilder("ST_GeogFromText(\"POLYGON((");
+      for (Point point : polygon.getPoints()) {
+        sb.append(String.format("%s %s,", point.getX(), point.getY()));
+      }
+      
+      // 追加起始点，形成闭环      
+      Point point = polygon.getPoints().get(0);
+      sb.append(String.format("%s %s,", point.getX(), point.getY()));
+      
+      sb.deleteCharAt(sb.length() - 1);
+      sb.append("))\")");
+      return sb.toString();
+    }
+    
     return value;
   }
 }

src/main/java/org/nebula/contrib/ngbatis/utils/ResultSetUtil.java

@@ -13,10 +13,13 @@
 import com.vesoft.nebula.DateTime;
 import com.vesoft.nebula.ErrorCode;
 import com.vesoft.nebula.Time;
+import com.vesoft.nebula.client.graph.data.CoordinateWrapper;
 import com.vesoft.nebula.client.graph.data.DateTimeWrapper;
 import com.vesoft.nebula.client.graph.data.DateWrapper;
 import com.vesoft.nebula.client.graph.data.DurationWrapper;
+import com.vesoft.nebula.client.graph.data.GeographyWrapper;
 import com.vesoft.nebula.client.graph.data.Node;
+import com.vesoft.nebula.client.graph.data.PointWrapper;
 import com.vesoft.nebula.client.graph.data.Relationship;
 import com.vesoft.nebula.client.graph.data.ResultSet;
 import com.vesoft.nebula.client.graph.data.TimeWrapper;
@@ -39,6 +42,9 @@
 import org.nebula.contrib.ngbatis.proxy.MapperProxy;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.springframework.data.geo.Box;
+import org.springframework.data.geo.Point;
+import org.springframework.data.geo.Polygon;
 
 /**
  * 结果集基础类型处理的工具类
@@ -96,7 +102,8 @@ public static <T> T getValue(ValueWrapper value, Class<T> resultType) {
                             : value.isSet() ? transformSet(value.asSet())
                               : value.isMap() ? transformMap(value.asMap())
                                 : value.isDuration() ? transformDuration(value.asDuration())
-                                  : null;
+                                  : value.isGeography() ? transformGeo(value.asGeography())
+                                    : null;
       if (o instanceof Number) {
         o = castNumber((Number) o, resultType);
       }
@@ -147,6 +154,41 @@ private static Object transformTime(TimeWrapper time) {
   private static Object transformDuration(DurationWrapper du) {
     return java.time.Duration.ofNanos(du.getSeconds() * 1000000000);
   }
+  
+  private static Object transformGeo(GeographyWrapper geo) {
+    String geoStr = String.valueOf(geo);
+    boolean isPoint = geoStr.startsWith("POINT");
+    boolean isLineString = geoStr.startsWith("LINESTRING");
+    boolean isPolygon = geoStr.startsWith("POLYGON");
+        
+    if (isPoint) {
+      CoordinateWrapper coordinate = geo.getPointWrapper().getCoordinate();
+      return coordToPoint(coordinate);
+    } else if (isLineString) {
+      List<CoordinateWrapper> coordinateList = geo.getLineStringWrapper().getCoordinateList();
+      Point first = coordToPoint(coordinateList.get(0));
+      Point second = coordToPoint(coordinateList.get(1));
+      return new Box(first, second);
+    } else if (isPolygon) {
+      List<List<CoordinateWrapper>> coordListList = geo.getPolygonWrapper().getCoordListList();
+      List<Point> points = new ArrayList<>();
+      List<CoordinateWrapper> coordList = coordListList.get(0);
+      int size = coordList.size();
+      for (int i = 0; i < size; i++) {
+        if (i == size - 1) {
+          break;
+        }
+        CoordinateWrapper coordinate = coordList.get(i);
+        points.add(coordToPoint(coordinate));
+      }
+      return new Polygon(points);
+    }
+    return null;
+  }
+  
+  private static Point coordToPoint(CoordinateWrapper coordinate) {
+    return new Point(coordinate.getX(), coordinate.getY());
+  }
 
   private static Object transformNode(Node node, Class<?> resultType) {
     List<String> tagNames = node.tagNames();