Sprintf und Reflexion erreichen automatische Formatierung

In der täglichen Entwicklung verwenden wir häufig die Sprintf -Funktion, um Zeichenfolgen zu formatieren, z. B. Ausgabezahlen mit festen Dezimalpunkten, die Ausgabe des Ausgabeinhalts usw., wenn wir diese Formatierung der Logik "automatisieren" können, dh automatisch formatieren, die Meta-Eignung des Objekts (wie die Eigenschaften der Klasse und Format zu formatieren).

Die Reflexions -API von PHP bietet einen Mechanismus zur Analyse von Klassen, Eigenschaften und Methoden zur Laufzeit. In Kombination mit den leistungsstarken Formatierungsfunktionen von Sprintf können wir ein "automatisches Formatierungswerkzeug" implementieren, das Objekte basierend auf Anmerkungen oder Benennungskonventionen in den Klasseneigenschaften formatieren und ausgeben kann.

Das Ziel erreichen

Wir wollen die folgenden Effekte erzielen:

 $user = new User('Alice', 5, 1234.5678);
echo AutoFormatter::format($user);

Das Ausgangsergebnis ähnelt:

 Name: Alice     | Level: 005 | Balance: $1234.57

Wobei das Format durch die Definition der Klasse bestimmt wird, anstatt in der Formatierungsfunktion fest codiert.

Schritt 1: Definieren Sie die Klasse mit Formatbeschreibung

Wir verwenden Php 8 -Attribute , um den Attributen der Klasse Formatierungsanweisungen hinzuzufügen.

 #[Attribute]
class Format {
    public function __construct(public string $format) {}
}

class User {
    #[Format('%-10s')] // Links ausgerichtet，besetzen10Bisschen
    public string $name;

    #[Format('%03d')] // Ganze Zahl，Auffüllen von Null zu3Bisschen
    public int $level;

    #[Format('$%.2f')] // 保留两Bisschen小数，Und fügen Sie das Dollarschild hinzu
    public float $balance;

    public function __construct($name, $level, $balance) {
        $this->name = $name;
        $this->level = $level;
        $this->balance = $balance;
    }
}

Schritt 2: Erstellen Sie ein automatisches Formatierer

Wir verwenden Reflexion, um Eigenschaften, ihre entsprechenden Formate zu lesen und formatierte Zeichenfolgen zu erzeugen.

 class AutoFormatter {
    public static function format(object $obj): string {
        $refClass = new ReflectionClass($obj);
        $values = [];
        $formats = [];

        foreach ($refClass->getProperties() as $prop) {
            $prop->setAccessible(true);
            $value = $prop->getValue($obj);

            $attrs = $prop->getAttributes(Format::class);
            if (!empty($attrs)) {
                $formatAttr = $attrs[0]->newInstance();
                $formats[] = $formatAttr->format;
                $values[] = $value;
            }
        }

        $formatString = implode(' | ', $formats);
        return sprintf($formatString, ...$values);
    }
}

Schritt 3: Verwenden Sie die Effektdemonstration

 $user = new User('Alice', 5, 1234.5678);
echo AutoFormatter::format($user);
// Ausgabe：Name: Alice     | Level: 005 | Balance: $1234.57

Wenn Sie sich auf der Webschnittstelle bewerben möchten, müssen Sie nur das formatierte Ergebnis zurückgeben:

 header('Content-Type: text/plain');
echo AutoFormatter::format(new User('Bob', 42, 98765.4321));

Sie können diese Formate auch für Protokollierung, Vorlagewiedergabe oder API -Antwort verwenden. Zum Beispiel:

 file_put_contents('https://gitbox.net/logs/user.log', AutoFormatter::format($user), FILE_APPEND);

Zusammenfassung

Durch die Kombination von PHP -Sprintf und Reflexion können wir die Formatierungslogik aus dem Anwendungscode extrahieren, um hochkarientierte und konfigurierbare automatische Formatierungsfunktionen zu erzielen. Dies macht den Code nicht nur eleganter, sondern bietet auch große Bequemlichkeit für zukünftige Formatänderungen.

Diese Methode eignet sich besonders für Szenarien wie Protokollierung, Export und Berichterstattung, die ein einheitliches Formatausgang erfordern.