GeoHandler (redis-spring-boot-starter-码云(gitee.com))

java.lang.Object
- wiki.xsx.core.handler.GeoHandler

All Implemented Interfaces:

RedisHandler
```
public final class GeoHandler
extends Object
implements RedisHandler
```
地理位置助手

Since:

1.8

Author:

xsx

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`add(String key, Map<String,org.springframework.data.geo.Point> params)` 添加字符串
`Long`	`add(String key, org.springframework.data.geo.Point point, String value)` 添加字符串
`Long`	`addAsObj(String key, Map<Object,org.springframework.data.geo.Point> params)` 添加对象
`Long`	`addAsObj(String key, org.springframework.data.geo.Point point, Object value)` 添加对象
`org.springframework.data.geo.Distance`	`distance(String key, String member1, String member2)` 字符串距离
`org.springframework.data.geo.Distance`	`distance(String key, String member1, String member2, org.springframework.data.geo.Metric metric)` 字符串距离
`org.springframework.data.geo.Distance`	`distanceAsObj(String key, Object member1, Object member2)` 对象距离
`org.springframework.data.geo.Distance`	`distanceAsObj(String key, Object member1, Object member2, org.springframework.data.geo.Metric metric)` 对象距离
`org.springframework.data.redis.core.RedisTemplate<String,Object>`	`getRedisTemplate()` 获取spring redis模板
`org.springframework.data.redis.core.StringRedisTemplate`	`getStringRedisTemplate()` 获取spring string redis模板
`List<String>`	`hash(String key, String... values)` 字符串地理位置哈希码
`List<String>`	`hashAsObj(String key, Object... values)` 对象地理位置哈希码
`List<org.springframework.data.geo.Point>`	`position(String key, String... values)` 定位字符串
`List<org.springframework.data.geo.Point>`	`positionAsObj(String key, Object... values)` 定位对象
`List<String>`	`radius(String key, org.springframework.data.geo.Circle within)` 中心范围内的字符串
`List<String>`	`radius(String key, org.springframework.data.geo.Circle within, org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)` 中心范围内的字符串
`List<Object>`	`radiusAsObj(String key, org.springframework.data.geo.Circle within)` 中心范围内的对象
`List<Object>`	`radiusAsObj(String key, org.springframework.data.geo.Circle within, org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)` 中心范围内的对象
`org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<Object>>`	`radiusAsObjWithResult(String key, org.springframework.data.geo.Circle within)` 中心范围内的对象(带详细信息)
`org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<Object>>`	`radiusAsObjWithResult(String key, org.springframework.data.geo.Circle within, org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)` 中心范围内的对象(带详细信息)
`List<String>`	`radiusByMember(String key, String value, org.springframework.data.geo.Distance distance)` 中心范围内的字符串
`List<String>`	`radiusByMember(String key, String value, org.springframework.data.geo.Distance distance, org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)` 中心范围内的字符串
`List<String>`	`radiusByMember(String key, String value, Double radius)` 中心范围内的字符串
`List<Object>`	`radiusByMemberAsObj(String key, Object value, org.springframework.data.geo.Distance distance)` 中心范围内的对象
`List<Object>`	`radiusByMemberAsObj(String key, Object value, org.springframework.data.geo.Distance distance, org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)` 中心范围内的对象
`List<Object>`	`radiusByMemberAsObj(String key, Object value, Double radius)` 中心范围内的对象
`org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<Object>>`	`radiusByMemberAsObjWithResult(String key, Object value, org.springframework.data.geo.Distance distance, org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)` 中心范围内的对象(带详细信息)
`org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<Object>>`	`radiusByMemberAsObjWithResult(String key, Object value, Double radius)` 中心范围内的对象(带详细信息)
`org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<String>>`	`radiusByMemberWithResult(String key, String value, org.springframework.data.geo.Distance distance)` 中心范围内的字符串(带详细信息)
`org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<String>>`	`radiusByMemberWithResult(String key, String value, org.springframework.data.geo.Distance distance, org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)` 中心范围内的字符串(带详细信息)
`org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<String>>`	`radiusByMemberWithResult(String key, String value, Double radius)` 中心范围内的字符串(带详细信息)
`org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<Object>>`	`radiusByMemberWithResultAsObj(String key, Object value, org.springframework.data.geo.Distance distance)` 中心范围内的对象(带详细信息)
`org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<String>>`	`radiusWithResult(String key, org.springframework.data.geo.Circle within)` 中心范围内的字符串(带详细信息)
`org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<String>>`	`radiusWithResult(String key, org.springframework.data.geo.Circle within, org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)` 中心范围内的字符串(带详细信息)
`Long`	`remove(String key, String... members)` 移除字符串
`Long`	`removeAsObj(String key, Object... members)` 移除对象

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addAsObj

