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\[email protected]');

這裡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)
                        ?: redirect($this->redirectPath());
    }
 

這裡用到了RegisterController  中的registered、validator、create這幾個方法

成功的情況下，修改資料返回格式比較簡單

直接在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);
            
    }

然後在哪裡捕捉異常然後失敗的時候修改資料返回格式，搗鼓了好久。

一開始嘗試直接在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);
    }