百搜论坛
 
收藏文章 楼主
thinkphp5.0极速搭建restful风格接口层(实例解析)
版块:官方动态   类型:普通   作者:柠檬   查看:70   回复:0   获赞:0   时间:2020-06-22 19:31:59
下面由thinkphp框架教程栏目给大家介绍thinkphp5.0极速搭建restful风格接口层实例,希望对需要的朋友有所帮助!

下面是基于ThinkPHP V5.0 RC4框架,以restful风格完成的新闻查询(get)、新闻增加(post)、新闻修改(put)、新闻删除(delete)等server接口层。

1、下载ThinkPHP V5.0 RC4版本;

2、配置虚拟域名(非必须,只是为了方便);

Apache\conf\extra\httpd-vhosts.conf

1

2

3

4

5

6

7

8

9

10

<VirtualHost *:80>

    DocumentRoot "D:/webroot/tp5/public"

    ServerName www.tp5-restful.com

    <Directory "D:/webroot/tp5/public">

    DirectoryIndex index.html index.php

    AllowOverride All

    Order deny,allow

    Allow from all

    </Directory>

</VirtualHost>

3、开启伪静态支持.htaccess文件

apache方法:

a)在conf目录下httpd.conf中找到下面这行并去掉#

1

LoadModule rewrite_module modules/mod_rewrite.so

b)将所有AllowOverride None改成AllowOverride All

public\.htaccess文件内容:

1

2

3

4

5

6

7

8

<IfModule mod_rewrite.c>

Options +FollowSymlinks -Multiviews

RewriteEngine on

 

RewriteCond %{REQUEST_FILENAME} !-d

RewriteCond %{REQUEST_FILENAME} !-f

RewriteRule ^(.*)$ index.php [L,E=PATH_INFO:$1]

</IfModule>

4、创建测试数据
tprestful.sql

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

--

-- 数据库: `tprestful`

--

 

-- --------------------------------------------------------

 

--

-- 表的结构 `news`

--

 

CREATE TABLE IF NOT EXISTS `news` (

  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,

  `title` varchar(255) NOT NULL,

  `content` text NOT NULL,

  PRIMARY KEY (`id`)

) ENGINE=MyISAM  DEFAULT CHARSET=utf8 COMMENT='新闻表' AUTO_INCREMENT=1;

 

--

-- 转存表中的数据 `news`

--

 

INSERT INTO `news` (`id`, `title`, `content`) VALUES

(1, '新闻1', '新闻1内容'),

(2, '新闻2', '新闻2内容'),

(3, '新闻3', '新闻3内容'),

(4, '房价又涨了', '据新华社消息:上海均价环比上涨5%');

5、修改数据库配置文件
application\database.php

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

<?php

return [

    // 数据库类型

    'type'           => 'mysql',

    // 服务器地址

    'hostname'       => '127.0.0.1',

    // 数据库名

    'database'       => 'tprestful',

    // 用户名

    'username'       => 'root',

    // 密码

    'password'       => '123456',

    // 端口

    'hostport'       => '',

    // 连接dsn

    'dsn'            => '',

    // 数据库连接参数

    'params'         => [],

    // 数据库编码默认采用utf8

    'charset'        => 'utf8',

    // 数据库表前缀

    'prefix'         => '',

    // 数据库调试模式

    'debug'          => true,

    // 数据库部署方式:0 集中式(单一服务器),1 分布式(主从服务器)

    'deploy'         => 0,

    // 数据库读写是否分离 主从式有效

    'rw_separate'    => false,

    // 读写分离后 主服务器数量

    'master_num'     => 1,

    // 指定从服务器序号

    'slave_no'       => '',

    // 是否严格检查字段是否存在

    'fields_strict'  => true,

    // 数据集返回类型 array 数组 collection Collection对象

    'resultset_type' => 'array',

    // 是否自动写入时间戳字段

    'auto_timestamp' => false,

    // 是否需要进行SQL性能分析

    'sql_explain'    => false,

];

6、定义restful风格的路由规则,
application\route.php

1

2

3

4

5

6

7

8

9

10

<?php

use think\Route;

Route::get('/',function(){

    return 'Hello,world!';

});

Route::get('news/:id','index/News/read');   //查询

Route::post('news','index/News/add');       //新增

Route::put('news/:id','index/News/update'); //修改

Route::delete('news/:id','index/News/delete'); //删除

//Route::any('new/:id','News/read');        // 所有请求都支持的路由规则

7、新建模型
application\index\model\News.php

1

2

3

4

5

6

7

<?php

namespace app\index\model;

use think\Model;

class News extends Model{

    protected $pk = 'id';

    //protected static $table = 'news';

}

8、新建控制器
application\index\controller\News.php

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

<?php

namespace app\index\controller;

use think\Request;

use think\controller\Rest;

 

class News extends Rest{

    public function rest(){

        switch ($this->method){

            case 'get':     //查询

                $this->read($id);

                break;

            case 'post':    //新增

                $this->add();

                break;

            case 'put':     //修改

                $this->update($id);

                break;

            case 'delete':  //删除

                $this->delete($id);

                break;

             

        }

    }

