Netbeansでのライセンスヘッダーのカスタマイズ

Netbenasにおいて、ソースコードのファイルを新規に追加した際に自動付与されるライセンスヘッダーをカスタマイズする方法を紹介します。

 

まず、ライセンスヘッダーの文章を作成します。[ツール]-[テンプレート]を選択します。

標準で、各種ライセンス用のライセンスヘッダーの文章が用意されています。自身でライセンスヘッダーの文章を作成したい場合はデフォルト・ライセンスを編集するか新規に追加します。

Netbeans-Tool-Template-License

 

ライセンスヘッダーの文章には、テンプレートバリアブルを埋め込むことで、ファイル生成時に自動的にファイル名称や

日時等を埋め込むことが可能です。利用可能なテンプレートバリアブルの一覧はNetbeansの公式サイトで紹介されているます(FaqTemplateVariables)。
下記に、auxakのソースコードのライセンスヘッダーのテンプレートをサンプルとして示します。

<#if licenseFirst??>
${licenseFirst}
</#if>
${licensePrefix}======================================================================
${licensePrefix}Project Name    : ${project.name}
${licensePrefix}File Name       : ${nameAndExt}
${licensePrefix}Encoding        : ${encoding}
${licensePrefix}Creation Date   : ${date}
${licensePrefix?replace(" +$", "", "r")}
${licensePrefix}Copyright © ${date?date?string("yyyy")} auxak. All rights reserved.
${licensePrefix?replace(" +$", "", "r")}
${licensePrefix}This source code or any portion thereof must not be
${licensePrefix}reproduced or used in any manner whatsoever.
${licensePrefix}======================================================================
<#if licenseLast??>
${licenseLast}
</#if>

ライセンスヘッダーは、プロジェクト毎に切り返ることも可能です。テンプレートから選択する場合は、グローバル・ライセンスのドロップダウンリストから任意のライセンスヘッダーを選択します。

特定のテキストファイルをライセンスヘッダーに利用することも可能です。

netbeans-license-header

 

Read More

XDebugを利用してNetBeansでPHPをデバッグするための環境構築

PHPのデバッグを効率化するために、NetBeansにXDebugを利用したPHPのデバッグ環境を整えます。 これにより、PHPの処理を任意の位置に設置したブレークポイントで中断し変数値を確認したり、ステップ実行で処理を追いかけることが可能となります。

PHP開発環境の準備

XAMPPとNetBeansをインストールしてそれらが利用出来る環境を整えます。未だの場合は、コチラを参照して下さい。

XDebugダウンロード

Windows用のXDebugのバイナリファイルをXDEBUG EXTENSION FOR PHPのダウンロードページからダウンロードします。

XDebugのバージョンは最新のバイナリファイルをダウンロードするのが良いでしょう。ただ同一XDebugのバージョンでも、OSのプラットフォーム(32bit or 64bit)、PHPのバージョン、スレッドセーフ(IISやApache worker MPMでPHPを実行する場合のZend Thread Safety(ZTS))対応有無により複数のバイナリファイルが公開されています。開発環境にあった適切なバイナリファイルをダウンロードして下さい。 ダウンロードしたバイナリファイルは、<XAMPPインストールフォルダ>\xampp\php\ext内に保存します。

適切なバイナリファイルを利用しないとXAMPPがそのバイナリファイルを読み込めずXDebugが有効になりませんので注意が必要です。

 

ただ、実は適切なバイナリファイルを確実な方法で選択しダウンロードする方法があるので今回はこの方法を採用します。

バイナリファイルの配布先であるXDEBUG EXTENSION FOR PHPのWebサイトでは、phpinfo()が出力するHTMLソースからOSプラットフォーム、PHPバージョン、スレッドセーフ有無等を解析し、環境にあった適切なバイナリファイルのダウンロードURLを示してくれる親切な機能が提供されています。

XAMPPを起動させた状態で、http://localhost/xampp/phpinfo.phpにアクセスしてその全てのHTMLソースをコピーします。

次に、Xdebug: Support; Tailored Installation Instructionsにアクセスし赤枠内にコピーしたHTMLソースを貼り付け、[Analyze my phpinfo() output]をクリックします。

