Dlaczego warto korzystać z funkcji sprintf w PHP?

Próbuję dowiedzieć się więcej o funkcji PHP sprintf (), ale php.net niewiele mi pomógł, ponieważ nadal jestem zdezorientowany, dlaczego chcesz z niego korzystać?

Spójrz na mój przykład poniżej.

Po co korzystać z tego:

$output = sprintf("Here is the result: %s for this date %s", $result, $date);

Gdy robi to samo i łatwiej jest napisać IMO:

$output = 'Here is the result: ' .$result. ' for this date ' .$date;

Czy coś mi umyka?

sprintf ma wszystkie możliwości formatowania oryginalnego printf, co oznacza, że ​​możesz zrobić znacznie więcej niż tylko wstawianie wartości zmiennych do ciągów.

Na przykład określ format liczb (szesnastkowy, dziesiętny, ósemkowy), liczbę miejsc po przecinku, wypełnienie i inne. Google dla printf, a znajdziesz wiele przykładów. Artykuł w Wikipedii dotyczący printf powinien zacząć.

Istnieje wiele przypadków użycia sprintf, ale jednym ze sposobów ich użycia jest przechowywanie takiego ciągu: „Witaj, nazywam się% s” w bazie danych lub jako stała w klasie PHP. W ten sposób, gdy chcę użyć tego ciągu, mogę po prostu to zrobić:

$name = 'Josh';
// $stringFromDB = 'Hello, My Name is %s';
$greeting = sprintf($stringFromDB, $name);
// $greetting = 'Hello, My Name is Josh'

Zasadniczo pozwala na pewną separację w kodzie. Jeśli użyję „Witaj, moje imię to% s” w wielu miejscach w moim kodzie, mogę je zmienić na „% s to moje imię” w jednym miejscu i aktualizuje się ono wszędzie indziej automatycznie, bez konieczności przechodzenia do każdej instancji i poruszania się konkatenacje.

Kolejnym zastosowaniem sprintfjest zlokalizowane aplikacje jako argumentysprintf nie muszą być w kolejności, w jakiej występują w ciągu formatu.

Przykład:

$color = 'blue';
$item = 'pen';

sprintf('I have a %s %s', $color, $item);

Ale język taki jak francuski porządkuje słowa inaczej:

$color = 'bleu';
$item = 'stylo';

sprintf('J\'ai un %2$s %1$s', $color, $item);

(Tak, mój francuski jest do bani: Nauczyłem się niemieckiego w szkole!)

W rzeczywistości użyłbyś gettext do przechowywania zlokalizowanych ciągów, ale masz pomysł.

Łatwiej jest przetłumaczyć.

echo _('Here is the result: ') . $result . _(' for this date ') . $date;

Ciągi tłumaczenia (gettext) są teraz:

• Oto wynik:
• na tę datę

Przetłumaczone na inny język może być niemożliwe lub może prowadzić do bardzo dziwnych zdań.

Teraz jeśli masz

echo sprintf(_("Here is the result: %s for this date %s"), $result, $date);

Ciągi tłumaczenia (gettext) są teraz:

• Oto wynik:% s dla tej daty% s

Co ma o wiele większy sens i jest o wiele bardziej elastyczne w tłumaczeniu na inne języki

Najlepszym powodem, który znalazłem, jest to, że pozwala ci umieścić wszystkie ciągi językowe w twoim pliku językowym, gdzie ludzie mogą tłumaczyć i zamawiać je w razie potrzeby - a mimo to wiesz, że bez względu na format, w jakim znajduje się napis - chcesz pokazać nazwa użytkownika.

Na przykład Twoja strona powie „Witaj ponownie [[Użytkownik]]” u góry strony. Jako programista nie wiesz ani nie obchodzi Cię, jak ludzie z interfejsu będą to pisać - po prostu wiesz, że nazwa użytkownika zostanie wyświetlona gdzieś w wiadomości.

Możesz więc osadzić wiadomość w kodzie, nie martwiąc się o to, czym ona jest.

Plik Lang (EN_US):

...
$lang['welcome_message'] = 'Welcome back %s';
...

Następnie możesz obsługiwać dowolny rodzaj wiadomości w dowolnym języku, używając tego w swoim prawdziwym kodzie php.

sprintf($lang['welcome_message'], $user->name())

