Ответ

Ответ на самом деле является объектом support\Response, и для удобства создания этого объекта в webman предоставлены некоторые вспомогательные функции.

Возврат произвольного ответа

Пример

<?php
namespace app\controller;

use support\Request;

class FooController
{
    public function hello(Request $request)
    {
        return response('hello webman');
    }
}

Функция response реализована следующим образом:

function response($body = '', $status = 200, $headers = array())
{
    return new Response($status, $headers, $body);
}

Вы также можете сначала создать пустой объект response, а затем на подходящем этапе использовать $response->cookie(), $response->header(), $response->withHeaders(), $response->withBody() для настройки возвращаемого содержимого.

public function hello(Request $request)
{
    // Создание объекта
    $response = response();

    // .... Пропущена бизнес-логика

    // Установка cookie
    $response->cookie('foo', 'value');

    // .... Пропущена бизнес-логика

    // Установка http- заголовков
    $response->header('Content-Type', 'application/json');
    $response->withHeaders([
                'X-Header-One' => 'Header Value 1',
                'X-Header-Tow' => 'Header Value 2',
            ]);

    // .... Пропущена бизнес-логика

    // Установка данных для возврата
    $response->withBody('返还的数据');
    return $response;
}

Возврат json

Пример

<?php
namespace app\controller;

use support\Request;

class FooController
{
    public function hello(Request $request)
    {
        return json(['code' => 0, 'msg' => 'ok']);
    }
}

Функция json реализована следующим образом

function json($data, $options = JSON_UNESCAPED_UNICODE)
{
    return new Response(200, ['Content-Type' => 'application/json'], json_encode($data, $options));
}

Возврат xml

Пример

<?php
namespace app\controller;

use support\Request;

class FooController
{
    public function hello(Request $request)
    {
        $xml = <<<XML
               <?xml version='1.0' standalone='yes'?>
               <values>
                   <truevalue>1</truevalue>
                   <falsevalue>0</falsevalue>
               </values>
               XML;
        return xml($xml);
    }
}

Функция xml реализована следующим образом：

function xml($xml)
{
    if ($xml instanceof SimpleXMLElement) {
        $xml = $xml->asXML();
    }
    return new Response(200, ['Content-Type' => 'text/xml'], $xml);
}

Возврат представления

Создайте файл app/controller/FooController.php следующим образом

<?php
namespace app\controller;

use support\Request;

class FooController
{
    public function hello(Request $request)
    {
        return view('foo/hello', ['name' => 'webman']);
    }
}

Создайте файл app/view/foo/hello.html следующим образом

<!doctype html>
<html>
<head>
    <meta charset="utf-8">
    <title>webman</title>
</head>
<body>
hello <?=htmlspecialchars($name)?>
</body>
</html>

Перенаправление

<?php
namespace app\controller;

use support\Request;

class FooController
{
    public function hello(Request $request)
    {
        return redirect('/user');
    }
}

Функция redirect реализована следующим образом：

function redirect($location, $status = 302, $headers = [])
{
    $response = new Response($status, ['Location' => $location]);
    if (!empty($headers)) {
        $response->withHeaders($headers);
    }
    return $response;
}

Установка заголовка

<?php
namespace app\controller;

use support\Request;

class FooController
{
    public function hello(Request $request)
    {
        return response('hello webman', 200, [
            'Content-Type' => 'application/json',
            'X-Header-One' => 'Header Value' 
        ]);
    }
}

Вы также можете использовать методы header и withHeaders, чтобы установить заголовки по одному или массово.

<?php
namespace app\controller;

use support\Request;

class FooController
{
    public function hello(Request $request)
    {
        return response('hello webman')
        ->header('Content-Type', 'application/json')
        ->withHeaders([
            'X-Header-One' => 'Header Value 1',
            'X-Header-Tow' => 'Header Value 2',
        ]);
    }
}

Вы также можете установить заголовки заранее, а затем установить данные, которые нужно вернуть.

public function hello(Request $request)
{
    // Создание объекта
    $response = response();

    // .... Пропущена бизнес-логика

    // Установка http- заголовков
    $response->header('Content-Type', 'application/json');
    $response->withHeaders([
                'X-Header-One' => 'Header Value 1',
                'X-Header-Tow' => 'Header Value 2',
            ]);

    // .... Пропущена бизнес-логика

    // Установка данных для возврата
    $response->withBody('返还的数据');
    return $response;
}

Установка cookie

<?php
namespace app\controller;

use support\Request;

class FooController
{
    public function hello(Request $request)
    {
        return response('hello webman')
        ->cookie('foo', 'value');
    }
}

Вы также можете установить cookie заранее, а затем установить данные, которые нужно вернуть.

public function hello(Request $request)
{
    // Создание объекта
    $response = response();

    // .... Пропущена бизнес-логика

    // Установка cookie
    $response->cookie('foo', 'value');

    // .... Пропущена бизнес-логика

    // Установка данных для возврата
    $response->withBody('返还的数据');
    return $response;
}

Полные параметры метода cookie следующие:

cookie($name, $value = '', $max_age = 0, $path = '', $domain = '', $secure = false, $http_only = false)

Возврат потокового файла

<?php
namespace app\controller;

use support\Request;

class FooController
{
    public function hello(Request $request)
    {
        return response()->file(public_path() . '/favicon.ico');
    }
}
  • webman поддерживает отправку очень больших файлов
  • Для больших файлов (более 2M) webman не будет считывать весь файл в память целиком, а будет считывать файл по частям в подходящий момент и отправлять
  • webman оптимизирует скорость чтения и отправки файла в зависимости от скорости приема клиентом, чтобы гарантировать быструю отправку файла при минимальном использовании памяти
  • Отправка данных является неблокирующей и не повлияет на обработку других запросов
  • Метод file автоматически добавляет заголовок if-modified-since и на следующем запросе проверяет заголовок if-modified-since, если файл не изменен, то просто возвращает 304 для экономии пропускной способности
  • Отправляемый файл будет автоматически отправлен браузеру с соответствующим заголовком Content-Type
  • Если файл не существует, будет автоматически возвращен ответ 404

Скачивание файла

<?php
namespace app\controller;

use support\Request;

class FooController
{
    public function hello(Request $request)
    {
        return response()->download(public_path() . '/favicon.ico', '文件名.ico');
    }
}

Метод download по сути аналогичен методу file, различия заключаются в следующем:
1、если задать имя загружаемого файла, файл будет загружен, а не отображен в браузере
2、метод download не будет проверять заголовок if-modified-since

Получение вывода

Некоторые библиотеки выводят содержимое файла непосредственно в стандартный вывод, то есть данные будут напечатаны в терминале командной строки и не будут отправлены браузеру; в этом случае нам нужно использовать ob_start();, ob_get_clean(); для захвата данных в переменную, а затем отправить данные в браузер, например:

<?php

namespace app\controller;

use support\Request;

class ImageController
{
    public function get(Request $request)
    {
        // Создание изображения
        $im = imagecreatetruecolor(120, 20);
        $text_color = imagecolorallocate($im, 233, 14, 91);
        imagestring($im, 1, 5, 5,  'A Simple Text String', $text_color);

        // Начало захвата вывода
        ob_start();
        // Вывод изображения
        imagejpeg($im);
        // Получение содержимого изображения
        $image = ob_get_clean();

        // Отправка изображения
        return response($image)->header('Content-Type', 'image/jpeg');
    }
}

Пакетный ответ

Иногда мы хотим отправить ответ по частям, вы можете обратиться к следующему примеру.

<?php

namespace app\controller;

use support\Request;
use support\Response;
use Workerman\Protocols\Http\Chunk;
use Workerman\Timer;

class IndexController
{
    public function index(Request $request): Response
    {
        // Получение соединения
        $connection = $request->connection;
        // Регулярная отправка тела http
        $timer = Timer::add(1, function () use ($connection, &$timer) {
            static $i = 0;
            if ($i++ < 10) {
                // Отправка тела http
                $connection->send(new Chunk($i));
            } else {
                // Удаление ненужного таймера, чтобы избежать утечек памяти
                Timer::del($timer);
                // Отправка пустого пакета Chunk для уведомления клиента о завершении ответа
                $connection->send(new Chunk(''));
            }
        });
        // Сначала отправьте заголовок http с Transfer-Encoding: chunked, тело http будет отправлено асинхронно
        return response()->withHeaders([
            "Transfer-Encoding" => "chunked",
        ]);
    }

}

Если вы вызываете большую модель, посмотрите следующий пример.

composer require webman/openai
<?php
namespace app\controller;
use support\Request;

use Webman\Openai\Chat;
use Workerman\Protocols\Http\Chunk;

class ChatController
{
    public function completions(Request $request)
    {
        $connection = $request->connection;
        // https://api.openai.com, если доступ недоступен, можете использовать адрес https://api.openai-proxy.com
        $chat = new Chat(['apikey' => 'sk-xx', 'api' => 'https://api.openai.com']);
        $chat->completions(
            [
                'model' => 'gpt-3.5-turbo',
                'stream' => true,
                'messages' => [['role' => 'user', 'content' => 'hello']],
            ], [
            'stream' => function($data) use ($connection) {
                // Когда интерфейс openai возвращает данные, пересылайте их в браузер
                $connection->send(new Chunk(json_encode($data, JSON_UNESCAPED_UNICODE) . "\n"));
            },
            'complete' => function($result, $response) use ($connection) {
                // Проверка на наличие ошибок при завершении ответа
                if (isset($result['error'])) {
                    $connection->send(new Chunk(json_encode($result, JSON_UNESCAPED_UNICODE) . "\n"));
                }
                // Возврат пустого пакета chunk представляет завершение ответа
                $connection->send(new Chunk(''));
            },
        ]);
        // Сначала вернуть заголовок http, а затем асинхронно возвращать данные
        return response()->withHeaders([
            "Transfer-Encoding" => "chunked",
        ]);
    }
}