php dependency analysis

เครื่องวิเคราะห์การพึ่งพา PHP

PHP DA เป็นเครื่องมือสำหรับการตรวจสอบและสนับสนุนการพึ่งพาภายในโครงการของคุณชัดเจน

ตัวอย่างเช่น:

• คุณมีโครงการที่มี 3 รูทเนมสเปซ: โดเมนแอปพลิเคชันโครงสร้างพื้นฐาน
• คุณต้องการให้แน่ใจว่าการพึ่งพาในโครงการของคุณที่กำหนดเป็นกราฟ

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

นั่นหมายถึงคลาสทั้งหมดจากเนมสเปซ โดเมน ควรใช้คลาสเฉพาะจากเนมสเปซนี้และอาจเป็นผู้ขาย (กำหนดค่าไว้)

คลาสทั้งหมดจาก แอปพลิเคชัน สามารถใช้คลาสจาก โดเมน และเนมสเปซ ของแอปพลิเคชัน แต่ไม่ได้มาจาก โครงสร้างพื้นฐาน ฯลฯ

หากบางคลาสที่ใช้การพึ่งพาไม่พอใจกราฟการพึ่งพาที่กำหนดคุณจะให้ข้อผิดพลาดในรายงาน:

 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

ใช้เคส

มันจะมีประโยชน์ในบางกรณีเช่น:

• คุณต้องการแยกส่วนหนึ่งของแอปพลิเคชันของคุณในบริการแยกต่างหากคุณกำหนดการพึ่งพาที่ถูกต้องและเรียกใช้ PHP-DA เพื่อตรวจสอบปริมาณงาน
• คุณต้องการรองรับการมีเพศสัมพันธ์ต่ำในแอปพลิเคชันของคุณคุณกำหนดการพึ่งพาที่ถูกต้องและเรียกใช้ php-da บนเซิร์ฟเวอร์ CI ของคุณสำหรับ MR ทุกตัวเท่านั้นสำหรับไฟล์ที่เปลี่ยนแปลง
• คุณต้องการเปลี่ยนแปลงโครงสร้างที่มองเห็นได้ของแอปพลิเคชันของคุณสำหรับนักพัฒนาทุกคนตอนนี้สามารถมองเห็นได้ในการกำหนดค่า PHP-DA

เริ่มต้นอย่างรวดเร็ว

ติดตั้งไลบรารีโดยใช้นักแต่งเพลง

 composer require paglliac/dependency-analysis

การกำหนดค่า

เพิ่มไฟล์กำหนดค่า config.php ไปยังรูทของโครงการของคุณ:

 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 ' ]
];

วิ่ง

เรียกใช้การตรวจสอบการพึ่งพา:

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

ตัวเลือก:

• -c หรือ --config เป็นตัวเลือกด้วยพา ธ สัมพัทธ์ไปยังไฟล์ config

ข้อโต้แย้ง:

• [files filter] รายการไฟล์สำหรับการวิเคราะห์มันมีประโยชน์ในการใช้ใน CI รวมกับ -DIFF

ตัวอย่างของเอาต์พุต

 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