本文实例讲述了Laravel框架实现修改登录和注册接口数据返回格式的方法，分享给大家供大家参考，具体如下：

1、背景：需要将所有的数据返回格式统一成retCode/retMsg/data

2、登陆接口：

文件目录：app/Http/Controllers/Auth/LoginController

先写登陆接口是因为修改登录接口比注册接口要简单许多

登录接口中的第一句

use AuthenticatesUsers;

可以进去修改登录验证内容(默认是email+password登录)，可以修改

validateLogin()或者直接修改username()，将email改成name，即可用name+password登录了

修改登录接口数据返回格式login()方法

1. public function login(Request $request) 
2. { 
3.     $this->validateLogin($request); 
4.     if ($this->attemptLogin($request)) { 
5.       $user = $this->guard()->user(); 
6.       $user->generateToken(); 
7.       $ret=new RetObject(); 
8.       $ret->retCode="0000"; 
9.       $ret->retMsg='success'; 
10.       $ret->data= $user->toArray(); 
11.     }else{ 
12.       $ret=new RetObject(); 
13.       $ret->retCode="0001"; 
14.       $ret->retMsg='failed'; 
15.       $ret->data= null; 
16.     } 
17.     return response()->json($ret); 
18. } 

直接修改login方法中的返回内容就可以了

3、注册接口

一开始我都不知道register的接口到底是藏在哪

然后看routes/api.php里的

Route::post('register', 'Auth\RegisterController@register');

这里register接口指向的是RegisterController中的 register方法

但是在RegisterController没有找到register方法，只有registered、validator、create这几个方法，真正的register方法在第一句的

1. use RegistersUsers; 
2. RegistersUsers的register 
3. public function register(Request $request) 
4. { 
5.     $this->validator($request->all())->validate(); 
6.     event(new Registered($user = $this->create($request->all()))); 
7.     $this->guard()->login($user); 
8.     return $this->registered($request, $user) 
9.             ?: redirect($this->redirectPath()); 
10. } 

这里用到了RegisterController  中的registered、validator、create这几个方法

成功的情况下，修改数据返回格式比较简单

直接在RegisterController中的registered()方法中修改

1. protected function registered(Request $request,$user) 
2. { 
3.   $user->generateToken(); 
4.   $ret=new RetObject(); 
5.   $ret->retCode="0000"; 
6.   $ret->retMsg='register success'; 
7.   $ret->data= $user->toArray(); 
8.   return response()->json($ret); 
9. } 

然后在哪里捕捉异常然后失败的时候修改数据返回格式，捣鼓了好久。

一开始尝试直接在RegisterController中的registered()方法中使用try/catch捕捉异常信息，但是每次Debug都不会跳进来，直接在更底层验证的时候就直接输出报错信息了。

1. try{ 
2.   $user->generateToken(); 
3.   $ret=new RetObject(); 
4.   $ret->retCode="0000"; 
5.   $ret->retMsg='register success'; 
6.   $ret->data= $user->toArray(); 
7.   return response()->json($ret); 
8. }catch (Exception $exception){ 
9.   $ret=new RetObject(); 
10.   $ret->retCode="0001"; 
11.   $ret->retMsg='register failed'; 
12.   $ret->data= null; 
13.   return response()->json($ret); 
14. } 

最终在app/Exception/Handler.php中

report方法是用来将异常写入日志，render是用来渲染各种异常的浏览器输出

所以我们应该是在render中修改捕捉到异常之后返回数据的格式

1. public function render($request, Exception $exception) 
2. { 
3.     // This will replace our 404 response with 
4.     // a JSON response. 
5.     if ($exception instanceof ModelNotFoundException && 
6.       $request->wantsJson()) 
7.     { 
8.       $ret=new RetObject(); 
9.       $ret->retCode="404"; 
10.       $ret->retMsg='页面未找到'; 
11.       $ret->data= null; 
12.       return response()->json($ret); 
13.     }elseif ($exception instanceof ValidationException) 
14.     { 
15.       $ret=new RetObject(); 
16.       $ret->retCode="0001"; 
17.       $ret->retMsg=$exception->getMessage(); 
18.       $ret->data= null; 
19.       return response()->json($ret); 
20.     } 
21.     return parent::render($request, $exception); 
22. } 

然后起码是可以自定义捕捉到验证数据异常ValidationException 时候的返回数据格式了，还有其他的异常也是可以直接在Handler.php的render方法中添加。

补充一下Handler的异常处理的控制器基类：目录为vendor/laravel/framework/src/Illuminate/Foundation/Exception/Handler.php中的report和render方法

1. public function report(Exception $e) 
2. { 
3.     if ($this->shouldntReport($e)) { 
4.       return; 
5.     } 
6.     try { 
7.       $logger = $this->container->make(LoggerInterface::class); 
8.     } catch (Exception $ex) { 
9.       throw $e; // throw the original exception 
10.     } 
11.     $logger->error($e); 
12. } 
13. public function render($request, Exception $e) 
14. { 
15.     $e = $this->prepareException($e); 
16.     if ($e instanceof HttpResponseException) { 
17.       return $e->getResponse(); 
18.     } elseif ($e instanceof AuthenticationException) { 
19.       return $this->unauthenticated($request, $e); 
20.     } elseif ($e instanceof ValidationException) { 
21.       return $this->convertValidationExceptionToResponse($e, $request); 
22.     } 
23.     return $this->prepareResponse($request, $e); 
24. }

Tags: Laravel修改登录 Laravel注册接口

分享到：