Pengantar Bermain di Java

1. Ikhtisar

Tujuan dari tutorial intro ini adalah untuk menjelajahi Kerangka Play dan mencari tahu bagaimana kita dapat membuat aplikasi web dengannya.

Play adalah framework aplikasi web produktivitas tinggi untuk bahasa pemrograman yang kodenya dikompilasi dan dijalankan di JVM, terutama Java dan Scala. Ini mengintegrasikan komponen dan API yang kami butuhkan untuk pengembangan aplikasi web modern.

2. Mainkan Pengaturan Kerangka

Mari menuju ke halaman resmi kerangka Play dan mengunduh versi terbaru dari distribusinya. Pada saat tutorial ini, yang terbaru adalah versi 2.7.

Kami akan mengunduh folder zip tutorial Play Java Hello World dan mengekstrak file tersebut ke lokasi yang nyaman. Di root folder ini, kita akan menemukan sbt yang dapat dieksekusi yang dapat kita gunakan untuk menjalankan aplikasi. Atau, kita dapat menginstal sbt dari halaman resmi mereka.

Untuk menggunakan sbt dari folder yang diunduh, lakukan hal berikut:

cd /path/to/folder/ ./sbt run

Perhatikan bahwa kita menjalankan skrip di direktori saat ini, karenanya menggunakan sintaks ./ .

Jika kita menginstal sbt, maka kita dapat menggunakannya sebagai gantinya:

cd /path/to/folder/ sbt run

Setelah menjalankan perintah ini, kita akan melihat pernyataan yang berbunyi “(Server dimulai, gunakan Enter untuk berhenti dan kembali ke konsol…)”. Ini berarti aplikasi kita sudah siap, oleh karena itu kita sekarang dapat menuju ke // localhost: 9000 di mana kita akan disajikan dengan halaman Selamat Datang Play:

3. Anatomi Aplikasi Play

Di bagian ini, kita akan mendapatkan pemahaman yang lebih baik tentang bagaimana aplikasi Play disusun dan untuk apa setiap file dan direktori dalam struktur itu digunakan.

Jika Anda ingin langsung menantang diri Anda sendiri dengan contoh sederhana, lompat ke bagian berikutnya.

Ini adalah file dan folder yang kami temukan di aplikasi Play Framework biasa:

├── app → Application sources │   ├── assets → Compiled Asset sources │   │   ├── javascripts → Typically Coffee Script sources │   │   └── stylesheets → Typically LESS CSS sources │   ├── controllers → Application controllers │   ├── models → Application business layer │   └── views → Templates ├── build.sbt → Application build script ├── conf → Configurations files and other non-compiled resources (on classpath) │   ├── application.conf → Main configuration file │   └── routes → Routes definition ├── dist → Arbitrary files to be included in your projects distribution ├── lib → Unmanaged libraries dependencies ├── logs → Logs folder │   └── application.log → Default log file ├── project → sbt configuration files │   ├── build.properties → Marker for sbt project │   └── plugins.sbt → sbt plugins including the declaration for Play itself ├── public → Public assets │   ├── images → Image files │   ├── javascripts → Javascript files │   └── stylesheets → CSS files ├── target → Generated files │   ├── resolution-cache → Information about dependencies │   ├── scala-2.11 │   │   ├── api → Generated API docs │   │   ├── classes → Compiled class files │   │   ├── routes → Sources generated from routes │   │   └── twirl → Sources generated from templates │   ├── universal → Application packaging │   └── web → Compiled web assets └── test → source folder for unit or functional tests 

3.1. The app Directory

Direktori ini berisi kode sumber Java, templat web, dan sumber aset yang dikompilasi - pada dasarnya, semua sumber dan semua sumber daya yang dapat dieksekusi.

Direktori app berisi beberapa subdirektori penting, yang masing-masing memaketkan satu bagian dari pola arsitektur MVC:

  • model - ini adalah lapisan bisnis aplikasi, file dalam paket ini mungkin akan memodelkan tabel database kami dan memungkinkan kami untuk mengakses lapisan persistensi
  • views - semua template HTML yang dapat di-render ke browser ada di folder ini
  • controller - subdirektori di mana kita memiliki controller kita. Pengontrol adalah file sumber Java yang berisi tindakan yang akan dijalankan untuk setiap panggilan API. Tindakan adalah metode publik yang memproses permintaan HTTP dan mengembalikan hasil yang sama seperti tanggapan HTTP
  • assets - subdirektori yang berisi kumpulan aset seperti CSS dan javascript. Konvensi penamaan di atas fleksibel, kita bisa membuat paket kita misalnya paket app / utils . Kami juga dapat menyesuaikan aplikasi penamaan paket / com / baeldung / controllers

Ini juga berisi file dan direktori opsional yang diperlukan oleh aplikasi tertentu.

3.2. The publik Direktori

Sumber daya yang disimpan di direktori publik adalah aset statis yang dilayani langsung oleh server Web.

Direktori ini biasanya memiliki tiga subdirektori untuk file gambar, CSS, dan JavaScript. Kami merekomendasikan agar kami mengatur file aset seperti ini agar konsisten di semua aplikasi Play.

3.3. The conf Direktori

Direktori conf berisi file konfigurasi aplikasi. The application.conf adalah di mana kami akan menempatkan sebagian besar sifat konfigurasi untuk aplikasi Putar. Kami akan menentukan titik akhir untuk aplikasi di rute .

Jika aplikasi membutuhkan file konfigurasi tambahan, mereka harus diletakkan di direktori ini.

3.4. The lib Direktori

Direktori lib bersifat opsional dan berisi dependensi library yang tidak dikelola. Jika kami memiliki jars yang tidak ditentukan dalam sistem build, kami meletakkannya di direktori ini. Mereka akan ditambahkan secara otomatis ke jalur kelas aplikasi.

