Cara Menggunakan Antara Muka JSonserializable

3

Sejak beberapa tahun kebelakangan JSON telah mengambil alih sebagai raja format pertukaran data. Sebelum JSON, XML memerintah roost. Ia hebat untuk memodelkan data kompleks tetapi sukar untuk menghuraikan dan sangat verbose. JSON benar -benar berlepas dengan percambahan tapak yang didorong oleh Ajax yang kaya kerana ia adalah format yang sangat mudah dibaca, cepat untuk menghuraikan dan perwakilan kunci/nilai mudahnya memotong semua kelebihan XML.

Saya fikir kita semua boleh bersetuju bahawa menulis kurang kod yang seterusnya memerlukan penyelenggaraan yang kurang dan memperkenalkan kurang bug adalah matlamat yang kita semua ingin capai. Dalam jawatan ini, saya ingin memperkenalkan anda kepada antara muka yang diketahui yang diperkenalkan dalam Php 5.4.0 yang dipanggil JSonserializable.

Sebelum antara muka jSonserializable tersedia, mengembalikan perwakilan yang dikodkan oleh JSON objek untuk perkhidmatan yang memakan bermakna salah satu daripada dua perkara.

Takeaways Key

Antara muka JSonserializable dalam Php 5.4.0 menawarkan cara yang lebih berkesan untuk mengembalikan perwakilan yang dikodkan oleh JSON objek, menghapuskan keperluan untuk membina struktur data di luar objek atau menginternalisasi fungsi pengekodan dalam objek.

Antara muka jSonserializable membolehkan pelaksanaan kaedah jSonserialize dalam kelas, yang secara automatik dicetuskan apabila contoh kelas adalah JSON yang dikodkan. Kaedah ini mengembalikan pelbagai data objek, memudahkan proses mengemas kini data jika perubahan diperlukan.

Melaksanakan antara muka jSonserializable meningkatkan pemeliharaan kod dan mengurangkan peluang untuk memperkenalkan pepijat, kerana ia menghilangkan duplikasi dan memudahkan orang lain untuk menguji keupayaan objek untuk dikodkan dengan memeriksa apakah itu contoh jSonserializable.

hodoh
Pendekatan pertama adalah untuk membina struktur data di luar objek yang mengandungi semua data yang ingin kami dedahkan.
• kami menggunakan array di sini untuk memegang data dari objek pelanggan yang kami mahu encode, tetapi ia dapat dengan mudah menjadi stdclass.

Pendekatan ini fleksibel dan berkhidmat dengan tujuannya dalam situasi yang sangat mudah di mana kita tahu bahawa objek pelanggan tidak akan berubah dan kami hanya memerlukan data pelanggan dalam format ini, di satu tempat ini. Kami juga mempunyai pilihan untuk menambah data ke array ini dari sumber lain jika kita perlu.

Walau bagaimanapun, seperti yang kita semua berpengalaman pada satu masa atau yang lain, andaian yang telah kami buat dapat terbukti palsu pada suatu masa notis. Kami mungkin mendapat keperluan yang meminta kami menambah lebih banyak data ke kelas pelanggan. Data baru itu perlu dikembalikan ke perkhidmatan yang memakan dan kami akan mahu melakukan ini di banyak tempat.

Seperti yang anda bayangkan, pendekatan ini dengan cepat menjadi menyusahkan. Bukan sahaja kita perlu menduplikasi kod array ini di seluruh permohonan kita, kita perlu ingat untuk mengemas kini semua keadaan apabila lebih banyak perubahan tidak dapat dielakkan. Ada cara lain, yang akan membantu kita membatalkan beberapa isu ini.

yang buruk

bernasib baik kami pintar apabila permintaan perubahan pertama masuk dan kami menyedari bahawa menduplikasi array kami akan menjadi mimpi ngeri, jadi apa yang kami memutuskan untuk dilakukan adalah menginternalisasi fungsi pengekodan dalam objek kami, mengeluarkan isu penyelenggaraan dan mengurangkan kemungkinan memperkenalkan pepijat.

