Hapicode

# Laravel を API サーバーとしての初期設定

Laravel とは

Laravel は、2011 年に Taylor Otwell によって開発されたオープンソースの PHP Web アプリケーションフレームワークです。
エレガントな構文と優れた開発体験と効率的な Web アプリケーションの構築ができることで世界から人気を得ています。

Laravel の特徴

  • MVC アーキテクチャ
    Laravel は、モデル-ビュー-コントローラー（MVC）アーキテクチャを採用しています。これにより、ビジネスロジックとデータベース操作を分離し、柔軟性と保守性を向上させます。

  • ルーティング
    Laravel のルーティングシステムは、URL とコードのマッピングを簡単に行うことができます。ルーティングは、クライアントからのリクエストを正しいコントローラーとアクションにルーティングします。

  • ORM（Object-Relational Mapping）
    Laravel の ORM である Eloquent は、データベースとの対話を簡素化し、データベースレコードをオブジェクトとして扱うことができます。

  • ビュー
    Laravel のビューシステムは、Blade と呼ばれるテンプレートエンジンを使用しています。Blade テンプレートは、PHP のコードと組み合わせて柔軟なビューレンダリングを実現します。

  • セキュリティ
    Laravel は、CSRF（クロスサイトリクエストフォージェリ）対策や XSS（クロスサイトスクリプティング）対策など、セキュリティに関する標準的な機能を提供しています。

  • 認証と認可
    Laravel は、ユーザーの認証と認可を簡単に実装するための機能を提供しています。ユーザーの登録、ログイン、パスワードリセットなどの機能を簡単に実装することができます。

Laravel は、開発者の生産性を向上させるために設計されており、優れたドキュメントやアクティブなコミュニティなど、豊富なリソースが利用できます。そのため、多くの開発者によって広く採用されています。

# Laravel インストール

composer create-project laravel/laravel laravel-api-server

composer があれば一行で Laravel プロジェクトのインストールができます。

# Sail インストール

ローカルにある PHP 使って開発するのもできますが、Laravel Sail という Docker ツール利用して開発します。
Composer を使用して Sail をインストールします。

composer require laravel/sail --dev

php artisan sail:install

Docker で PHP と Composer 使う方法

Composer

docker run --rm -v $(pwd):/app composer --version
# Composer version 2.4.4 2022-10-27 14:39:29

PHP

docker run --rm -v $(pwd):/app php -v

# PHP 8.1.13 (cli) (built: Nov 29 2022 02:43:34) (NTS)
# Copyright (c) The PHP Group
# Zend Engine v4.1.13, Copyright (c) Zend Technologies

sail を立ち上げる

./vendor/bin/sail up

Sail エイリアスを貼る

Sail のコマンドをより簡単に実行できるようなシェルエイリアスを設定

alias sail='[ -f sail ] && sh sail || sh vendor/bin/sail'

~/.zshrc や ~/.bashrc へ追加後、シェルを再起動

# Sail にサービス追加

sail artisan sail:add

# ┌ Which services would you like to install? ───────────────────┐
# │ › ◼ mysql                                                  ┃ │
# │   ◻ pgsql                                                  │ │
# │   ◻ mariadb                                                │ │
# │   ◻ redis                                                  │ │
# │   ◻ memcached                                              │ │
# │   ◻ meilisearch                                            │ │
# │   ◻ minio                                                  │ │
# │   ◻ mailpit                                                │ │
# │   ◻ selenium                                               │ │
# │ › ◻ soketi
# └────────────────────────────────────────────────── 1 selected ┘
#  Use the space bar to select options.

# Sail でコマンドいろいろ


# Laravel Sail の中で Artisan コマンドを実行

sail artisan queue:work

# PHP バージョン確認

sail php -v

# Composer コマンドインストール

sail composer require laravel/sanctum

# コンテナ CLI

sail shell

# コンテナ CLI Root 権限

sail root-shell

# docker ディレクトリに Sail 独自の Dockerfile をリソース公開

sail artisan sail:publish

# タイムゾーン & デフォルト言語設定

日本でシステム運営するなら、タイムゾーンと言語を日本の時間と言語に合わすべき

作業ファイル config/app.php

return [
    // アプリケーションデフォルトのタイムゾーン設定
    // PHPの日付および日時関数を使用する際にこの設定を参照
    'timezone' => 'Asia/Tokyo',

    // 翻訳サービスプロバイダーが使用するデフォルトのロケールを設定
    'locale' => 'ja',

    // フォールバックロケールは、指定したロケールが使用できない場合に使用するロケールを決定
    'fallback_locale' => 'ja',

    // FakerPHPライブラリがデータを生成する際に使用
    'faker_locale' => 'ja_JP',
],