dlaczego chcesz tego użyć?

Jest to bardzo przydatne, gdy używasz (zewnętrznego) źródła dla ciągów językowych. Jeśli potrzebujesz stałej liczby zmiennych w danym ciągu wielojęzycznym, musisz tylko znać prawidłowe uporządkowanie:

en.txt

not_found    = "%s could not be found."
bad_argument = "Bad arguments for function %s."
bad_arg_no   = "Bad argument %d for function %s."

hu.txt

not_found    = "A keresett eljárás (%s) nem található."
bad_argument = "Érvénytelen paraméterek a(z) %s eljárás hívásakor."
bad_arg_no   = "Érvénytelen %d. paraméter a(z) %s eljárás hívásakor."

Wstawiane zmienne nie muszą nawet znajdować się na początku lub na końcu w wielu językach, liczy się tylko ich kolejność.

Oczywiście możesz napisać własną funkcję, aby wykonać tę zamianę, niewątpliwie nawet przy niewielkich wzrostach wydajności, ale jest to o wiele szybsze po prostu (pod warunkiem, że masz klasę Languagedo czytania ciągów językowych) :

/**
 * throws exception with message($name = "ExampleMethod"):
 *  - using en.txt: ExampleMethod could not be found.
 *  - using hu.txt: A keresett eljárás (ExampleMethod) nem található.
 */
throw new Exception(sprintf(Language::Get('not_found'), $name));

/**
 * throws exception with message ($param_index = 3, $name = "ExampleMethod"):
 *  - using en.txt: Bad argument 3 for function ExampleMethod.
 *  - using hu.txt: Érvénytelen 3. paraméter a(z) ExampleMethod eljárás hívásakor.
 */
throw new Exception(sprintf(Language::Get('bad_arg_no'), $param_index, $name));

Posiada również pełne możliwości printf, dlatego jest również jednokierunkowym formatowaniem wielu typów zmiennych, na przykład:

• precyzja wyjściowa liczby zmiennoprzecinkowej , lub
• wypełnianie liczb całkowitych wiodącymi zerami .

Jak wspomniano, umożliwia formatowanie danych wejściowych. Na przykład wymuszanie 2dp, 4-cyfrowych liczb itp. Jest to całkiem przydatne do budowania ciągów zapytań MySQL.

Kolejną zaletą jest to, że pozwala oddzielić układ ciągu od danych, które są do niego podawane, prawie jak podawanie parametrów. Na przykład w przypadku zapytania MySQL:

// For security, you MUST sanitise ALL user input first, eg:
$username = mysql_real_escape_string($_POST['username']); // etc.
// Now creating the query:
$query = sprintf("INSERT INTO `Users` SET `user`='%s',`password`='%s',`realname`='%s';", $username, $passwd_hash, $realname);

Ta metoda ma oczywiście inne zastosowania, takie jak drukowanie wydruku w formacie HTML itp.

Edycja: Ze względów bezpieczeństwa , stosując powyższą technikę , należy zdezynfekować wszystkie zmienne wejściowe mysql_real_escape_string()przed użyciem tej metody , aby zapobiec atakom z użyciem MySQL. Jeśli przeanalizujesz niechciane dane wejściowe, Twoja witryna i serwer zostaną zhakowane . (Z wyjątkiem, oczywiście, zmiennych, które zostały całkowicie skonstruowane przez Twój kod i są bezpieczne.)

Użycie sprintf () jest znacznie czystsze i bezpieczniejsze do sformatowania łańcucha.

Na przykład, gdy masz do czynienia ze zmiennymi wejściowymi, zapobiega nieoczekiwanym niespodziankom, określając wcześniej oczekiwany format (na przykład, że oczekujesz ciągu [ %s] lub liczby [%d ]). Może to potencjalnie pomóc w potencjalnym ryzyku wstrzyknięcia SQL , ale nie zapobiegnie, jeśli ciąg znaków będzie zawierał cudzysłowy.

Pomaga również radzić sobie z liczbami %.2fzmiennoprzecinkowymi , możesz jawnie określić precyzję cyfr (np. ), Która oszczędza ci korzystania z funkcji konwersji.

