本文實(shí)例講述了Laravel框架實(shí)現(xiàn)修改登錄和注冊(cè)接口數(shù)據(jù)返回格式的方法。分享給大家供大家參考，具體如下：
1、背景：需要將所有的數(shù)據(jù)返回格式統(tǒng)一成retCode/retMsg/data
2、登陸接口：
文件目錄：app/Http/Controllers/Auth/LoginController
先寫登陸接口是因?yàn)樾薷牡卿浗涌诒茸?cè)接口要簡(jiǎn)單許多
登錄接口中的第一句
可以進(jìn)去修改登錄驗(yàn)證內(nèi)容(默認(rèn)是email+password登錄)，可以修改
validateLogin()或者直接修改username()，將email改成name，即可用name+password登錄了
修改登錄接口數(shù)據(jù)返回格式login()方法
public function login(Request $request)
{
$this->validateLogin($request);
if ($this->attemptLogin($request)) {
$user = $this->guard()->user();
$user->generateToken();
$ret=new RetObject();
$ret->retCode="0000";
$ret->retMsg='success';
$ret->data= $user->toArray();
}else{
$ret=new RetObject();
$ret->retCode="0001";
$ret->retMsg='failed';
$ret->data= null;
}
return response()->json($ret);
}
直接修改login方法中的返回內(nèi)容就可以了
3、注冊(cè)接口
一開始我都不知道register的接口到底是藏在哪
然后看routes/api.php里的
Route::post('register', 'Auth\RegisterController@register');
這里register接口指向的是RegisterController中的 register方法
但是在RegisterController沒(méi)有找到register方法，只有registered、validator、create這幾個(gè)方法
真正的register方法在第一句的
use RegistersUsers;
RegistersUsers的register
public function register(Request $request)
{
$this->validator($request->all())->validate();
event(new Registered($user = $this->create($request->all())));
$this->guard()->login($user);
return $this->registered($request, $user)
?: redirect($this->redirectPath());
}
這里用到了RegisterController 中的registered、validator、create這幾個(gè)方法
成功的情況下，修改數(shù)據(jù)返回格式比較簡(jiǎn)單
直接在RegisterController中的registered()方法中修改
protected function registered(Request $request,$user)
{
$user->generateToken();
$ret=new RetObject();
$ret->retCode="0000";
$ret->retMsg='register success';
$ret->data= $user->toArray();
return response()->json($ret);
}
然后在哪里捕捉異常然后失敗的時(shí)候修改數(shù)據(jù)返回格式，搗鼓了好久。
一開始嘗試直接在RegisterController中的registered()方法中使用try/catch捕捉異常信息，但是每次Debug都不會(huì)跳進(jìn)來(lái)，直接在更底層驗(yàn)證的時(shí)候就直接輸出報(bào)錯(cuò)信息了。
try{
$user->generateToken();
$ret=new RetObject();
$ret->retCode="0000";
$ret->retMsg='register success';
$ret->data= $user->toArray();
return response()->json($ret);
}catch (Exception $exception){
$ret=new RetObject();
$ret->retCode="0001";
$ret->retMsg='register failed';
$ret->data= null;
return response()->json($ret);
}
最終在app/Exception/Handler.php中
report方法是用來(lái)將異常寫入日志，render是用來(lái)渲染各種異常的瀏覽器輸出
所以我們應(yīng)該是在render中修改捕捉到異常之后返回?cái)?shù)據(jù)的格式
public function render($request, Exception $exception)
{
// This will replace our 404 response with
// a JSON response.
if ($exception instanceof ModelNotFoundException
$request->wantsJson())
{
$ret=new RetObject();
$ret->retCode="404";
$ret->retMsg='頁(yè)面未找到';
$ret->data= null;
return response()->json($ret);
}elseif ($exception instanceof ValidationException)
{
$ret=new RetObject();
$ret->retCode="0001";
$ret->retMsg=$exception->getMessage();
$ret->data= null;
return response()->json($ret);
}
return parent::render($request, $exception);
}
然后起碼是可以自定義捕捉到驗(yàn)證數(shù)據(jù)異常ValidationException 時(shí)候的返回?cái)?shù)據(jù)格式了，還有其他的異常也是可以直接在Handler.php的render方法中添加。
補(bǔ)充一下Handler的異常處理的控制器基類：目錄為vendor/laravel/framework/src/Illuminate/Foundation/Exception/Handler.php
中的report和render方法
public function report(Exception $e)
{
if ($this->shouldntReport($e)) {
return;
}
try {
$logger = $this->container->make(LoggerInterface::class);
} catch (Exception $ex) {
throw $e; // throw the original exception
}
$logger->error($e);
}
public function render($request, Exception $e)
{
$e = $this->prepareException($e);
if ($e instanceof HttpResponseException) {
return $e->getResponse();
} elseif ($e instanceof AuthenticationException) {
return $this->unauthenticated($request, $e);
} elseif ($e instanceof ValidationException) {
return $this->convertValidationExceptionToResponse($e, $request);
}
return $this->prepareResponse($request, $e);
}
更多關(guān)于Laravel相關(guān)內(nèi)容感興趣的讀者可查看本站專題：《Laravel框架入門與進(jìn)階教程》、《php優(yōu)秀開發(fā)框架總結(jié)》、《php面向?qū)ο蟪绦蛟O(shè)計(jì)入門教程》、《php+mysql數(shù)據(jù)庫(kù)操作入門教程》及《php常見數(shù)據(jù)庫(kù)操作技巧匯總》
希望本文所述對(duì)大家基于Laravel框架的PHP程序設(shè)計(jì)有所幫助。
您可能感興趣的文章:- 記Laravel調(diào)用Gin接口調(diào)用formData上傳文件的實(shí)現(xiàn)方法
- laravel 錯(cuò)誤處理,接口錯(cuò)誤返回json代碼
- 在Laravel中使用GuzzleHttp調(diào)用第三方服務(wù)的API接口代碼
- laravel實(shí)現(xiàn)一個(gè)上傳圖片的接口,并建立軟鏈接,訪問(wèn)圖片的方法
- Laravel5.4簡(jiǎn)單實(shí)現(xiàn)app接口Api Token認(rèn)證方法
- Laravel統(tǒng)一封裝接口返回狀態(tài)實(shí)例講解
