【Redis】Redis 中地理位置功能 Geospatial 了解一下？

悠悠 2023-10-11 23:39 15阅读 0赞

#### 文章目录 ####

*  前言
 *  一、Geospatial Indexes 的数据结构
 *  二、常用命令
 *  三、实用场景示例
 *   *  1. 找出某一经纬度周围的餐馆
     *  2. 按照距离排序查询景点
 *  四、在实际开发中，需要注意以下几点：

## 前言 ##

Geospatial Indexes 是 Redis 提供的一种数据结构，用于存储和查询地理位置信息。它可以将地理位置的经度和纬度编码为二维平面上的点，并支持根据距离或矩形区域查询附近的地理位置点，这使得它在很多场景下被广泛应用，比如 LBS（Location Based Service）、智能推荐、出行规划等。

Redis 中 Geospatial Indexes 是通过有序集合实现的，其内部使用 zset 数据类型来存储地理位置点的经纬度和成员信息。其中，经纬度以浮点数表示，成员信息则可以是用户 ID、商铺名称等。  
在使用 Geospatial Indexes 时，我们需要注意以下几个方面：

*  地理位置点的经纬度采用 WGS-84 坐标系表示；
 *  距离单位默认为米，可以通过参数设置为其他单位；
 *  矩形区域查询默认采用左闭右开的方式，即包括左边界，不包括右边界。

## 一、Geospatial Indexes 的数据结构 ##

Geospatial Indexes 在 Redis 中是通过 zset 实现的，其中地理位置点的经纬度被编码为 zset 中每个 member 的分数。具体来说，Redis 在将经纬度编码为分数时，使用了 zset 的有序性质，将其转化为一个唯一的、不可重复的浮点数。

例如，如果我们要存储以下三个地理位置点：

*  北京 39.9042° N, 116.4074° E
 *  上海 31.2304° N, 121.4737° E
 *  广州 23.1291° N, 113.2644° E

则可以将经纬度编码为分数，存入 zset 中，如下所示：

*  ZADD city\_geo\_location 116.4074 39.9042 “北京”
 *  ZADD city\_geo\_location 121.4737 31.2304 “上海”
 *  ZADD city\_geo\_location 113.2644 23.1291 “广州”

此时，zset 中的每个 member 都代表了一个地理位置点，其分数则代表了该点的唯一标识，在进行距离或矩形区域查询时将会用到。

## 二、常用命令 ##

Redis 中的 Geospatial Indexes 提供了一组命令来管理和查询地理位置数据，包括以下命令：