Inną zaletą jest to, że większość głównych języków programowania ma własną implementację sprintf() , więc kiedy się z nią zapoznasz, korzystanie z niej jest jeszcze łatwiejsze niż uczenie się nowego języka (np. Jak łączyć ciągi znaków lub konwertować zmiennoprzecinkowe).

Podsumowując, dobrą praktyką jest używanie w celu uzyskania czystszego i bardziej czytelnego kodu.

Na przykład zobacz prawdziwy przykład poniżej :

$insert .= "('".$tr[0]."','".$tr[0]."','".$tr[0]."','".$tr[0]."'),";

Lub prosty przykład, który drukuje np . '1','2','3','4':

print "foo: '" . $a . "','" . $b . "'; bar: '" . $c . "','" . $d . "'" . "\n";

i drukowanie ze sformatowanym łańcuchem:

printf("foo: '%d','%d'; bar: '%d','%d'\n", $a, $b, $c, $d);

gdzie printf()jest równoważne zsprintf() , ale wyświetla sformatowany ciąg zamiast zwracać go (do zmiennej).

Który jest bardziej czytelny?

Nawet myślałem o tym samym, chyba że ostatnio go użyłem. Przy generowaniu dokumentów na podstawie danych wprowadzonych przez użytkownika będzie to przydatne.

"<p>Some big paragraph ".$a["name"]." again have tot ake care of space and stuff .". $a["age"]. "also would be hard to keep track of punctuations and stuff in a really ".$a["token"]. paragarapoh.";

Które można łatwo zapisać jako

sprintf("Some big paragraph %s. Again have to take care of space and stuff.%s also wouldnt be hard to keep track of punctuations and stuff in a really %s paragraph",$a,$b,$c);

To:

"<p>Some big paragraph ".$a["name"]." again have to take care of space and stuff .". $a["age"]. "also would be hard to keep track of punctuations and stuff in a really ".$a["token"]. paragraph.";

Można również napisać:

"<p>Some big paragraph {$a['name']} again have to take care of space and stuff .{$a['age']} also would be hard to keep track of punctuations and stuff in a really {$a['token']} paragraph.";

Moim zdaniem jest to łatwiejsze do odczytania, ale widzę zastosowanie do lokalizacji lub formatowania.

Niektóre typowe przypadki wymagają dokładniejszej kontroli formatu wyjściowego. Na przykład trudne może być upewnienie się, że określona wartość ma określoną liczbę spacji dopełnionych do przodu, w zależności od jej długości, lub że liczba jest wyprowadzana w określonym, precyzyjnym formacie.

Istnieje wiele przykładów w podręczniku PHP

Także to, co przychodzi do twojego przykładu „łatwiej pisać”. Chociaż echo może być łatwiejsze do napisania, sprintf jest łatwiejszy do odczytania, szczególnie jeśli masz wiele zmiennych.

Innym powodem używania sprintf lub printf może być to, że chcesz pozwolić użytkownikowi zdefiniować format wyjściowy o pewnej wartości - możesz bezpiecznie pozwolić mu zdefiniować format wyjściowy zgodny z sprintf.

Aha, a twój przykład jest błędny z jednej strony. sprintfzwraca ciąg, ale echonie - echonatychmiast go wypisuje i nic nie zwraca, a sprintftylko zwraca.

1. Jeśli używałeś C / C ++, to przywykłbyś do funkcji sprintf.

2. Istnieje duża szansa, że ​​druga linia jest mniej wydajna. Echo jest zaprojektowane jako polecenie wyjściowe, podczas gdy sprintf służy do zastępowania tokenów łańcuchowych. Nie jestem PHP, ale podejrzewam, że echo zawiera więcej obiektów. Jeśli zachowuje się jak Java, tworzy nowy ciąg za każdym razem, gdy coś jest dodawane do listy, więc powstają 4 ciągi.

Czasami mam coś takiego, co uważam za nieco łatwiejsze do odczytania:

$fileName = sprintf('thumb_%s.%s', 
                    $fileId,
                    $fileInfo['extension']);

Zwykle używam sprintf, aby upewnić się, że identyfikator pochodzący z danych wejściowych użytkownika jest liczbą całkowitą, na przykład:

// is better use prepared statements, but this is practical sometimes
$query = sprintf("SELECT * from articles where id = %d;",$_GET['article_id']);

