示例中心
功能在线体验
控制台
您现在的位置: 开发 > iOS 定位SDK > 开发指南 > 辅助功能 > 地理围栏 >

高德 开发 iOS 定位SDK 开发指南 辅助功能 地理围栏

更新时间:2018年08月13日

以下内容自 iOS 定位SDK V2.3.0 后支持。

第 1 步,引入头文件

在调用地理围栏功能的类中引入AMapFoundationKit.h和AMapLocationKit.h这两个头文件,注意Swift需要在桥接文件中引入头文件:

#import <AMapFoundationKit/AMapFoundationKit.h>

#import <AMapLocationKit/AMapLocationKit.h>
//在桥接文件中引入头文件
#import <AMapFoundationKit/AMapFoundationKit.h>

#import <AMapLocationKit/AMapLocationKit.h>

第 2 步,配置Key

在调用定位时,需要添加Key,需要注意的是请在 SDK 任何类的初始化以及方法调用之前设置正确的 Key。

如果您使用的是定位SDK v2.x版本需要引入基础 SDK AMapLocationKit.framework ,设置apiKey的方式如下:

iOS 定位SDK v2.x版本设置 Key:

[AMapServices sharedServices].apiKey =@"您的key";
AMapServices.shared().apiKey = "您的key"

第 3 步:创建地理围栏

地理围栏没有最大个数限制,您可以无限制的创建围栏。但请您根据业务需求合理的创建围栏,控制围栏个数可以有效的保证程序执行效率。定位 SDK 提供根据高德POI、行政区划,自定义圆形、自定义多边形四种方式创建地理围栏。

1、初始化地理围栏管理manager

self.geoFenceManager = [[AMapGeoFenceManager alloc] init];
self.geoFenceManager.delegate = self; 
self.geoFenceManager.activeAction = AMapGeoFenceActiveActionInside | AMapGeoFenceActiveActionOutside | AMapGeoFenceActiveActionStayed; //设置希望侦测的围栏触发行为,默认是侦测用户进入围栏的行为,即AMapGeoFenceActiveActionInside,这边设置为进入,离开,停留(在围栏内10分钟以上),都触发回调
self.geoFenceManager.allowsBackgroundLocationUpdates = YES;  //允许后台定位
self.geoFenceManager = AMapGeoFenceManager()
self.geoFenceManager.delegate = self
self.geoFenceManager.activeAction = [AMapGeoFenceActiveAction.inside , AMapGeoFenceActiveAction.outside , AMapGeoFenceActiveAction.stayed ]//进入,离开,停留都要进行通知
self.geoFenceManager.allowsBackgroundLocationUpdates = true  //允许后台定位

2、创建高德POI地理围栏

提供两个创建高德POI围栏的接口,一个是根据关键字创建POI围栏,另一个是根据经纬度进行周边搜索创建POI围栏。

根据关键字创建围栏:

- (void)addKeywordPOIRegionForMonitoringWithKeyword:(NSString *)keyword POIType:(NSString *)type city:(NSString *)city size:(NSInteger)size customID:(NSString *)customID;

参数说明

参数

说明

示例

keyword

POI关键字

北京大学

type

POI类型

高等院校

city

POI所在的城市名称

北京

customID

与围栏关联的自有业务ID


示例代码

[self.geoFenceManager addKeywordPOIRegionForMonitoringWithKeyword:@"北京大学" POIType:@"高等院校" city:@"北京" size:20 customID:@"poi_1"];
self.geoFenceManager.addKeywordPOIRegionForMonitoring(withKeyword: "北京大学", poiType: "高等院校", city: "北京", size: 20, customID: "poi_1")

根据周边POI创建围栏:

- (void)addAroundPOIRegionForMonitoringWithLocationPoint:(CLLocationCoordinate2D)locationPoint aroundRadius:(NSInteger)aroundRadius keyword:(NSString *)keyword POIType:(NSString *)type size:(NSInteger)size customID:(NSString *)customID;

