PHP:构建 JSON 数据接口的 Web 服务器

Table of Contents

  • 前言
  • 题材和需求分析
    • API
    • JSON 数据
  • 实现
    • 当地服务器出环境:MAMP
    • 后台数据库 MySQL
    • 服务器程序

<a id=”1″></a>前言

于以开发的经过中,涉及网络,常常就待经一些 HTTP
请求于网上获取数据。很多网络服务器(Web server)提供了 URL 类型的
API,通过顾特定的 URL,就会自服务器返回数据,比如:

http://api.openweathermap.org/data/2.5/weather?q=London,uk&appid=b1b15e88fa797225412429c1c50c122a1

于浏览器访问上面这链接,服务器即会见回数据。返回的数据类型有好多种植,如:JSON,XML等。

正文旨在通过一个事例简要介绍这种服务器程序的构建,最终形成一个服务器程序,实现通过
URL 与服务器通信,服务器返回 JSON 格式的数码。

<a id=”2″></a>问题及需求分析

<a id=”21″></a>API

着眼地方的 URL,我们得窥见她好分成两独片。

一如既往凡是主机地址:http://api.openweathermap.org/data/2.5/weather

其次凡参数:q=London,uk&appid=b1b15e88fa797225412429c1c50c122a1

长机地址及参数之间用 ? 隔开。参数又得分成多只单身的参数。在这 URL
中,共含了少于单参数,分别是 qappid,等号后是参数的价值。

咱设举行的凡一个物联网温度传感器的后台服务器,即基于不同之
URL,返回温度数据要储存温度数据。

如我们的 API 如下:

获取最近的一个温度数据 API:
http://localhost:8888/temperature.php?key=lsw&query=get
返回示例(JSON):
成功:{"status":true,"date":"2016-11-17 19:13:09","value":32.63}
失败:{"status”:false,”message”:”*"}
备注:”value” 的数据类型是 double

上传一个温度数据 API:
http://localhost:8888/temperature.php?key=lsw&query=set&value=27.1
返回示例(JSON):
成功:{"status":true,"message":"setting success"}
失败:{"status”:false,”message”:”*"}

URL 中之 temperature.php 就是咱们将编写的网页文件。key 和 query
是鲜单参数,在 query=set 时,还应涵盖 value 参数。返回的数据类型是
JSON,以 status 标志操作是否中标,以及附带有信息或数量。

<a id=”22″></a>JSON 数据

JSON(JavaScript
Object Notation)
是平等种植轻量级的数据交换格式。它基于ECMAScript的一个子集。
JSON采用完全独立于言语的文本格式,但是呢用了看似于C语言家族的习惯(包括C、C++、C#、Java、JavaScript、Perl、Python等)。这些特点使JSON成为美好之数据交换语言。
易于人口读与编制,同时也容易机器解析和转变(一般用来升级网络传输速率)。

JSON 数据是可蕴涵数据类型的,如上面返回示例中之 value 是一个 double
类型的数量。

<a id=”3″></a>实现

<a id=”31″></a>本地服务器出条件:MAMP

MAMP
是藏本地服务器环境之 Mac OS 软件。MAMP 这几乎单首字母代表苹果之 Mac OS
系统上的 Macintosh、Apache、MySQL 和 PHP。在 Windows
系统上吧起相应的开销条件,WAMP。这里因 MAMP 为例进行认证。

MAMP 分免费版及专业版,我们目前止待因此到免费版。安装好后运行,点击
Start Servers
就好运作本地的服务器。默认的本土服务器地址是:http://localhost:8888

当 MAMP 的 Preferences.. -> Web Server -> Document Foot
可以一定及服务器源文件目录。服务器的次序即使保存于这目录里。

<a id=”32″></a>后台数据库 MySQL

为存储数据,服务器需要来一个数据库,并实现与数据库里的通信。首先我们用
MAMP 运行本地的服务器,在打开的领航网页中开拓数据库的军事管制页面。

新建一个叫作也 temperatureData 的数据库,再新建一个数目表
temperature,并累加如下字段:

诸如此类虽做到了数据库的安排,目前只待仓储温度信心,因此才布置这几个条文。

<a id=”33″></a>服务器程序

发生矣数据库,接下去就要写服务器程序了。服务器程序需要做到以下几独片的情:

  1. 连年数据库,与数据库通信,实现数量的读取与仓储。
  2. 落 URL 中之参数,根据不同的参数与参数值执行相应的操作。
  3. 打包要回的信,以 JSON 形式返回。

现实的次序如下,在关键之地方盖注释的方式展开说明。

<?php
    //函数:用于把数据封装为 JSON 格式
    function echoJSON($withStatus,$andMessage){
        $data = array('status' => $withStatus, 'message' => $andMessage);
        $jsonstring = json_encode($data);
        header('Content-Type: application/json');
        echo $jsonstring;
    }
    // 配置数据库
    $user = 'root';
    $password = 'root';
    $db = 'temperatureData';
    $host = 'localhost';
    $port = 8889;
    $link = mysqli_init();
    $success = mysqli_real_connect(
                                   $link,
                                   $host,
                                   $user,
                                   $password,
                                   $db,
                                   $port
                                   );
    $privateKey = "lsw";
    if($success){
    //与数据库连接成功后,获取 URL 中的参数值,根据参数执行相应的程序。如:$_GET["key"] 用于获取 URL 中 "key" 的参数值。
        $key = $_GET["key"];
        if($key == $privateKey){
            $query = $_GET["query"];
            switch ($query){
                case "get":
                    $result = mysqli_query($link,"SELECT * FROM `Temperature`");
                    $row = mysqli_fetch_array($result);

                    $data = array('status' => true, 'date' => $row["Date"], 'value' => (double)$row["Value"]);
                    $jsonstring = json_encode($data);
                    header('Content-Type: application/json');
                    echo $jsonstring;
                    break;
                case "set":
                    $value = $_GET["value"];
                    $valueDouble = (double)$value;
                    if($valueDouble){
                        mysqli_query($link,"DELETE FROM `Temperature` WHERE 1");
                        mysqli_query($link,"INSERT INTO `Temperature`(`Date`, `Value`) VALUES (CURRENT_TIMESTAMP,$valueDouble);");
                        $data = array('status' => true, 'message' => 'setting success');
                        $jsonstring = json_encode($data);
                        header('Content-Type: application/json');
                        echo $jsonstring;
                    }else{
                        echoJSON(false,"invalid value");
                    }
                    break;
                default:
                    echoJSON(false,"unsupported query");
            }
        }else{
            echoJSON(false,"invalid key");
        }
    }else{
        echoJSON(false,"Connect Error: " . mysqli_connect_error());
    }
    // 关闭数据库连接。
    mysqli_close($link);
?>

在服务器目录ECMAScript里新建一个 temperature.php
文件,将上述顺序复制到文件被保存。用 MAMP
运行服务器,下面将检查我们服务器的配备情况。

以浏览器被访问:http://localhost:8888/temperature.php?key=lsw&query=get
就能够获取数据库中之温度信息。如果数据库被还尚无温度信息,则会回到如下结果:

{"status":true,"date":null,"value":0}

于浏览器中显得如下:

整体的次序要圈这里。

有关什么利用这 Web 服务器就物联网温度传感器,请参见:LOT|物联网
温度传感器。

起其它疑窦的语,欢迎在江湖评论区讨论。

屈居自己的Github:LinShiwei (Lin Shiwei) ·
GitHub