タイムゾーン変更後の時間確認

php artisan tinker
>>> echo Carbon\Carbon::now();
# 2022-09-07 12:00:00　 //変更前
# 2022-09-07  21:00:00   //変更後

テストしてないけど、locale を日本語化にするならファイルダウンロードする必要があるようです。

日本語ファイルをダウンロード

php -r "copy('https://readouble.com/laravel/6.x/ja/install-ja-lang-files.php', 'install-ja-lang.php');"
php -f install-ja-lang.php
php -r "unlink('install-ja-lang.php');"

# DB 周りの設定

config/database.php




 
 




return [
    'connections' => [
        'mysql' => [
            'charset' => 'utf8mb4',
            'collation' => 'utf8mb4_ja_0900_as_cs_ks',
        ],
    ],
];

'charset' => 'utf8mb4' 文字コードは 1 文字最大 4 バイトを使用し、絵文字をサポート
'collation' => 'utf8mb4_ja_0900_as_cs_ks' 照合順序はアクセント記号(清音濁音半濁音)、大文字小文字(拗音促音など)、ひらがなとカタカナを判別

# env 設定

以前のバージョンでは key を generate する必要があったが、いつの間に Laravel インストールしたら自動生成するよう便利になりました。

# DB 接続情報

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=laravel
DB_USERNAME=root
DB_PASSWORD=password

Sail 使って Docker Compose でコンテナ作成する際に env にある DB 接続情報を元に Mysql サーバー作成してくれます。

# セッションタイムアウト値 SESSION_LIFETIME

env ファイル env.example ファイル両方変更

# デフォルトは 120 (2時間)
# 1440 (１日)
# 10080 (１週間)
# 43800 (1ヶ月)
# 525600 (１年)
SESSION_LIFETIME=10080

# APP_NAME

APP_NAME というアプリネームを設定します。

# composer.json 設定

プロジェクト名、プロジェクトの説明、ライセンスを記入





 


{
  "name": "laravel-app",
  "type": "project",
  "description": "プロジェクト説明",
  "license": "proprietary"
}

プライベート開発の場合 proprietary と明示

# エディター　.editorconfig 設定

EditorConfig (opens new window)

## EditorConfig is awesome: https://EditorConfig.org

## top-most EditorConfig file
root = true

## Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true

## Matches multiple files with brace expansion notation
## Set default charset
[*.{js,php}]
charset = utf-8

## 4 space indentation
[*.php]
indent_style = space
indent_size = 4

## Tab indentation (no size specified)
[Makefile]
indent_style = tab

