Въведение в гоблена Apache

1. Общ преглед

В днешно време, от социалните мрежи до банковото дело, здравеопазването до държавните услуги, всички дейности са достъпни онлайн. Следователно те разчитат много на уеб приложения.

Уеб приложение позволява на потребителите да се възползват / да се наслаждават на онлайн услугите, предоставяни от компания. В същото време той действа като интерфейс към бекенд софтуера.

В този уводен урок ще изследваме уеб рамката на Apache Tapestry и ще създадем просто уеб приложение, използвайки основните функции, които предоставя.

2. Гоблен Apache

Apache Tapestry е базирана на компоненти рамка за изграждане на мащабируеми уеб приложения.

Той следва парадигмата на конвенцията за конфигуриране и използва конвенции за анотации и имена за конфигурации.

Всички компоненти са прости POJO. В същото време те са разработени от нулата и нямат зависимост от други библиотеки.

Заедно с поддръжката на Ajax, Tapestry има и големи възможности за отчитане на изключения. Той предоставя и обширна библиотека от вградени общи компоненти.

Сред другите страхотни функции, видна е горещото презареждане на кода. Следователно, използвайки тази функция, можем незабавно да видим промените в средата за разработка.

3. Настройка

Apache Tapestry изисква прост набор от инструменти за създаване на уеб приложение:

  • Java 1.6 или по-нова версия
  • Инструмент за изграждане (Maven или Gradle)
  • IDE (Eclipse или IntelliJ)
  • Сървър за приложения (Tomcat или Jetty)

В този урок ще използваме комбинацията от Java 8, Maven, Eclipse и Jetty Server.

За да създадем най-новия проект на Apache Tapestry, ще използваме архетипа Maven и следваме инструкциите, предоставени от официалната документация:

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

Или, ако имаме съществуващ проект, можем просто да добавим зависимостта Maven на ядрото на гобена към pom.xml :

 org.apache.tapestry tapestry-core 5.4.5 

След като сме готови с настройката, можем да стартираме приложението apache-гоблен чрез следната команда Maven:

$ mvn jetty:run

По подразбиране приложението ще бъде достъпно на localhost: 8080 / apache-tapestry :

4. Структура на проекта

Нека разгледаме оформлението на проекта, създадено от Apache Tapestry:

Можем да видим подобна на Maven структура на проекти, заедно с няколко пакета, базирани на конвенции.

Класовете Java се поставят в src / main / java и се категоризират като компоненти , страници и услуги.

По същия начин src / main / resources съдържат нашите шаблони (подобно на HTML файловете) - те имат разширението .tml .

За всеки клас Java, поставен под директории на компоненти и страници , трябва да се създаде файл с шаблон със същото име.

Директорията src / main / webapp съдържа ресурси като изображения, таблици със стилове и JavaScript файлове. По същия начин тестовите файлове се поставят в src / test .

И накрая, src / site ще съдържа файловете с документация.

За по-добра идея, нека да разгледаме структурата на проекта, отворена в Eclipse IDE:

5. Анотации

Нека обсъдим няколко полезни пояснения, предоставени от Apache Tapestry за ежедневна употреба. Занапред ще използваме тези пояснения в нашите внедрения.

5.1. @ Инжектиране

В @Inject анотацията е наличен в org.apache.tapestry5.ioc.annotations пакета и предоставя лесен начин да се инжектира зависимости в класове на Java.

Тази анотация е доста удобна за инжектиране на актив, блок, ресурс и услуга.

5.2. @InjectPage

Предлага се в org.apache.tapestry5.annotations пакета, @InjectPage анотация ни позволява да се инжектира страница в друг компонент. Освен това инжектираната страница винаги е свойство само за четене.

5.3. @InjectComponent

По същия начин анотацията @InjectComponent ни позволява да инжектираме компонент, дефиниран в шаблона.

5.4. @ Влез

В @Log анотацията е наличен в org.apache.tapestry5.annotations пакета и е удобно да разрешите записване на ниво DEBUG на всеки метод. Той регистрира влизането и излизането на метода, заедно със стойностите на параметрите.

5.5. @Имот

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.

И така, нека направим необходимите промени в началния клас:

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

Сега, когато щракнем върху бутона Call Ajax, регистраторът ще влезе на ниво INFO:

[INFO] pages.Home Ajax call 

12. Заключение

В тази статия разгледахме уеб рамката на Apache Tapestry.

Като начало създадохме уеб приложение за бързо стартиране и добавихме начална страница, използвайки основните функции на Apache Tapestry, като компоненти , страници и шаблони .

След това разгледахме няколко полезни анотации, предоставени от Apache Tapestry, за да конфигурираме свойство и инжектиране на компонент / страница.

И накрая, проучихме вградения Ajax и поддръжката на регистриране, предоставена от рамката.

Както обикновено, всички реализации на кода са достъпни в GitHub.