PHP

PythonエンジニアがPHPフレームワークSymfonyをざっくり紹介する

普段私はPythonDjangoで書くことが多いのですが、先日PHPSymfonyを触る機会がありました。

そこで今回は、普段Djangoを使っている目線でのSymfonyの構成などをざっくりご紹介したいと思います。

  1. まずSymfonyとは?

Symphonyではありません。Google先生に頼っていて思うような検索結果が出ていないときは、結構な確率でタイポしていたりします。

Symfonyとは、PHPのフレームワークの一つです。

PHPのフレームワークというと、日本ではLaravelCakePHPがメジャーですが、海外ではSymfonyも幅広く使われています。

Symfonyの設計思想はMVCModel View Controller)です。

DjangoMTVModel Template View)ですね。

役割的には

  • Model データ
  • ViewSymfony), Template 画面に表示されるもの
  • Controller, ViewDjangoModelView(Symfony)やTemplateに渡す部分

ざっくり上記になっています。名前が違ったり被っていたりするので分かりにくいですが、大まかな考え方は近しい部分があります。

  1. Symfonyの構造

ディレクトリ構成は大まかに以下のような形になっています

紹介解説用に番号を振っています

0. sample

├── 1. app                    

  ├── 1-1. Resources

    └── 1-1-1. views     

  └── 1-2. config             

├── 2. bin                    

├── 3. src                    

  └── 3-1. SampleBundle      

    ├── 3-1-1. Controller          

    ├── 3-1-2. Entity     

    ├── 3-1-3. Form            

    ├── 3-1-4. Resources

        └── 3-1-4-1. views   

    ├── 3-1-5. Service

    └── 3-1-6. Validator

├── 4. var                    

└── 5. vendor         

└── 6. web    

  • 0 sample

プロジェクトディレクトリになります

  • 1 app

ここに、プロジェクト全体で使用する設定ファイル(yamlなど)や、初期表示のindex.htmlを入れたりします。

細かい表示制御やデータの加工など各ページで使用するソースは基本的にこのディレクトリには置きません

  • 2 bin

コンソールで使用するコマンドなどのファイルを格納します。

  • 3 src

BundleごとにソースコードやHTMLファイルを格納します。主に開発をする際触るのはここになるかと思います。

  • 3-1 SampleBundle

そもそもBundleって何?と思う方も多いかと思われます。

簡潔にまとめると、Bundleとは、データベースと関連付いたエンティティや、ソースコードやテスト、画面に表示するHTMLなどのファイルをひとところにまとめた機能の塊です。

Djangoで言うところのアプリケーションに近いものだと思うと、想像しやすいかもしれません。

Bundle単位で機能拡張ソースコードも多く公開されているので、取捨選択することで自分でコードを書かずとも色々な機能を組み込めるようになっています。

  • 3-1-1 Controller

Djangoで言うところのView部分です。画面表示するデータを制御したり、URLのルーティング制御を行います。

  • 3-1-2 Entity

データベースのテーブルに応じたEntityを格納する場所です。getter, setterを設定したり、更新時のシーケンスなど、データベースの接続の際の付加処理を設定します。Djangoの方がこの部分に記載する処理の幅は広くなりがちですが、各アプリのmodels.pyに記載するような、データベースに応じたオブジェクトを定義する場所です。

  • 3-1-3 Form

画面で使用するFormを設定する部分です。ここで、各項目のバリデーションも設定するのですが、細かいバリデーション処理はまた別途記載したります。Djangoでいう各アプリのforms.pyに近い役割を担っています。

  • 3-1-4 Resources

viewsディレクトリに、HTMLファイルを格納します。

また、Bundle固有で使う設定ファイルなどある場合は、ここに置いたりも。

  • 3-1-5 Service

Serviceだったりhelperだったり、Bundle内の位置付けで名称は多々あるかと。

Controllerでやるには複雑な処理や、細かいビジネスロジックを記載していく部分になります。

  • 3-1-6 Validator

文字通り、バリデーションを記述する部分です。ここでバリデーションクラスを作成し、formの方でインポートして各項目へのバリデーションを設定します。

  • 4 var

キャッシュファイルや、ログファイルを格納しておくディレクトリになります。

  • 5 vendor

ライブラリ一般を格納するディレクトリになります。

  • 6 web

Jscss、画像ファイルなど、画面上から見えるファイルを格納する場所です。Djangoでいうstaticのような役割です。

  1. Symfonyのメリット・特徴

個人的に使っていてSymfonyってここが面白い!と感じた部分を取り上げてみます。

  • 分業がしやすい