3.5. The build.sbt Berkas

File build.sbt adalah skrip pembuatan aplikasi. Di sinilah kami membuat daftar dependensi yang diperlukan untuk menjalankan aplikasi, seperti pustaka pengujian dan persistensi.

3.6. The proyek Direktori

Semua file yang mengkonfigurasi proses build berdasarkan SBT ditemukan di direktori proyek .

3.7. The Target Directory

Direktori ini berisi semua file yang dibuat oleh sistem build - misalnya, semua file .class .

Setelah melihat dan menjelajahi struktur direktori untuk contoh Play Framework Hello World yang baru saja kita unduh, sekarang kita dapat mempelajari dasar-dasar kerangka kerja menggunakan sebuah contoh.

4. Contoh Sederhana

Di bagian ini, kami akan membuat contoh yang sangat dasar dari aplikasi web. Kami akan menggunakan aplikasi ini untuk membiasakan diri dengan dasar-dasar kerangka kerja Play.

Alih-alih men-download contoh proyek dan membangun dari itu, mari kita lihat cara lain kita bisa membuat aplikasi Putar Framework, dengan menggunakan baru sbt perintah .

Mari buka command prompt, arahkan ke lokasi pilihan kita, dan jalankan perintah berikut:

sbt new playframework/play-java-seed.g8

For this one, we'll need to have installed sbt already as explained in Section 2.

The above command will prompt us for a name for the project first. Next, it will ask for the domain (in reverse, as is the package naming convention in Java) that will be used for the packages. We press Enter without typing a name if we want to keep the defaults which are given in square brackets.

The application generated with this command has the same structure as the one generated earlier. We can, therefore, proceed to run the application as we did previously:

cd /path/to/folder/ sbt run

The above command, after completion of execution, will spawn a server on port number 9000 to expose our API, which we can access through //localhost:9000. We should see the message “Welcome to Play” in the browser.

Our new API has two endpoints that we can now try out in turn from the browser. The first one – which we have just loaded – is the root endpoint, which loads an index page with the “Welcome to Play!” message.

The second one, at //localhost:9000/assets, is meant for downloading files from the server by adding a file name to the path. We can test this endpoint by getting the favicon.png file, which was downloaded with the application, at //localhost:9000/assets/images/favicon.png.

5. Actions and Controllers

A Java method inside a controller class that processes request parameters and produces a result to be sent to the client is called an action.

A controller is a Java class that extends play.mvc.Controller that logically groups together actions that may be related to results they produce for the client.

Let's now head over to app-parent-dir/app/controllers and pay attention to HomeController.java.

The HomeController‘s index action returns a web page with a simple welcome message:

public Result index() { return ok(views.html.index.render()); }

This web page is the default index template in the views package:

@main("Welcome to Play") {  }

As shown above, the index page calls the main template. The main template then handles the rendering of the page header and body tags. It takes two arguments: a String for the title of the page and an Html object to insert into the body of the page.

@(title: String)(content: Html)    @* Here's where we render the page title `String`. *@ @title     @* And here's where we render the `Html` object containing * the page content. *@ @content   

Let's change the text in the index file a little:

@main("Welcome to Baeldung") {  }

Reloading the browser will give us a bold heading:

Welcome to Play Framework Tutorial on Baeldung!

We can do away with the template completely by removing the render directive in the index() method of the HomeController so that we can return plain text or HTML text directly:

public Result index() { return ok("REST API with Play by Baeldung"); }

After editing the code, as shown above, we'll have only the text in the browser. This will just be plain text without any HTML or styling:

REST API with Play by Baeldung

We could just as well output HTML by wrapping the text in the header tags and then passing the HTML text to the Html.apply method. Feel free to play around with it.

Let's add a /baeldung/html endpoint in routes:

GET /baeldung/html controllers.HomeController.applyHtml

Now let's create the controller that handles requests on this endpoint:

public Result applyHtml() { return ok(Html.apply("")); }

When we visit //localhost:9000/baeldung/html we'll see the above text formatted in HTML.

We've manipulated our response by customizing the response type. We'll look into this feature in more detail in a later section.

We have also seen two other important features of the Play Framework.

First, reloading the browser reflects the most recent version of our code; that's because our code changes are compiled on the fly.

Secondly, Play provides us with helper methods for standard HTTP responses in the play.mvc.Results class. An example is the ok() method, which returns an OK HTTP 200 response alongside the response body we pass to it as a parameter. We've already used the method displaying text in the browser.

There are more helper methods such as notFound() and badRequest() in the Results class.

6. Manipulating Results

We have been benefiting from Play's content negotiation feature without even realizing it. Play automatically infers response content type from the response body. This is why we have been able to return the text in the ok method:

return ok("text to display");

And then Play would automatically set the Content-Type header to text/plain. Although this works in most cases, we can take over control and customize the content type header.

Mari sesuaikan respons untuk tindakan HomeController.customContentType ke teks / html :

public Result customContentType() { return ok("This is some text content").as("text/html"); }

Pola ini melintasi semua jenis jenis konten. Bergantung pada format data yang kita berikan ke metode ok helper, kita dapat mengganti teks / html dengan teks / biasa atau aplikasi / json .

Kita bisa melakukan sesuatu yang mirip dengan set header:

public Result setHeaders() { return ok("This is some text content") .as("text/html") .withHeader("Header-Key", "Some value"); }

7. Kesimpulan

Pada artikel ini, kami telah menjelajahi dasar-dasar Kerangka Play. Kami juga dapat membuat aplikasi web Java dasar menggunakan Play.

Seperti biasa, kode sumber untuk tutorial ini tersedia di GitHub.