maria stan

มาเรีย

Mariastan เป็นเครื่องมือวิเคราะห์แบบคงที่สำหรับการสืบค้น Mariadb วัตถุประสงค์หลักของมันคือการทำหน้าที่เป็นพื้นฐานสำหรับการขยาย phpstan

สถานะปัจจุบัน (24. 04. 2024):

มาเรียไม่สมบูรณ์มาก มันอาจครอบคลุม ~ 90% ของกรณีการใช้งานในฐานรหัสขนาดใหญ่ที่ฉันใช้มัน (หลายร้อยตาราง, การสืบค้นหลายพัน) เป็นผลให้มีกิจกรรมไม่มาก แต่มันได้รับการดูแลอย่างแข็งขันในแง่ที่ว่าถ้ามีอะไรบางอย่างหยุดพักสำหรับฉันมันอาจจะได้รับการแก้ไข

หากคุณพยายามใช้มันในโครงการของคุณคุณมีแนวโน้มที่จะใช้กรณีการใช้งานที่ไม่ได้ใช้งาน (เช่นไวยากรณ์/ฟังก์ชั่นที่โครงการของฉันไม่ได้ใช้) หากสิ่งนั้นเกิดขึ้นคุณควรเตรียมพร้อมที่จะแก้ไขสิ่งต่าง ๆ ด้วยตัวคุณเอง (สิ่งส่วนใหญ่ควรง่าย)

ไม่มีสัญญาที่เข้ากันได้กับสิ่งใดก็ได้และไม่มีการเผยแพร่ - ฉันแค่ใช้ Master

Mariastan ได้รับการทดสอบกับ Mariadb 10.11 และ Php 8.1-8.3

การติดตั้ง

ติดตั้ง Mariastan โดยใช้ composer require --dev schlndh/maria-stan:dev-master จากนั้นคุณจะต้องเพิ่มสิ่งต่อไปนี้ใน phpstan.neon ของคุณ:

 includes :
    - ./vendor/schlndh/maria-stan/extension.neon

การกำหนดค่า

Mariastan ต้องการเข้าถึงสคีมาฐานข้อมูล วิธีที่ง่ายที่สุดในการให้มันคือการให้มันเชื่อมต่อโดยตรงกับฐานข้อมูล คุณจะต้องเพิ่มการกำหนดค่าต่อไปนี้ใน phpstan.neon ของคุณและตั้งค่าข้อมูลรับรองที่เหมาะสม:

 parameters : 
    maria-stan :
        db :
            # Change these to match your database
            host : 127.0.0.1
            port : 3306
            user : ' root '
            password : ' '
            database : ' db '

Mariastan ต้องการการเข้าถึงฐานข้อมูลเพื่อดึงสคีมาสำหรับการวิเคราะห์แบบสอบถาม มันอ่านสคีมาตารางเท่านั้นและไม่ได้เขียนอะไรเลย อย่างไรก็ตาม อย่า ให้การเข้าถึงฐานข้อมูลใด ๆ ที่มีข้อมูลสำคัญใด ๆ

อีกวิธีหนึ่งก็เป็นไปได้ที่จะใช้ Mariastan โดยไม่ต้องเข้าถึงฐานข้อมูลในระหว่างการวิเคราะห์ ในกรณีนี้คุณจะต้องทิ้งสคีมาก่อนโดยใช้ MariaDbFileDbReflection::dumpSchema และบันทึกลงในไฟล์ นี่คือตัวอย่างสคริปต์ที่ทำเช่นนั้น:

 <?php

declare (strict_types= 1 );

use MariaStan  DbReflection  MariaDbFileDbReflection ;

require_once __DIR__ . ' /vendor/autoload.php ' ;

$ mysqli = new mysqli ( ' 127.0.0.1 ' , ' root ' , '' );
file_put_contents ( __DIR__ . ' /maria-stan-schema.dump ' , MariaDbFileDbReflection:: dumpSchema ( $ mysqli , ' database ' ));

จากนั้นเพิ่มสิ่งต่อไปนี้ใน phpstan.neon ของคุณ:

 parameters :
    maria-stan :
        reflection :
            file : %rootDir%/../../../maria-stan-schema.dump
services :
    mariaDbReflection : @ mariaDbFileDbReflection

โปรดทราบว่าการขยายตัวโดยอัตโนมัติของเส้นทางสัมพัทธ์จะทำงานได้เฉพาะกับการกำหนดค่าของ PHPSTAN (เช่นเป็นรายการ hardcoded ของปุ่มกำหนดค่า) ดังนั้นคุณจะต้องจัดเตรียมเส้นทางที่แน่นอนไปยังไฟล์ Dump