*  GEOADD：向有序集合中添加一个或多个地理位置元素。
    
     *  语法：GEOADD key longitude latitude member \[longitude latitude member …\]
     *  参数：
        
         *  key：必需，要添加元素的有序集合的键名。
         *  longitude：必需，要添加元素的经度值，范围为 -180 到 180 度。
         *  latitude：必需，要添加元素的纬度值，范围为 -90 到 90 度。
         *  member：必需，要添加元素的成员名，必须为字符串类型。
     *  示例：GEOADD restaurants 139.7329 35.6634 “Sushi Dai” 139.7712 35.7100 “Afuri Ramen” 139.7198 35.7101 “Komoro Soba”
 *  GEOPOS：获取指定成员在有序集合中的经纬度坐标。
    
     *  语法：GEOPOS key member \[member …\]
     *  参数：
        
         *  key：必需，要获取经纬度坐标的有序集合的键名。
         *  member：必需，要获取经纬度坐标的元素的成员名，可以指定多个成员名。
     *  返回值：一个二维数组，每个子数组表示一个成员的经纬度坐标，每个子数组包含两个元素，分别表示经度和纬度。
     *  示例：GEOPOS restaurants “Sushi Dai” “Komoro Soba”，返回值为 \[\[“139.7329”,“35.6634”\],\[“139.7198”,“35.7101”\]\]
 *  GEODIST：获取有序集合中两个成员之间的距离。
    
     *  语法：GEODIST key member1 member2 \[unit\]
     *  参数：
        
         *  key：必需，要计算距离的有序集合的键名。
         *  member1：必需，第一个成员的名字。
         *  member2：必需，第二个成员的名字。
         *  unit：可选，默认为米，表示要返回的距离单位，可以是以下四种单位之一：“m”（米）、“km”（千米）、“mi”（英里）、“ft”（英尺）。
     *  返回值：两个成员之间的距离值，以指定的单位表示。
     *  示例：GEODIST restaurants “Sushi Dai” “Komoro Soba” km，返回值为 “2.0499”
 *  GEORADIUS：按照给定的经纬度坐标和半径范围查找有序集合中符合条件的元素。
    
     *  语法：GEORADIUS key longitude latitude radius m|km|mi|ft \[WITHCOORD\] \[WITHDIST\] \[ASC|DESC\] \[COUNT count\]
     *  参数：
        
         *  key：必需，要查询的有序集合的键名。
         *  longitude：必需，中心点的经度值，范围为 -180 到 180 度。
         *  latitude：必需，中心点的纬度值，范围为 -90 到 90 度。
         *  radius：必需，半径范围，可以是以下格式之一：m（米）、km（千米）、mi（英里）或 ft（英尺）。
         *  m|km|mi|ft：必需，半径范围的单位，可以是以下四种单位之一：“m”（米）、“km”（千米）、“mi”（英里）、“ft”（英尺）。
         *  WITHCOORD：可选，指示返回结果是否包含元素的经纬度坐标。如果指定了该参数，则结果将包含经纬度坐标，否则不包含经纬度坐标。
         *  WITHDIST：可选，指示返回结果是否包含元素与中心点之间的距离值。如果指定了该参数，则结果将包含距离值，否则不包含距离值。
         *  ASC|DESC：可选，指示返回结果是否按照距离值（从小到大）排序。如果指定了该参数，则结果将按距离值排序，否则默认按有序集合中的顺序返回结果。
         *  COUNT count：可选，指示返回结果的数量限制。如果指定了该参数，则结果将最多包含 count 个元素，否则返回所有符合条件的元素。
     *  返回值：若干个符合条件的元素（根据查询参数而定），每个元素由成员名、经度坐标和纬度坐标组成。如果指定了 WITHDIST 参数，则每个元素还包含距离值。如果指定了 WITHCOORD 参数，则每个元素还包含经纬度坐标。
     *  示例：GEORADIUS restaurants 139.7329 35.6634 5 km WITHCOORD WITHDIST，表示查找以经纬度 (139.7329, 35.6634) 为中心，半径为 5 公里范围内的所有元素，并返回它们与中心点之间的距离值和经纬度坐标。
 *  GEORADIUSBYMEMBER：按照给定的成员名和半径范围查找有序集合中符合条件的元素。
    
     *  语法：GEORADIUSBYMEMBER key member radius m|km|mi|ft \[WITHCOORD\] \[WITHDIST\] \[ASC|DESC\] \[COUNT count\]
     *  参数：
        
         *  key：必需，要查询的有序集合的键名。
         *  member：必需，中心点的成员名。
         *  radius：必需，半径范围，可以是以下格式之一：m（米）、km（千米）、mi（英里）或 ft（英尺）。
         *  m|km|mi|ft：必需，半径范围的单位，可以是以下四种单位之一：“m”（米）、“km”（千米）、“mi”（英里）、“ft”（英尺）。
         *  WITHCOORD：可选，指示返回结果是否包含元素的经纬度坐标。如果指定了该参数，则结果将包含经纬度坐标，否则不包含经纬度坐标。
         *  WITHDIST：可选，指示返回结果是否包含元素与中心点之间的距离值。如果指定了该参数，则结果将包含距离值，否则不包含距离值。
         *  ASC|DESC：可选，指示返回结果是否按照距离值（从小到大）排序。如果指定了该参数，则结果将按距离值排序，否则默认按有序集合中的顺序返回结果。
         *  COUNT count：可选，指示返回结果的数量限制。如果指定了该参数，则结果将最多包含 count 个元素，否则返回所有符合条件的元素。
     *  返回值：若干个符合条件的元素（根据查询参数而定），每个元素由成员名、经度坐标和纬度坐标组成。如果指定了 WITHDIST 参数，则每个元素还包含距离值。如果指定了 WITHCOORD 参数，则每个元素还包含经纬度坐标。
     *  示例：GEORADIUSBYMEMBER restaurants “Sushi Dai” 5 km WITHCOORD WITHDIST，表示查找以成员名 “Sushi Dai” 对应的经纬度为中心，半径为 5 公里范围内的所有元素，并返回它们与中心点之间的距离值和经纬度坐标。
 *  GEOHASH：获取指定成员在有序集合中的 Geohash 值。
    
     *  语法：GEOHASH key member \[member …\]
     *  参数：
        
         *  key：必需，要获取 Geohash 值的有序集合的键名。
         *  member：必需，要获取 Geohash 值的元素的成员名，可以指定多个成员名。
     *  返回值：一个数组，每个元素表示一个成员的 Geohash 值。
     *  示例：GEOHASH restaurants “Sushi Dai” “Komoro Soba”，返回值为 \[“xn7743”,“xn773w”\]
 *  GEOINTERSECTS：检查指定的两个成员之间是否存在任何交集。
    
     *  语法：GEOINTERSECTS key member1 member2
     *  参数：
        
         *  key：必需，要检查交集的有序集合的键名。
         *  member1：必需，第一个成员的名字。
         *  member2：必需，第二个成员的名字。
     *  返回值：一个整数值，如果两个成员之间存在交集，则返回 1，否则返回 0。
     *  示例：GEOINTERSECTS restaurants “Sushi Dai” “Komoro Soba”，如果 “Sushi Dai” 和 “Komoro Soba” 代表的位置之间存在任何交集，则返回 1，否则返回 0。