    public function read($id){

        $model = model('News');

        //$data = $model::get($id)->getData();

        //$model = new NewsModel();

        $data=$model->where('id', $id)->find();// 查询单个数据

        return json($data);

    }

     

    public function add(){

        $model = model('News');

        $param=Request::instance()->param();//获取当前请求的所有变量(经过过滤)

        if($model->save($param)){

            return json(["status"=>1]);

        }else{

            return json(["status"=>0]);

        }

    }

    public function update($id){

        $model = model('News');

        $param=Request::instance()->param();

        if($model->where("id",$id)->update($param)){

            return json(["status"=>1]);

        }else{

            return json(["status"=>0]);

        }

    }

    public function delete($id){

         

        $model = model('News');

        $rs=$model::get($id)->delete();

        if($rs){

            return json(["status"=>1]);

        }else{

            return json(["status"=>0]);

        }

    }

}

9、测试
a)、访问入口文件,默认在public\index.php

b)、客户端测试restful的get、post、put、delete方法

client\client.php 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

<?php

require_once './ApiClient.php';

 

$param = array(

  'title' => '房价又涨了',

  'content' => '据新华社消息:上海均价环比上涨5%'

);

$api_url = 'http://www.tp5-restful.com/news/4';

$rest = new restClient($api_url, $param, 'get');

$info = $rest->doRequest();

//$status = $rest->status;//获取curl中的状态信息

 

 

$api_url = 'http://www.tp5-restful.com/news';

$rest = new restClient($api_url, $param, 'post');

$info = $rest->doRequest();

 

$api_url = 'http://www.tp5-restful.com/news/4';

$rest = new restClient($api_url, $param, 'put');

$info = $rest->doRequest();

 

echo '<pre/>';

print_r($info);exit;

 

$api_url = 'http://www.tp5-restful.com/news/4';

$rest = new restClient($api_url, $param, 'delete');

$info = $rest->doRequest();

?>

请求工具类
client\ApiClient.php

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

<?php

class restClient

{

  //请求的token

  const token='yangyulong';

   

  //请求url

  private $url;

     

  //请求的类型

  private $requestType;

     

  //请求的数据

  private $data;

     

  //curl实例

  private $curl;

   

  public $status;

   

  private $headers = array();

  /**

   * [__construct 构造方法, 初始化数据]

   * @param [type] $url     请求的服务器地址

   * @param [type] $requestType 发送请求的方法

   * @param [type] $data    发送的数据

   * @param integer $url_model  路由请求方式

   */

  public function __construct($url, $data = array(), $requestType = 'get') {

       

    //url是必须要传的,并且是符合PATHINFO模式的路径

    if (!$url) {

      return false;

    }

    $this->requestType = strtolower($requestType);

    $paramUrl = '';

    // PATHINFO模式

    if (!empty($data)) {

      foreach ($data as $key => $value) {

        $paramUrl.= $key . '=' . $value.'&';

      }

      $url = $url .'?'. $paramUrl;

    }

       

    //初始化类中的数据

    $this->url = $url;

       

    $this->data = $data;

    try{

      if(!$this->curl = curl_init()){

        throw new Exception('curl初始化错误:');

      };

    }catch (Exception $e){

      echo '<pre>';

      print_r($e->getMessage());

      echo '</pre>';

    }

   

    curl_setopt($this->curl, CURLOPT_URL, $this->url);

    curl_setopt($this->curl, CURLOPT_RETURNTRANSFER, 1);

    //curl_setopt($this->curl, CURLOPT_HEADER, 1);

  }

     

  /**

   * [_post 设置get请求的参数]

   * @return [type] [description]

   */

  public function _get() {

   

  }

     

  /**

   * [_post 设置post请求的参数]

   * post 新增资源

   * @return [type] [description]

   */

  public function _post() {

   

    curl_setopt($this->curl, CURLOPT_POST, 1);

   

    curl_setopt($this->curl, CURLOPT_POSTFIELDS, $this->data);

       

  }

     

  /**

   * [_put 设置put请求]

   * put 更新资源

   * @return [type] [description]

   */

  public function _put() {

       

    curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'PUT');

  }

     

  /**

   * [_delete 删除资源]

   * delete 删除资源

   * @return [type] [description]

   */

  public function _delete() {

    curl_setopt($this->curl, CURLOPT_CUSTOMREQUEST, 'DELETE');

   

  }

     

  /**

   * [doRequest 执行发送请求]

   * @return [type] [description]

   */

  public function doRequest() {

    //发送给服务端验证信息

    if((null !== self::token) && self::token){

      $this->headers = array(

        'Client-Token:'.self::token,//此处不能用下划线

        'Client-Code:'.$this->setAuthorization()

      );

    }

     

    //发送头部信息

    $this->setHeader();

   

    //发送请求方式

    switch ($this->requestType) {

      case 'post':

        $this->_post();

        break;

   

      case 'put':

        $this->_put();

        break;

   

      case 'delete':

        $this->_delete();

        break;

   

      default