Pengantar Apache Tapestry

1. Ikhtisar

Saat ini, dari jejaring sosial hingga perbankan, perawatan kesehatan hingga layanan pemerintah, semua aktivitas tersedia secara online. Oleh karena itu, mereka sangat bergantung pada aplikasi web.

Aplikasi web memungkinkan pengguna untuk mengkonsumsi / menikmati layanan online yang disediakan oleh sebuah perusahaan. Pada saat yang sama, ini bertindak sebagai antarmuka ke perangkat lunak backend.

Dalam tutorial pengantar ini, kita akan menjelajahi kerangka web Apache Tapestry dan membuat aplikasi web sederhana menggunakan fitur-fitur dasar yang disediakannya.

2. Permadani Apache

Apache Tapestry adalah kerangka kerja berbasis komponen untuk membangun aplikasi web yang dapat diskalakan.

Ini mengikuti paradigma konvensi-over-konfigurasi dan menggunakan anotasi dan konvensi penamaan untuk konfigurasi.

Semua komponen adalah POJO sederhana. Pada saat yang sama, mereka dikembangkan dari awal dan tidak memiliki ketergantungan pada pustaka lain.

Bersamaan dengan dukungan Ajax, Tapestry juga memiliki kemampuan pelaporan pengecualian yang hebat. Ini menyediakan pustaka lengkap dari komponen umum bawaan juga.

Di antara fitur-fitur hebat lainnya, yang menonjol adalah hot reload kode. Oleh karena itu, dengan menggunakan fitur ini, kita dapat melihat perubahan secara instan di lingkungan pengembangan.

3. Penyiapan

Apache Tapestry membutuhkan seperangkat alat sederhana untuk membuat aplikasi web:

  • Java 1.6 atau yang lebih baru
  • Build Tool (Maven atau Gradle)
  • IDE (Eclipse atau IntelliJ)
  • Server Aplikasi (Tomcat atau Jetty)

Dalam tutorial ini, kita akan menggunakan kombinasi Java 8, Maven, Eclipse, dan Jetty Server.

Untuk menyiapkan proyek Apache Tapestry terbaru, kami akan menggunakan arketipe Maven dan mengikuti instruksi yang diberikan oleh dokumentasi resmi:

$ mvn archetype:generate -DarchetypeCatalog=//tapestry.apache.org

Atau, jika kita memiliki proyek yang sudah ada, kita cukup menambahkan ketergantungan Maven tapestry-core ke pom.xml :

 org.apache.tapestry tapestry-core 5.4.5 

Setelah kita siap dengan pengaturannya, kita dapat memulai aplikasi apache-tapestry dengan perintah Maven berikut:

$ mvn jetty:run

Secara default, aplikasi akan dapat diakses di localhost: 8080 / apache-tapestry :

4. Struktur Proyek

Mari jelajahi tata letak proyek yang dibuat oleh Apache Tapestry:

Kita dapat melihat struktur proyek mirip Maven, bersama dengan beberapa paket berdasarkan konvensi.

Kelas Java ditempatkan di src / main / java dan dikategorikan sebagai komponen , halaman , dan layanan.

Demikian pula, src / main / resources menampung template kami (mirip dengan file HTML) - ini memiliki ekstensi .tml .

Untuk setiap kelas Java yang ditempatkan di bawah direktori komponen dan halaman , file template dengan nama yang sama harus dibuat.

Direktori src / main / webapp berisi sumber daya seperti gambar, stylesheet, dan file JavaScript. Demikian pula, file pengujian ditempatkan di src / test .

Terakhir, src / situs akan berisi file dokumentasi.

Untuk ide yang lebih baik, mari kita lihat struktur proyek yang dibuka di Eclipse IDE:

5. Anotasi

Mari kita bahas beberapa anotasi praktis yang disediakan oleh Apache Tapestry untuk penggunaan sehari-hari. Untuk selanjutnya, kami akan menggunakan anotasi ini dalam penerapan kami.

5.1. @Menyuntikkan

The @Inject penjelasan tersedia di org.apache.tapestry5.ioc.annotations paket dan menyediakan cara mudah untuk menyuntikkan dependensi di kelas Java.

Anotasi ini sangat berguna untuk memasukkan aset, blok, sumber daya, dan layanan.

5.2. @Injectage

Tersedia dalam paket org.apache.tapestry5.annotations , anotasi @InjectPage memungkinkan kita memasukkan halaman ke dalam komponen lain. Selain itu, halaman yang dimasukkan selalu merupakan properti hanya-baca.

5.3. @Injeksi

Demikian pula, anotasi @InjectComponent memungkinkan kita memasukkan komponen yang ditentukan dalam template.

5.4. @Catatan

The @Log penjelasan tersedia di org.apache.tapestry5.annotations paket dan berguna untuk memungkinkan tingkat DEBUG logging pada metode apapun. Ini mencatat masuk dan keluar metode, bersama dengan nilai parameter.

5.5. @Properti

Available in the org.apache.tapestry5.annotations package, the @Property annotation marks a field as a property. At the same time, it automatically creates getters and setters for the property.

5.6. @Parameter

Similarly, the @Parameter annotation denotes that a field is a component parameter.

6. Page

So, we're all set to explore the basic features of the framework. Let's create a new Home page in our app.

First, we'll define a Java class Home in the pages directory in src/main/java:

public class Home { }

6.1. Template

Then, we'll create a corresponding Home.tml template in the pages directory under src/main/resources.

A file with the extension .tml (Tapestry Markup Language) is similar to an HTML/XHTML file with XML markup provided by Apache Tapestry.

For instance, let's have a look at the Home.tml template:

  apache-tapestry Home   

