php dependency analysis

PHP -Abhängigkeitsanalysator

PHP DA ist Tool zum Überprüfen und Unterstützen von Abhängigkeiten in Ihrem Projekt Clear.

Zum Beispiel:

• Sie haben ein Projekt mit 3 Root -Namespaces: Domäne, Anwendung, Infrastruktur
• Sie möchten sicher sein, dass Abhängigkeiten in Ihrem Projekt als Grafik definiert werden

[
    ' dependencies ' => [
        ' Domain ' => null ,
        ' Application ' => [ ' Domain ' ],
        ' Infrastructure ' => [ ' Domain ' , ' Application ' ]
    ]
];

Das bedeutet, dass alle Klassen aus dem Domain -Namespace nur Klassen aus diesem Namespace und möglicherweise den Anbieter verwenden sollten (es ist konfiguriert).

Alle Klassen aus Anwendungen können Klassen aus Domänen- und Anwendungsnamenspitzen verwenden, jedoch nicht aus der Infrastruktur usw.

Wenn einige Klassen, die Abhängigkeiten verwenden, nicht erfüllt definierte Abhängigkeitsgrafiken, geben Sie Fehler im Bericht an:

 Have been analyzed 4 files
You have dependency problems in 2 files in your project:

Class ApplicationTrackingService have errors:
    - Class ApplicationTrackingService using class InfrastructureShipImplementation which not satisfy dependency graph

Class DomainCargo have errors:
    - Class DomainCargo using class ApplicationTrackingService which not satisfy dependency graph
    - Class DomainCargo using class InfrastructureShipImplementation which not satisfy dependency graph

Anwendungsfälle

Dies kann in einigen Fällen beispielsweise nützlich sein:

• Sie möchten einen Teil Ihrer Anwendung in separatem Service extrahieren. Sie definieren gültige Abhängigkeiten und führen PHP-DA für die Untersuchung der Arbeitsbelastung aus
• Sie möchten eine niedrige Kopplung in Ihrer Anwendung unterstützen. Sie definieren gültige Abhängigkeiten und führen für jeden MR PHP-DA auf Ihrem CI-Server aus, nur für geänderte Dateien
• Sie möchten sich für alle Entwickler sichtbare Strukturänderungen Ihrer Anwendung vornehmen, jetzt ist sie in PHP-DA-Konfiguration sichtbar

Schneller Start

Installieren Sie die Bibliothek über einen Komponisten

 composer require paglliac/dependency-analysis

Konfiguration

Fügen Sie die Konfigurationsdatei config.php zum root Ihres Projekts hinzu:

 return [
    /**
     * REQUIRED
     * Dependencies Graph
     *
     * Description of valid dependencies in project
     *
     * This config means
     *
     * Package (every class in namespace) Domain can use only classes from namespace Domain or vendor dependencies
     * Package Application can use only classes from namespaces Domain, Application or vendor dependencies
     * Package Infrastructure can use only classes from namespaces Domain, Application, Infrastructure or vendor dependencies
     */
    ' dependencies ' => [
        ' Domain ' => null ,
        ' Application ' => [ ' Domain ' ],
        ' Infrastructure ' => [ ' Domain ' , ' Application ' ]
    ],

    /**
     * REQUIRED
     * Source path where dependencies will be analyzed
     */
    ' path ' => __DIR__ ,

    /**
     * OPTIONAL
     *
     * Make available to use vendor dependencies in whole project
     *
     * true - all project classes can use vendor dependencies
     * false - all project can not use vendor dependencies
     */
    ' skip_vendor_dir ' => true ,

    /**
     * OPTIONAL
     * Flag that define how to do when some files placed in namespaces not presented in Dependencies Graph
     *
     * true - mark class as having incorrect dependencies
     * false - skip this file
     *
     * For example, in directory we have namespace SomeNamespace with class SomeNamespaceSomeClass
     * if flag is true, it will be marked as incorrect file, if flag is true, this file wil be marked as correct
     */
    ' fail_on_non_presented_namespace ' => false ,

    /**
     * OPTIONAL
     * Flag for php parser, correct values:
     *
     * PhpParserParserFactory::PREFER_PHP7 - 1 (default)
     * PhpParserParserFactory::PREFER_PHP5 - 2
     * PhpParserParserFactory::ONLY_PHP7 - 3
     * PhpParserParserFactory::ONLY_PHP5 - 4
     */
    ' php_version ' => PhpParser ParserFactory:: PREFER_PHP7 ,

    /**
     * OPTIONAL
     * 
     * List of allowed files extensions, all files with other extensions will be skipped from analysis
     * 
     * Default - ['php']
     */
    ' allowed_extensions ' => [ ' php ' ]
];

Läuft

Abhängigkeitsvalidierung ausführen:

 /vendor/bin/php-da -c config.php [files filter]

Optionen:

• -c oder --config ist eine Option mit dem relativen Pfad zur Konfigurationsdatei erforderlich

Argumente:

• [files filter] Liste der Dateien zur Analyse. Es ist nützlich, in CI Combine mit - -diff zu verwenden

Beispiel für die Ausgabe

 Have been analyzed 4 files
You have dependency problems in 2 files in your project:

Class ApplicationTrackingService have errors:
    - Class ApplicationTrackingService using class InfrastructureShipImplementation which not satisfy dependency graph

Class DomainCargo have errors:
    - Class DomainCargo using class ApplicationTrackingService which not satisfy dependency graph
    - Class DomainCargo using class InfrastructureShipImplementation which not satisfy dependency graph