Xdebug-Support-Tailored Installation Instructions-form

 

すると、phpInfo()の内容が解析され、赤枠内のINSTRUCTIONSにバイナリファイルのダウンロード先とphp.iniに追記すべき情報を示してくれます。

この指示に従い、バイナリファイルをダウンロードして下さい。

Xdebug-Support-Tailored Installation Instructions-Instructions

php.iniの編集

<XAMPPインストールフォルダ>\xampp\php\php.iniを開き、XDebugセクションを以下の通り編集し保存します。

まず、「;report_zend_debug = 0」のコメントアウトを外します。


; This setting is on by default.
;report_zend_debug = 0

2行目先頭のセミコロンを削除して以下の様にする。


; This setting is on by default.
report_zend_debug = 0

次に、XDebugセクションを探し、以下の通りに追加及び編集します。zend_extensionキーには、先のINSTRUCTIONSで示された情報を記載します。

[XDebug]
zend_extension = "C:\xampp\php\ext\php_xdebug-2.2.5-5.5-vc11.dll"
xdebug.remote_enable = On
xdebug.remote_handler = "dbgp"
xdebug.remote_mode = "req"
xdebug.remote_host = "127.0.0.1"
xdebug.remote_port = "9000"
xdebug.trace_output_dir = "C:\xampp\tmp"

XDebugの有効化確認

XAMPPを再起動させ、http://localhost/xampp/phpinfo.phpにアクセスします。下図のようにXDebugの情報が表示されていればXDebugの有効化は成功です。

phpInfo-xdebug

NetBeans設定

NetBeasnを起動し、メニューバーから[ツール] – [オプション]を開きます。

PHPのデバッグタブを開き、デバッガ・ポートに、php.iniにおいて、xdebug.remote_portに指定したポート番号を設定し保存します。

xdebug.remote_port = "XXXX"

NetBeans-option-debug-port

 

以上で、XDebugを利用してNetBeasnでPHPをデバッグするための環境構築は完了です。実行したいPHPプロジェクトの実行構成を設定し、デバッグ機能を実行してみて下さい。

 

 

Read More

WindowsにおけるPHP開発環境の構築

PHPでアプリケーションをWindows上で開発するため環境を構築します。

 

ローカル環境で、PHPのコーディングから実行、デバッグを行うには以下のソフトウェアが必要です。

PHP自体は、テキストファイルなので最低メモ帳等のテキストエディタがあればコーディングは出来ますし、あとWebサーバーとブラウザがあれば実行できます。ただ、開発効率を考えたとき、よっぽどの理由がない限り、統合開発環境(IDE)も合わせて導入することを強くおすすめします。

◎Webサーバー (Apache)

◎PHP

△DBサーバー (MySQL)

△統合開発環境(IDE)

(◎:必須、△:任意)

 

いろいろと調査した結果、XAMPP(ザンプ) + NetBeansという組み合わせを採用することにしました。

 

XAMPPに関してはPHP開発環境を構築する上でこれをインストールしておけば間違いないという鉄板の必須ソフトウェアです。

XAMPPはWindows用で、Linux用にはLAMP(ランプ)、Mac OS X用にはMAMP(マンプ)とOS別にパッケージが提供されています。

通常、Apache、PHP、MySQL等は個別インストールが必要ですが、XAMPPを使うとそれらを一括インストール出来るので非常に便利です。

配布先のApache Friendsの言葉を引用すると、XAMPPとは以下の様なソフトウェアです。

 

XAMPP とは?
XAMPP は最も人気のある PHP 開発環境です。

XAMPP は、完全に無償で MySQL、PHP、および Perl を含んだ、簡単にインストールできる Apache ディストリビューションです。

XAMPP オープン ソース ・パッケージは、インストールと利用が非常に簡単できるよう設定されています。

 

なぜ XAMPP を使うのか?
・最も人気のある PHP dev パッケージであること
・Windows、Mac OS X & Linux をサポート
・インストールと設定が簡単
・完全に無償

 

一方、統合開発環境(IDE)ですが、数あるIDEの中から最終的にNetBeasnを選択しました。

