小白折腾服务器(六):使用后置中间件自定义接口成功返回格式
7

题记

肯定有小伙伴公司团队强制规范api返回code、message、data。
肯定有小伙伴纠结过自定义laravel的分页返回格式,不管是用api资源类还是没用资源类。
肯定有小伙伴是写了公共方法,helpers文件中或base控制器中继承来处理正确数据返回。
肯定有小伙伴公司团队强制要求记录每个接口请求日志、响应日志。

那么,最好的处理位置,一定是中间件啦

新建After中间件:

<?php

namespace App\Http\Middleware;

use Closure;
use Illuminate\Http\JsonResponse;

class After
{
    /**
     * 记录响应日志,处理成功返回自定义格式
     *
     * @param  \Illuminate\Http\Request $request
     * @param  \Closure                 $next
     *
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        $response = $next($request);

        // 执行动作
        if ($response instanceof JsonResponse) {
            $oriData = $response->getData();

            $message = [
                'code'    => 0,
                'message' => 'success',
            ];

            $data['data'] = ($oriData->data ?? []) ? $oriData->data : $oriData;

            if ($oriData->current_page ?? '') {
                $data['meta'] = [
                    'total'        => $oriData->total ?? 0,
                    'per_page'     => (int)$oriData->per_page ?? 0,
                    'current_page' => $oriData->current_page ?? 0,
                    'last_page'    => $oriData->last_page ?? 0
                ];
            }

            if ($oriData->meta ?? '') {
                $data['meta'] = [
                    'total'        => $oriData->meta->total ?? 0,
                    'per_page'     => (int)$oriData->meta->per_page ?? 0,
                    'current_page' => $oriData->meta->current_page ?? 0,
                    'last_page'    => $oriData->meta->last_page ?? 0
                ];
            }

            $temp = ($oriData) ? array_merge($message, $data) : $message;

            $response = $response->setData($temp);
            iuLog('debug', 'Response Success: ', $response->getData());
            iuLog(PHP_EOL);
        }

        return $response;
    }
}

效果:

最基础的返回详情:
    public function show(Topic $topic)
    {
        return $topic;
    }

file

最基础的返回分页:
    public function index(Request $request, Topic $topic)
    {
        // 为了截图完整 只查 id 和 title 
        return $topic->paginate($request->per_page ?? 15, ['id', 'title']);
    }

file

使用API资源类的返回详情:
    public function show(Product $product)
    {
        return new ProductResource($product);
    }

file

使用API资源类的返回分页:
    public function index(Request $request, Product $product)
    {
        $list = $product->paginate($request->per_page ?? 15);

        // 这里把ProductResource的toArray()改了,为了截图只保留 id 和 title 

        return ProductResource::collection($list);
    }

file

最基础的只返回操作成功:
    public function update(Product $product)
    {
        return [];
    }

返回格式:空数组就ok啦
file

后记

我之前用的是在helpers函数中新建success(),successPaginate()等方法,使用API资源的时候,helpers中新建getPaginateMeta()方法,然后使用API资源类的additional()方法。
api资源分页的返回姿势是这样的

 $list = User::paginate($request->per_page ?? 15);

 return UserResource::collection(collect($list->items()))
            ->additional(getPaginateMeta($list));

这里的笔记是,很多人想要获得laravel分页的data(就是不包括link,meta这些数据的主数据),其实$list->items()就是了。
如果使用这些自定义辅助函数,我需要给多个辅助函数增加['code' => 0, 'message' => 'success'] ,给多个辅助函数增加记录日志的地方,而且自定义的辅助方法记日志好加,但api资源返回的日志就不好加了....

看下日志:iu.test 是本地环境啦,线上也ok的
file

《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

  • 请注意单词拼写,以及中英文排版,参考此页
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`, 更多语法请见这里 Markdown 语法
  • 支持表情,使用方法请见 Emoji 自动补全来咯,可用的 Emoji 请见 :metal: :point_right: Emoji 列表 :star: :sparkles:
  • 上传图片, 支持拖拽和剪切板黏贴上传, 格式限制 - jpg, png, gif
  • 发布框支持本地存储功能,会在内容变更时保存,「提交」按钮点击时清空
  请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!