## Indentation override for all JS under lib directory
[lib/**.js]
indent_style = space
indent_size = 2

## Matches the exact files either package.json or .travis.yml
[{package.json,.travis.yml}]
indent_style = space
indent_size = 2

# filesystems の設定

# storage 公開

必要に応じて filesystems 設定ファイルに含まれている public ディスクは、パブリックに公開してアクセスできるようシンボリックリンクを貼る。
デフォルトでは、public ディスクは local ドライバを使用し、そのファイルを storage/app/public に保存

php artisan storage:link

シンボリックリンクを作成したら、asset ヘルパを使用してファイルへの URL を作成できます。

echo asset('storage/file.txt');

# FTP ドライバの設定

FTP ドライバを使用する前に、Composer パッケージマネージャを使用し、Flysystem FTP パッケージをインストールする必要があります。

composer require league/flysystem-ftp "^3.0"

config/filesystems.php

'ftp' => [
    'driver' => 'ftp',
    'host' => env('FTP_HOST'),
    'username' => env('FTP_USERNAME'),
    'password' => env('FTP_PASSWORD'),

    // オプションのFTP設定
    // 'port' => env('FTP_PORT', 21),
    // 'root' => env('FTP_ROOT'),
    // 'passive' => true,
    // 'ssl' => true,
    // 'timeout' => 30,
],

# SFTP ドライバの設定

composer require league/flysystem-sftp-v3 "^3.0"

config/filesystems.php

'sftp' => [
    'driver' => 'sftp',
    'host' => env('SFTP_HOST'),

    // 基本認証の設定
    'username' => env('SFTP_USERNAME'),
    'password' => env('SFTP_PASSWORD'),

    // 暗号化パスワードを使用するSSHキーベースの認証の設定
    'privateKey' => env('SFTP_PRIVATE_KEY'),
    'password' => env('SFTP_PASSWORD'),

    // オプションのSFTP設定
    // 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'),
    // 'maxTries' => 4,
    // 'passphrase' => env('SFTP_PASSPHRASE'),
    // 'port' => env('SFTP_PORT', 22),
    // 'root' => env('SFTP_ROOT', ''),
    // 'timeout' => 30,
    // 'useAgent' => true,
],

# その他

  • 開発のコーディングルールを決める

php 開発におけるコーディングルール・規約 (opens new window)

複数人で開発する際に、開発ルールを前もって決めた方がトラブルを回避できます。

  • GitHub Actions

Github 使うなら必ずというほど、自動デプロイや自動テストの実装をします。

  • Socialite のインストール

コミュニティログインで使えるソーシャルプロバイダー管理ライブラリ

composer require laravel/socialite

Socialite Providers (opens new window)

2023-09-15
  • php
  • laravel

関連記事

Laravel メンテナンスモード

Laravelのメンテナンスモードの使い方 Artisan down コマンド使ってメンテナンスモー...

Laravel model で hidden に設定したカラムを一時解除

Laravel モデルにhiddenで非表示になったカラムを一時的に表示するように変更しました。...

Laravel でカテゴリー作成 テーブル構築と再帰クエリ

カテゴリ関係を管理するためのテーブルを設計...

Laravel Queue で非同期処理

Queue処理のメリットとLaravel Queue使って一括処理の例をまとめ...

Laravel notification メール通知カスタマイズ

Laravelの通知（Notification）機能を使ってメール送信する作業があったので、まとめま...

Laravel lang バリデーションメッセージを多言語対応

Laravelバリデーションのエラーメッセージを多言語で対応する手順を紹介...

Laravel リクエストログ出力

Laravelでリクエストログを出力する手順をまとめました。...

Laravel 429 Too Many Requests

Laravel 19使ってAPIサーバー構築とフロントはReact nextjsで構築しています。複...

Laravel Email バリデーションについて

Laravel Validation Email チェックする際の注意点、バリデーションルールオプシ...

Laravel Sanctum 使って API トークン JWT 認証と SPA 認証

Laravel JWT APIトークンの仕組みと Laravel Sanctum SPA認証使って認...

AWS SES メール開封確認　 DB に集計

メール送信の開封確認して DB更新するために使う AWS サービス SES SNS LAMBDA と...

Laravel logger でエラーログを chatwork に自動送信

Laravel 使ってエラー発生した場合、chatworkにエラー内容をリアルタイムで連絡するcha...

php CSV データ取得は fgetcsv 使う

PHP csvアップロードしてデータインポート作業がありましたが、fgetcsv使ってcsv処理につ...

Laravel tinker 使って DB データベース接続とコマンド

Laravel tinker REPLツール使ってDBアクセス、環境確認など対話式で楽しく遊べる...

Laravel Test についてのメモ

Laravel自動テスト行う際のコマンドと設定 faker 使ってデータ生成...

Laravel Log の基本設定＆使い方

Laravel Logの基本設定 エラー発生時にslackに連絡通知する設定方法 tailコマンド使...

Exception: Class 'ZipArchive' not found

エクセル操作でZipArchive classが見つからないエラーがあったので、対応しました。...

Laravel Sail で Docker 環境構築

Laravel Sail で Docker 開発環境PHP Mysql phpMyAdmin構築 s...

PHP 文字列長さ・文字列の幅を取得方法

PHP 文字列操作関数 マルチバイト文字列日本語韓国語中国語の長さ取得など...

Codeigniter 画像アップロードとリサイズ

Codeigniter アップロード画像リサイズと回転するなど画像操作するライブラリの使い方...

Laravel Lumen Faker 日本語設定

Laravel Faker 日本語化設定 fakerphpの使い方とよく使うオプション 名前や住所の...

laravel method の基本 get post put options

Laravel Routeでget post メソッド同時に設定したい！Laravel ルート制約の...

Laravel schedule 設定

Laravel スケジュール管理の基本とtimezone設定などlaravel 8最新メソッド説明...

Class 'Imagick' not found Error

phpで画像操作したらimagickエラーで動かなくなったため、imagickモジュールをインストを...

Laravel eloquent model の規約

最新Laravel開発eloquent model設定資料まとめ...

PHP mbconvertkana 全角半角英数カナ変換

php カナコンバートなら mb_convert_kana を使う！全角半角、英数字や記号など簡単に...

Codeigniter APPPATH BASEPATH FCPATH 各種パスと URL 取得

codeigniter host url取得方法と APPPATH BASEPATHの意味を紹介...

Laravel timestamp() auto update 有効化無効化

Laravel updated_at timestamp自動にしたい！MysqlはすぐにできるけどS...

Lumen8 で JWT ユーザー認証

Lumen8でJWT認証のAPIサーバー構築してみた、便利になった時代だなあ...

Laravel toSql パラメータ付きで出力

Laravel Query Builder toSqlで出力したsql文にパラメータを自動でセット...

Lumen8 で API 開発

codeigniter 愛用者がLumenでAPIサーバーを立ててみた...

php Exception エラーキャッチでメール送信

エラーメッセージ、エラーコード、エラー詳細取得、php例外処理exceptionのいろいろ...

Smarty HTTP URL 取得できるサーバー関数

スマーティで取得するサーバー関数URLとenvなど...

Laravel blade foreach loop と current url

laravel blade foreach loop変数とurlのプロパティ対照表...

laravel session を制する

laravel sesssion 使い方を紹介、読込保存削除を使えるようになったらsession制覇...

PHP empty isset is_null の違い

PHP empty, isset, is_nullの違い よく使うPHP isset と if の違...

PHP 8 リリース新機能と変更

php8がリリースされたので、新機能と特徴などの資料まとめました。25周年迎えたPHPは更に速いプロ...

FlattenException deprecated

laravelバージョンアップ作業する際にFlattenException deprecatedにつ...

php.ini 初期設定のいろいろ

php ini ローカル環境や新規リモート環境の初期設定...

Laravel 5.1 から 8.1 にバージョンアップ

laravel5 から8にアップグレードする際に遭遇したエラーとカスタマイズauth認証の設定を修正...

PHP 7.4 にアップグレードして使えなくなる機能

php 5 から php7.4 にアップする作業があったので、アップグレード時のエラーと7.4では動...

開発時によく使うゼロ埋めパディング作業まとめ

mysql twig phpとjavascriptでよく使うゼロ埋めのいろいろ...

解決！phpMyAdmin テーブル構造の内容が表示されない問題

phpmyadmin5.0.1のxampp入れたら テーブル構造メニューが真っ白になって表示されない...

Composer コマンドとオプション

composer install updateの違い post-install-cmdとpost-u...

爆速軽量フレームワーク codeigniter PHP 開発

ルーター設定もなく、初期設定も少ない！軽量と爆速で動いてくれるフレームワーク codeigniter...

Lumen と Laravel 違い比較

軽量で速いマイクロフレームワークlumenとlaravelの違い、使い方比較と本当にlumen必要か...

HTML から PDF に変換 PHP ライブラリ mPDF の設定

HTMLレンダリングしてPDFに変換出力するライブリmpdfを使いこなせるための設定いろいろ...

twig 3 人気 PHP テンプレートエンジンがバージョンアップ

以前からtwigテンプレートエンジン使っていて、非常にパワーフルで使いやすさに魅了しました。15日に...

Laravel Error についてのメモ

laravelを使う時に出てくるエラー対応...

laravel に vuejs 使うための初期設定

PHPフレームワークlaravelにvuejs入れる時の初期設定まとめ、備忘録的...

php curl 使って クリックなしで POST 送信

PHP curl_setopt使ってシンプルにデータ転送してpost投げます。PHPは本当に短いソー...

allowurlinclude の設定で ftp_connect()エラー

FTPサーバーとやりとりする時にftp_connect()エラーが発生、PHP７にアップしたばかりで...

Carbon で php date 日付の日数・月数差を計算

Laravel Carbonは、DateTimeクラスよりもシンプルで読みやすいコードを書くことがで...

codeigniter email ライブラリでメール送信 日本語対応

codeigniterメール送信で日本語文字化け対策、改行コードとSMTP項目設定...

nuxtjs と codeigniter で jwt システム構築

nuxtjsとcodeigniterでシステム構築する際のメモ...

正規表現一覧 よく使う検索・置換のパターン

よく使う正規表現、文字検索・置換をまとめてみました。...

Apache 初期設定メモ

LAMP環境のApache初期設定メモ...

開発におけるコーディングルール・規約

コーディングルールと規約を大事にする、複数人で開発しても、一人で開発してもメンテナンスやコードのわか...