Play Framework介紹：Hello World

作者：Chaos 2012-02-20 14:26:48

Play！是一個(gè)full-stack（全棧的）Java Web應(yīng)用框架，包括一個(gè)簡(jiǎn)單的無(wú)狀態(tài)MVC模型，具有Hibernate的對(duì)象持續(xù)，一個(gè)基于Groovy的模板引擎，以及建立一個(gè)現(xiàn)代Web應(yīng)用所需的所有東西。

本文翻譯自官網(wǎng)。原文見(jiàn)：http://www.playframework.org/documentation/1.1.1/firstapp

Play是一個(gè)Rails風(fēng)格的Java Web框架。先上官網(wǎng)的Hello World，感覺(jué)下。運(yùn)行環(huán)境，我換成了Windows ^_^

準(zhǔn)備

安裝 Java 5 以上版本及Play。安裝指導(dǎo)見(jiàn)：http://www.playframework.org/documentation/1.1.1/install

項(xiàng)目創(chuàng)建

打開(kāi)CMD，執(zhí)行：

play new helloworld

Play new 命令在當(dāng)前路徑下創(chuàng)建了一個(gè)helloworld目錄，其中包含一系列文件和目錄，重要的如下：

app/ 包含應(yīng)用核心，分為models，controllers和views目錄。.java生活的地方^_^

conf/包含應(yīng)用的所有配置。application.conf應(yīng)用主配置.routes定義url路由規(guī)則，messages國(guó)際化用。

lib/ 包含應(yīng)用依賴(lài)的標(biāo)準(zhǔn).jar文件。

public/包含所有外部可訪(fǎng)問(wèn)的資源：js,css和image。

test/包含所有應(yīng)用的測(cè)試程序。測(cè)試程序基于JUnit或Selenium。

注：Play要求所有文件必須是UTF-8編碼。

等等應(yīng)用的.class文件在哪兒。恩，Play不使用class文件而是直接讀取Java源文件，并使用Eclipse compiler編譯他們。

這導(dǎo)致兩件重要的事情。首先運(yùn)行時(shí)Play會(huì)檢查你對(duì)源文件所作的變更并自動(dòng)加載它們。其次，當(dāng)發(fā)生異常時(shí)，Play將創(chuàng)建更好的錯(cuò)誤報(bào)告并附加相關(guān)代碼。

運(yùn)行應(yīng)用

在cmd中鍵入play run helloworld,play啟動(dòng)Web Server并監(jiān)聽(tīng)9000端口

打開(kāi)瀏覽器鍵入http://localhost:9000,應(yīng)用顯示了一個(gè)缺省的歡迎頁(yè)

現(xiàn)在，看下此頁(yè)是如何顯示的。

應(yīng)用的主入口點(diǎn)配置在conf/routes文件中。它定義了應(yīng)用所有可訪(fǎng)問(wèn)的URL。打開(kāi)routes文件，會(huì)看到***個(gè)route:

GET / Application.index

它告訴Play，當(dāng)/路徑收到GET請(qǐng)求后調(diào)用Application.indexJava方法。它是controllers.Application.index的縮寫(xiě)，因?yàn)閏ontrollers包是隱式的附加的。

創(chuàng)建標(biāo)準(zhǔn)Java應(yīng)用時(shí)，通常使用一個(gè)入口點(diǎn)即main方法。Play應(yīng)用則有多個(gè)，一個(gè)URL一個(gè)。這些方法稱(chēng)為action方法。定義action方法的類(lèi)稱(chēng)為controller。

打開(kāi)helloworld/app/controllers/Application.java:

package controllers;  
 
import play.*;  
import play.mvc.*;  
 
import java.util.*;  
 
import models.*;  
 
public class Application extends Controller {  
 
    public static void index() {  
        render();  
    }  
 
}

看到Application擴(kuò)展了play.mvcController類(lèi)。它提供了所有Controller需要使用的方法，如index動(dòng)作中使用的render方法。

index方法定義成public static void，因?yàn)镃ontroller永遠(yuǎn)無(wú)需實(shí)例化和返回值。（譯注：為了防止被使用者引入狀態(tài)，并讓Controller自然、干凈而如此設(shè)計(jì)。但副作用是render只能通過(guò)throw扔出結(jié)果，用異常當(dāng)GOTO，可謂兵行詭道）。

缺省的index動(dòng)作調(diào)用render方法，通知Play渲染一個(gè)模板。模板是app/views目錄下一個(gè)簡(jiǎn)單的text文件。此處使用Application/index.html

打開(kāi)helloworld/app/views/Application/index.html文件：

#{extends 'main.html' /}  
#{set title:'Home' /}  
 
#{welcome /}

其中的內(nèi)容是Play tag，類(lèi)似JSP taglib.#{welcome/}tag生成了之前看到的歡迎消息。#{extends/}tags告訴Play此模板集成另一個(gè)main.html的模板.模板繼承可用來(lái)創(chuàng)建復(fù)雜的web也并重用公共部分。

打開(kāi)helloworld/app/views/main.html模板

<!DOCTYPE html> 
 
<html> 
    <head> 
        <title>#{get 'title' /}</title> 
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 
        <link rel="stylesheet" type="text/css" media="screen" href="@{'/public/stylesheets/main.css'}"> 
        #{get 'moreStyles' /}  
        <link rel="shortcut icon" type="image/png" href="@{'/public/images/favicon.png'}"> 
        <script src="@{'/public/javascripts/jquery-1.4.2.min.js'}" type="text/javascript" charset="utf-8"></script> 
        #{get 'moreScripts' /}  
    </head> 
    <body> 
        #{doLayout /}  
    </body> 