Służy również do tworzenia podstawowych szablonów (do wiadomości e-mail HTML i innych rzeczy), dzięki czemu możesz ponownie użyć szablonu w wielu miejscach:

$mail_body = "Hello %s, ...";
$oneMail = sprintf($mail_body, "Victor");
$anotherMail = sprintf($mail_body, "Juan");

Bardzo przydatne jest także formatowanie liczb w różnych reprezentacjach (ósemkowe, kontrolowanie miejsca dziesiętnego itp.).

define('TEXT_MESSAGE', 'The variable "%s" is in the middle!');

sprintf(TEXT_MESSAGE, "Var1");
sprintf(TEXT_MESSAGE, "Var2");
sprintf(TEXT_MESSAGE, "Var3");

sprintf jest szczególnie użyteczny podczas formatowania ciągów, które używają liczb. Na przykład,

$oranges = -2.34;
echo sprintf("There are %d oranges in the basket", $oranges);

Output: There are -2 oranges in the basket

Pomarańcze są sformatowane jako liczba całkowita (-2), ale zawiną się na liczbach dodatnich, jeśli użyje się% u dla wartości bez znaku. Aby uniknąć tego zachowania, używam funkcji absolutnej, abs (), aby zaokrąglić liczbę w kierunku zera w następujący sposób:

$oranges = -5.67;
echo sprintf("There are %d oranges in the basket", abs($oranges));

Output: There are 5 oranges in the basket

Wynikiem końcowym jest stwierdzenie o wysokiej czytelności, logicznej budowie, czytelnym formatowaniu i elastyczności w dodawaniu dodatkowych zmiennych zgodnie z wymaganiami. Wraz ze wzrostem liczby zmiennych w połączeniu z funkcjami, które manipulują tymi zmiennymi, korzyści stają się bardziej widoczne. Jako ostatni przykład:

$oranges = -3.14;
$apples = 1.5;
echo sprintf("There are %d oranges and %d apples", abs($oranges), abs($apples));

Output: There are 3 oranges and 4 apples

Lewa strona instrukcji sprintf wyraźnie wyraża ciąg i typy oczekiwanych wartości, podczas gdy prawa strona wyraźnie wyraża używane zmienne i sposób ich manipulacji.

Cóż, sprintf ma wiele możliwości, jak znamy przykład jak poniżej:

Kilka miesięcy temu potrzebowałem przekształcić format sekund na godzinę: minuta: sekundy Tak jak $t = 494050 //secondschciałem wydrukować, 137 h 14 m 10 swięc wymyśliłem funkcję php, springf()po prostu trzymam sekundy $ti echo sprintf("%02d h %s%02d m %s%02d s", floor($t/3600), $f, ($t/60)%60, $f, $t%60);daje mi137 h 14 m 10 s

Funkcja sprintf () jest bardzo przydatna, jeśli wiemy, jak z niej korzystać.

Argument jest taki sam w przypadku używania szablonów. Będziesz chciał oddzielić Textsleev od rzeczywistych wartości zmiennych. Poza dodatkowymi mocami sprintf, o których wspomnieliśmy, to tylko kwestia stylu.

Naprawdę dobrym przykładem użycia sprintf jest wyprowadzanie wypełnionych formatów liczb, a także mieszanie różnych typów w ciągu. W wielu przypadkach może być łatwiejszy do odczytania i sprawia, że ​​bardzo proste jest drukowanie różnych reprezentacji tej samej zmiennej, szczególnie numerycznych.

Korzystanie z funkcji sprintf () w porównaniu ze zwykłą konkatenacją ma tę zaletę, że można stosować różne typy formatowania zmiennych, które mają być konkatenowane.

W twoim przypadku masz

$output = sprintf("Here is the result: %s for this date %s", $result, $date);

i

$output = 'Here is the result: ' .$result. ' for this date ' .$date;

Weźmy $result = 'passed'; date = '23rd';

Za pomocą zwykłej konkatenacji można uzyskać tylko wynik:

Here is the result: passed for this date 23rd

Jeśli jednak użyjesz sprintf(), możesz uzyskać zmodyfikowane dane wyjściowe, takie jak:

$output = sprintf('Here is the result: %.4s for this date %.2s',$result,$date);
echo $output;

Wynik:

Here is the result: pass for this date 23

