使用UniApi调用百度地图API的需要注意的地方

目录

前言

一、百度开放平台

1、功能简介

2、地点搜索服务

3、按行政区划检索API

二、Uniapi集成百度API

1、API集成流程

2、访问接口的定义

3、业务调用集成

三、可能遇到的问题

1、指定输出格式无效

2、返回数据的总数

四、总结

前言

        在之前的系列博客中，关于地图在线API我们介绍了天地图、高德开放平台API，当然除了这两个平台还有其它的平台。有朋友发私信留言，希望可以在Uniapi中调用百度开放平台的API的方法和实践方法介绍一下，因为他在亲自动手实践的时候出现了一些状况，然后来交流想看一下是否是哪里的设置有问题。在此之前，对百度地图的API使用的也不多，而且想着都是开放平台，调用方式应该差不多。但是在亲自动手联调的时候，却发现了几个地方不符合预期。

        本文是一篇实践型内容，主要讲解如何在Java中使用uniapi来集成百度地图的开放接口实现POI数据的获取，重点讲解在集成过程中的遇到的几个问题，围绕面向问题来寻找解决方案，叙述如何来解决这些问题，让大家在使用同样的方式进行集成时遇到问题有一些参考。为了让大家对百度地图开放平台API有更深入的了解，博文首先将依然对使用到的百度API接口进行简单的介绍，然后介绍在Uniapi来调用百度地图的API接口，最后针对问题来逐一讲解解决方案。示例将涵盖从API密钥的获取、HTTP请求的发送、数据的解析到最终结果的展示等完整流程。通过本文的学习，开发者将能够掌握Java与百度开放平台WebAPI集成的基本方法，并能够根据实际需求，灵活应用这些技术解决实际问题。通过本文的实践，开发者将能够更好地理解和使用百度开放平台的API，为未来的项目开发打下坚实的基础。

一、百度开放平台

        本节介绍百度开放平台的功能和主要服务，包括地图、定位、导航等API的概述。其次介绍如何在百度平台中申请个人的账号，以及简要介绍对接方法。

1、功能简介

        在之前的系列博客中，我们介绍了天地图的相关WebAPI和高德的开放平台API，基于这两个WebAPI我们可以做一些应用。高德地图和百度地图都是很优秀的地图类产品，这里我们来说说如何从百度平台获取数据。进入到开放平台的首页后可以看到以下界面，这里有很多介绍的文字，大家可以到官网看一下，不再赘述。

         关于百度地图提供的服务接口有很多，这里有一个总的入口可以粗略的看一下：

        与高德地图提供的接口类似，基本的导航服务、规划服务、地图服务都是应有尽有，大家可以尽情的发挥自己的聪明才智来进行功能使用和探索。 

2、地点搜索服务

        地点检索服务（又名Place API）是一类Web API接口服务；服务提供多种场景的地点（POI）检索功能，包括城市检索、圆形区域检索、多边形区域检索。开发者可通过接口获取地点（POI）基础或详细地理信息。注意：地点检索服务适用于【XX大厦】、【XX小区】等POI地点名称的检索;若需要检索结构化地址，如【北京市海淀区上地十街十号】，则推荐使用地理编码服务。

        以地点搜索API为例，地点搜索包含以下几种地点规则，分别市行政区划区域检索，圆形区域检索，多边形检索，地点详情检索，地点输入提示，POI图片获取以及获取POI的营业状态。

3、按行政区划检索API

         为了让大家对百度的开放平台API有更深入的了解，这里将把官网的按行政区划检索POI数据的接口进行重点讲解，希望对大家理解API有所帮助。开发者可通过该功能，检索某一行政区划内（目前最细到城市级别）的地点信息。

        API的服务地址：

https://api.map.baidu.com/place/v2/search?query=ATM机&tag=银行&region=北京&output=json&ak=您的ak
//GET请求

        请求参数

        返回参数

二、Uniapi集成百度API

        本节详细介绍如何在Java中使用Uniapi来集成百度api实现相关的检索服务。主要从以下三个部分进行介绍，第一是介绍API的集成流程；第二是介绍如何在Uniapi中定义接口；第三是介绍如何在业务中进行集成。

1、API集成流程

        在官网中已经详细的说明了如何进行API的注册和集成，按照以下的步骤进行集成即可。

        与所有的开放平台一样，要想在外面调用这些接口来进行token的申请，在下面的应用中可以创建访问token。

2、访问接口的定义

          这里介绍如何在Uniapi中创建访问api，用来跟开放平台进行交互，uniapi的操作比较简单，下面是示例代码：

