Pengenalan Bermain Di Jawa

1. Gambaran keseluruhan

Tujuan tutorial intro ini adalah untuk meneroka Play Framework dan mengetahui bagaimana kita dapat membuat aplikasi web dengannya.

Play adalah kerangka aplikasi web produktiviti tinggi untuk bahasa pengaturcaraan yang kodnya disusun dan dijalankan di JVM, terutamanya Java dan Scala. Ini menggabungkan komponen dan API yang kita perlukan untuk pengembangan aplikasi web moden.

2. Mainkan Kerangka Persediaan

Mari pergi ke halaman rasmi kerangka Play dan muat turun versi edaran terkini. Pada masa tutorial ini, yang terbaru adalah versi 2.7.

Kami akan memuat turun folder zip tutorial Play Java Hello World dan membuka zip fail ke lokasi yang mudah. Pada root folder ini, kita akan dapati sbt yang dapat kita gunakan untuk menjalankan aplikasi. Sebagai alternatif, kita boleh memasang sbt dari halaman rasmi mereka.

Untuk menggunakan sbt dari folder yang dimuat turun, mari lakukan perkara berikut:

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

Perhatikan bahawa kami menjalankan skrip di direktori saat ini, oleh itu penggunaan sintaks ./ .

Sekiranya kita memasang sbt, maka kita boleh menggunakannya:

cd /path/to/folder/ sbt run

Setelah menjalankan perintah ini, kita akan melihat pernyataan yang mengatakan "(Pelayan dimulakan, gunakan Enter untuk berhenti dan kembali ke konsol ...)". Ini bermaksud bahawa aplikasi kita sudah siap, oleh itu kita sekarang boleh menuju ke // localhost: 9000 di mana kita akan disajikan dengan halaman Welcome Play:

3. Anatomi Aplikasi Main

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

Sekiranya anda ingin mencabar diri anda dengan contoh mudah dengan segera, kemudian lompat ke bahagian seterusnya.

Ini adalah fail dan folder yang kami dapati dalam 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 Direktori

Direktori ini mengandungi kod sumber Java, templat web, dan sumber aset yang disusun - pada dasarnya, semua sumber dan semua sumber yang dapat dilaksanakan.

The app direktori mengandungi beberapa subdirektori penting, setiap yang pakej satu bahagian corak seni bina MVC:

  • model - ini adalah lapisan perniagaan aplikasi, fail dalam pakej ini mungkin akan memodelkan jadual pangkalan data kami dan membolehkan kami mengakses lapisan ketekunan
  • paparan - semua templat HTML yang dapat diberikan ke penyemak imbas terdapat dalam folder ini
  • pengendali - subdirektori di mana kita mempunyai pengawal kita. Pengawal adalah file sumber Java yang berisi tindakan yang akan dijalankan untuk setiap panggilan API. Tindakan adalah kaedah awam yang memproses permintaan HTTP dan mengembalikan hasil yang sama dengan respons HTTP
  • aset - subdirektori yang mengandungi aset yang disusun seperti CSS dan javascript. Konvensyen penamaan di atas fleksibel, kami dapat membuat pakej kami seperti pakej aplikasi / utiliti . Kami juga dapat menyesuaikan aplikasi penamaan paket / com / baeldung / pengendali

Ini juga berisi fail dan direktori pilihan yang diperlukan oleh aplikasi tertentu.

3.2. The awam Direktori

Sumber yang disimpan dalam direktori awam adalah aset statik yang dilayan secara langsung oleh pelayan Web.

Direktori ini biasanya mempunyai tiga subdirektori untuk gambar, CSS, dan fail JavaScript. Sebaiknya kami mengatur fail aset seperti ini untuk konsistensi dalam semua aplikasi Play.

3.3. The conf Direktori

The conf direktori mengandungi fail konfigurasi aplikasi. The application.conf adalah di mana kita akan meletakkan kebanyakan hartanah tatarajah bagi aplikasi Play. Kami akan menentukan titik akhir untuk aplikasi dalam laluan .

Sekiranya aplikasi memerlukan fail konfigurasi tambahan, mereka harus dimasukkan ke dalam direktori ini.

3.4. The lib Direktori

The lib direktori adalah pilihan dan mengandungi tidak diurus kebergantungan perpustakaan. Sekiranya kita mempunyai balang yang tidak ditentukan dalam sistem binaan, kita memasukkannya ke dalam direktori ini. Mereka akan ditambahkan secara automatik ke jalan kelas aplikasi.

3.5. The build.sbt Fail

The build.sbt fail adalah skrip permohonan membina. Di sinilah kami menyenaraikan pergantungan yang diperlukan untuk menjalankan aplikasi, seperti perpustakaan ujian dan kegigihan.

3.6. Yang projek Direktori

Semua fail yang mengkonfigurasi proses build berdasarkan SBT terdapat di direktori projek .

3.7. The sasaran Direktori

Direktori ini mengandungi semua fail yang dihasilkan oleh sistem binaan - misalnya, semua fail .class .

Setelah melihat dan meneroka struktur direktori untuk contoh Play Framework Hello World yang baru sahaja kami muat turun, kini kami dapat mempelajari asas kerangka menggunakan contoh.

4. Contoh Ringkas

Di bahagian ini, kami akan membuat contoh aplikasi web yang sangat asas. Kami akan menggunakan aplikasi ini untuk membiasakan diri dengan asas-asas kerangka Play.

Daripada memuat turun projek contoh dan membangunnya, mari kita lihat cara lain untuk membuat aplikasi Play Framework, menggunakan perintah baru sbt .

Mari buka command prompt, arahkan ke lokasi pilihan kami, dan laksanakan 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 tindak balas untuk tindakan HomeController.customContentType ke teks / html :

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

Corak ini merangkumi semua jenis jenis kandungan. Bergantung pada format data yang kami sampaikan ke metode ok helper, kami dapat mengganti teks / html dengan teks / polos atau aplikasi / json .

Kita boleh melakukan perkara yang serupa dengan tajuk yang ditetapkan:

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

7. Kesimpulannya

Dalam artikel ini, kami telah meneroka asas-asas Play Framework. Kami juga dapat membuat aplikasi web Java asas menggunakan Play.

Seperti biasa, kod sumber untuk tutorial ini boleh didapati di GitHub.