http查询

1 概述

1.1 版本

1.2 功能简介

在复杂的多应用系统环境下的数据分析，考虑到系统间的数据安全，除了直接连接业务数据库进行数据查询外，往往需要通过调用外部系统已提供的http/https的数据接口为报表提供数据来源。而外部系统提供的接口规范不尽相同，乐创者支持通过接口数据方式，对来源自不同外部系统调用接口进行适配。

2 实例

我们以“城市天气预报”为例，通过“接口数据”调用某城市的实时天气数据，进行数据展示。
运行效果如下图：

3 制作过程

3.1 http查询

实例制作的第一步就是进入数据模型管理界面创建接口数据“http查询”，调用第三方提供的外部接口。
点击全局“+”或某目录的“+”选择新建模型“http查询”，创建一个http查询接口数据，为报表的制作提供数据源。

创建http查询接口数据时，需要进行“请求”和“返回”的配置。

1、请求
主要根据访问的接口配置请求方式、访问地址以及相关的参数。其中，请求方式分为两种：GET和POST，根据请求接口允许访问的方式进行配置。
1）GET和POST的公共配置：

• 地址
  格式要求：“http（s）://${域名}/${接口路径}”
  既然是http发出的请求，所以肯定是一个URL，用域名和接口路径来确定一个具体的接口。
• 字符集编码
  默认是UTF-8，支持选择UTF-8、GBK、GB2312，也可以手工填写。
• 请求头
  请求头包含许多有关的客户端环境和请求正文的有用信息。例如，请求头可以声明浏览器所用的语言，请求正文的长度等。
  2）GET的个性化配置
• 请求参数
  “GET”的请求参数设置位置有两种：一种是在地址中定义；一种是在请求参数中以“key-value”的方式定义。
  3）POST的个性化配置
• 请求体
  请求体支持三种方式：none、x-www-form-urlencoded和raw。
  
  x-www-form-urlencoded：以“key-value”的方式传参。
  
  raw：可以上传任意类型的文本，比如TEXT、JSON、XML等，以请求体的方式传参。
  
  实例中接口请求方式两种都支持，所以配置任何一种方式都可以。
  以“GET”请求为例，请求时需要传递一个参数“cityCode”,分页查询数据还需呀传递分页相关参数。
  配置如下图：
  
  请求参数也可以定义在地址中，但是一般不建议，如果参数中含特殊字符，可能会导致接口无法正常调用。

2、返回
主要根据请求接口返回的数据配置对应的数据类型和取数规则，并配置输出字段。
返回的数据类型包括：XML、JSON，依据调用接口返回数据的类型进行配置。

在进行“返回”相关配置之前，我们先来看一下“天气预报”实时的原始数据：

{
    "weatherinfo": {
        "city": "北京",
        "cityid": "101010100",
        "temp": "27.9",
        "WD": "南风",
        "WS": "小于3级",
        "SD": "28%",
        "AP": "1002hPa",
        "njd": "暂无实况",
        "WSE": "<3",
        "time": "17:55",
        "sm": "2.1",
        "isRadar": "1",
        "Radar": "JC_RADAR_AZ9010_JB"
    }
}

从原始数据中，可以看出，返回的数据类型为“JSON”，而且可以得知相关数据的取数节点名称，那么，接下来我们就可以进行“返回”的取数设置了，配置结果如下图：

JSON取数规则的说明：

取数规则配置好之后，就可以配置“输出字段”了，点击“获取字段”弹出设置界面如下图：

点击“接口执行”，因为“请求”中设置了自定义参数，所以需要先设置参数值，如下图：

参数设置完成后即可将获取接口数据中的字段信息，选择实例中需要使用的字段确定即可，选择的字段将作为输出字段使用，如下图：

我们可以对输出字段进行增删改操作，其中路径名称中的节点之间规定以“.”分隔。
到此，实例中的http接口数据就准备完成了，点击“运行”输入城市名称就可以查询该城市实时的“天气预报”数据了。数据如下图：

3.2 制作报表

新建一个普通报表，只需简单的三步即可完成报表的制作。
第一步：将创建好的http查询接口数据添加到数据源中，此处会显示我们创建时定义的参数，如下图：

第二步：进行报表制作，将需要展示的信息拖入报表页面：

第三步：最后调整样式，制作控件联动，最终效果：

到此，“天气预报”报表就完成了，执行报表时输入城市名称，即可查看对应城市近一周的天气温度变化。

4 总结

1）“GET”请求和“POST”请求主要的区别就是传参方式不同；
2）返回的数据类型支持包括：TXT、CSV、Excel、XML、JSON；
3）“POST”请求的请求体支持的类型包括：none、x-www-form-urlencoded和raw；
4）“GET”请求的参数最好在“请求参数”中设置。