package com.yelang.project.thridinterface;
import com.burukeyou.uniapi.http.annotation.HttpApi;
import com.burukeyou.uniapi.http.annotation.param.QueryPar;
import com.burukeyou.uniapi.http.annotation.request.GetHttpInterface;
import com.burukeyou.uniapi.http.core.response.HttpResponse;
@HttpApi(url = "https://api.map.baidu.com/place/v2")
public interface BaiduGeoSearchService {
	@GetHttpInterface("/search?")
	public HttpResponse<String> getSearch(@QueryPar("query") String query,@QueryPar("region") String region,@QueryPar("output") String output,@QueryPar("ak") String ak,@QueryPar("page_size") int pageSize,@QueryPar("page_num") int pageNum,@QueryPar("scope") String scope);
}

        请注意，这里的参数跟之前的请求参数有一定的差异，因为我们按照需要传入相应的请求参数即可，不需要传入所有的参数。在上面的例子中，创建了两个一个访问接口。第一个方法是根据关键字和行政区划来调用检索一些感兴趣的空间地理信息。 

3、业务调用集成

         接下来讲解如何在Java当中调用Uniapi定义的接口，根据我们传入的参数来查询目标POI。比如我们需要查询湖南省长沙市的医院（query：医院）的数据，每页数据返回的大小为20条数据。集成的访问代码如下：

package com.yelang.project.unihttp;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import com.burukeyou.uniapi.http.core.response.HttpResponse;
import com.yelang.project.thridinterface.BaiduGeoSearchService;
@SpringBootTest
@RunWith(SpringRunner.class)
public class BaiduGeoUnihttpCase {
	private static final String BAIDU_CLIENT_AK = "百度AK";
	@Autowired
	private BaiduGeoSearchService bdsearchService;
	@Test
	public void testSearch() {
		String query = "医院";
		String region = "长沙市";
		String output = "json";
		HttpResponse<String> result = bdsearchService.getSearch(query, region, output, BAIDU_CLIENT_AK,20,0,"2");
		System.out.println("第一页的数据如下：");
		System.out.println(result.getBodyResult());
	}
}

        完成以上的定义之后，我们就可以来调用相关的接口实现关键字的指定行政区划检索，执行结果如如下图所示：

        细心的朋友一定发了上面红框中的问题 。在代码中我们指定了响应数据的格式为json，但后台返回前端的却不是，那么问题出在哪里呢？下节将进行讲解。

三、可能遇到的问题

        在实际开发过程中，开发者可能会遇到一些常见问题，如API调用频率限制、数据解析错误、网络请求超时等。这里我们讲解两个很容易碰到的问题，第一个就是上面提到过的指定输出格式后，输出依然是Xml格式的问题，另外就是如何获取数据总数，从而进行分页获取数据的问题。

1、指定输出格式无效

        请注意，在前面的代码中我们已经正确的设置了请求接口中的值output，String output = "json";表示输出响应数据格式为json，而不要是xml。如果不是用uniapi的朋友，大家可以去看一下官方提供的实例，也是可以直接运行跑的。官方实例如下：

        请注意在官方提供的示例里，需要访问的接口search后是跟了一个问号的。如果您使用的不是uniapi那么应该是没有问题的。如果使用了uniapi后，一定不要有这个问号，问否输出的值就一直是xml，这个问题曾经让我很迷惑，以为是哪里的值没传过去。 经过事件，在定义时一定不要在search后加？。将问号去掉以后再来看最后的输出，如下所示：

        是不是惊奇的发现output参数生效了，是我们需要的json了，那么将output修改成xml来看看有没有作用？可以直观的看到，这里的响应输出已经改为xml了，说明output参数可以进行精确的控制。

2、返回数据的总数

        在上面的数据中，我们要查询整个长沙市的医院，省会城市的医院数量肯定是超过20条，因为我们设置了默认的参数是20。在返回的响应报文中，包含了数据的总数是130，如下：

"status":0,
"message":"ok",
"total":130,
"result_type":"poi_type",

        如果你的接口返回的数据中没有包含total字段，请先检查在请求接口中是否传入了page_num即当前第几页的参数。没有这个参数，则接口中不会返回total。POI检索总数，开发者请求中设置了page_num字段才会出现total字段。 

四、总结

        以上就是本文的主要内容，本文是一篇实践型内容，主要讲解如何在Java中使用uniapi来集成百度地图的开放接口实现POI数据的获取，重点讲解在集成过程中的遇到的几个问题，围绕面向问题来寻找解决方案，叙述如何来解决这些问题，让大家在使用同样的方式进行集成时遇到问题有一些参考。为了让大家对百度地图开放平台API有更深入的了解，博文首先将依然对使用到的百度API接口进行简单的介绍，然后介绍在Uniapi来调用百度地图的API接口，最后针对问题来逐一讲解解决方案。通过文本，大家不仅掌握了百度地图API接口的相关功能、如何集成百度地图以及使用UniApi的实践过程，希望对大家有所帮助。行文仓促，定有不足之处，欢迎各位朋友在评论区批评指正，不胜感激。