tarsdocs
  • Readme.md
  • CLA
  • LICENSE
  • 基础介绍
    • 简介
    • 基础概念
    • 基础通信协议 Tars
    • 统一通信协议 Tup
    • 开发模式介绍
    • 模板配置
    • 服务市场
    • 服务扩展
    • 框架版本说明
  • 开源版框架介绍
    • 开源版本部署
      • 部署总体介绍
      • Docker环境安装
      • Mysql安装
      • 框架源码部署(Linux/Mac)
      • 框架源码部署(Windows)
      • 框架Docker部署
      • 框架节点部署
      • 业务服务容器化
      • 框架K8SDocker 部署
      • 框架K8STARS 部署
      • 框架K8SFramework 部署(强烈推荐)
      • 框架更新及扩容
      • 调用链升级注意事项
      • TarsWeb-v3.0.3升级说明
    • 开源版管理平台
      • TarsWeb说明
      • web用户体系
      • web管理平台 API
  • 企业版本介绍
    • 企业版说明
    • 框架集群化机制
    • 框架单节点机制
    • 使用二进制包部署
    • 使用容器部署
    • 业务服务一主多备机制
    • 命令行控制终端
    • IP-LIST级联缓存机制
    • 多数据中心管理
    • 多网络支持
    • 第三方服务管理
    • 数据产生和管理机制
    • 密码重置
    • TarsPython介绍
  • 框架关键特性
    • 业务配置
    • 服务监控
    • 无损发布/重启
    • 调用链
    • IDC分组
    • 鉴权功能
  • TarsCPP
    • 编译
    • 快速开发入门
    • 使用指南
    • 开发规范
    • 服务线程说明文档
    • protobuf 协议支持文档
    • 第三方协议支持
    • HTTP1 支持
    • HTTP2 支持
    • TLS 通信支持
    • Push 功能说明
    • PushCallback 功能说明
    • Cookie 支持
    • 队列模式
    • 手动绑定
    • 性能数据
    • 2.x 版本变化
    • 3.x 版本变化
    • 协程版本说明
    • 基础类库说明
    • [案例]
      • 框架快速入门
      • Http 服务示例
  • TarsJava
    • 快速开始
    • 快速开发入门
    • [使用指南]
      • Tars 服务开发与上线
      • HTTP 服务开发与上线
      • 生成接口调用文件
    • [性能测试]
      • tars java 压测代码
  • TarsGo
    • 基本介绍
    • 快速开始
    • 使用指南
    • cmake 管理代码
    • pb2tarsgo
    • 性能数据
    • 使用示例
  • TarsPHP
    • 搭建 php 环境
    • 快速开发入门
    • [快速起步]
      • 搭建 HttpServer
      • 搭建 TimerServer
      • 搭建 TcpServer
      • 搭建 WebSocketServer
      • 弹幕活动实战
    • [框架简介]
      • 简介
      • tars-server
      • tars-client
      • tars-config
      • tars-deploy
      • tars-extension
      • tars-log
      • tars-monitor
      • tars-registry
      • tars-report
      • tars-utils
      • tars2php
    • [高阶应用]
      • PHP 的 Swoole 框架如何接入 Tars
      • 与 thinkphp 结合使用
      • 与 Swoft 结合使用
      • 与 Laravel 结合使用
      • 与 Yii2 结合使用
      • 持续集成方案
    • [其他]
      • 常见问题
      • 如何 Debug
      • changelog
      • 其他外部文档
  • Tars.js
    • 基本介绍
    • 脚手架
    • 快速开发入门
    • @tars/stream
    • @tars/rpc
    • @tars/logs
    • @tars/config
    • @tars/monitor
    • @tars/notify
    • @tars/utils
    • @tars/dyeing
    • @tars/node-agent
    • @tars/winston-tars
    • tars2node
  • K8SFramework
    • [安装和使用说明]
      • 介绍
      • 特性
      • 安装
      • 升级
      • 云原生运维
      • 管理平台
      • 证书
    • [开发环境构建]
      • Dockerfile 说明
      • 服务发布流程说明
      • 制作基础编译镜像
      • 制作业务服务镜像
      • 制作 Helm 包
      • 发布业务镜像到 K8S 集群
      • 服务发布示例
      • 如何调试业务服务
  • 服务扩展
    • 云告警
    • 接口及压测工具
    • 网关服务
    • dcache缓存服务
    • 发送邮件服务
    • 一致性存储服务
    • 一致性存储web管理平台
    • 唯一计数服务
  • 常见问题
    • 安装常见问题
    • Issues
    • Issues-tarscpp
    • Issues-tarsjava
    • Issues-tarsgo
    • Issues-tarsphp
  • 开源合作
    • TarsFramework 项目 Git 合作规范
  • 直播视频
    • B 站 TARS 培训系列课程
  • 相关文章
    • TARS 技术文章
  • 其它资源分享
    • 下载
    • Tars 介绍.pptx
    • TarsPHP 解密.pdf
    • TarsJava 本地调试.pdf
    • 微服务在腾讯的业务实践.pptx