優秀な有償のPHP用の統合開発環境(IDE)もありましたが、導入コストは押さえたいので無償の統合開発環境(IDE)という観点で選択しました。

本業では、MicsoftのVisual Studioを利用しているので、それが使えれば慣れた環境で良かったのですが、Visual StudioでPHPを開発するための拡張機能「PHP Tools for Visual Studio」は無料のExpressエディションには導入不可。また、PHP Tools for Visual Studioは無償のBASICと有償のPROFESSIONALに2つのエディションがあり、BASICエディションでは構文の色分け(シンタックスハイライト)機能といった基本的な機能しか使えず、PROFESSIONALエディションでないと補完機能が利用できない等の理由で却下しました。

Javaの開発環境として有名な拡張性の高いEclipseも有力候補でしたが、NetBeasnの方が補完機能が優れる、軽量動作、公式の日本語サイトが存在し公式資料が数多く提供されている等の理由で、NetBeansを選択しました。

 

各ソフトウェアは以下より無償でダウンロードすることが出来ます。

XAMPP

NetBeans ※PHPのNetBeansバンドルをダウンロードしてください。

 

[XAMPPインストールメモ]

XAMPP ※v1.8.3のインストーラーの場合

・Antivirusの確認画面は[OK]を押す。

・User Account Control(UAC)の警告画面は[Yes]を押す。

・Select Componentsウィザードでは下図の通りコンポーネントを選択する。

XAMPP Installation Select Components

・Installation folderウィザードでは、デフォルトの「C:\xampp」のまま利用。

・Bitnami for XAMPPウィザードでは、[Learn more about Bitnami for XAMPP]のチェックを外す。

・インストール後、<XAMPPインストールフォルダー>\php\php.iniを以下の通り編集する。

≪タイムゾーン設定≫

「date.timezone=Europe/Berlin」 ⇒ 「date.timezone=Asia/Tokyo」

≪日本語関係設定≫

「;default_charset = “UTF-8″」 ⇒ 「default_charset = “UTF-8″」

「;mbstring.language = Japanese」 ⇒ 「mbstring.language = Japanese」

「;mbstring.internal_encoding = EUC-JP」 ⇒ 「mbstring.internal_encoding = UTF-8」

≪Xdebug設定≫

「;zend_extension = “C:\xampp\php\ext\php_xdebug.dll」 ⇒ 「zend_extension = “C:\xampp\php\ext\php_xdebug.dll”」

≪リモートデバッグ設定≫

「;xdebug.remote_enable = 0」 ⇒ 「xdebug.remote_enable = 1」

≪FileInfo拡張モジュール設定≫

「;extension=php_fileinfo.dll」 ⇒ 「extension=php_fileinfo.dll」

・ ApacheとSkypeが共存する場合、Skype初期設定ではポート80を利用するようになっているためApacheの起動が失敗する。この場合、Skypeの設定画面を開き[詳細]-[接続]の[追加の受信接続にポート80と443を使用]のチェックを外しSkypeを再起動する。これで、ポート80が空くのでApacheが起動可能となる。尚、ポート80をIISやWindowsが利用している場合もApacheの起動に失敗するので、どちらかのポート番号を変更する等の対応が必要となる。

・XAMPPのphpコマンド(php.exe)をコマンドプロンプトでフルパス指定しなくても使えるように「C:\xampp\php\」をシステム環境変数のPathへ追加する。

 

NetBeans

・NetBeansのインストールにはJava Platform (JDK)のインストールが必要。

・NetBeansのインストール手順はNetBeansの公式サイトにバージョン毎に公開されています。

・基本的に、インストールウィザードに従い全てデフォルトのインストールオプションでインストールを完了します。

・日本語の文字化け対策として、NetBeansのデフォルトのエンコーディングをUTF-8へ変更します。NetBeansが起動していない状態で、<NetBeansインストールフォルダ>\etc\netbeans.confを開き、netbeans_default_options に 下図の赤枠内のように「-J-Dfile.encoding=UTF-8」を追記し保存します。

NetBeans_DefaultEncoding

 

Read More