Laravel 和 PHP：返回特殊格式的 JSON答案

【问题标题】：Laravel & PHP: Return special formatted JSONLaravel 和 PHP：返回特殊格式的 JSON
【发布时间】：2015-08-26 12:34:59
【问题描述】：

进行查询后，我如何创建和回显这样的格式化 JSON：

{
  "results": [
    {
      "user_id": "1",
      "name": "Apple",
      "address": "7538 N LA CHOLLA BLVD",
      "city": "Palo Alto",
      "state": "CA",
      "latlon": [
        -111.012654,
        32.339807
      ],
    },
    {
      "user_id": "2",
      "name": "Microsoft",
      "address": "75 S BWY STE 400",
      "city": "Palo Alto",
      "state": "CA",
      "latlon": [
        -73.764497,
        41.031858
      ],
    },
   ],

  "meta": {
    "page": 1,
    "per_page": 10,
    "count": 493,
    "total_pages": 50
  }
}

这是我当前的查询：

public function getAgenciesJson() {

    $agencies = DB::table('users')->where('type','a')->orWhere('type','l');

}

考虑到我有一个像 [-111.012654,32.339807] 这样的“latlon”字段，还有一个“results”标签和一个“meta”标签，还没有想出如何输出这样的 JSON。

提前致谢

【问题讨论】：

我否决了所有未考虑您要求预先格式化 json 以使用“结果”和“元”的答案。似乎现在没有人正确地阅读问题。 @espadav8 使用转换器（或演示者）有一个很好的解决方案。
只是好奇你为什么使用DB::table('users')而不是通过模型Users::where('type', 'a')->orWhere('type', 'l')访问表格。

标签： php mysql json laravel

【解决方案1】：

您需要一种称为转换器（或演示器）的东西，将您的原始模型转换为可以发送给用户的格式。

Phil Sturgeon 称为 Fractal (http://fractal.thephpleague.com/) 的一个非常流行的包。有一个 Laravel 包，它可能会使其更易于使用，称为 Larasponse (https://github.com/salebab/larasponse)。

Phil 实际上就在前几天发表了一篇关于此的博客文章 - https://philsturgeon.uk/api/2015/05/30/serializing-api-output/ - 这说明了为什么您应该始终在模型和发送给用户的内容之间使用某种转换器。

这里还有一个关于使用 Larasponse 和 Fractal 的指南 - http://laravelista.com/laravel-fractal/。

它的要点归结为将模型传递给另一个类，该类将获取模型值并以已知/固定格式构建数组/对象，例如（来自 Phil 的博文）

return [
    'id'      => (int) $book->id,
    'title'   => $book->title,
    'year'    => (int) $book->yr,
    'author'  => [
        'name'  => $book->author_name,
        'email' => $book->author_email,
    ],
    'links'   => [
        [
            'rel' => 'self',
            'uri' => '/books/'.$book->id,
        ]
    ]
];

这样您就不会暴露您的原始字段名称，并且如果您的列名称在任何时候应该更改，您只需要在一个地方更新它，而不必让您的 JSON 的任何用户更新他们的网站/应用程序。它还允许您对 latlon 列进行字符串操作，以便将其拆分为 2 个不同的值。

使用 Fractal 文档中稍作修改的示例。假设您有一个用户转换器

class UserTransformer extends Fractal\TransformerAbstract
{
    public function transform(User $user) 
    {
        return [
            'id' => (int) $user->id,
            'name' => $user->first_name . ' ' . $user->last_name,
        ];
    }
}

然后您可以使用这个类来转换集合中的单个项目

$user = User::find(1);
$resource = new Fractal\Resource\Item($user, new UserTransformer);

// Or transform a collection
// $users = User::all();
// $resource = new Fractal\Resource\Collection($users, new UserTransformer);

// Use a manager to convert the data into an array or json
$json = (new League\Fractal\Manager)->createData($resource)->toJson();

Fractal 包含一个用于 Laravel 的分页器适配器，可以立即使用

$paginator = User::paginate();
$users = $paginator->getCollection();

$resource = new Collection($users, new UserTransformer);
$resource->setPaginator(new IlluminatePaginatorAdapter($paginator));

【讨论】：

请添加更多信息，如何将转换器与集合协作使用，而不是仅使用一个模型实例，包括 TS 要求的元数据。顺便说一句，答案很好。
关于集合/元的信息有多少是好的？ Fractal 的文档解释了这一切，并且添加到答案中大多只是复制它（可以吗？）。
链接更糟糕，因为远程源可能会改变。您还可以调整代码以适应问题中的参数/对象。

【解决方案2】：

方法存在：

->toJson()

参考号：http://laravel.com/docs/4.2/eloquent#converting-to-arrays-or-json

将您的 getAgenciesJson 更新为：

public function getAgenciesJson() {

    return DB::table('users')->where('type','a')->orWhere('type','l')->toJson();

}

然后你可以通过以下方式回显：

<?= SomeModel::getAgenciesJson(); ?>

要修改列名，您可以更新您的选择。以下是取自 Laravel 文档的示例：

$users = DB::table('users')->select('name as user_name')->get();

这将是您正在寻找的减去列别名的更完全实现的版本，因为您没有真正提及它们是什么。

public function getAgenciesJson($page, $per_page = 10) {
   $output = [
        'results' => [],
        'meta'    => [],
    ];

    // Get Results
    $output['results'] = DB::table('users')->where('type','a')->orWhere('type','l')->take($per_page)->skip($per_page * ($page - 1))->get();

    // Set Meta
    $output['meta'] = [
        'page'        => $page,
        'per_page'    => $per_page,
        'count'       => DB::select('SELECT FOUND_ROWS()'),
        'total_pages' => DB::table('users')->count() / $per_page        
    ];

    // Return
    return json_encode($output);
}

您的原始代码并未尝试获取或处理分页信息，但此示例涵盖了这些信息，以便提供您表示希望返回的元数据。

不确定您是否希望 Count 成为当前结果集的数量或该表上所有记录的数量。如果您不想要当前设置，而是想要整个计数，您可以使用 DB::table('users')->count() 尽管我会将它分配给一个变量并使用它而不是在元信息。

【讨论】：

谢谢，但是有什么方法可以指定字段名称，使它们与我的表格中的不同，人们看不到它们是如何被调用的，或者只是为了自定义过程。另外，“latlon”字段看起来像一个数组，但在我的桌子上我有一个像“1.5435345,6.143244”这样的普通字符串，也是“元”字段。
查看我的最新编辑以选择列名作为别名。您的 latlon 应该以字符串的形式出现，您用来解析测试数据的任何内容都可能导致它的格式错误。尝试使用上面的 mod 来呼应它。
谢谢，试试这个
已更新以适应使用结果和元数据的 json 格式。您可以使用我之前提到的 ->select('column_name as alias_name') 更新结果查询。

【解决方案3】：

public function getAgenciesJson() {

    $agencies = DB::table('users')->where('type','a')->orWhere('type','l')->get();
    return response()->tojson($agencies,200);//for response with status code 200
}

您应该调用 get 函数来获取数组格式的数据，并且响应函数会将您的输出格式化为 json。第二个参数表示您必须为响应分配哪个状态代码。

【讨论】：