Spring Boot 2 實戰：利用Redis的Geo功能實現查詢附近的位置

碼農小胖哥發表於2020-06-19
Spring BootRedis

1. 前言

老闆突然要上線一個需求，獲取當前位置方圓一公里的業務代理點。明天上線！當接到這個需求的時候我差點吐血，這時間也太緊張了。趕緊去查相關的技術選型。經過一番折騰，終於在晚上十點完成了這個需求。現在把大致實現的思路總結一下。

圖1

2. MySQL 不合適

遇到需求，首先要想到現有的東西能不能滿足，成本如何。

MySQL是我首先能夠想到的，畢竟大部分資料要持久化到MySQL。但是使用MySQL需要自行計算Geohash。需要使用大量數學幾何計算，並且需要學習地理相關知識，門檻較高，短時間內不可能完成需求，而且長期來看這也不是MySQL擅長的領域，所以沒有考慮它。

Geohash 參考 https://www.cnblogs.com/LBSer/p/3310455.html

2. Redis 中的GEO

Redis是我們最為熟悉的K-V資料庫，它常被拿來作為高效能的快取資料庫來使用，大部分專案都會用到它。從3.2版本開始它開始提供了GEO能力，用來實現諸如附近位置、計算距離等這類依賴於地理位置資訊的功能。GEO相關的命令如下：

Redis命令 描述
GEOHASH 返回一個或多個位置元素的 Geohash 表示
GEOPOS 從key裡返回所有給定位置元素的位置（經度和緯度）
GEODIST 返回兩個給定位置之間的距離
GEORADIUS 以給定的經緯度為中心， 找出某一半徑內的元素
GEOADD 將指定的地理空間位置（緯度、經度、名稱）新增到指定的key中
GEORADIUSBYMEMBER 找出位於指定範圍內的元素，中心點是由給定的位置元素決定

Redis會假設地球為完美的球形, 所以可能有一些位置計算偏差，據說<=0.5%，對於有嚴格地理位置要求的需求來說要經過一些場景測試來檢驗是否能夠滿足需求。

2.1 寫入地理資訊

那麼如何實現目標單位半徑內的所有元素呢？我們可以將所有的位置的經緯度通過上表中的GEOADD將這些地理資訊轉換為52位的Geohash寫入Redis。

該命令格式：

geoadd key longitude latitude member [longitude latitude member ...]

對應例子：

redis> geoadd cities:locs 117.12 39.08 tianjin 114.29 38.02  shijiazhuang 
(integer) 2

意思是將經度為117.12緯度為39.08的地點tianjin和經度為114.29緯度為38.02的地點shijiazhuang加入key為cities:locs的 sorted set集合中。可以新增一到多個位置。然後我們就可以藉助於其他命令來進行地理位置的計算了。

有效的經度從-180度到180度。有效的緯度從-85.05112878度到85.05112878度。當座標位置超出上述指定範圍時，該命令將會返回一個錯誤。

2.2 統計單位半徑內的地區

我們可以藉助於GEORADIUS來找出以給定經緯度，某一半徑內的所有元素。

該命令格式：

georadius key longtitude latitude radius m|km|ft|mi [WITHCOORD] [WITHDIST] [WITHHASH] [COUNT count] [ASC|DESC]

這個命令比GEOADD要複雜一些：

  • radius 半徑長度，必選項。後面的m、km、ft、mi、是長度單位選項，四選一。
  • WITHCOORD 將位置元素的經度和維度也一併返回，非必選。
  • WITHDIST 在返回位置元素的同時， 將位置元素與中心點的距離也一併返回。 距離的單位和查詢單位一致，非必選。
  • WITHHASH 返回位置的52位精度的Geohash值，非必選。這個我反正很少用，可能其它一些偏向底層的LBS應用服務需要這個。
  • COUNT 返回符合條件的位置元素的數量，非必選。比如返回前10個，以避免出現符合的結果太多而出現效能問題。
  • ASC|DESC 排序方式，非必選。預設情況下返回未排序，但是大多數我們需要進行排序。參照中心位置，從近到遠使用ASC ，從遠到近使用DESC。

例如，我們在 cities:locs 中查詢以（115.03，38.44）為中心，方圓200km的城市，結果包含城市名稱、對應的座標和距離中心點的距離（km），並按照從近到遠排列。命令如下：

redis> georadius cities:locs 115.03 38.44 200 km WITHCOORD WITHDIST ASC
1) 1) "shijiazhuang"
   2) "79.7653"
   3) 1) "114.29000169038772583"
      2) "38.01999994251037407"
2) 1) "tianjin"
   2) "186.6937"
   3) 1) "117.02000230550765991"
      2) "39.0800000535766543"