<span><span><?php </span></span><span>
</span><span><span>class Customer
</span></span><span><span>{
</span></span><span>
</span><span>    <span>private $email = null;
</span></span><span>    <span>private $name = null;
</span></span><span>
</span><span>    <span>public function __construct($email, $name)
</span></span><span>    <span>{
</span></span><span>        <span>$this->email = $email;
</span></span><span>        <span>$this->name = $name;
</span></span><span>    <span>}
</span></span><span>
</span><span>    <span>public function getName()
</span></span><span>    <span>{
</span></span><span>        <span>return $this->name;
</span></span><span>    <span>}
</span></span><span>
</span><span>    <span>public function getEmail()
</span></span><span>    <span>{
</span></span><span>        <span>return $this->email;
</span></span><span>    <span>}
</span></span><span><span>}
</span></span><span>
</span><span><span>$customer = new Customer('customer@sitepoint.com', 'Joe');
</span></span><span>
</span><span><span>$data = [
</span></span><span>    <span>'customer' => [
</span></span><span>        <span>'email' => $customer->getEmail(),
</span></span><span>        <span>'name' => $customer->getName()
</span></span><span>    <span>]
</span></span><span><span>];
</span></span><span>
</span><span><span>echo json_encode($data);</span></span></span>

Sekarang jika ada lagi permintaan perubahan yang masuk yang ingin lebih banyak data ditambah dan dikembalikan dari objek pelanggan kita hanya dapat mengemas kini kaedah Tojson.

Pendekatan ini mempunyai kelemahan sendiri, walaupun. Sesiapa sahaja yang datang dan ingin menggunakan pelanggan kami perlu mengetahui kaedah Tojson ini kerana ia bukan sesuatu yang mudah diperiksa, jadi kami memerlukan dokumentasi yang tepat. Kami juga perlu ingat bahawa kaedah ini

mengembalikan json sekarang, (walaupun kita boleh menggerakkan siri di luar kaedah). Ini menjadikan menggabungkan data pelanggan dengan sumber data lain yang lebih janggal kerana kita perlu berhati -hati untuk tidak menyandarkan hasil kaedah ini sekali lagi kerana itu akan menyebabkan beberapa bug jahat. yang baik

Akhirnya, masukkan antara muka jSonserializable. Ini memberi kita semua fleksibiliti senario yang hodoh dengan faedah pemeliharaan senario yang buruk. Walaupun untuk menggunakan antara muka ini, anda perlu menjalankan Php 5.4.0 yang mana anda harus lakukan, kerana terdapat banyak penambahbaikan berbanding versi yang lebih lama.

jadi, untuk perniagaan.

Seperti yang anda lihat, kami melaksanakan jSonserializable dengan menambahkan antara muka ke kelas kami dan kemudian menambahkan kaedah jSonserialize ke badan kelas kami untuk memenuhi kontrak antara muka.

<span><span><?php </span></span><span>
</span><span><span>class Customer
</span></span><span><span>{
</span></span><span>
</span><span>    <span>public $email = null;
</span></span><span>    <span>public $name = null;
</span></span><span>
</span><span>    <span>public function __construct($email, $name)
</span></span><span>    <span>{
</span></span><span>        <span>$this->email = $email;
</span></span><span>        <span>$this->name = $name;
</span></span><span>    <span>}
</span></span><span>
</span><span>    <span>public function getName()
</span></span><span>    <span>{
</span></span><span>        <span>return $this->name;
</span></span><span>    <span>}
</span></span><span>
</span><span>    <span>public function getEmail()
</span></span><span>    <span>{
</span></span><span>        <span>return $this->email;
</span></span><span>    <span>}
</span></span><span>
</span><span>    <span>public function toJson()
</span></span><span>    <span>{
</span></span><span>        <span>return json_encode([
</span></span><span>            <span>'customer' => [
</span></span><span>                <span>'email' => $this->getEmail(),
</span></span><span>                <span>'name' => $this->getName()
</span></span><span>            <span>]
</span></span><span>        <span>]);
</span></span><span>    <span>}
</span></span><span><span>}
</span></span><span>
</span><span><span>$customer = new Customer('customer@sitepoint.com', 'Joe');
</span></span><span>
</span><span><span>echo $customer->toJson();</span></span></span>

Dalam kaedah jSonserialize kami membina dan mengembalikan pelbagai data objek, seperti yang kita lakukan dengan contoh -contoh lain. Sekali lagi jika ada perubahan maka kita hanya boleh mengemas kini kaedah ini. Anda akan melihat bahawa kaedah jSonserialize hanya mengembalikan array.

Keajaiban datang apabila anda ingin mencetuskan kaedah ini, yang perlu kita lakukan sekarang ialah JSON menyandarkan contoh kelas ini dan kaedah ini akan dipanggil secara automatik, pelbagai data yang dikembalikan dan kemudian dikodkan! Sekarang bahawa kelas melaksanakan antara muka yang kita mendapat manfaat daripada dapat memeriksa sama ada kelas ini adalah contoh JSonserializable. Sekiranya anda mahu, anda juga boleh menaip petunjuk dalam kaedah untuk memastikan antara muka jSonserializable diluluskan.

Ringkasan

