Perlの@INCはどのように構築されますか？（別名Perlモジュールが検索される場所に影響を与えるすべての方法は何ですか？）

Perlモジュールが検索される場所に影響を与えるすべての方法は何ですか？または、Perlの@INCはどのように構築されますかますか？

ご存じのとおり、Perlは@INCディレクトリ名を含む配列を使用して、Perlモジュールファイルを検索する場所を決定します。

StackOverflowに包括的な「@INC」FAQタイプの投稿はないようですので、この質問は1つとして意図されています。

この配列の内容がどのように構築され、Perlインタープリターがモジュールファイルを検索する場所に影響を与えるように操作できるかを見ていきます。

1. デフォルト @INC

   Perlインタープリターは、特定の@INCデフォルト値でコンパイルされます。この値を確認するには、env -i perl -Vコマンドを実行します（環境変数env -iは無視されPERL5LIBます-＃2を参照）。出力には次のようなものが表示されます。

   $ env -i perl -V
   ...
   @INC:
    /usr/lib/perl5/site_perl/5.18.0/x86_64-linux-thread-multi-ld
    /usr/lib/perl5/site_perl/5.18.0
    /usr/lib/perl5/5.18.0/x86_64-linux-thread-multi-ld
    /usr/lib/perl5/5.18.0
    .

.最後に注意してください。これは現在のディレクトリです（スクリプトのディレクトリと同じである必要はありません）。Perl 5.26以降では欠落しており、Perlが-T（汚染チェックが有効になっている）状態でます。

Perlバイナリコンパイルの構成時にデフォルトパスを変更するには、構成オプションを設定しますotherlibdirs。

Configure -Dotherlibdirs=/usr/lib/perl5/site_perl/5.16.3

2. 環境変数 PERL5LIB（またはPERLLIB）

   Perl は、シェルの環境変数（定義されていない場合は使用されます@INC）に含まれているPERL5LIB（コロンで区切られた）ディレクトリのリストを先頭に付加しPERLLIBます。@INCafter PERL5LIBおよびPERLLIB環境変数の内容が有効になったことを確認するには、を実行しperl -Vます。

   $ perl -V
   ...
   %ENV:
     PERL5LIB="/home/myuser/test"
   @INC:
    /home/myuser/test
    /usr/lib/perl5/site_perl/5.18.0/x86_64-linux-thread-multi-ld
    /usr/lib/perl5/site_perl/5.18.0
    /usr/lib/perl5/5.18.0/x86_64-linux-thread-multi-ld
    /usr/lib/perl5/5.18.0
    .

3. -I コマンドラインオプション

   Perl @INCは、-Iコマンドラインオプションの値として渡された（コロンで区切られた）ディレクトリのリストを先頭に付加します。これは、Perlオプションの場合と同様に、3つの方法で実行できます。

   • コマンドラインで渡してください：

     perl -I /my/moduledir your_script.pl

   • Perlスクリプトの最初の行（シバン）を介して渡します。

     #!/usr/local/bin/perl -w -I /my/moduledir

   • PERL5OPT（またはPERLOPT）環境変数の一部として渡します（Perlのプログラミングの 19.02章を参照）。

4. プラグマを介して渡しますlib

   Perlプリペ​​ンド @INCは、を介して渡されたディレクトリのリストをしuse libます。

   プログラム内：

   use lib ("/dir1", "/dir2");

   コマンドラインで：

   perl -Mlib=/dir1,/dir2

   via からディレクトリを削除@INCno libすることもできます。

5. @INC通常のPerl配列として直接操作できます。

   注：@INCはコンパイル段階で使用されるためBEGIN {}、use MyModuleステートメントの前のブロック内で実行する必要があります。

   • を介してディレクトリを最初に追加しunshift @INC, $dirます。

   • を介してディレクトリを最後に追加しpush @INC, $dirます。

   • Perl配列でできることは他に何でもしてください。