public Long addAsObj(String key,
                     org.springframework.data.geo.Point point,
                     Object value)

添加对象

Parameters:: key - 键; point - 坐标; value - 对象
Returns:: 返回总数
Since:: redis 3.2.0
See Also:: Redis Documentation: GEOADD

add

public Long add(String key,
                org.springframework.data.geo.Point point,
                String value)

添加字符串

Parameters:: key - 键; point - 坐标; value - 字符串
Returns:: 返回总数
Since:: redis 3.2.0
See Also:: Redis Documentation: GEOADD

addAsObj
```
public Long addAsObj(String key,
                     Map<Object,org.springframework.data.geo.Point> params)
```
添加对象

Parameters:

key - 键

params - 参数，键为待添加对象，值为待添加坐标

Returns:

返回总数

Since:

redis 3.2.0

See Also:

Redis Documentation: GEOADD

add
```
public Long add(String key,
                Map<String,org.springframework.data.geo.Point> params)
```
添加字符串

Parameters:

key - 键

params - 参数，键为待添加字符串，值为待添加坐标

Returns:

返回总数

Since:

redis 3.2.0

See Also:

Redis Documentation: GEOADD

positionAsObj

public List<org.springframework.data.geo.Point> positionAsObj(String key,
                                                              Object... values)

定位对象

Parameters:: key - 键; values - 对象
Returns:: 返回坐标列表
Since:: redis 3.2.0
See Also:: Redis Documentation: GEOPOS

position

public List<org.springframework.data.geo.Point> position(String key,
                                                         String... values)

定位字符串

Parameters:: key - 键; values - 字符串
Returns:: 返回坐标列表
Since:: redis 3.2.0
See Also:: Redis Documentation: GEOPOS

hashAsObj
```
public List<String> hashAsObj(String key,
                              Object... values)
```
对象地理位置哈希码

Parameters:

key - 键

values - 对象

Returns:

返回对象地理位置哈希码

Since:

redis 3.2.0

See Also:

Redis Documentation: GEOHASH

hash
```
public List<String> hash(String key,
                         String... values)
```
字符串地理位置哈希码

Parameters:

key - 键

values - 对象

Returns:

返回字符串地理位置哈希码

Since:

redis 3.2.0

See Also:

Redis Documentation: GEOHASH

distanceAsObj

public org.springframework.data.geo.Distance distanceAsObj(String key,
                                                           Object member1,
                                                           Object member2)

对象距离

Parameters:: key - 键; member1 - 对象1; member2 - 对象2
Returns:: 返回对象间的距离
Since:: redis 3.2.0
See Also:: Redis Documentation: GEODIST

distance

public org.springframework.data.geo.Distance distance(String key,
                                                      String member1,
                                                      String member2)

字符串距离

Parameters:: key - 键; member1 - 字符串1; member2 - 字符串2
Returns:: 返回字符串间的距离
Since:: redis 3.2.0
See Also:: Redis Documentation: GEODIST

distanceAsObj

public org.springframework.data.geo.Distance distanceAsObj(String key,
                                                           Object member1,
                                                           Object member2,
                                                           org.springframework.data.geo.Metric metric)

对象距离

Parameters:: key - 键; member1 - 对象1; member2 - 对象2; metric - 单位
Returns:: 返回对象间的距离
Since:: redis 3.2.0
See Also:: Redis Documentation: GEODIST

distance