Dengan pelaksanaan mudah ini, kami telah menghapuskan pertindihan, menurunkan jumlah penyelenggaraan dan mengurangkan peluang memperkenalkan pepijat. Kami juga menjadikannya sepele untuk orang lain menggunakan kod kami untuk menguji keupayaan objek yang dikodkan dengan memeriksa sama ada ia adalah contoh jSonserializable.

Contoh -contoh di atas sudah tentu dirangka, bagaimanapun, saya harap saya telah berjaya menunjukkan manfaat menggunakan antara muka ini dan memberi inspirasi kepada anda untuk meneruskan dan menggunakannya sendiri.

Soalan Lazim (Soalan Lazim) Mengenai Interface JSonserializable

Apakah tujuan utama antara muka jSonserializable dalam PHP? Apabila objek diserahkan kepada fungsi JSON_ENCODE (), jika ia melaksanakan antara muka JSonserializable, kaedah JSonserialize () akan dipanggil, yang membolehkan objek untuk menentukan bagaimana ia harus bersiri. Ini memberikan tahap kawalan yang tinggi ke atas output JSON, menjadikannya lebih mudah untuk menguruskan struktur data yang kompleks atau melakukan transformasi pada data sebelum dikodkan. 🎜> Kaedah jSonserialize () adalah sebahagian daripada antara muka jSonserializable. Apabila objek yang melaksanakan antara muka ini dihantar ke json_encode (), kaedah jSonserialize () secara automatik dipanggil. Kaedah ini harus mengembalikan struktur data yang siap untuk bersiri ke JSON. Ini boleh menjadi array, rentetan, nombor, atau objek lain. Data yang dikembalikan kemudiannya akan dikodkan oleh json_encode () ke dalam rentetan json. Kaedah jSonserialize () mempunyai akses kepada sifat peribadi dan dilindungi objek, yang membolehkan anda memasukkannya dalam data yang dikembalikan untuk siri. Ini berguna apabila anda ingin menyandarkan keadaan dalaman objek ke dalam JSON, tetapi masih menyimpan sifat -sifat peribadi atau dilindungi dalam kelas. > Jika pengecualian dibuang dalam kaedah JSonserialize (), ia tidak akan ditangkap oleh JSON_ENCODE (). Sebaliknya, json_encode () akan kembali palsu, dan pengecualian perlu ditangkap dan ditangani secara berasingan. Untuk mengendalikan pengecualian dalam jSonserialize (), anda boleh menggunakan blok percubaan dalam kaedah itu sendiri, yang membolehkan anda menguruskan pengecualian dan mengembalikan struktur data yang sah untuk siri. ? Untuk menyahkod JSON, anda akan menggunakan fungsi JSON_DECODE (). Walau bagaimanapun, anda boleh membuat kaedah dalam kelas anda untuk mengendalikan penyahkodan dan pembinaan semula objek dari rentetan JSON.

Bagaimanakah saya boleh menggunakan antara muka jSonserializable dengan objek bersarang? Apabila json_encode () dipanggil pada objek induk, ia juga akan memanggil jSonserialize () pada setiap objek bersarang, yang membolehkan setiap orang menentukan bagaimana ia harus bersiri. >

Ya, anda boleh menggunakan antara muka jSonserializable dengan tatasusunan. Jika array mengandungi objek, setiap objek harus melaksanakan antara muka jSonserializable. Apabila json_encode () dipanggil pada array, ia akan memanggil jSonserialize () pada setiap objek dalam array, yang membolehkan setiap orang menentukan bagaimana ia harus bersiri. ?

Anda boleh menyesuaikan output JSON dengan mengembalikan struktur data tersuai dari kaedah jSonserialize (). Ini boleh menjadi array dengan kunci tersuai, rentetan, nombor, atau objek lain. Struktur data yang anda kembali dari jSonserialize () akan menjadi data yang dikodkan ke dalam json. susunan multidimensi. Jika tatasusunan mengandungi objek, setiap objek harus melaksanakan antara muka jSonserializable. Apabila json_encode () dipanggil pada pelbagai multidimensi, ia akan memanggil jSonserialize () pada setiap objek dalam array, yang membolehkan setiap orang menentukan bagaimana ia harus bersiri. Array? Jika array mengandungi objek, setiap objek harus melaksanakan antara muka jSonserializable. Apabila json_encode () dipanggil pada array yang tidak bersekutu, ia akan memanggil jSonserialize () pada setiap objek dalam array, yang membolehkan setiap orang menentukan bagaimana ia harus bersiri.

Atas ialah kandungan terperinci Cara Menggunakan Antara Muka JSonserializable. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!