注：ディレクトリは、この回答にリストされている順序でシフトさ@INCれません。たとえば、デフォルト@INCはリストの最後にあり、前にPERL5LIB、前に-I、前にuse libし、直接@INC操作があり、後者の2つは、Perlコード内の順序で混在しています。

参照：

• perldoc perlmod
• perldoc lib
• Perl Module Mechanics-実用的なHOW-TOを含む優れたガイド
• にないディレクトリでPerlモジュールを「使用」するにはどうすればよい@INCですか？
• Perlのプログラミング -第31章、パート13、チャネル7.2.41
• Perlプログラムは、使用するPerlモジュールを含むファイルの場所をどのようにして知るのですか？

@INCStack Overflowに包括的なFAQタイプの投稿はないようですので、この質問は1つとして意図されています。

それぞれのアプローチをいつ使用するのですか？

• ディレクトリ内のモジュールをサイトの多くの/すべてのスクリプトで使用する必要がある場合、特に複数のユーザーが実行する場合@INCは、Perlバイナリにコンパイルされるデフォルトにそのディレクトリを含める必要があります。

• ディレクトリ内のモジュールが、ユーザーが実行するすべてのスクリプトに対して特定のユーザーによって排他的に使用される場合（または、Perlの再コンパイル@INCが以前の使用例でデフォルトを変更するオプションではない場合）、ユーザーのを設定しPERL5LIBます。通常はユーザーのログイン時に行います。

  注：通常のUnix環境変数の落とし穴に注意してください。たとえば、特定のユーザーとしてスクリプトを実行しても、そのユーザーの環境が設定された状態でスクリプトが実行されるとは限りませんsu。

• ディレクトリ内のモジュールを特定の状況でのみ使用する必要がある場合（たとえば、スクリプトが開発/デバッグモードで実行される場合）、PERL5LIB手動で設定するか、-I perlにオプションをできます。

• モジュールを特定のスクリプトにのみ使用する必要がある場合は、それらを使用するすべてのユーザーが、プログラム自体でuse lib/ no libプラグマを使用します。また、スクリプトのコマンドラインパラメータやスクリプトのパスなど、実行時に検索対象のディレクトリを動的に決定する必要がある場合にも使用します（非常に優れた使用例については、FindBinモジュールを参照してください）。

• @INC複雑なロジックに従ってディレクトリを操作する必要がある場合、use lib/ no libプラグマの組み合わせでは実装するのが難しいため、ブロック内またはスクリプトで使用する必要がある操作用に指定された専用ライブラリ内で直接@INC操作を使用します。 （s）他のモジュールが使用される前。BEGIN {}@INC

  この例は、prod / uat / devディレクトリのライブラリを自動的に切り替えることです。devやUATに欠落している場合、ウォーターフォールライブラリのピックアップがprodにあります（最後の条件により、標準の「use lib + FindBin」ソリューションがかなり複雑になります。Aこのシナリオの詳細な説明は、「ベータPerlスクリプトからベータPerlモジュールを使用するにはどうすればよいですか？」にあります。

• 直接操作する追加のユースケース@INCは、サブルーチン参照またはオブジェクト参照を追加できるようにすることです（そうです、バージニア州は、@ INCのサブルーチン参照が呼び出されるタイミングで@INC説明されているように、ディレクトリ名だけでなく、カスタムPerlコードを含めることができます）。

上記の場所に加えて、OS XバージョンのPerlには次の2つの方法があります。

6. /Library/Perl/x.xx/AppendToPathファイル。このファイルにリストされているパスは、実行時に@INCに追加されます。

7. /Library/Perl/x.xx/PrependToPathファイル。このファイルにリストされているパスは、実行時に@INCの前に付加されます。

すでに述べたように、@ INCは配列であり、必要なものを自由に追加できます。

私のCGI RESTスクリプトは次のようになります。

#!/usr/bin/perl
use strict;
use warnings;
BEGIN {
    push @INC, 'fully_qualified_path_to_module_wiht_our_REST.pm';
}
use Modules::Rest;
gone(@_);

なくなったサブルーチンはRest.pmによってエクスポートされます。