本文实例讲述了Laravel框架实现修改登录和注册接口数据返回格式的方法。分享给大家供大家参考,具体如下:
1、背景:需要将所有的数据返回格式统一成retCode/retMsg/data
2、登陆接口:
文件目录:app/Http/Controllers/Auth/LoginController
先写登陆接口是因为修改登录接口比注册接口要简单许多
登录接口中的第一句
use AuthenticatesUsers;
可以进去修改登录验证内容(默认是email+password登录),可以修改
validateLogin()
或者直接修改username()
,将email改成name,即可用name+password登录了
修改登录接口数据返回格式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方法中的返回内容就可以了
3、注册接口
一开始我都不知道register的接口到底是藏在哪
然后看routes/api.php里的
Route::post('register', 'Auth\RegisterController@register');
这里register接口指向的是RegisterController中的 register方法
但是在RegisterController没有找到register方法,只有registered、validator、create这几个方法
真正的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) "htmlcode">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); }然后在哪里捕捉异常然后失败的时候修改数据返回格式,捣鼓了好久。
一开始尝试直接在RegisterController中的
registered()
方法中使用try/catch
捕捉异常信息,但是每次Debug都不会跳进来,直接在更底层验证的时候就直接输出报错信息了。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方法是用来将异常写入日志,render是用来渲染各种异常的浏览器输出
所以我们应该是在render中修改捕捉到异常之后返回数据的格式
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='页面未找到'; $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); }然后起码是可以自定义捕捉到验证数据异常
ValidationException
时候的返回数据格式了,还有其他的异常也是可以直接在Handler.php的render
方法中添加。补充一下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); }更多关于Laravel相关内容感兴趣的读者可查看本站专题:《Laravel框架入门与进阶教程》、《php优秀开发框架总结》、《php面向对象程序设计入门教程》、《php+mysql数据库操作入门教程》及《php常见数据库操作技巧汇总》
希望本文所述对大家基于Laravel框架的PHP程序设计有所帮助。
免责声明:本站文章均来自网站采集或用户投稿,网站不提供任何软件下载或自行开发的软件! 如有用户或公司发现本站内容信息存在侵权行为,请邮件告知! 858582#qq.com
更新日志
- 纯音入心系列纯音乐《天籁古筝》1CD[MP3][331MB]
- 男女对唱典藏天碟《发烧对唱·那个季节里的歌DSD》10CD[WAV]
- 群星2010-歌林精选辑[歌林][WAV+CUE]
- TrioZimbalist-PianoTriosofWeinberg,Auerbach,Dvorak(2024)[24-44,1]wav
- 群星.1992-滚石第一流台湾歌·12王牌大车拼【滚石】【WAV+CUE】
- 林子祥.1984-创作歌集【华纳】【WAV+CUE】
- 周汤豪.2010-周汤豪【华纳】【FLAC分轨】
- Mozart-TheStringQuintets-AmadeusQuartet,CecilAronowitz(2017)[24-44,1][WAV+CUE]
- JamesWilliamsDennisIrwin-Focus(2024,Red)[24-48]FLAC
- 藤泽麻衣《空みあげて》[WAV]
- 纯音入心系列纯音乐《中国古筝经典名曲》1CD[MP3][1.3GB]
- 纯音入心系列纯音乐《古筝新奏:岁月静好与筝语,细水流年与筝同》1CD[MP3][846.9MB]
- 670《脆弱敏感小女生》[320K/MP3][27.53MB]
- 曾琳.2011-好好爱我【南方】【WAV+CUE】
- 范晓萱.1995-RAIN【福茂】【WAV+CUE】