Yii2 API 인터페이스 출력 통합 Json 및 jsonp 형식 방법

만약 다른 사람들이 인터페이스를 호출할 때 통합된 표준 json 또는 jsonp 형식을 갖도록 하려면 어떻게 해야 할까요? json 응답은 각각의 개별 계약이 다르기 때문에 데이터가 전송되기 전에 특정 처리를 수행해야 합니다.

1 beforeSend를 호출하기 위해 초기화해야 합니다. beforesend에 대한 일부 처리가 필요하기 때문입니다. 다음은 초기화 처리 코드입니다.

/**
 * (non-PHPdoc)
 * @see \yii\base\Object::init()
 */
public function init()
{       
    parent::init();	//绑定beforeSend事件，更改数据输出格式
    Yii::$app->getResponse()->on(Response::EVENT_BEFORE_SEND, [$this, 'beforeSend']);
}

#🎜🎜 #

2. 그런 다음 전송 전에 처리해야 합니다. 처리 지점에는 다음과 같은 핵심 사항이 있습니다.

1>데이터 출력 형식 변경

2>기본적으로 Json 데이터가 출력됩니다

3> 클라이언트 요청 시 $_GET['callback'] 매개변수가 전달되면 Jsonp 형식이 출력됩니다

# 🎜🎜#4> 요청이 올바른 경우 데이터는 {"success":true,"data":{...}}

5>요청 오류가 발생한 경우 데이터는 { "성공":false,"데이터":{"이름": "찾을 수 없음","message":"페이지를 찾을 수 없습니다.","code":0,"status":404}}

#🎜 🎜#6>구체적인 코드는 다음과 같습니다:

/**
     * 更改数据输出格式
     * 默认情况下输出Json数据
     * 如果客户端请求时有传递$_GET['callback']参数，输入Jsonp格式
     * 请求正确时数据为  {"success":true,"data":{...}}
     * 请求错误时数据为  {"success":false,"data":{"name":"Not Found","message":"页面未找到。","code":0,"status":404}}
     * @param \yii\base\Event $event
     */
    public function beforeSend($event)
    {        /* @var $response \yii\web\Response */
        $response = $event->sender;
        $isSuccessful = $response->isSuccessful;        if ($response->statusCode>=400) {            //异常处理
            if (true && $exception = Yii::$app->getErrorHandler()->exception) {
                $response->data = $this->convertExceptionToArray($exception);
            }            //Model出错了
            if ($response->statusCode==422) {
                $messages=[];                foreach ($response->data as $v) {
                    $messages[] = $v['message'];
                }                //请求错误时数据为  {"success":false,"data":{"name":"Not Found","message":"页面未找到。","code":0,"status":404}}
                $response->data = [                    'name'=> 'valide error',                    'message'=> implode("  ", $messages),                    'info'=>$response->data
                ];
            }
            $response->statusCode = 200;
        }        elseif ($response->statusCode>=300) {
            $response->statusCode = 200;
            $response->data = $this->convertExceptionToArray(new ForbiddenHttpException(Yii::t('yii', 'Login Required')));
        }        //请求正确时数据为  {"success":true,"data":{...}}
        $response->data = [            'success' => $isSuccessful,            'data' => $response->data,
        ];
        $response->format = Response::FORMAT_JSON;
        \Yii::$app->getResponse()->getHeaders()->set('Access-Control-Allow-Origin', '*');
        \Yii::$app->getResponse()->getHeaders()->set('Access-Control-Allow-Credentials', 'true');       //jsonp 格式输出
        if (isset($_GET['callback'])) {
            $response->format = Response::FORMAT_JSONP;
            $response->data = [                'callback' => $_GET['callback'],                'data'=>$response->data,
            ];
        }
    }

#🎜 🎜#

3. 또한 요청에 대한 응답으로 일부 예외가 발생할 수 있으며 이를 배열 출력으로 변환해야 합니다. 구체적인 코드는 다음과 같습니다:

/**
     * 将异常转换为array输出
     * @see \yii\web\ErrorHandle
     * @param \Exception $exception
     * @return multitype:string NULL Ambigous <string, \yii\base\string> \yii\web\integer \yii\db\array multitype:string NULL Ambigous <string, \yii\base\string> \yii\web\integer \yii\db\array
     */
    protected function convertExceptionToArray($exception)
    {        if (!YII_DEBUG && !$exception instanceof UserException && !$exception instanceof HttpException) {
            $exception = new HttpException(500, Yii::t(&#39;yii&#39;, &#39;An internal server error occurred.&#39;));
        }
        $array = [            &#39;name&#39; => ($exception instanceof Exception || $exception instanceof ErrorException) ? $exception->getName() : &#39;Exception&#39;,            &#39;message&#39; => $exception->getMessage(),            &#39;code&#39; => $exception->getCode(),
        ];        if ($exception instanceof HttpException) {
            $array[&#39;status&#39;] = $exception->statusCode;
        }        if (YII_DEBUG) {
            $array[&#39;type&#39;] = get_class($exception);            if (!$exception instanceof UserException) {
                $array[&#39;file&#39;] = $exception->getFile();
                $array[&#39;line&#39;] = $exception->getLine();
                $array[&#39;stack-trace&#39;] = explode("\n", $exception->getTraceAsString());                if ($exception instanceof \yii\db\Exception) {
                    $array[&#39;error-info&#39;] = $exception->errorInfo;
                }
            }
        }        if (($prev = $exception->getPrevious()) !== null) {
            $array[&#39;previous&#39;] = $this->convertExceptionToArray($prev);
        }        return $array;
    }

#🎜🎜 #좋아, 이제 데이터 형식을 반환하는 동일한 표준 API 인터페이스가 있으므로 인터페이스를 호출하는 사용자는 일관되지 않은 형식에 대해 걱정할 필요가 없습니다. # 🎜🎜#

추천: "#🎜 🎜#Yii2.0 프레임워크 개발 실습 동영상 튜토리얼

》

위 내용은 Yii2 API 인터페이스 출력 통합 Json 및 jsonp 형식 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!