public org.springframework.data.geo.Distance distance(String key,
                                                      String member1,
                                                      String member2,
                                                      org.springframework.data.geo.Metric metric)

字符串距离

Parameters:: key - 键; member1 - 字符串1; member2 - 字符串2; metric - 单位
Returns:: 返回字符串间的距离
Since:: redis 3.2.0
See Also:: Redis Documentation: GEODIST

radiusByMemberAsObj

public List<Object> radiusByMemberAsObj(String key,
                                        Object value,
                                        org.springframework.data.geo.Distance distance)

中心范围内的对象

Parameters:: key - 键; value - 对象; distance - 距离
Returns:: 返回包含的对象
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusByMember

public List<String> radiusByMember(String key,
                                   String value,
                                   org.springframework.data.geo.Distance distance)

中心范围内的字符串

Parameters:: key - 键; value - 字符串; distance - 距离
Returns:: 返回包含的字符串
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusByMemberAsObj

public List<Object> radiusByMemberAsObj(String key,
                                        Object value,
                                        Double radius)

中心范围内的对象

Parameters:: key - 键; value - 对象; radius - 半径
Returns:: 返回包含的对象
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusByMember

public List<String> radiusByMember(String key,
                                   String value,
                                   Double radius)

中心范围内的字符串

Parameters:: key - 键; value - 字符串; radius - 半径
Returns:: 返回包含的字符串
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusByMemberAsObj

public List<Object> radiusByMemberAsObj(String key,
                                        Object value,
                                        org.springframework.data.geo.Distance distance,
                                        org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)

中心范围内的对象

Parameters:: key - 键; value - 对象; distance - 距离; args - 命令参数
Returns:: 返回包含的对象
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusByMember

public List<String> radiusByMember(String key,
                                   String value,
                                   org.springframework.data.geo.Distance distance,
                                   org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)

中心范围内的字符串

Parameters:: key - 键; value - 字符串; distance - 距离; args - 命令参数
Returns:: 返回包含的字符串
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusAsObj
```
public List<Object> radiusAsObj(String key,
                                org.springframework.data.geo.Circle within)
```
中心范围内的对象

Parameters:

key - 键

within - 圆

Returns:

返回包含的对象

Since:

redis 3.2.0

See Also:

Redis Documentation: GEORADIUS

radius
```
public List<String> radius(String key,
                           org.springframework.data.geo.Circle within)
```
中心范围内的字符串

Parameters:

key - 键

within - 圆

Returns:

返回包含的字符串

Since:

redis 3.2.0

See Also:

Redis Documentation: GEORADIUS

radiusAsObj

public List<Object> radiusAsObj(String key,
                                org.springframework.data.geo.Circle within,
                                org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)

中心范围内的对象

Parameters:: key - 键; within - 圆; args - 命令参数
Returns:: 返回包含的对象
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUS

radius

public List<String> radius(String key,
                           org.springframework.data.geo.Circle within,
                           org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)

中心范围内的字符串

Parameters:: key - 键; within - 圆; args - 命令参数
Returns:: 返回包含的字符串
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUS

radiusByMemberWithResultAsObj

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<Object>> radiusByMemberWithResultAsObj(String key,
                                                                                                                                                             Object value,
                                                                                                                                                             org.springframework.data.geo.Distance distance)

中心范围内的对象(带详细信息)

Parameters:: key - 键; value - 对象; distance - 距离
Returns:: 返回包含的对象
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusByMemberWithResult

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<String>> radiusByMemberWithResult(String key,
                                                                                                                                                        String value,
                                                                                                                                                        org.springframework.data.geo.Distance distance)

中心范围内的字符串(带详细信息)

Parameters:: key - 键; value - 字符串; distance - 距离
Returns:: 返回包含的字符串
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusByMemberAsObjWithResult

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<Object>> radiusByMemberAsObjWithResult(String key,
                                                                                                                                                             Object value,
                                                                                                                                                             Double radius)

中心范围内的对象(带详细信息)

Parameters:: key - 键; value - 对象; radius - 半径
Returns:: 返回包含的对象
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusByMemberWithResult

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<String>> radiusByMemberWithResult(String key,
                                                                                                                                                        String value,
                                                                                                                                                        Double radius)

