공개 이슈 gnuboard/g7 이 지목한 병목은 "같은 일을 반복 실행한다" 축이다. 응답·행의 무게를 다룬 · 과 겹치지 않는다. 공통 계약 — 총 건수 상한과 페이지 이동 범위는 별개 결정이다. 묶으면 필요 없이 기능이 깎인다. 총 건수만 상한을 받고(파생 테이블 COUNT), "다음" 이동은 per_page + 1 실측으로 끝까지 열어 둔다. 계산이 불가능해지는 것은 마지막 페이지 번호 하나뿐이며 그 사실은 last_page: null 이 알린다. 최신순처럼 실제 컬럼으로 정렬하는 목록은 커서로 전환해 깊이와 무관하게 일정 속도로 이동한다. 관련도순은 계산값 정렬이라 커서 키로 쓸 수 없어 offset 을 유지한다. 계약의 입구는 표준 paginate 와 같은 폭이어야 한다. 관계·쿼리 빌더를 받지 못하면 그 좁은 만큼이 그대로 운영 500 이 되고, 실제로 관리자 알림 목록에서 그렇게 터졌다. 응답 조립도 컬렉션마다 손으로 하면 형태가 늘어나는 순간 없는 값을 부르거나 새 필드를 흘리므로, 형태 판정을 paginationMeta 한 곳에 모았다. 표준 paginate 응답은 필드 단위로 이전과 동일하다. 요청당 반복 비용 — 훅 구독마다 남기던 로그 400줄, 요청당 스무 번 넘던 설정 파일 재읽기, 이미 캐시된 목록의 DB 재조회를 없앴다. 권한 판정은 요청 스코프 메모를 두어 화면 요소마다 나가던 조회를 한 번으로 줄였고, 크로스 요청 캐시는 두지 않아 권한 변경이 종전처럼 다음 요청에 반영된다. 검색 질의는 활성 엔진이 만든다. 저장소가 구체 엔진을 지목하면 플러그인이 등록한 엔진은 호출될 기회 자체를 잃고 오류 없이 다른 방식으로 동작한다. 해석기를 두어 활성 엔진에 위임하고, 전문검색이 없는 DBMS 의 부분일치 폴백도 드라이버명 하드코딩 대신 선언형 config 로 옮겼다. 총 건수가 잘린 목록에서 순번을 역산하면 0 과 음수가 나온다. 지어내지 않고 null 을 돌려주며, 그 원칙을 last_page 와 동일하게 적용했다.
94 lines
3.0 KiB
PHP
94 lines
3.0 KiB
PHP
<?php
|
|
|
|
namespace App\Http\Controllers\Api\Base;
|
|
|
|
use App\Contracts\Extension\CacheInterface;
|
|
use Illuminate\Support\Facades\Log;
|
|
|
|
/**
|
|
* 공개 API용 베이스 컨트롤러
|
|
*
|
|
* 인증이 필요하지 않은 공개 API 컨트롤러가 상속받아야 하는 기본 클래스입니다.
|
|
* 캐싱, 속도 제한, API 사용량 추적 등의 기능을 제공합니다.
|
|
*/
|
|
abstract class PublicBaseController extends BaseApiController
|
|
{
|
|
public function __construct()
|
|
{
|
|
// 공개 API는 속도 제한 없음 (무제한 접근 허용)
|
|
}
|
|
|
|
/**
|
|
* 캐시된 응답을 반환하거나 새로 생성합니다.
|
|
*
|
|
* 주의: 콜백 반환값이 배열이고 `error` 키가 있으면 캐시하지 않는다.
|
|
* 이는 확장 설치 직후·활성화 전 등의 일시적 상태에서 얻은 "not found" 같은
|
|
* 에러 응답이 영구 캐시되어 복구 후에도 잘못된 응답을 반환하는 문제를 방지한다.
|
|
*
|
|
* @param string $key 캐시 키
|
|
* @param callable $callback 데이터 생성 콜백
|
|
* @param int $ttl 캐시 유지 시간 (초)
|
|
* @return mixed
|
|
*/
|
|
protected function cached(string $key, callable $callback, int $ttl = 3600)
|
|
{
|
|
$cache = app(CacheInterface::class);
|
|
|
|
$cached = $cache->get($key);
|
|
if ($cached !== null) {
|
|
return $cached;
|
|
}
|
|
|
|
$result = $callback();
|
|
|
|
// 에러 응답은 캐시하지 않음 (일시적 상태 회복 가능성 보장)
|
|
if (! (is_array($result) && isset($result['error']))) {
|
|
$cache->put($key, $result, $ttl);
|
|
}
|
|
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* API 사용량을 기록합니다.
|
|
*
|
|
* @param string $endpoint 엔드포인트
|
|
* @param array $data 관련 데이터
|
|
* @return void
|
|
*/
|
|
protected function logApiUsage(string $endpoint, array $data = []): void
|
|
{
|
|
// TODO: API 사용량 통계 시스템 구현
|
|
//
|
|
// 호출 지점은 레이아웃·확장 번들·정적 자산처럼 페이지 로드마다 여러 번 열리는
|
|
// 공개 엔드포인트다. 통계 시스템이 서기 전까지 이 자리가 요청마다 로그 파일에
|
|
// 줄을 쌓지 않도록, 디버그 모드에서만 기록한다. 기본 설치는 APP_DEBUG=false 이므로
|
|
// 아무것도 쓰지 않는다.
|
|
if (! config('app.debug')) {
|
|
return;
|
|
}
|
|
|
|
Log::debug("Public API Usage: {$endpoint}", [
|
|
'ip' => request()->ip(),
|
|
'user_agent' => request()->userAgent(),
|
|
'data' => $data,
|
|
'timestamp' => now(),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* 클라이언트 정보를 가져옵니다.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function getClientInfo(): array
|
|
{
|
|
return [
|
|
'ip' => request()->ip(),
|
|
'user_agent' => request()->userAgent(),
|
|
'referer' => request()->header('referer'),
|
|
'timestamp' => now(),
|
|
];
|
|
}
|
|
}
|