改进Response类 改进traits\controller\Jump 添加response助手函数

This commit is contained in:
thinkphp
2016-05-11 07:51:41 +08:00
parent 70f184556d
commit 8e1cd9c51f
5 changed files with 166 additions and 289 deletions

View File

@@ -23,6 +23,7 @@ use think\Lang;
use think\Loader; use think\Loader;
use think\Log; use think\Log;
use think\Request; use think\Request;
use think\Response;
use think\Route; use think\Route;
use think\Session; use think\Session;
use think\Url; use think\Url;
@@ -370,3 +371,14 @@ function request($name, $param = '')
{ {
return Request::instance()->$name($param); return Request::instance()->$name($param);
} }
/**
* 设置Response输出
* @param string $name 方法
* @param mixed $param 参数
* @return mixed
*/
function response($name, $param = '')
{
return Response::$name($param);
}

View File

@@ -11,6 +11,8 @@
namespace think; namespace think;
use think\Response;
/** /**
* App 应用管理 * App 应用管理
* @author liu21st <liu21st@gmail.com> * @author liu21st <liu21st@gmail.com>
@@ -100,12 +102,12 @@ class App
default: default:
throw new Exception('dispatch type not support', 10008); throw new Exception('dispatch type not support', 10008);
} }
// 输出数据到客户端
if (isset($data) && !is_null($data)) {
// 监听app_end // 监听app_end
APP_HOOK && Hook::listen('app_end', $data); APP_HOOK && Hook::listen('app_end', $data);
// 输出数据到客户端
if (isset($data)) {
// 自动响应输出 // 自动响应输出
return Response::send($data, Response::type(), Config::get('response_return')); return Response::send($data, '', Config::get('response_return'));
} }
} }

View File

@@ -13,32 +13,20 @@ namespace think;
use think\Config; use think\Config;
use think\Url; use think\Url;
use think\View;
class Response class Response
{ {
// 输出数据的转换方法 // 输出数据的转换方法
protected static $transform = null; protected static $transform = null;
// 输出数据的类型
protected static $type = '';
// 输出数据 // 输出数据
protected static $data = ''; protected static $data = '';
// 是否exit // 是否exit
protected static $isExit = false; protected static $isExit = false;
// 输出类型
/** protected static $type = '';
* 发送数据到客户端 // contentType
* @access protected protected static $contentType = [
* @param mixed $data 要返回的数据
* @param String $type 返回数据格式
* @param bool $return 是否返回数据
* @return mixed
*/
public static function send($data = '', $type = '', $return = false)
{
$type = strtolower($type ?: self::$type);
$headers = [
'json' => 'application/json', 'json' => 'application/json',
'xml' => 'text/xml', 'xml' => 'text/xml',
'html' => 'text/html', 'html' => 'text/html',
@@ -46,218 +34,8 @@ class Response
'script' => 'application/javascript', 'script' => 'application/javascript',
'text' => 'text/plain', 'text' => 'text/plain',
]; ];
// HTTP status
if (!headers_sent() && isset($headers[$type])) { protected static $code = [
header('Content-Type:' . $headers[$type] . '; charset=utf-8');
}
$data = $data ?: self::$data;
if (is_callable(self::$transform)) {
$data = call_user_func_array(self::$transform, [$data]);
} else {
switch ($type) {
case 'json':
// 返回JSON数据格式到客户端 包含状态信息
$data = json_encode($data, JSON_UNESCAPED_UNICODE);
break;
case 'jsonp':
// 返回JSON数据格式到客户端 包含状态信息
$handler = !empty($_GET[Config::get('var_jsonp_handler')]) ? $_GET[Config::get('var_jsonp_handler')] : Config::get('default_jsonp_handler');
$data = $handler . '(' . json_encode($data, JSON_UNESCAPED_UNICODE) . ');';
break;
}
}
APP_HOOK && Hook::listen('return_data', $data);
if ($return) {
return $data;
}
echo $data;
self::isExit() && exit();
}
/**
* 转换控制器输出的数据
* @access public
* @param mixed $callback 调用的转换方法
* @return void
*/
public static function transform($callback)
{
self::$transform = $callback;
}
/**
* 输出类型设置
* @access public
* @param string $type 输出内容的格式类型
* @return mixed
*/
public static function type($type = null)
{
if (is_null($type)) {
return self::$type ?: (IS_AJAX ? Config::get('default_ajax_return') : Config::get('default_return_type'));
}
self::$type = $type;
}
/**
* 输出数据设置
* @access public
* @param mixed $data 输出数据
* @return void
*/
public static function data($data)
{
self::$data = $data;
}
/**
* 输出是否exit设置
* @access public
* @param bool $exit 是否退出
* @return mixed
*/
public static function isExit($exit = null)
{
if (is_null($exit)) {
return self::$isExit;
}
self::$isExit = (boolean) $exit;
}
/**
* 返回封装后的API数据到客户端
* @access public
* @param mixed $data 要返回的数据
* @param integer $code 返回的code
* @param string $msg 提示信息
* @param string $type 返回数据格式
* @return mixed
*/
public static function result($data, $code = 0, $msg = '', $type = '')
{
$result = [
'code' => $code,
'msg' => $msg,
'time' => NOW_TIME,
'data' => $data,
];
if ($type) {
self::type($type);
}
return $result;
}
/**
* 操作成功跳转的快捷方法
* @access public
* @param mixed $msg 提示信息
* @param mixed $data 返回的数据
* @param string $url 跳转的URL地址
* @param integer $wait 跳转等待时间
* @return mixed
*/
public static function success($msg = '', $data = '', $url = null, $wait = 3)
{
$code = 1;
if (is_numeric($msg)) {
$code = $msg;
$msg = '';
}
$result = [
'code' => $code,
'msg' => $msg,
'data' => $data,
'url' => is_null($url) && isset($_SERVER["HTTP_REFERER"]) ? $_SERVER["HTTP_REFERER"] : $url,
'wait' => $wait,
];
$type = IS_AJAX ? Config::get('default_ajax_return') : Config::get('default_return_type');
if ('html' == $type) {
$result = View::instance(Config::get('template'), Config::get('view_replace_str'))
->fetch(Config::get('dispatch_success_tmpl'), $result);
}
self::type($type);
return $result;
}
/**
* 操作错误跳转的快捷方法
* @access public
* @param mixed $msg 提示信息
* @param mixed $data 返回的数据
* @param string $url 跳转的URL地址
* @param integer $wait 跳转等待时间
* @return mixed
*/
public static function error($msg = '', $data = '', $url = null, $wait = 3)
{
$code = 0;
if (is_numeric($msg)) {
$code = $msg;
$msg = '';
}
$result = [
'code' => $code,
'msg' => $msg,
'data' => $data,
'url' => is_null($url) ? 'javascript:history.back(-1);' : $url,
'wait' => $wait,
];
$type = IS_AJAX ? Config::get('default_ajax_return') : Config::get('default_return_type');
if ('html' == $type) {
$result = View::instance(Config::get('template'), Config::get('view_replace_str'))
->fetch(Config::get('dispatch_error_tmpl'), $result);
}
self::type($type);
return $result;
}
/**
* URL重定向
* @access public
* @param string $url 跳转的URL表达式
* @param array|int $params 其它URL参数或http code
* @return void
*/
public static function redirect($url, $params = [])
{
$http_response_code = 301;
if (is_int($params) && in_array($params, [301, 302])) {
$http_response_code = $params;
$params = [];
}
$url = preg_match('/^(https?:|\/)/', $url) ? $url : Url::build($url, $params);
header('Location: ' . $url, true, $http_response_code);
}
/**
* 设置响应头
* @access public
* @param string $name 参数名
* @param string $value 参数值
* @return void
*/
public static function header($name, $value)
{
header($name . ':' . $value);
}
/**
* 发送HTTP状态
* @param integer $code 状态码
* @return void
*/
public static function sendHttpStatus($code)
{
static $_status = [
// Informational 1xx // Informational 1xx
100 => 'Continue', 100 => 'Continue',
101 => 'Switching Protocols', 101 => 'Switching Protocols',
@@ -306,10 +84,161 @@ class Response
505 => 'HTTP Version Not Supported', 505 => 'HTTP Version Not Supported',
509 => 'Bandwidth Limit Exceeded', 509 => 'Bandwidth Limit Exceeded',
]; ];
if (isset($_status[$code])) {
header('HTTP/1.1 ' . $code . ' ' . $_status[$code]); /**
* 发送数据到客户端
* @access public
* @param mixed $data 数据
* @param string $type 返回类型
* @param bool $return 是否返回数据
* @return mixed
*/
public static function send($data = [], $type = '', $return = false)
{
if ('' == $type) {
$type = self::$type ?: (IS_AJAX ? Config::get('default_ajax_return') : Config::get('default_return_type'));
}
$data = $data ?: self::$data;
if (!headers_sent() && isset(self::$contentType[$type])) {
header('Content-Type:' . self::$contentType[$type] . '; charset=utf-8');
}
if (is_callable(self::$transform)) {
$data = call_user_func_array(self::$transform, [$data]);
} else {
switch ($type) {
case 'json':
// 返回JSON数据格式到客户端 包含状态信息
$data = json_encode($data, JSON_UNESCAPED_UNICODE);
break;
case 'jsonp':
// 返回JSON数据格式到客户端 包含状态信息
$handler = !empty($_GET[Config::get('var_jsonp_handler')]) ? $_GET[Config::get('var_jsonp_handler')] : Config::get('default_jsonp_handler');
$data = $handler . '(' . json_encode($data, JSON_UNESCAPED_UNICODE) . ');';
break;
}
}
APP_HOOK && Hook::listen('return_data', $data);
if ($return) {
return $data;
}
echo $data;
self::isExit() && exit();
}
/**
* 转换控制器输出的数据
* @access public
* @param mixed $callback 调用的转换方法
* @return $this
*/
public static function transform($callback)
{
self::$transform = $callback;
}
/**
* 输出数据设置
* @access public
* @param mixed $data 输出数据
* @return $this
*/
public static function data($data)
{
self::$data = $data;
}
/**
* 输出类型设置
* @access public
* @param string $type 输出内容的格式类型
* @return mixed
*/
public static function type($type)
{
self::$type = $type;
}
/**
* 输出是否exit设置
* @access public
* @param bool $exit 是否退出
* @return mixed
*/
public static function isExit($exit = null)
{
if (is_null($exit)) {
return self::$isExit;
}
self::$isExit = (boolean) $exit;
}
/**
* 返回封装后的API数据到客户端
* @access public
* @param mixed $data 要返回的数据
* @param integer $code 返回的code
* @param string $msg 提示信息
* @return mixed
*/
public static function result($data, $code = 0, $msg = '', $type = '')
{
$result = [
'code' => $code,
'msg' => $msg,
'time' => NOW_TIME,
'data' => $data,
];
self::$type = $type;
return $result;
}
/**
* URL重定向
* @access public
* @param string $url 跳转的URL表达式
* @param array|int $params 其它URL参数或http code
* @return void
*/
public static function redirect($url, $params = [])
{
$http_response_code = 301;
if (is_int($params) && in_array($params, [301, 302])) {
$http_response_code = $params;
$params = [];
}
$url = preg_match('/^(https?:|\/)/', $url) ? $url : Url::build($url, $params);
header('Location: ' . $url, true, $http_response_code);
}
/**
* 设置响应头
* @access public
* @param string $name 参数名
* @param string $value 参数值
* @return void
*/
public static function header($name, $value)
{
header($name . ':' . $value);
}
/**
* 发送HTTP状态
* @param integer $code 状态码
* @return void
*/
public static function code($code)
{
if (isset(self::$statusCode[$code])) {
header('HTTP/1.1 ' . $code . ' ' . self::$statusCode[$code]);
// 确保FastCGI模式下正常 // 确保FastCGI模式下正常
header('Status:' . $code . ' ' . $_status[$code]); header('Status:' . $code . ' ' . self::$statusCode[$code]);
} }
} }
} }