画面表示はここ、バリデーションはここ、formの生成内容はここ、と細かく記述ファイルが分かれているので、多人数で分業をする際はコンフリクトを減らしやすいかと思います。また、Bundleごとに切り分けて開発を進める事も出来るため、開発方法の幅が広がります。

  • テンプレート言語のTwigが使いやすい

Djangotemplate記法と近しい、Twigが使えます。画面上でオブジェクトをループさせてテーブルに値を入れ込んだり、if分岐で表示するものを変えたり、生のHTMLでは表現しにくい処理が簡潔に行えます。

  • Formを使う機能を補助する仕組みが協力

検索であったりデータの登録・更新、ログインと、formを使わないシステムはほぼ無いかと思われます。Symfonyでは、Validationクラスで細かく設定してのバリデーションや、entityをまるっとフォームに入れてそれを使用してデータの更新を行う事、また画面にレンダリングする際も、細かくlabelform本体の配置は行えます。使い方のルールがある程度定まっている事で、多人数での開発の際にソースの揺れを減らせる事もメリットだと思います。

今までSymfonyの名前も知らなかったのですが、使ってみると意外と馴染んだ部分もありました。

PHPのメリットでありデメリットでもある自由にコードが書ける(≒フォーマットの統一が難しい)という部分を、Symfonyの記法である程度統一規格を持たせ一貫性のあるソースに仕上げやすいという風にうまくカバーしていました。

日本でのシェアが広くない事もあり、ドキュメントは少ないのでそこはお気をつけください。

もしPHPで開発を行う事がありましたら、フレームワークの選択肢の一つに検討してみてはいかがでしょうか?

2016/09/19PHP

2ファイルでLAMP開発環境構築

LAMPでの開発を行う際、まず必要となるのがローカル開発環境の用意でしょう。
ローカル環境で開発を行い、
開発環境 => ステージング環境 => 本番環境
へと順々にソースコードを反映していくのが一般的なフローかと思います。

今回、一番手元である「LAMPローカル環境」の簡単な構築方法について初心者向けに紹介したいと思います。
タイトル通り「Vagrant + シェルスクリプト」で構築を行っていきますが、各バージョンは以下となります。


vagrant 2.2.3
virtualBox 6.0
centos 7.2
php 7.3
mysql 8.0

※執筆時点、極力最新版のもので統一させていただいております。


「Vagrant + シェルスクリプト」ということで、必要となるのは
Vagrantfile と シェルスクリプトの2つのみです。
ファイルのみの構成となるので、共有が非常に楽という利点があります。
イメージファイルではないので、サイズを気にすることもありません。

もちろん、Vagrantfileにシェルスクリプトを記述することもできますが、
別ファイルで定義したほうが見やすかったり再利用できたりもするので、別々に記述する手法を私はよく取ります。
(個人的にはこのほうが分かりやすいのかなと思っています)

それでは、順々に見ていきましょう。

1. 設定準備をしよう

まずは、以下からvagrantとVirtualBoxをインストールします。

[vagrant]

https://www.vagrantup.com/downloads.html

[virtualbox]

https://www.virtualbox.org/wiki/Downloads

インストールが完了したら Vagrantfile を設定していきます
適当なディレクトリで(執筆サンプルでは「dev」とします)

$ vagrant init

を実行し、Vagrantfileを作成します。
(あるいは、Vagrantfileを自分で作成します)
加え、「provision.sh」シェルスクリプトファイルを作成しておき、
構築確認用に「source」のディレクトリを作成、php_info.phpというファイルを作っておきましょう。中身は以下となります。

--php_info.php--

<?php
    phpinfo();
?>

ディレクトリ構成はこのような形になるでしょう
    dev(適当なディレクトリ)
      |----Vagrantfile
      |----provision.sh
      |----source(確認用ファイル設置ディレクトリ)
                |----php_info.php

2. Vagrantfileを設定しよう

Vagrantfileのの中身を以下のように記述します。


--Vagrantfile--

Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
  config.vm.define "centos7-web" do |web|
    web.vm.box = "centos7.2"
    web.vm.box_url = "https://github.com/CommanderK5/packer-centos-template/releases/download/0.7.2/vagrant-centos-7.2.box"
    web.vm.hostname = "centos7-web"
    web.vm.network :private_network, ip: "192.168.33.10"
    web.vm.provision :shell, :path => "provision.sh",:privileged => true
    web.vm.synced_folder "./source" , "/var/www/html/source"
  end
end