参数说明

参数

说明

示例

locationPoint

周边区域中心点的经纬度,以此中心点建立周边地理围栏

(39.908692, 116.397477)

aroundRadius

周边半径,0-50000米,默认为3000米,这个是搜索半径,不是建立的围栏的半径


keyword

POI关键字

肯德基

type

POI类型

050301

customID

与围栏关联的自有业务ID


示例代码

CLLocationCoordinate2D coordinate = CLLocationCoordinate2DMake(39.908692, 116.397477); //天安门
[self.geoFenceManager addAroundPOIRegionForMonitoringWithLocationPoint:coordinate aroundRadius:10000 keyword:@"肯德基" POIType:@"050301" size:20 customID:@"poi_2"];
let coordinate = CLLocationCoordinate2DMake(39.908692, 116.397477) //天安门
self.geoFenceManager.addAroundPOIRegionForMonitoring(withLocationPoint: coordinate, aroundRadius: 10000, keyword: "肯德基", poiType: "050301", size: 20, customID: "poi_2")

3、创建行政区域围栏

根据行政区域关键字创建行政区域围栏:

- (void)addDistrictRegionForMonitoringWithDistrictName:(NSString *)districtName customID:(NSString *)customID;

参数说明

参数

说明

示例

districtName

行政区域关键字

海淀区

customID

与围栏关联的自有业务ID


示例代码

[self.geoFenceManager addDistrictRegionForMonitoringWithDistrictName:@"海淀区" customID:@"district_1"];
self.geoFenceManager.addDistrictRegionForMonitoring(withDistrictName: "海淀区", customID: "district_1")

4、创建自定义圆形围栏

需要提供中心点和半径来创建圆形围栏,一次创建一个

- (void)addCircleRegionForMonitoringWithCenter:(CLLocationCoordinate2D)center radius:(CLLocationDistance)radius customID:(NSString *)customID;

参数说明

参数

说明

示例

center

围栏中心点的经纬度


radius

要创建的围栏的半径,半径大于0,单位米


customID

与围栏关联的自有业务ID


示例代码

CLLocationCoordinate2D coordinate = CLLocationCoordinate2DMake(39.908692, 116.397477); //天安门
[self.geoFenceManager addCircleRegionForMonitoringWithCenter:coordinate radius:300 customID:@"circle_1"];
let coordinate = CLLocationCoordinate2DMake(39.908692, 116.397477) //天安门
self.geoFenceManager.addCircleRegionForMonitoring(withCenter: coordinate, radius: 300, customID: "circle_1")

5、创建自定义多边形围栏

根据经纬度坐标数据添加一个闭合的多边形围栏,点与点之间按顺序尾部相连, 第一个点与最后一个点相连,一次创建一个

- (void)addPolygonRegionForMonitoringWithCoordinates:(CLLocationCoordinate2D *)coordinates count:(NSInteger)count customID:(NSString *)customID;

参数说明

参数

说明

示例

coordinates

经纬度坐标点数据,coordinates对应的内存会拷贝,调用者负责该内存的释放,最少3个点


count

coordinates对应的个数


customID

与围栏关联的自有业务ID


示例代码

NSInteger count = 4;
CLLocationCoordinate2D *coorArr = malloc(sizeof(CLLocationCoordinate2D) * count);
coorArr[0] = CLLocationCoordinate2DMake(39.933921, 116.372927);     //平安里地铁站
coorArr[1] = CLLocationCoordinate2DMake(39.907261, 116.376532);     //西单地铁站
coorArr[2] = CLLocationCoordinate2DMake(39.900611, 116.418161);     //崇文门地铁站
coorArr[3] = CLLocationCoordinate2DMake(39.941949, 116.435497);     //东直门地铁站
[self.geoFenceManager addPolygonRegionForMonitoringWithCoordinates:coorArr count:count customID:@"polygon_1"];
    