你可以加上 COUNT 1來查詢最近的一個位置。

3. 基於Redis GEO實戰

大致的原理思路說完了，接下來就是實操了。結合Spring Boot應用我們應該如何做？

3.1 開發環境

需要具有GEO特性的Redis版本，這裡我使用的是Redis 4 。另外我們客戶端使用 spring-boot-starter-data-redis 。這裡我們會使用到 RedisTemplate物件。

3.2 批量新增位置資訊

第一步，我們需要將位置資料初始化到Redis中。在Spring Data Redis中一個位置座標(lng,lat) 可以封裝到org.springframework.data.geo.Point物件中。然後指定一個名稱，就組成了一個位置Geo資訊。RedisTemplate提供了批量新增位置資訊的方法。我們可以將章節2.1中的新增命令轉換為下面的程式碼：

   Map<String, Point> points = new HashMap<>();
   points.put("tianjin", new Point(117.12, 39.08));
   points.put("shijiazhuang", new Point(114.29, 38.02));
   // RedisTemplate 批量新增 Geo
   redisTemplate.boundGeoOps("cities:locs").add(points);

可以結合Spring Boot 提供的ApplicationRunner介面來實現初始化。

@Bean
public ApplicationRunner cacheActiveAppRunner(RedisTemplate<String, String> redisTemplate) {

    return args -> {
        final String GEO_KEY = "cities:locs";

        // 清理快取
        redisTemplate.delete(GEO_KEY);
        
        Map<String, Point> points = new HashMap<>();
        points.put("tianjin", new Point(117.12, 39.08));
        points.put("shijiazhuang", new Point(114.29, 38.02));
        // RedisTemplate 批量新增 GeoLocation
        BoundGeoOperations<String, String> geoOps = redisTemplate.boundGeoOps(GEO_KEY);
        geoOps.add(points);
    };
}

地理資料持久化到MySQL，然後同步到Redis中。

3.3 查詢附近的特定位置

RedisTemplate 針對GEORADIUS命令也有封裝：

GeoResults<GeoLocation<M>> radius(K key, Circle within, GeoRadiusCommandArgs args)

Circle物件是封裝覆蓋的面積（圖1），需要的要素為中心點座標Point物件、半徑（radius）、計量單位（metric）, 例如：

Point point = new Point(115.03, 38.44);

Metric metric = RedisGeoCommands.DistanceUnit.KILOMETERS;
Distance distance = new Distance(200, metric);

Circle circle = new Circle(point, distance);

GeoRadiusCommandArgs用來封裝GEORADIUS的一些可選命令引數，參見章節2.2中的WITHCOORD、COUNT、ASC等，例如我們需要在返回結果中包含座標、中心距離、由近到遠排序的前5條資料：

RedisGeoCommands.GeoRadiusCommandArgs args = RedisGeoCommands
        .GeoRadiusCommandArgs
        .newGeoRadiusArgs()
        .includeDistance()
        .includeCoordinates()
        .sortAscending()
        .limit(limit);

然後執行 radius方法就會拿到GeoResults<RedisGeoCommands.GeoLocation<String>>封裝的結果，我們對這個可迭代物件進行解析就可以拿到我們想要的資料：

GeoResults<RedisGeoCommands.GeoLocation<String>> radius = redisTemplate.opsForGeo()
        .radius(GEO_STAGE, circle, args);

if (radius != null) {
    List<StageDTO> stageDTOS = new ArrayList<>();
    radius.forEach(geoLocationGeoResult -> {
        RedisGeoCommands.GeoLocation<String> content = geoLocationGeoResult.getContent();
        //member 名稱  如  tianjin 
        String name = content.getName();
        // 對應的經緯度座標
        Point pos = content.getPoint();
        // 距離中心點的距離
        Distance dis = geoLocationGeoResult.getDistance();
    });
}

3.4 刪除元素

有時候我們可能需要刪除某個位置元素，但是Redis的Geo並沒有刪除成員的命令。不過由於它的底層是zset，我們可以藉助zrem命令進行刪除，對應的Java程式碼為：

redisTemplate.boundZSetOps(GEO_STAGE).remove("tianjin");

4. 總結

今天我們使用Redis的Geo特性實現了常見的附近的地理資訊查詢需求，簡單易上手。其實使用另一個Nosql資料庫MongoDB也可以實現。在資料量比較小的情況下Redis已經能很好的滿足需要。如果資料量大可使用MongoDB來實現。 文中涉及的DEMO可通過我個人部落格獲取。

關注公眾號：Felordcn 獲取更多資訊

個人部落格：https://felord.cn

相關文章