## 三、实用场景示例 ##

### 1. 找出某一经纬度周围的餐馆 ###

import redis.clients.jedis.GeoRadiusResponse;
    import redis.clients.jedis.GeoUnit;
    import redis.clients.jedis.Jedis;
    
    import java.util.List;
    
    public class RestaurantFinder {
        
        private final static String HOST = "localhost";
        private final static int PORT = 6379;
        private final static int TIMEOUT = 5000;
        private final static String PASSWORD = "";
        
        private static final String KEY_RESTAURANT_LOCATION = "restaurant_location";
    
        private static Jedis jedis = null;
    
        static {
        
            try {
        
                jedis = new Jedis(HOST, PORT, TIMEOUT);
                if (!PASSWORD.isEmpty()) {
        
                    jedis.auth(PASSWORD);
                }
            } catch (Exception e) {
        
                e.printStackTrace();
            }
        }
    
        /**
         * 添加餐馆的经纬度信息
         *
         * @param longitude 经度
         * @param latitude  纬度
         * @param name      餐馆名称
         * @return
         */
        public Long addRestaurant(double longitude, double latitude, String name) {
        
            return jedis.geoadd(KEY_RESTAURANT_LOCATION, longitude, latitude, name);
        }
    
        /**
         * 根据给定的坐标和半径查找周围的餐馆
         *
         * @param longitude 经度
         * @param latitude  纬度
         * @param radius    半径，单位为米
         * @return
         */
        public List<GeoRadiusResponse> findNearbyRestaurants(double longitude, double latitude, double radius) {
        
            return jedis.georadius(KEY_RESTAURANT_LOCATION, longitude, latitude, radius, GeoUnit.M);
        }
    
        /**
         * 测试
         *
         * @param args
         */
        public static void main(String[] args) {
        
            RestaurantFinder finder = new RestaurantFinder();
            finder.addRestaurant(121.451087, 31.228591, "麦当劳");
            finder.addRestaurant(121.454987, 31.227568, "星巴克");
            finder.addRestaurant(121.455831, 31.225719, "肯德基");
    
            List<GeoRadiusResponse> restaurants = finder.findNearbyRestaurants(121.453289, 31.228032, 500);
            for (GeoRadiusResponse restaurant : restaurants) {
        
                System.out.println(restaurant.getMemberByString() + " " + restaurant.getDistance());
            }
        }
    }

### 2. 按照距离排序查询景点 ###