ดู extension.neon สำหรับรายการพารามิเตอร์ที่สมบูรณ์

การใช้งาน

Mariastan รวมถึงตัวอย่าง phpstan ตัวอย่างสำหรับ mysqli อย่างไรก็ตามวัตถุประสงค์ของส่วนขยายนี้เป็นเพียงการตรวจสอบการรวมเข้ากับ phpstan ฉันไม่คาดหวังว่าใครจะใช้ mysqli โดยตรง ดังนั้นคุณคาดว่าจะเขียนส่วนขยาย phpstan ของคุณเองที่รวมเข้ากับ Mariastan หากคุณต้องการใช้ส่วนขยาย mysqli รวมถึง ./vendor/schlndh/maria-stan/extension.mysqli.neon ใน phpstan.neon ของคุณ

คุณสามารถใช้ส่วนขยาย MySQLI เป็นจุดเริ่มต้นที่แก้ไขเพื่อให้ตรงกับความต้องการของคุณ แนวคิดพื้นฐานคือการรับสตริงแบบสอบถามจาก phpstan ส่งผ่านไปยัง Mariastan เพื่อทำการวิเคราะห์จากนั้นรายงานประเภทผลลัพธ์และข้อผิดพลาดกลับไปที่ PHPSTAN

ก่อนที่คุณจะเริ่มใช้ส่วนขยายของคุณเองเพื่อรวม Mariastan เข้ากับโครงการของคุณคุณสามารถลองใช้งานได้อย่างรวดเร็ว คุณสามารถเริ่มต้นด้วยการตรวจสอบตัวอย่างง่ายๆซึ่งใช้ส่วนขยาย MySQLI จากนั้นคุณสามารถลองโทรค้นหาจาก codebase ของคุณผ่าน MySQLI และวิเคราะห์ด้วยส่วนขยาย MySQLI เพื่อให้แน่ใจว่า Mariastan รองรับคุณสมบัติที่โครงการของคุณใช้

คุณสมบัติ

นี่คือรายการของคุณสมบัติที่คุณสามารถนำไปใช้ในส่วนขยาย phpstan ของคุณเองตาม Mariastan (ส่วนใหญ่ควรแสดงในส่วนขยาย MySQLI):

• พิมพ์การอนุมานสำหรับผลลัพธ์การสืบค้น สิ่งนี้มีค่าเพียงอย่างเดียวเมื่อใช้ phpstan กับรหัสที่ทำงานกับข้อมูล DB
  • บางครั้ง Mariastan สามารถอนุมานประเภทที่แคบกว่าประเภทที่ส่งคืนโดยฐานข้อมูล (เช่น mysqli_result::fetch_fields ) นี่เป็นเพราะ Mariastan สามารถ (ในกรณีง่ายๆ) เข้าใจการสืบค้นเช่น SELECT col FROM tbl WHERE col IS NOT NULL และลบ NULL ออกจากประเภทผลลัพธ์ในขณะที่ Mariadb ดูเหมือนจะไม่ทำเช่นนั้น
• การตรวจจับข้อผิดพลาดพื้นฐาน ตัวอย่างเช่น:
  • ไม่ทราบตารางคอลัมน์ ...
  • ชื่อคอลัมน์ที่คลุมเครือ
  • จำนวนผู้ถือตำแหน่งไม่ตรงกัน
  • ข้อมูลที่ขาดหายไปสำหรับคอลัมน์บังคับใน INSERT / REPLACE
  • -