中心范围内的字符串(带详细信息)

Parameters:: key - 键; value - 字符串; radius - 半径
Returns:: 返回包含的字符串
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusByMemberAsObjWithResult

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<Object>> radiusByMemberAsObjWithResult(String key,
                                                                                                                                                             Object value,
                                                                                                                                                             org.springframework.data.geo.Distance distance,
                                                                                                                                                             org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)

中心范围内的对象(带详细信息)

Parameters:: key - 键; value - 对象; distance - 距离; args - 命令参数
Returns:: 返回包含的对象
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusByMemberWithResult

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<String>> radiusByMemberWithResult(String key,
                                                                                                                                                        String value,
                                                                                                                                                        org.springframework.data.geo.Distance distance,
                                                                                                                                                        org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)

中心范围内的字符串(带详细信息)

Parameters:: key - 键; value - 字符串; distance - 距离; args - 命令参数
Returns:: 返回包含的字符串
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUSBYMEMBER

radiusAsObjWithResult

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<Object>> radiusAsObjWithResult(String key,
                                                                                                                                                     org.springframework.data.geo.Circle within)

中心范围内的对象(带详细信息)

Parameters:: key - 键; within - 圆
Returns:: 返回包含的对象
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUS

radiusWithResult

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<String>> radiusWithResult(String key,
                                                                                                                                                org.springframework.data.geo.Circle within)

中心范围内的字符串(带详细信息)

Parameters:: key - 键; within - 圆
Returns:: 返回包含的字符串
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUS

radiusAsObjWithResult

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<Object>> radiusAsObjWithResult(String key,
                                                                                                                                                     org.springframework.data.geo.Circle within,
                                                                                                                                                     org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)

中心范围内的对象(带详细信息)

Parameters:: key - 键; within - 圆; args - 命令参数
Returns:: 返回包含的对象
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUS

radiusWithResult

public org.springframework.data.geo.GeoResults<org.springframework.data.redis.connection.RedisGeoCommands.GeoLocation<String>> radiusWithResult(String key,
                                                                                                                                                org.springframework.data.geo.Circle within,
                                                                                                                                                org.springframework.data.redis.connection.RedisGeoCommands.GeoRadiusCommandArgs args)

中心范围内的字符串(带详细信息)

Parameters:: key - 键; within - 圆; args - 命令参数
Returns:: 返回包含的字符串
Since:: redis 3.2.0
See Also:: Redis Documentation: GEORADIUS

removeAsObj
```
public Long removeAsObj(String key,
                        Object... members)
```
移除对象

Parameters:

key - 键

members - 对象

Returns:

返回移除数量

Since:

redis 2.4.0

See Also:

Redis Documentation: ZREM

remove
```
public Long remove(String key,
                   String... members)
```
移除字符串

Parameters:

key - 键

members - 字符串

Returns:

返回移除数量

Since:

redis 2.4.0

See Also:

Redis Documentation: ZREM

getRedisTemplate

public org.springframework.data.redis.core.RedisTemplate<String,Object> getRedisTemplate()

获取spring redis模板

Returns:: 返回对象模板

getStringRedisTemplate

public org.springframework.data.redis.core.StringRedisTemplate getStringRedisTemplate()

获取spring string redis模板

Returns:: 返回字符串模板

Class GeoHandler

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addAsObj

add

addAsObj

add

positionAsObj

position

hashAsObj

hash

distanceAsObj

distance

distanceAsObj

distance

radiusByMemberAsObj

radiusByMember

radiusByMemberAsObj

radiusByMember

radiusByMemberAsObj

radiusByMember

radiusAsObj

radius

radiusAsObj

radius

radiusByMemberWithResultAsObj

radiusByMemberWithResult

radiusByMemberAsObjWithResult

radiusByMemberWithResult

radiusByMemberAsObjWithResult

radiusByMemberWithResult

radiusAsObjWithResult

radiusWithResult

radiusAsObjWithResult

radiusWithResult

removeAsObj

remove

getRedisTemplate

getStringRedisTemplate