sprintf()jest dość podobny do printf(). Jeśli wiesz printf()szczegółowo, to sprintf()nawet vsprintf()nie jest naprawdę trudne do zrozumienia.

jedną z rzeczy, która różni się sprintf()od printf()jest to, że trzeba będzie zadeklarować zmienną złapać wyjście z funkcji, gdyż nie bezpośrednio drukować / echo nic. Zobaczmy następujące fragmenty kodu:

printf("Hello %s", "world"); // "Hello world"

sprintf("Hello %s", "world"); // does not display anything

echo sprintf("Hello %s", "world"); // "Hello world"

$a = sprintf("Hello %s", "world"); // does not display anything

echo $a;// "Hello world"

Mam nadzieję, że to pomaga.

Jedno „wyjście”, drugie „powrót”, to jedna z głównych różnic.

printf() Wyjścia

sprintf() Zwroty

Podczas używania sprintf w pętlach należy zachować ostrożność:

$a = 'Anton';
$b = 'Bert';
$c = 'Corni';
$d = 'Dora';
$e = 'Emiel';
$f = 'Falk';
$loops = 10000000;

$time = microtime(true);

for ($i = 0; $i < $loops; $i++)
{
    $test = $a . $b . $c . $d . $e . $f;
}

$concatTime = microtime(true) - $time;

$time = microtime(true);

for ($i = 0; $i < $loops; $i++)
{
    $test = "$a $b $c $d $e $f";
}

$concat2Time = microtime(true) - $time;

$time = microtime(true);

for ($i = 0; $i < $loops; $i++)
{
    $test = sprintf('%s %s %s %s %s %s', $a, $b, $c, $d, $e, $f);
}

$sprintfTime = microtime(true) - $time;

echo 'Loops: ' . $loops . '<br>';
echo '\'$a . $b . $c . $d . $e . $f\'' . ' needs ' . $concatTime  . 's<br>';
echo '"$a $b $c $d $e $f"' . ' needs ' . $concat2Time  . 's<br>';
echo 'sprintf(\'%s %s %s %s %s %s\', $a, $b, $c, $d, $e, $f)' . ' needs ' . $sprintfTime  . 's<br>';

Co prowadzi do następujących czasów (na mojej lokalnej maszynie z PHP 7.2):

Pętle: 10000000

„$ a. $ b. $ c. $ d. $ e. $ f 'potrzebuje 1.4507689476013s

„$ a $ b $ c $ d $ e $ f” potrzebuje 1,9958319664001s

sprintf ('% s% s% s% s% s% s', $ a, $ b, $ c, $ d, $ e, $ f) potrzebuje 9.1771278381348s

Używam go do wysyłania wiadomości do użytkowników lub innych „ładnych” rodzajów funkcjonalności. Na przykład, jeśli wiem, że użyję nazwy użytkownika.

$name = 'Some dynamic name';

I mieć wiele wiadomości do wykorzystania w tej sytuacji. (Tzn. Blokowanie lub śledzenie innego użytkownika)

$messageBlock = 'You have blocked %s from accessing you.';
$messageFollow = 'Following %s is a great idea!';

Możesz stworzyć ogólną funkcję, która robi coś dla użytkownika i dodać ten ciąg, i bez względu na strukturę zdania powinno to wyglądać całkiem ładnie. Zawsze nie lubię dodawać razem ciągów znaków i ciągle używać notacji kropkowej oraz ciągów zamykających i ponownie otwierających, aby zdanie wyglądało dobrze. Z początku byłem fanem, jak większość, ale wydaje się to bardzo przydatne, gdy trzeba manipulować wieloma łańcuchami i nie chcesz za każdym razem umieszczać zmiennej w kodzie.

Pomyśl o tym, co wygląda lepiej?

return $messageOne === true ? $name.'. Please use the next example' : 'Hi '.$name.', how are you?'

Lub

$message = $messageOne === true ? 'Option one %s' 
: ($messageTwo === true ? 'Option Two %s maybe?' : '%s you can choose from tons of grammatical instances and not have to edit variable placement and strings');

return sprintf($message, $name);

Pewnie, że to dodatkowy krok, ale co, jeśli twoje testy warunkowe wykonują wiele innych czynności funkcjonalnych, wówczas cytaty i dołączanie zaczynają przeszkadzać w funkcjonalnym kodowaniu.