import redis.clients.jedis.GeoRadiusParam;
    import redis.clients.jedis.GeoRadiusResponse;
    import redis.clients.jedis.GeoUnit;
    import redis.clients.jedis.Jedis;
    
    import java.util.List;
    
    public class ScenicSpotFinder {
        
        private final static String HOST = "localhost";
        private final static int PORT = 6379;
        private final static int TIMEOUT = 5000;
        private final static String PASSWORD = "";
    
        private static final String KEY_SPOT_LOCATION = "spot_location";
    
        private static Jedis jedis = null;
    
        static {
        
            try {
        
                jedis = new Jedis(HOST, PORT, TIMEOUT);
                if (!PASSWORD.isEmpty()) {
        
                    jedis.auth(PASSWORD);
                }
            } catch (Exception e) {
        
                e.printStackTrace();
            }
        }
    
        /**
         * 添加景点的经纬度信息
         *
         * @param longitude 经度
         * @param latitude  纬度
         * @param name      景点名称
         * @return
         */
        public Long addScenicSpot(double longitude, double latitude, String name) {
        
            return jedis.geoadd(KEY_SPOT_LOCATION, longitude, latitude, name);
        }
    
        /**
         * 根据给定的坐标和半径查找周围的景点，并按照距离排序
         *
         * @param longitude 经度
         * @param latitude  纬度
         * @param radius    半径，单位为米
         * @return
         */
        public List<GeoRadiusResponse> findNearbyScenicSpots(double longitude, double latitude, double radius) {
        
            GeoRadiusParam geoRadiusParam = GeoRadiusParam.geoRadiusParam().sortAscending();
            return jedis.georadius(KEY_SPOT_LOCATION, longitude, latitude, radius, GeoUnit.M, geoRadiusParam);
        }
    
        /**
         * 测试
         *
         * @param args
         */
        public static void main(String[] args) {
        
            ScenicSpotFinder finder = new ScenicSpotFinder();
            finder.addScenicSpot(121.451087, 31.228591, "东方明珠");
            finder.addScenicSpot(121.454987, 31.227568, "外滩");
            finder.addScenicSpot(121.455831, 31.225719, "人民广场");
    
            List<GeoRadiusResponse> spots = finder.findNearbyScenicSpots(121.453289, 31.228032, 500);
            for (GeoRadiusResponse spot : spots) {
        
                System.out.println(spot.getMemberByString() + " " + spot.getDistance());
            }
        }
    }
    
    ## 3.  根据经纬度计算两点距离
    java复制代码import redis.clients.jedis.GeoUnit;
    import redis.clients.jedis.Jedis;
    
    public class DistanceCalculator {
        
        private final static String HOST = "localhost";
        private final static int PORT = 6379;
        private final static int TIMEOUT = 5000;
        private final static String PASSWORD = "";
    
        private static Jedis jedis = null;
    
        static {
        
            try {
        
                jedis = new Jedis(HOST, PORT, TIMEOUT);
                if (!PASSWORD.isEmpty()) {
        
                    jedis.auth(PASSWORD);
                }
            } catch (Exception e) {
        
                e.printStackTrace();
            }
        }
    
        /**
         * 计算两个经纬度之间的距离
         *
         * @param longitude1 经度1
         * @param latitude1  纬度1
         * @param longitude2 经度2
         * @param latitude2  纬度2
         * @return
         */
        public Double calculateDistance(double longitude1, double latitude1, double longitude2, double latitude2) {
        
            return jedis.geodist("distance", longitude1, latitude1, longitude2, latitude2, GeoUnit.M);
        }
    
        /**
         * 测试
         *
         * @param args
         */
        public static void main(String[] args) {
        
            DistanceCalculator calculator = new DistanceCalculator();
            double distance = calculator.calculateDistance(121.453289, 31.228032, 121.451087, 31.228591);
            System.out.println(distance);
        }
    }

## 四、在实际开发中，需要注意以下几点： ##

*  每个位置都需要一个唯一的标识符。
 *  经度和纬度的值需要使用正确的格式。
 *  半径的单位为米。
 *  Redis 地理位置功能支持多种查询方式，例如矩形查询、关键字查询等，需要根据实际需求进行选择。