基于 Java 的百度地图路线规划服务开发指南

4、响应参数

二、UniHttp 接口访问集成

这里我们使用 UniHttp 来简化 Http 服务调用。这里仅详细说明如何进行访问接口的创建和本地接口的创建和集成。本节是实际的进行接口调用，并且返回相应的结果实战。

1、访问接口创建

package com.yelang.project.thridinterface;
import com.burukeyou.uniapi.http.annotation.param.QueryPar;
import com.burukeyou.uniapi.http.annotation.request.GetHttpInterface;
import com.burukeyou.uniapi.http.core.response.HttpResponse;
import com.yelang.project.thridinterface.apiprocessor.BaiduHttpApi;

/**
 * - 百度驾车路径规划服务 2.0 版本
 */
@BaiduHttpApi(snMode = false)
public interface BaiduDrivingV2Service {
    @GetHttpInterface(path = "/direction/v2/driving")
    /**
     * - 驾车路线规划
     * @param ak 用户的访问权限
     * @param origin 起点经纬度
     * @param destination 终点经纬度
     * @return
     */
    public HttpResponse<String> getSearch(@QueryPar("ak") String ak, @QueryPar("origin") String origin, @QueryPar("destination") String destination, @QueryPar("coord_type") String coordType, @QueryPar("ret_coordtype") String retCoordtype, @QueryPar("tactics") int tactics, @QueryPar("alternatives") int alternatives, @QueryPar("cartype") int cartype, @QueryPar("speed") float speed, @QueryPar("steps_info") int stepsInfo );
}

以上参数是根据业务的需求进行定义的，除必填的参数以外，很多选填的参数是可以不定义，直接使用默认值即可。

2、本地调用测试

下面我们以从广东省广州市为起点，驾车开往贵州省铜仁市为例，车速选择匀速 100 公里，车型为普通油车、需要返回备选路线、并且返回下发详情的实例进行接口请求。这里我们使用 Junit 的方式进行集成，核心代码如下：

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.common.utils.StringUtils;
import com.yelang.project.thridinterface.BaiduDrivingV2Service;

/**
 * - 百度地图驾车服务测试类
 */
@SpringBootTest
@RunWith(SpringRunner.class)
public class BaiduDrivingV2ServiceCase {
    private static final String BAIDU_CLIENT_AK = "yourak";
    @Autowired
    private BaiduDrivingV2Service drivingService;

    @Test
    public void testDriving() {
        String origin = "23.115102,113.269043";//出发地：广东省广州市
        String destination = "27.728514,109.186249";//目的地：贵州省铜仁市
        String coordType = "wgs84";
        String retCoordtype = "bd09ll";//返回坐标类型
        int tactics = 0;//默认距离最短
        int alternatives = 1;//1 表示返回 1-3 条备选路线
        int cartype = 0;//普通油车
        float speed = 27.78F;//100 千米/小时 ≈ 27.78 米/秒
        int stepsInfo = 1;//下发详情
        HttpResponse<String> result = drivingService.getSearch(BAIDU_CLIENT_AK, origin, destination, coordType, retCoordtype, tactics, alternatives, cartype, speed, stepsInfo);
        System.out.println(result.getBodyResult());
    }
}

3、响应对象初探

在本地 IDE 中运行以上程序后，可以看到以下输出：

在文本编辑器中对返回数据进行 json 格式化后，可以看到如下结构：

这个结构很重要，这个结构是我们下一步进行 Java 对象封装的重要参考资料。

三、响应对象的 Java 封装

通过上一节，我们已经成功的获取到了百度地图开放平台返回的路径规划结果，数据格式是 json，在实际业务中，我们需要使用 Java 来进行数据的持久化或者数据挖掘，因此需要将 json 反序列化成 JavaBean。这里分别介绍响应类图、以及相应的实现，最后基于 GSON 来进行对象转换说明。

1、驾车路线服务响应类图

根据前面的响应参数介绍以及在上一小节的真实响应对象的研究，我们大致对返回对象有了一个初印象。整理成如下类图：

根据业务的需要，为了完整的业务数据还原，这里设计 11 个类来对百度地图的路线规划服务接口返回数据进行接收。

2、响应对象实现

a、公共属性类

公共对象是所有百度公共接口的父类，用来定义响应数据的公共属性，定义如下：

package com.yelang.project.meteorology.domain;
import java.io.Serializable;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;

/**
 * - 百度接口公共 DTO 对象，用于封装通用信息
 */
@NoArgsConstructor
@AllArgsConstructor
@Setter
@Getter
@ToString
public class BdCommonDTO implements Serializable {
    private static final long serialVersionUID = 4985268844473756688L;
    private int status;//状态码 本次 API 访问状态，如果成功返回 0，如果失败返回其他数字。
    private String message;//响应信息 对 status 的中文描述
}

b、驾车路线数据传输类

驾车路线数据传输类封装了规划的路线信息，核心代码如下：