Voila! Simply by restarting the Jetty server, we can access the Home page at localhost:8080/apache-tapestry/home:

6.2. Property

Let's explore how to render a property on the Home page.

For this, we'll add a property and a getter method in the Home class:

@Property private String appName = "apache-tapestry"; public Date getCurrentTime() { return new Date(); }

To render the appName property on the Home page, we can simply use ${appName}.

Similarly, we can write ${currentTime} to access the getCurrentTime method from the page.

6.3. Localization

Apache Tapestry provides integrated localization support. As per convention, a page name property file keeps the list of all the local messages to render on the page.

For instance, we'll create a home.properties file in the pages directory for the Home page with a local message:

introMsg=Welcome to the Apache Tapestry Tutorial

The message properties are different from the Java properties.

For the same reason, the key name with the message prefix is used to render a message property — for instance, ${message:introMsg}.

6.4. Layout Component

Let's define a basic layout component by creating the Layout.java class. We'll keep the file in the components directory in src/main/java:

public class Layout { @Property @Parameter(required = true, defaultPrefix = BindingConstants.LITERAL) private String title; }

Here, the title property is marked required, and the default prefix for binding is set as literal String.

Then, we'll write a corresponding template file Layout.tml in the components directory in src/main/resources:

  ${title} 
     

© Your Company

Now, let's use the layout on the home page:

${message:introMsg}

${currentTime}

Note, the namespace is used to identify the elements (t:type and t:body) provided by Apache Tapestry. At the same time, the namespace also provides components and attributes.

Here, the t:type will set the layout on the home page. And, the t:body element will insert the content of the page.

Let's take a look at the Home page with the layout:

7. Form

Let's create a Login page with a form, to allow users to sign-in.

As already explored, we'll first create a Java class Login:

public class Login { // ... @InjectComponent private Form login; @Property private String email; @Property private String password; }

Here, we've defined two properties — email and password. Also, we've injected a Form component for the login.

Then, let's create a corresponding template login.tml:

Please sign in

Now, we can access the login page at localhost:8080/apache-tapestry/login:

8. Validation

Apache Tapestry provides a few built-in methods for form validation. It also provides ways to handle the success or failure of the form submission.

The built-in method follows the convention of the event and the component name. For instance, the method onValidationFromLogin will validate the Login component.

Likewise, methods like onSuccessFromLogin and onFailureFromLogin are for success and failure events respectively.

So, let's add these built-in methods to the Login class:

public class Login { // ... void onValidateFromLogin() { if (email == null) System.out.println("Email is null); if (password == null) System.out.println("Password is null); } Object onSuccessFromLogin() { System.out.println("Welcome! Login Successful"); return Home.class; } void onFailureFromLogin() { System.out.println("Please try again with correct credentials"); } }

9. Alerts

Form validation is incomplete without proper alerts. Not to mention, the framework also has built-in support for alert messages.

For this, we'll first inject the instance of the AlertManager in the Login class to manage the alerts. Then, replace the println statements in existing methods with the alert messages:

public class Login { // ... @Inject private AlertManager alertManager; void onValidateFromLogin() { if(email == null || password == null) { alertManager.error("Email/Password is null"); login.recordError("Validation failed"); //submission failure on the form } } Object onSuccessFromLogin() { alertManager.success("Welcome! Login Successful"); return Home.class; } void onFailureFromLogin() { alertManager.error("Please try again with correct credentials"); } }

Let's see the alerts in action when the login fails:

10. Ajax

So far, we've explored the creation of a simple home page with a form. At the same time, we've seen the validations and support for alert messages.

Next, let's explore the Apache Tapestry's built-in support for Ajax.

First, we'll inject the instance of the AjaxResponseRenderer and Block component in the Home class. Then, we'll create a method onCallAjax for processing the Ajax call:

public class Home { // .... @Inject private AjaxResponseRenderer ajaxResponseRenderer; @Inject private Block ajaxBlock; @Log void onCallAjax() { ajaxResponseRenderer.addRender("ajaxZone", ajaxBlock); } }

Also, we need to make a few changes in our Home.tml.

First, we'll add the eventLink to invoke the onCallAjax method. Then, we'll add a zone element with id ajaxZone to render the Ajax response.

Last, we need to have a block component that will be injected in the Home class and rendered as Ajax response:

Call Ajax


Rendered through Ajax

The current time is: ${currentTime}

Let's take a look at the updated home page:

Then, we can click the Call Ajax button and see the ajaxResponseRenderer in action:

11. Logging

To enable the built-in logging feature, the instance of the Logger is required to be injected. Then, we can use it to log at any level like TRACE, DEBUG, and INFO.

Jadi, mari buat perubahan yang diperlukan di kelas Home :

public class Home { // ... @Inject private Logger logger; void onCallAjax() { logger.info("Ajax call"); ajaxResponseRenderer.addRender("ajaxZone", ajaxBlock); } }

Sekarang, ketika kita mengklik tombol Panggil Ajax, logger akan masuk pada level INFO:

[INFO] pages.Home Ajax call 

12. Kesimpulan

Pada artikel ini, kami telah menjelajahi kerangka kerja web Apache Tapestry.

Untuk memulainya, kami telah membuat aplikasi web quickstart dan menambahkan halaman Beranda menggunakan fitur dasar Apache Tapestry, seperti komponen , halaman , dan template .

Kemudian, kami telah memeriksa beberapa anotasi praktis yang disediakan oleh Apache Tapestry untuk mengonfigurasi properti dan injeksi komponen / halaman.

Terakhir, kami telah menjelajahi Ajax bawaan dan dukungan logging yang disediakan oleh framework.

Seperti biasa, semua implementasi kode tersedia di GitHub.