</html>

看到#{doLayout/}tag嗎？是Application/index.html插入的位置。

#p#

創(chuàng)建FORM

編輯helloworld/app/views/Application/index.html模板

#{extends 'main.html' /}  
#{set title:'Home' /}  
   
<form action="@{Application.sayHello()}" method="GET">  
    <input type="text" name="myName" />   
    <input type="submit" value="Say hello!" />  
</form>

我們使用@{…}符號(hào)請(qǐng)求Play自動(dòng)產(chǎn)生調(diào)用Application.sayHello動(dòng)作的方法。刷新瀏覽器。

Oops,出錯(cuò)了。因?yàn)橐昧艘粋€(gè)不存在的動(dòng)作。需要在helloworld/app/controllers/Application.java中創(chuàng)建：

package controllers;  
 
import play.mvc.*;  
 
public class Application extends Controller {  
 
    public static void index() {  
        render();  
    }  
      
    public static void sayHello(String myName){  
        render(myName);  
    }  
}

我們聲明了myName參數(shù)，它會(huì)自動(dòng)映射到form提交的HTTP請(qǐng)求的myName參數(shù)。刷新瀏覽器。

輸入name提交，出現(xiàn)另一個(gè)錯(cuò)誤.

因?yàn)镻lay渲染此動(dòng)作的缺省模板時(shí)，沒(méi)有找到它。我們創(chuàng)建文件helloworld/app/views/Application/sayHello.html

#{extends 'main.html' /}  
#{set title:'Home' /}  
 
<h1>Hello ${myName ?: 'guest'}!</h1>  
   
<a href="@{Application.index()}">Back to form</a>

然后刷新：

提供更好的URL

看下提交的url：

http://localhost:9000/application/sayhello?myName=chaos

它不夠RESTful。因?yàn)镻lay通過(guò)缺省規(guī)則捕獲了此URL

*    /{controller}/{action}     {controller}.{action}

可以編輯helloworld/conf/routes文件在缺省規(guī)則前添加一條規(guī)則，提供更自然的hello url

GET /hello Application.sayHello

#p#

自定義布局

可以修改模板更改布局。編輯helloworld/app/views/main.html文件：

添加驗(yàn)證

給form添加一個(gè)驗(yàn)證，要求name字段必填。我們通過(guò)Play validation實(shí)現(xiàn)。編輯helloworld/app/controllers/Application.java,在sayHello action處：

public static void sayHello(@Required String myName) {  
        if (validation.hasErrors()) {  
            flash.error("Oops, please enter your name!");  
            index();  
        }  
        render(myName);  
    }

并import play.data.validation.*。@Required告訴Play自動(dòng)檢查myName字段是否填寫(xiě)。如果驗(yàn)證失敗，我們加入一條消息到flash scope中并重定向到index動(dòng)作。flash scope允許在重定向時(shí)保持消息。

編輯helloworld/app/views/Application/index.html顯示錯(cuò)誤消息

#{extends 'main.html' /}  
#{set title:'Home' /}  
   
#{if flash.error}  
    <p style="color:#c00">  
        ${flash.error}  
    </p>  
#{/if}  
 
<form action="@{Application.sayHello()}" method="GET">  
    <input type="text" name="myName" />   
    <input type="submit" value="Say hello!" />  
</form>

輸入空參數(shù)并提交，OK起作用了。

自動(dòng)化測(cè)試

Selenium Test

在測(cè)試模式下運(yùn)行應(yīng)用。在cmd中輸入play test helloworld。

打開(kāi)瀏覽器，輸入http://localhost:9000/@tests啟動(dòng)測(cè)試器。

執(zhí)行測(cè)試

Selenium測(cè)試用例通常寫(xiě)成一個(gè)html文件。Play使用Play模板引擎生成這些文件。helloworld/test/Application.test.html文件：

*{ You can use plain selenium command using the selenium tag }*  
 
#{selenium}  
    // Open the home page, and check that no error occured  
    open('/')  
    assertNotTitle('Application error')  
#{/selenium}

此測(cè)試打開(kāi)home頁(yè)，確認(rèn)響應(yīng)中沒(méi)有“Application error”。

讓我們來(lái)編寫(xiě)自己的測(cè)試。編輯測(cè)試內(nèi)容：

*{ You can use plain selenium command using the selenium tag }*  
 
#{selenium}  
    // Open the home page, and check that no error occurred  
    open('/')  
    assertNotTitle('Application error')  
      
    // Check that it is the form  
    assertTextPresent('The Hello world app.')  
      
    // Submit the form  
    clickAndWait('css=input[type=submit]')  
      
    // Check the error  
    assertTextPresent('Oops, please enter your name!')  
      
    // Type the name and submit  
    type('css=input[type=text]', 'bob')  
    clickAndWait('css=input[type=submit]')  
      
    // Check the result  
    assertTextPresent('Hello bob!')  
    assertTextPresent('The Hello world app.')  
      
    // Check the back link  
    clickAndWait('link=Back to form')  
      
    // Home page?  
    assertTextNotPresent('Hello bob!')  
#{/selenium}