View File

@@ -14,36 +14,76 @@
*/ */
namespace traits\controller; namespace traits\controller;
use think\Config;
use think\Response; use think\Response;
use think\View;
trait Jump trait Jump
{ {
/**
* 操作错误跳转的快捷方法
* @access public
* @param mixed $msg 提示信息
* @param string $url 跳转的URL地址
* @param mixed $data 返回的数据
* @param integer $wait 跳转等待时间
* @return mixed
*/
public function error($msg = '', $url = null, $data = '', $wait = 3)
{
return Response::error($msg, $data, $url, $wait);
}
/** /**
* 操作成功跳转的快捷方法 * 操作成功跳转的快捷方法
* @access public * @access public
* @param mixed $msg 提示信息 * @param mixed $msg 提示信息
* @param string $url 跳转的URL地址
* @param mixed $data 返回的数据 * @param mixed $data 返回的数据
* @param string $url 跳转的URL地址
* @param integer $wait 跳转等待时间 * @param integer $wait 跳转等待时间
* @return mixed * @return mixed
*/ */
public function success($msg = '', $url = null, $data = '', $wait = 3) public static function success($msg = '', $data = '', $url = null, $wait = 3)
{ {
return Response::success($msg, $data, $url, $wait); $code = 1;
if (is_numeric($msg)) {
$code = $msg;
$msg = '';
}
$result = [
'code' => $code,
'msg' => $msg,
'data' => $data,
'url' => is_null($url) && isset($_SERVER["HTTP_REFERER"]) ? $_SERVER["HTTP_REFERER"] : $url,
'wait' => $wait,
];
$type = IS_AJAX ? Config::get('default_ajax_return') : Config::get('default_return_type');
if ('html' == $type) {
$result = View::instance(Config::get('template'), Config::get('view_replace_str'))
->fetch(Config::get('dispatch_success_tmpl'), $result);
}
Response::send($result, $type);
}
/**
* 操作错误跳转的快捷方法
* @access public
* @param mixed $msg 提示信息
* @param mixed $data 返回的数据
* @param string $url 跳转的URL地址
* @param integer $wait 跳转等待时间
* @return mixed
*/
public static function error($msg = '', $data = '', $url = null, $wait = 3)
{
$code = 0;
if (is_numeric($msg)) {
$code = $msg;
$msg = '';
}
$result = [
'code' => $code,
'msg' => $msg,
'data' => $data,
'url' => is_null($url) ? 'javascript:history.back(-1);' : $url,
'wait' => $wait,
];
$type = IS_AJAX ? Config::get('default_ajax_return') : Config::get('default_return_type');
if ('html' == $type) {
$result = View::instance(Config::get('template'), Config::get('view_replace_str'))
->fetch(Config::get('dispatch_error_tmpl'), $result);
}
Response::send($result, $type);
} }
/** /**

View File

@@ -129,10 +129,6 @@ class responseTest extends \PHPUnit_Framework_TestCase
{ {
$type = "json"; $type = "json";
Response::type($type); Response::type($type);
$result = Response::type();
$this->assertEquals($type, $result);
Response::type($type);
} }
/** /**
@@ -176,108 +172,6 @@ class responseTest extends \PHPUnit_Framework_TestCase
$this->assertEquals($msg, $result["msg"]); $this->assertEquals($msg, $result["msg"]);
$this->assertEquals($data, $result["data"]); $this->assertEquals($data, $result["data"]);
$this->assertEquals($_SERVER['REQUEST_TIME'], $result["time"]); $this->assertEquals($_SERVER['REQUEST_TIME'], $result["time"]);
$this->assertEquals($type, Response::type());
}
/**
* @covers think\Response::success
* @todo Implement testSuccess().
*/
public function testSuccess()
{
// round 1
$msg = 1001;
$data = "data";
$url = "www.HTTP_REFERER.com";
if (isset($_SERVER["HTTP_REFERER"])) {
$HTTP_REFERER = $_SERVER["HTTP_REFERER"];
}
$_SERVER["HTTP_REFERER"] = $url;
Config::set('default_return_type', "json");
$result = Response::success($msg, $data);
$this->assertEquals($msg, $result["code"]);
$this->assertEquals($data, $result["data"]);
$this->assertEquals($url, $result["url"]);
$this->assertEquals("json", Response::type());
$this->assertEquals(3, $result["wait"]);
// round 2
$msg = "the msg";
$url = "www.thinkphptestsucess.com";
$result = Response::success($msg, $data, $url);
$this->assertEquals($msg, $result["msg"]);
$this->assertEquals($url, $result["url"]);
// round 3 异常在travis-ci中未能重现
// $this->setExpectedException('\think\Exception');
// FIXME 静态方法mock
// $oMockView = $this->getMockBuilder('\think\View')->setMethods(array(
// 'fetch'
// ))->getMock();
// $oMockView->expects($this->any())->method('fetch')->will($this->returnValue('content'));
// Config::set('default_return_type', "html");
// $result = Response::success($msg, $data, $url);
// FIXME 静态方法mock
// $this->assertEquals('content', $result);
if (isset($HTTP_REFERER)) {
$_SERVER["HTTP_REFERER"] = $HTTP_REFERER;
}
}
/**
* @covers think\Response::error
* @todo Implement testError().
*/
public function testError()
{
// round 1
$msg = 1001;
$data = "data";
Config::set('default_return_type', "json");
$result = Response::error($msg, $data);
$this->assertEquals($msg, $result["code"]);
$this->assertEquals($data, $result["data"]);
$this->assertEquals('javascript:history.back(-1);', $result["url"]);
$this->assertEquals("json", Response::type());
$this->assertEquals(3, $result["wait"]);
// round 2
$msg = "the msg";
$url = "www.thinkphptesterror.com";
$result = Response::error($msg, $data, $url);
$this->assertEquals($msg, $result["msg"]);
$this->assertEquals($url, $result["url"]);
// round 3 异常在travis-ci中未能重现
// $this->setExpectedException('\think\Exception');
// FIXME 静态方法mock
// $oMockView = $this->getMockBuilder('\think\View')->setMethods(array(
// 'fetch'
// ))->getMock();
// $oMockView->expects($this->any())->method('fetch')->will($this->returnValue('content'));
// Config::set('default_return_type', "html");
// $result = Response::error($msg, $data, $url);
// FIXME 静态方法mock
// $this->assertEquals('content', $result);
} }
/** /**