Laravel框架实现修改登录和注册接口数据返回格式的方法

本文实例讲述了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)
            ?: 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);
}

更多关于laravel相关内容感兴趣的读者可查看本站专题：《laravel框架入门与进阶教程》、《php优秀开发框架总结》、《php面向对象程序设计入门教程》、《php+mysql数据库操作入门教程》及《php常见数据库操作技巧汇总》

希望本文所述对大家基于laravel框架的php程序设计有所帮助。