违法数据定制开发_客户端使用说明.docxVIP

客户端使用说明2018 客户端使用说明 2018 Date 日期 Revision Version 修订版本 Sec No.章节 Change Description 修改描述 Author 作者 2018-06-08 V1.0 初稿完成 刘笑宇  目录 TOC \o 1-3 \h \z \u 1、通讯规则 2 2、客户端使用方法 2 2.1、获得app的调用信息 2 2.2、导入相应的类库： 2 2.3、实现接口RealtimeVehicleListener 3 2.4、具体使用方法： 3 2.4.1实时数据获取方法： 4 2.4.2历史数据查询 4 1、通讯规则 本文档协议基于TCP/IP通信方式，采用B/S交互模型，由中心服务器充当B/S之服务器角色，侦听指定的TCP端口，接收来第三方平台的连接请求和数据请求。 第三方平台作为客户端，主动向接入服务器请求并建立HTTP或HTTPS连接,具体情况以中心服务器部署方式为准。 登录接入信息appKey和appSecret由中心服务平台提供，客户端需要事先将ip报给中心。 本文档使用自定义协议，协议采用标准JSON格式,字符集：UTF-8。 为了减少传输的数据，数据传输进行了压缩。 车牌的号码通过MD5进行脱敏处理。 2、客户端使用方法 2.1、获得app的调用信息 先向中心申请调用卡口过车信息服务接口，中心会分配相应的AppKey和AppSecret，以及服务部署地址的URL。同时，需要将调用服务的客户端ip报给中心。 2.2、导入相应的类库： 用java建一个工程，导入vehicleclient.jar到目标工程，将demo中类库全部导入到目标工程。具体类库如下图： 2.3、实现接口RealtimeVehicleListener 用java开发一个现实接口RealtimeVehicleListener接口处理实时的卡口过车信息的类，该方法不要阻塞，应尽快返回，以免影响实时信息的接收。返回数据JSONArray，有多条数据多则几千条，根据实际情况不同条数不等。 每条数据示例和说明如下。 //kakou_no:卡口编号，pass_time:过车时间(yyyy-MM-dd HH:mm:ss), brand_color:号牌颜色(0白色;1黄色;2蓝色;3黑色;4其它颜色),car_color:车辆颜色(A白;B灰;C黄;D粉;E红;F紫;G绿;H蓝;I棕;J黑;K橙;L青;M银;N银白;Z其他)，speed:速度(km/h)，car:车牌号码(MD32 小写)，location：通过地点（目前为空“”），camera：抓包方向（目前为“”），brand:车辆品牌，plate_prefix:号牌前两位(目前为“”)，direction：行驶方向(1东向西;2西向东;3南向北;4北向南;5东南向西北;6西北向东南;7东北向西南;8西南向东北)，status：车辆状态，plate_confidence:号牌一致 // 每条数据示例： {kakou_no:320594000000052105,pass_time:2018-06-28 00:03:12,brand_color:1, car_color:Z, speed:26, car:ddbd47c66764fc3ed0d6639d734fca9b,location:,camera:,brand:,lane:2,plate_prefix:,direction:2,status:0,plate_confidence:0} 2.4、具体使用方法： 调用方法，从中心拿到appKey、appSecret和服务url，根据这几个参数创建一个Puller对象。Puller对象会自动将服务端实时数据拉取过来。下面是具体使用方法的演示： String appKey = test1; String appSecret = abc321; int pageSize = 2000; boolean realtime = false; //是否需要获取实时数据 // 创建一个拉取对象，原则上一个appkey只能创建一个实时信息的拉取对象，如果创建多个获取实时数据对象时，客户端可能会出现数据不全的问题 // 参数说明 appkey,appSecret,TestListener // 自己根据业务需要实现自己listener,回调方法不要阻塞，要尽快返回，