Powered by GitBook
On this page
  • 目录结构说明
  • 服务部署guideline
  • 开发guideline

Was this helpful?

  1. TarsPHP
  2. [快速起步]

搭建 HttpServer

目录结构说明

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

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

  • component: 存储Controller的基础类,方便所有的Controller公用

  • conf: 业务需要的配置, 这里只是给出一个demo,如果从平台下发配置,默认也会写入到这个文件夹中;

  • controller: MVC模型中的C层;

  • servant: 使用tars2php生成的client端的代码, 这个目录名称完全可以自定义,只需要在使用的时候加以区分就可以了;

  • composer.json: 说明项目的依赖情况

  • index.php: 整个服务的入口文件,这个文件名称可以自定义,但是必须要更改平台上的私有模板,增加entrance这个字段在server下面

  • services.php: 声明整个项目的基础namespaceName

  1. 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

即可。

  • 第二种方式是在私有模板里面添加这部分内容:

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

  2. 选择服务类型为tars_php

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

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

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

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

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

  8. 点击添加和提交即可,接下来请进入开发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.2",
       "phptars/tars-deploy": "~0.1",
       "phptars/tars2php": "~0.1",
       "phptars/tars-log": "~0.1",
       "ext-zip" : ">=0.0.1"
   },
   "autoload": {
       "psr-4": {
           "HttpServer\\" : "./"

       }
   },
   "minimum-stability": "stable",
   "scripts" : {
       "deploy" : "\\Tars\\deploy\\Deploy::run"
   }
}

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

  1. 在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 [
     'obj' => [
         'namespaceName' => 'HttpServer\\',
         'saveTarsConfigFileDir' => 'src/conf/', //从tarsconfig拉下来的文件保存目录 默认src目录下的conf
         'saveTarsConfigFileName' => [ '',], //需要从tarsconfig拉下来的文件名 在web上配置
         'monitorStoreConf' => [
             //使用redis缓存主调上报信息
             //'className' => Tars\monitor\cache\RedisStoreCache::class,
             //'config' => [
             // 'host' => '127.0.0.1',
             // 'port' => 6379,
             // 'password' => ':'
             //],
             //使用swoole_table缓存主调上报信息(默认)
             'className' => Tars\monitor\cache\SwooleTableStoreCache::class,
             'config' => [
                 'size' => 40960
             ]
         ],
         'registryStoreConf' => [
             'className' => Tars\registry\RouteTable::class,
             'config' => [
                 'size' => 200
             ]
         ],
         'protocolName' => 'http', //http, json, tars or other
         'serverType' => 'http', //http(no_tars default), websocket, tcp(tars default), udp
     ],
 ]; 

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

  • className 为主调上报信息的存储实现类的类名,默认为 \Tars\monitor\cache\SwooleTableStoreCache::class 使用swoole_table存储,tars-monitor中还提供了redis的存储方式,用户也可以自定义新的实现,但是必须实现 \Tars\monitor\contract\StoreCacheInterface 接口

  • config 为主调上报信息的存储实现类的配置信息,在实现类初始化时作为参数传入,默认对应swoole_table的size

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

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

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

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

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

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

  2. 将隔壁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的名称也是相互对应的。

  1. 执行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调用文件

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

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

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

  4. 休息,休息一下

Previous[快速起步]Next搭建 TimerServer

Last updated 3 years ago

Was this helpful?