TARS-HTTP-SERVER的说明

依赖环境

运行本框架需要phptars扩展, phalcon扩展.

目录结构说明

1. scripts 存储业务所需要的脚本,如tars2php.sh 负责的就是根据tars文件,生成客户端所需要的代码

2. src 业务逻辑所在的目录,主要包含以下结构:

• component: 存储Controller的基础类,方便所有的Controller公用
• conf: 业务需要的配置, 这里只是给出一个demo,如果从平台下发配置,默认也会写入到这个文件夹中;
• controller: MVC模型中的C层;
• database: 数据库连接配置.
• libs: 存储公用类库, server/model扩展类库, 插件工具类
• models: 存储库表对应的model文件.
• servant: 使用tars2php生成的client端的代码, 这个目录名称完全可以自定义,只需要在使用的时候加以区分就可以了;
• services: 存储业务实现类
• tasks: 命令行方式执行业务services, 可以方便业务代码调试, 也可以做crontable定时任务
• composer.json: 说明项目的依赖情况
• index.php: 整个服务的入口文件,这个文件名称可以自定义,但是必须要更改平台上的私有模板,增加entrance这个字段在server下面
• services.php: 声明整个项目的基础namespaceName

3. tars 这个tcp服务所依赖的就是这个文件夹下面的example.tars文件 而tars.client.proto.php文件,则是生成servant下代码所必须的,这个会在下面的guideline中具体说明。

服务部署guideline

1. 进入运维管理=> 模板管理 平台会提供一份新的针对php的模板,命名为tars.tarsphp.default.

!!!!!!!必须首先修改其中php的执行路径!!!!!!!

其次有两种方式保证http-server使用正确的模板:

• 自己新建一个tars.tarsphp.http,里面添加如下内容:

<tars>
 <application>
...
    <client>
...
   </client>
   <server>
     ...
      protocolName=http
    </server>
 </application>
</tars>

只需要在里面添加:

  protocolName=http

即可。

• 第二种方式是在私有模板里面添加这部分内容,但是这种方式并不推荐。

2. 在平台上进入运维管理=>部署服务,填写对应的应用名和服务名称,注意,这个与下文中tars文件夹中的tars.proto.php 需要完全一致。

3. 选择服务类型为tars_php

4. 选择模板为刚刚建立的http服务模板,默认不启用set

5. 选择可用端口,填写服务器内网ip

6. 端口类型为TCP !!!!协议类型HTTP服务必须选择非TARS!!!!!!

7. 线程数对应SWOOLE的进程数

8. 最大连接数和队列最大长度、队列超时时间,对php服务不生效

9. 点击添加和提交即可,接下来请进入开发guidline

开发guideline

1. 新建对应的目录结构,固定为scripts、src和tars

2. 在src下新建目录,拷贝example中的component和controller两个文件夹

3. 新建composer.json文件,内容如下:

   {
       "name" : "tars-http-server-demo",
       "description": "tars http server",
       "require": {
           "phptars/tars-server": "~0.1.0",
           "phptars/tars-deploy": "~0.1.0",
           "phptars/tars2php": "~0.1.0",
           "phptars/tars-log": "~0.1.0",
           "ext-zip" : ">=0.0.1"
       },
       "autoload": {
           "psr-4": {
               "HttpServer\\" : "./"
           }
       },
       "minimum-stability": "stable",
       "scripts" : {
           "deploy" : "\\Tars\\deploy\\Deploy::run"
       }
   }
   
   

   其中name、description、autoload中的psr-4可以修改为自己需要的,我们这里以此为例子。

4. 在src下新建index.php,内容如下:

<?php
require_once(__DIR__."/vendor/autoload.php");

use \Tars\cmd\Command;

//php tarsCmd.php  conf restart
$config_path = $argv[1];
$pos = strpos($config_path,"--config=");

$config_path = substr($config_path,$pos+9);

$cmd = strtolower($argv[2]);

$class = new Command($cmd,$config_path);
$class->run();

这个文件负责进行启动和入口加载工作

5. 新建services.php文件,内容如下:

<?php  
// 以namespace的方式,在psr4的框架下对代码进行加载  
return array(  
 'namespaceName' => 'HttpServer\\', 
 'monitorStoreConf' => [
	 //'className' => Tars\monitor\cache\RedisStoreCache::class,
	 //'config' => [
		// 'host' => '127.0.0.1',  
		// 'port' => 6379,  
		// 'password' => ':'
	 //],
	 'className' => Tars\monitor\cache\SwooleTableStoreCache::class,
	 'config' => [
		 'size' => 40960
	 ]
 ]
);  

namespaceName为业务实际使用的namespaceName,必须与composer.json中的配置相互对应
monitorStoreConf为主调上报信息的存储配置

• className 为主调上报信息的存储实现类的类名，默认为 \Tars\monitor\cache\SwooleTableStoreCache::class 使用swoole_table存储，tars-monitor中还提供了redis的存储方式，用户也可以自定义新的实现，但是必须实现 \Tars\monitor\contract\StoreCacheInterface 接口
• config 为主调上报信息的存储实现类的配置信息，在实现类初始化时作为参数传入，默认对应swoole_table的size

6. composer install,加载对应的依赖包

7. 在src下新建conf目录存储配置,默认为ENVConf.php

8. tars文件夹下面新建tars.proto.php文件, 里面需要包含对你服务本身的说明:

<?php
return array(
    'appName' => 'PHPTest',
    'serverName' => 'PHPHttpServer',
    'objName' => 'obj',
);

这个名称要与在tars平台上面的名称完全一一对应。

9. 如果你只是试一试,那么首先在可以直接跳到第14步 如果你需要调用tars服务,请继续

10. 将隔壁tcp-server的hello.tars放入tars文件夹中,同时在tars文件夹下面新建tarsclient.proto.php文件:

<?php
return array(
    'appName' => 'PHPTest',
    'serverName' => 'PHPServer',
    'objName' => 'obj',
    'withServant' => false,//决定是服务端,还是客户端的自动生成
    'tarsFiles' => array(
        './example.tars'
    ),
    'dstPath' => '../src/servant',
    'namespacePrefix' => 'HttpServer\servant',
);

APPName、serverName、objName 需要与tars平台上面申请的完全一致。withServant必须为false,同时指定tarsFiles的路径。 dstPath一般是../src/?,这里为../src/servant,这样生成的代码就会到这个文件夹。 namespacePrefix是对应代码的命名空间,这里是HttpServer\servant,这个与composer.json中的psr-4的名称也是相互对应的。

11. 执行scripts下面的tars2php.sh, 会在src/servant下面生成一个三级文件夹,

cd ../tars/

php ../src/vendor/phptars/tars2php/src/tars2php.php ./tarsclient.proto.php

这里就是PHPTest/PHPServer/obj

• classes文件夹 - 存放tars中的struct生成的文件
• tars文件夹 - 存放tars文件
• TestTafServiceServant.php - 实际的远程rpc调用文件

12. 在controller中增加对应的rpc调用代码,具体可参考代码中demo,或tars-client的用法说明

13. 完成代码开发后,在src目录下执行 composer run-script deploy 会自动进行代码打包

14. 将打包好的代码,上传到tars平台,并进行发布

15. 休息,休息一下