• รายงานการใช้ตาราง/คอลัมน์ที่เลิกใช้แล้ว
• ช่วงการนับแถว: ในกรณีง่ายๆ Mariastan สามารถกำหนดจำนวนแถวที่ส่งคืน (เช่น SELECT COUNT(*) FROM tbl non-empty-array ซึ่งสามารถใช้เพื่อแคบลงประเภทการส่งคืนของวิธีการเช่น mysqli_result::fetch_all
• การแทนที่ประเภทคอลัมน์: คุณสามารถแทนที่ประเภทของคอลัมน์ (เช่นเนื่องจากตารางคือ "คงที่") และแม้แต่เผยแพร่โดยอัตโนมัติผ่านคีย์ต่างประเทศ
• ประเภท PHPDOC ที่กำหนดเอง: เช่น MySQlitableAsSocrowType

ข้อ จำกัด

• ขณะนี้ไม่มีการตรวจสอบแคชสำหรับ PHPStan ไม่ชัดเจนว่าสิ่งนั้นเป็นไปได้ง่าย ดูการสนทนานี้ อย่างไรก็ตามมีเพียงเรื่องสำคัญสำหรับการเปลี่ยนแปลงสคีมา (เช่นถ้าคุณเปลี่ยนแบบสอบถามในไฟล์ phpstan PHP จะทำให้เป็นโมฆะโดยอัตโนมัติ)
• ไม่มีการสนับสนุนสำหรับผู้สร้างแบบสอบถาม เครื่องวิเคราะห์คาดว่าจะมีการสืบค้นเป็นสตริงบนอินพุต
• แบบสอบถามจะต้องเป็นที่รู้จักอย่างเต็มที่ หากคุณมีรหัสเช่นนี้:

   function foo ( mysqli $ db , int $ count ) {
      return $ db -> prepare ( " SELECT * FROM tbl WHERE id IN ( " . implode ( ' , ' , array_fill ( 0 , $ count , ' ? ' )) . ' ) ' );
  }

  PHPSTAN จะไม่สามารถประเมินได้แบบคงที่และทำให้ Mariastan ไม่มีอะไรจะวิเคราะห์
• ไม่มีการสนับสนุนสำหรับตารางชั่วคราว
• ไม่มีการสนับสนุนสำหรับหลายฐานข้อมูล
• ข้อ จำกัด ข้างต้นเป็นข้อตกลงหลักในระยะยาว แต่นอกเหนือจากพวกเขาแล้วทุกอย่างก็มีเพียงบางส่วนเท่านั้น

โครงการที่คล้ายกัน

STAABM/PHPSTAN-DBA

เท่าที่ฉันสามารถบอกได้ PHPSTAN-DBA ทำงานโดยดำเนินการค้นหาเพื่อรับข้อมูลเกี่ยวกับประเภทผลลัพธ์ข้อผิดพลาด ... Mariastan ในอีกทางหนึ่งวิเคราะห์การสืบค้นแบบคงที่ ประโยชน์ของ PHPSTAN-DBA รวมถึง:

• รองรับฐานข้อมูลหลายฐานข้อมูลได้ง่าย ด้วย Mariastan สิ่งนี้เป็นไปไม่ได้ (ยกเว้น MySQL)
• การตรวจสอบข้อผิดพลาดที่สมบูรณ์และเชื่อถือได้มากขึ้นด้วยฐานข้อมูลที่ทำการยกหนัก ในทางกลับกันฐานข้อมูลจะส่งคืนข้อผิดพลาดเพียงครั้งเดียวในแต่ละครั้งในขณะที่มาเรียอาจสามารถค้นพบหลายประเด็นในครั้งเดียว
• การวิเคราะห์แผนค้นหา สิ่งนี้ดูเหมือนจะไม่สามารถทำได้แบบคงที่ ในทางกลับกันฉันไม่แน่ใจว่าสิ่งนี้มีประโยชน์ในทางปฏิบัติอย่างไรโดยเฉพาะอย่างยิ่งหากคุณไม่ต้องการให้ PHPSTAN-DBA เข้าถึงข้อมูลการผลิต
• ดูเหมือนว่าจะเริ่มต้นใช้งานได้ง่ายขึ้นเนื่องจากมีส่วนขยายสำหรับ abstractions ฐานข้อมูลหลายตัว

มีข้อเสียเล็กน้อยเกี่ยวกับวิธีการของ PHPSTAN-DBA:

• ไม่มีเส้นทางไปสู่การวิเคราะห์แบบคงที่เต็มรูปแบบ (เช่นไม่ต้องการฐานข้อมูลที่กำลังทำงานอยู่ที่จุดใด ๆ ) ปัจจุบันมาเรียยังต้องการฐานข้อมูลที่กำลังดำเนินการ (เพื่อรับข้อมูลจาก information_schema ไม่จำเป็นต้องใช้เวลาวิเคราะห์) แต่เป็นไปได้ที่จะใช้ CREATE TABLE (ฯลฯ ) การแยกวิเคราะห์และใช้การสะท้อน dB ที่ด้านบนของสิ่งนั้น
• เนื่องจากการสืบค้นถูกดำเนินการจึงต้องระมัดระวังด้วยการสืบค้นการปรับเปลี่ยนข้อมูล/สคีมา ฉันเห็นเงื่อนไขบางอย่างที่ จำกัด ให้ SELECT แบบสอบถามในหลาย ๆ ที่รวมถึงการใช้ธุรกรรม ดังนั้นฉันไม่แน่ใจว่ามันรองรับ INSERT ได้ดีเพียงใด (มีบางอย่างในการทดสอบอย่างน้อย)