# TARS-TCP-SERVER的说明

## 目录结构说明

1. scripts

   存储业务所需要的脚本,如tars2php.sh 负责的就是根据tars文件,生成服务端所需要的代码
2. src&#x20;

   业务逻辑所在的目录,主要包含以下结构:
3. conf: 业务需要的配置, 这里只是给出一个demo,如果从平台下发配置,默认也会写入到这个文件夹中;
4. impl: 业务实际的实现代码,是对interface的对应实现, 具体实现的文件路径需要写入到services.php中;
5. servant: 使用tars2php生成的server端的代码, 这个目录名称完全可以自定义,只需要在使用的时候加以区分就可以了;&#x20;
6. cservant: 调用其他client的代码,命名完全可以自定义,参考tars2php的代码生成;
7. composer.json: 说明项目的依赖情况
8. index.php: 整个服务的入口文件,可以自定义,但是必须要更改平台上的私有模板,增加entrance这个字段在server下面
9. services.php: 声明interface的地址,声明实际实现的地址,这个两个地址会被分别用作实例化调用和注解解析
10. tars 这个tcp服务所依赖的就是这个文件夹下面的example.tars文件 而tars.proto.php文件,则是生成servant下代码所必须的,这个会在下面的guideline中具体说明。

## 服务部署guideline

1. 进入运维管理 => 模板管理 平台会提供一份新的针对php的模板,命名为tars.tarsphp.default, !!!!!!!必须首先修改其中php的执行路径!!!!!!!

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

   * 自己新建一个tars.tarsphp.tcp模板,里面添加如下内容:

     ```markup
     <tars>
     <application>
     ...
      <client>
     ...
     </client>
     <server>
       ...
        package_length_type=N
        open_length_check=1
        package_length_offset=0
        package_body_offset=0
        package_max_length=2000000
      </server>
     </application>
     </tars>
     ```

     只需要在里面添加:

     ```
     package_length_type=N
     open_length_check=1
     package_length_offset=0
     package_body_offset=0
     package_max_length=2000000
     ```

     即可。
   * 第二种方式是在私有模板里面添加这部分内容,但是这种方式并不推荐。
2. 在平台上进入运维管理=>部署服务,填写对应的应用名和服务名称,注意,这个与下文中tars文件夹中的tars.proto.php 需要完全一致。
3. 选择服务类型为tars\_php
4. 选择模板为刚刚建立的tcp服务模板,默认不启用set
5. 选择可用端口,填写服务器内网ip
6. 端口类型为TCP !!!!协议类型TCP服务必须选择TARS!!!!!!
7. 线程数对应SWOOLE的进程数
8. 最大连接数和队列最大长度、队列超时时间,对php服务不生效
9. 点击添加和提交即可,接下来请进入开发guidline

## 开发guideline

1. 自行撰写了一份tars文件,姑且命名为example.tars
2. 新建对应的目录结构,固定为scripts、src和tars
3. 在scripts下面新建tars2php.sh文件, 内容为

```
cd ../tars/

php ../src/vendor/phptars/tars2php/src/tars2php.php ./tars.proto.php
```

1. 将example.tars放入tars文件夹中,同时在tars文件夹下面新建tars.proto.php文件:

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

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

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

   这里就是PHPTest/PHPServer/obj&#x20;
2. classes文件夹 - 存放tars中的struct生成的文件
3. tars文件夹 - 存放tars文件
4. TestTafServiceServant.php - interface文件
5. 在src下新建impl文件夹

   在里面新建PHPServerServantImpl.php文件,这个文件,必须实现TestTafServiceServant.php其中对应的所有方法
6. 新建composer.json文件,内容如下:

```javascript
{
    "name" : "tars-tcp-server-demo",
    "description": "tars tcp server",
    "require": {
        "phptars/tars-server": "~0.2",
        "phptars/tars-deploy": "~0.1",
        "phptars/tars-log": "~0.1",
        "phptars/tars2php": "~0.1",
        "ext-zip" : ">=0.0.1"
    },
    "autoload": {
        "psr-4": {
            "Server\\" : "./"
        }
    },
    "minimum-stability": "stable",
    "scripts" : {
        "deploy" : "\\Tars\\deploy\\Deploy::run"
    }
}
```

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

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

```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();
```

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

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

```php
<?php
/**
 * Created by PhpStorm.
 * User: liangchen
 * Date: 2018/2/24
 * Time: 下午2:51
 */

// 以namespace的方式,在psr4的框架下对代码进行加载
return [
    'obj' => [
        'home-api' => '\Server\servant\PHPTest\PHPServer\obj\TestTafServiceServant',
        'home-class' => '\Server\impl\PHPServerServantImpl',
        'protocolName' => 'tars', //http, json, tars or other
        'serverType' => 'tcp', //http(no_tars default), websocket, tcp(tars default), udp
    ],
];
```

home-api指的是interface文件对应的namespace名称和类名 home-class指的是实现文件对应的namespace名称和类名

1. composer install,加载对应的依赖包
2. 在src下新建conf目录存储配置,默认为ENVConf.php
3. 在PHPServerServantImpl 实现业务逻辑
4. 如果需要进行其他的tars服务调用,请参考tars-client模块的文档
5. 完成代码开发后,在src目录下执行 composer run-script deploy 会自动进行代码打包
6. 将打包好的代码,上传到tars平台,并进行发布