package com.yelang.project.meteorology.domain.baidudto;
import java.io.Serializable;
import com.yelang.project.meteorology.domain.BdCommonDTO;
import lombok.AllArgsConstructor;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;

@NoArgsConstructor
@AllArgsConstructor
@Setter
@Getter
@ToString(callSuper=true)//callSuper=true 表示输出父类属性
@EqualsAndHashCode(callSuper=true)
public class BdDrivingDTO extends BdCommonDTO implements Serializable{
    private static final long serialVersionUID = 5055488530865458258L;
    private Integer type;//默认返回 2，开发者无需关注
    private BdDrivingResultDTO result;
}

c、导航信息类

导航信息类包含了分段信息、方案总数、具体的方案路线信息，核心代码如下：

package com.yelang.project.meteorology.domain.baidudto;
import java.io.Serializable;
import java.util.List;
import com.google.gson.annotations.SerializedName;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;

@NoArgsConstructor
@AllArgsConstructor
@Setter
@Getter
@ToString
public class BdDrivingResultDTO implements Serializable{
    private static final long serialVersionUID = 6407644142297216118L;
    private String restriction;//限行结果提示信息，若无限行路线，则返回空，若无法规避限行，则返回限行提示信息
    private int total;//返回方案的总数
    @SerializedName("navi_restype")
    private String naviRestype;
    @SerializedName("session_id")
    private String sessionId;
    private List<BdDrivingRouteDTO> routes;
    private String holiday;
    @SerializedName("ret_coordtype")
    private String retCoordtype;
    @SerializedName("api_restype")
    private String apiRestype;
}

d、具体路线分段信息类

具体路线分段信息类，封装了路线详情、距离、打车费用预估、预计时间和具体的转折路线列表，核心代码如下：

package com.yelang.project.meteorology.domain.baidudto;
import java.io.Serializable;
import java.util.List;
import com.google.gson.annotations.SerializedName;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;

@NoArgsConstructor
@AllArgsConstructor
@Setter
@Getter
@ToString
public class BdDrivingRouteDTO implements Serializable{
    private static final long serialVersionUID = -2475019111446934340L;
    private BdLocationDTO origin;
    private BdLocationDTO destination;
    private String tag;//方案标签
    private String mrsl;
    @SerializedName("route_md5")
    private String routeMd5;
    @SerializedName("data_version")
    private String dataVersion;
    @SerializedName("traffic_light")
    private int trafficLight;
    private float distance;//距离，单位米
    private int duration;//未来驾车路线耗时，单位：秒
    @SerializedName("taxi_fee")
    private float taxiFee;
    @SerializedName("has_guidance")
    private boolean hasGuidance;
    private List<BdDrivingStepDTO> steps;//路线分段集合
    @SerializedName("restriction_info")
    private BdDrivingRestrictionInfoDTO restrictionInfo;
    @SerializedName("yellow_tip")
    private List<BdDrivingYelloTipDTO> yellowTipList;
    private int toll;//此路线道路收费，单位：元
    @SerializedName("toll_distance")
    private float tollDistance;
    private float score;
    @SerializedName("route_id")
    private String routeId;
}

篇幅有限，如果百度驾车路径规划完整响应类的代码，可以参考上述的结果先自己研究，如有问题，可以就具体的类进行交流。

3、使用 GSON 转换实例

最后我们将百度开放平台返回的 JSON 数据转换成 Java 对象，转换框架这里以 Gson 为例，其它的 json 框架也是可以的。转换代码如下：

Gson gson = new Gson();
if(StringUtils.isNotEmpty(result.getBodyResult())) {
    BdDrivingDTO drivingDTO = gson.fromJson(result.getBodyResult(), BdDrivingDTO.class);
    System.out.println(drivingDTO);
    System.out.println("---------------------------");
    System.out.println(gson.toJson(drivingDTO));
}

运行程序后，可以看到正常的数据输出。后续我们可以基于此和其他应用的结合。

四、常见问题

在百度驾车路线规划服务集成过程中，可能会遇到一些问题。比如我在集成过程中就遇到了关于坐标精度和坐标和格式的问题。导致这个问题的原因主要还是对官网文档不是很熟悉，实践出真知，纸上得来终觉浅，只有经过实战才知道可能会遇到什么问题。

1、坐标顺序问题

众所周知，在地理位置中，经纬度是描述一个点的具体格式。因此我们特别习惯在描述一个点时，使用（经度，纬度）的方式，如：113.269043,23.115102。但是这种方式在实际查询过程中会报以下错误：

解决的办法也比较简单，在百度的位置描述中，将纬度描述在前，即（纬度，经度）即可。

2、坐标格式问题

坐标类型永远是 GIS 应用中绕不开的话题，大家可能都以为通用的 WGS84，在接口的参数定义中，我们可以看到，查询参数的坐标是支持 WGS84 的，但是在返回的坐标中，却没有了这个参数支持。如果在返回参数中设置了 WGS84，大概率是会报错的，如下图所示：

解决办法就是按照文档调整参数设置即可。