free(coorArr);
coorArr = NULL;
var coordinates: [CLLocationCoordinate2D] = [
    CLLocationCoordinate2D(latitude: 39.933921, longitude: 116.372927),
    CLLocationCoordinate2D(latitude: 39.907261, longitude: 116.376532),
    CLLocationCoordinate2D(latitude: 39.900611, longitude: 116.418161),
    CLLocationCoordinate2D(latitude: 39.941949, longitude: 116.435497)]
self.geoFenceManager.addPolygonRegionForMonitoring(withCoordinates: &coordinates, count: 4, customID: "polygon_1")

第 4 步,开始定位

当围栏创建完毕,且围栏创建成功时会启动定位,这部分无需您来设置,SDK内部执行。 定位机制:通过“远离围栏时逐渐降低定位频率”来降低电量消耗,“离近围栏时逐渐提高定位频率”来保证有足够的定位精度从而完成围栏位置检测。

需要注意,在iOS9及之后版本的系统中,如果您希望程序在后台持续检测围栏触发行为,需要保证manager的allowsBackgroundLocationUpdates为YES,设置为YES的时候必须保证 Background Modes 中的 Location updates 处于选中状态,否则会抛出异常。

第 5 步,获取围栏创建后的回调和围栏状态改变时的回调

创建围栏后的信息和围栏状态改变时的信息均会通过AMapGeoFenceManagerDelegate进行回调,设置内容如下:

self.geoFenceManager.delegate = self;
self.geoFenceManager.delegate = self

1、获取围栏创建后的回调

在如下回调中知道创建的围栏是否成功,以及查看所创建围栏的具体内容。

- (void)amapGeoFenceManager:(AMapGeoFenceManager *)manager didAddRegionForMonitoringFinished:(NSArray<AMapGeoFenceRegion *> *)regions customID:(NSString *)customID error:(NSError *)error {
    if (error) {
        NSLog(@"创建失败 %@",error);
    } else {
        NSLog(@"创建成功");
    }
}
func amapGeoFenceManager(_ manager: AMapGeoFenceManager!, didAddRegionForMonitoringFinished regions: [AMapGeoFenceRegion]!, customID: String!, error: Error!) {
	if let error = error {
        let error = error as NSError
        NSLog("创建失败 %@",error);
    }
    else {
        NSLog("创建成功")
    }
}

2、围栏状态改变时的回调

在如下回调中知道围栏的状态是否发生改变,或者定位是否失败。围栏的状态表示的就是用户和围栏的关系,有未知、进入围栏、退出围栏、在围栏内停留。回调触发的条件需同时满足:1.围栏的状态从A变成B;2.B符合您在第一步设置的需要侦测的行为的范围内。当然如果self.geoFenceManager.activeAction在监听的过程中改变了,所有符合侦测范围的围栏即使状态没有改变也会再次触发回调。

- (void)amapGeoFenceManager:(AMapGeoFenceManager *)manager didGeoFencesStatusChangedForRegion:(AMapGeoFenceRegion *)region customID:(NSString *)customID error:(NSError *)error {
    if (error) {
        NSLog(@"status changed error %@",error);
    }else{
        NSLog(@"status changed success %@",[region description]);
    }
}
func amapGeoFenceManager(_ manager: AMapGeoFenceManager!, didGeoFencesStatusChangedFor region: AMapGeoFenceRegion!, customID: String!, error: Error!) {
    if error == nil {
        print("status changed \(region.description)")
    } else {
        print("status changed error \(error)")
    }
}

最后,移除围栏

当不再需要使用围栏时,可以调用以下几个函数对已经设定的围栏进行移除操作。

- (void)removeTheGeoFenceRegion:(AMapGeoFenceRegion *)region; //移除指定围栏
- (void)removeGeoFenceRegionsWithCustomID:(NSString *)customID; //移除指定customID的围栏
- (void)removeAllGeoFenceRegions;  //移除所有围栏
示例中心 功能
在线体验
常见问题