------------------------------------------------------------------------------------------------------------

順にみていきましょう

1. VAGRANTFILE_API_VERSION = "2"
  設定構文のバージョン番号を定義します。
  現状(2019年1月執筆時点)vagrantのバージョン1.1以降は"2"を設定するようにします。

2. Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
  構文についてはインデントでブロックを表しています。endで終了です。
  サンプルでは、configブロックとwebブロックがあります。webブロックを順に追っていきましょう。

3. web.vm.box = "centos7.2"
  vagrant box add を意味します。centos7.2の名前で追加をします(名前は自由につけて大丈夫です)

4. web.vm.box_url = "https://github.com/CommanderK5/packer-centos-template/releases/download/0.7.2/vagrant-centos-7.2.b
  追加するボックス(サンプルではcentos7.2)がなかった場合、指定したURLから取得しにいきます

5. web.vm.hostname = "centos7-web"
  ホスト名を指定します。未指定ですと、どんな仮想マシンに接続しているのか分かり難いので指定しましょう。

6. web.vm.network :private_network, ip: "192.168.33.10"
  IPアドレスを指定します。空きのあるアドレスを指定しましょう。


7. web.vm.provision :shell, :path => "./provision.sh",:privileged => true
  vagrant起動時にシェルスクリプトを実行させます(サンプルでは、同階層の「provision.sh」を実行します)。
  本記事のキモとなる箇所です。root権限で実行させるためにも「:privileged => true」を記述しておきます

web.vm.synced_folder "./source" , "/var/www/html/source"
  第1引数:同期をとりたいディレクトリを指定します。(サンプル同階層の「source」ディレクトリと同期をとります)
  第2引数:仮想マシン内に設置するパスを指定します。
  

3. シェルスクリプトを設定しよう

vagrant起動時に実行するシェルスクリプトの内容を記述します。
シェルスクリプトについては、必要に応じてインストールしたいものを追加していきましょう。
今回の場合は、Apache、MySQL、PHPをインストールしていきます。サンプルは以下となります。
--provision.sh--

#!/bin/sh

# epalとremiをそれぞれをインストール
yum -y install epel-release
rpm -Uvh http://rpms.famillecollet.com/enterprise/remi-release-7.rpm

# apacheインストール
yum -y --enablerepo=remi install httpd

# php7.3インストール
yum -y install --enablerepo=remi,remi-php73 php php-devel php-mbstring php-pdo php-gd php-xml php-mcrypt

# phpのタイムゾーンをUTCにする
sed -i -e "/;date\.timezone /a date\.timezone = 'UTC'" /etc/php.ini

# phpのerror_logを出力させる
sed -i -e "s/;display_errors\ =\ Off/display_errors = On/g" /etc/php.ini
sed -i -e "s/;error_log\ =\ php_errors.log/error_log\ =\ '\/var\/log\/php\/error.log'/g" /etc/php.ini
mkdir /var/log/php/
touch /var/log/php/error.log
chown apache:apache /var/log/php/error.log

# mysql8インストール
yum -y remove mariadb-libs
yum -y remove mysql*
rpm -ivh https://dev.mysql.com/get/mysql80-community-release-el7-1.noarch.rpm
yum -y install mysql-community-server

# mysqlの文字セットをUTF8にする
sed -i -e "/\[mysqld\]/a character-set-server=utf8" /etc/my.cnf
sed -i -e "/\[mysqld_safe\]/i \[mysql\]\ndefault-character-set = utf8" /etc/my.cnf

# 利用するサービスを開始する
systemctl enable httpd.service
systemctl enable mysqld.service
systemctl restart httpd
systemctl restart mysqld.service

# セットアップ終了
echo "COMPLETE!"


------------------------------------------------------------------------------------------------------------

4. vagrantを起動しよう

設定が完了したら、
$ vagrant up
を実行し、しばらく待ちましょう。

完了後(上記のように「COMPLETE!」表示で完了です。シェルで記述したmysqlインストール→「COMPLETE!」が動いています)
http://192.168.33.10/source/php_info.php
にアクセスし、php情報が表示されていればOKです

5. おわりに

如何でしたでしょうか。
2ファイルで容易に「ローカル環境」が作成できたかと思います。
この2つを用いることで手軽に環境構築/破壊が気軽に行えます。
試行錯誤を手軽さに行えるので非常に便利です。
この手軽さは、これからphpを始めてみようと思う方に特におすすめなのではと。

以上、phpエンジニアの簡単な紹介でした。乱文長文、失礼しました。

2016/09/19PHP
1