Play Framework介紹:控制器層
業(yè)務(wù)邏輯代碼通常位于模型(model)層?？蛻舳耍ū热鐬g覽器）無(wú)法直接調(diào)用其中的代碼，所以模型對(duì)象提供的功能，必須作為資源以URI方式暴露給外部。
客戶端使用HTTP協(xié)議來(lái)操作這些資源，從而調(diào)用了內(nèi)部的業(yè)務(wù)邏輯。但是，這種從資源到模型之間的映射是單向的：我們可以根據(jù)需要提供不同粒度的資源，可以虛擬出一些資源，還可以給某些資源起別名...
Controller層就是專門(mén)做這件事的：在模型層與傳輸層之間搭起一座橋梁。它使用與模型層同一種語(yǔ)言，以便訪問(wèn)和修改模型對(duì)象，但同時(shí)它又跟HTTP接口一樣，是面向請(qǐng)求(Request)和響應(yīng)(Response)的。
Controller層減少了HTTP與模型層之間的“阻抗不匹配”。
| 注意
不同的模型方案使用了不同的策略。有一些可以讓我們直接訪問(wèn)模型對(duì)象，比如EJB或者Corba協(xié)議，它們使用RPC(遠(yuǎn)程過(guò)程調(diào)用）。這種交互方式與web很難兼容。 |
另一些技術(shù)如SOAP，嘗試通過(guò)Web來(lái)訪問(wèn)模型層，但它也是一種PRC風(fēng)格的協(xié)議，只是以HTTP為傳輸協(xié)議。它也不是一種程序協(xié)議。
Web的理念在根本上與面向?qū)ο蟛煌?，所以我們需要一個(gè)層來(lái)協(xié)調(diào)。
Controller綜述
一個(gè)Controller就是一個(gè)位于 controllers 包中的類，其繼承于 play.mvc.Controller ：
示例：
- package controllers;
- import models.Client;
- import play.mvc.Controller;
- public class Clients extends Controller {
- public static void show(Long id) {
- Client client = Client.findById(id);
- render(client);
- }
- public static void delete(Long id) {
- Client client = Client.findById(id);
- client.delete();
- }
- }
Controller中每一個(gè)public static方法都被稱為一個(gè)action。它的簽名形如：
- public static void action_name(params...);
你可以在action的方法簽名中定義各種參數(shù)。Play會(huì)自動(dòng)從相應(yīng)的HTTP參數(shù)中，取出對(duì)應(yīng)的值賦過(guò)去（并進(jìn)行恰當(dāng)?shù)霓D(zhuǎn)換），這一點(diǎn)非常方便。
通常一個(gè)action不需要返回值。當(dāng)我們?cè)赼ction中調(diào)用了一個(gè)能產(chǎn)生“結(jié)果”的方法后，action就退出了。在本例中， render(…) 就是一個(gè)顯示一個(gè)模板的可產(chǎn)生結(jié)果的方法。
獲取HTTP參數(shù)
HTTP請(qǐng)求中可包含數(shù)據(jù)，這些數(shù)據(jù)可位于：
- URI路徑中: 如 /clients/1541, 1541就是一個(gè)動(dòng)態(tài)產(chǎn)生的參數(shù).
- Query String: /clients?id=1541.
- request body: 如果提交了一個(gè)HTML表彰，將request body中將包含以 x-www-urlform-encoded 方式轉(zhuǎn)換過(guò)的數(shù)據(jù)。
對(duì)于這些情況，Play都可以取得數(shù)據(jù)，并生成一個(gè) Map<String, String[]> 。Key是參數(shù)名，來(lái)源于：
- 在conf/routes文件中定義的規(guī)則中的動(dòng)態(tài)參數(shù)名
- Query String中的name=value
- 通過(guò)表單提交的數(shù)據(jù)的name.
使用參數(shù)map
在所有的Controller類中都可以直接使用 params 這個(gè)對(duì)象。它是在 play.mvc.Controller 中定義的。這個(gè)對(duì)象中，包含了當(dāng)前請(qǐng)求的所有數(shù)據(jù)。
示例：
- public static void show() {
- String id = params.get("id");
- String[] names = params.getAll("names");
- }
你還可以轉(zhuǎn)換參數(shù)值的類型：
- public static void show() {
- Long id = params.get("id", Long.class);
- }
其實(shí)，還有更好的辦法來(lái)轉(zhuǎn)換 :)
直接利用action方法的參數(shù)類型定義來(lái)轉(zhuǎn)換
我們可以直接從action方法的參數(shù)定義中，直接拿到對(duì)應(yīng)的參數(shù)值。方法中的參數(shù)名必須跟http傳過(guò)來(lái)的參數(shù)名相同。
比如，對(duì)于如下的URL：
- /clients?id=1451
我們可以定義一個(gè)包含 id 參數(shù)的action：
- public static void show(String id) {
- System.out.println(id);
- }
我們還可以使用其它的類型，play會(huì)自動(dòng)進(jìn)行轉(zhuǎn)換：
- public static void show(Long id) {
- System.out.println(id);
- }
如果同一個(gè)參數(shù)有多個(gè)值，還可以把它聲明為數(shù)組：
- public static void show(Long[] id) {
- for(String anId : id) {
- System.out.println(anid);
- }
- }
甚至集合：
- public static void show(List<Long> id) {
- for(String anId : id) {
- System.out.println(anid);
- }
- }
這一功能非常方便，其它的框架都很少提供（有一些提供了，但要求每個(gè)參數(shù)前都要加一個(gè)annotation，不太方便）。
內(nèi)部原理是，Play會(huì)對(duì)每個(gè)action進(jìn)行掃描，得到其參數(shù)信息（包括類型與參數(shù)名）。能過(guò)反射很容易得到參數(shù)類型，但得不到參數(shù)名，因?yàn)閖avac在編譯java代碼時(shí)，會(huì)忽略參數(shù)名信息。而Play內(nèi)置了eclipse的編譯器，并在編譯時(shí)打開(kāi)相關(guān)選項(xiàng)以記錄參數(shù)名信息，所以才能成功取到。
| 異 常 |
如果action方法中定義的某個(gè)參數(shù)，在http請(qǐng)求中找不到對(duì)應(yīng)的數(shù)據(jù)，則將會(huì)把它設(shè)為默認(rèn)值（對(duì)象類型設(shè)為null，基礎(chǔ)數(shù)字類型設(shè)為0，boolean類型設(shè)為false）。如果找到了，但是其值無(wú)法轉(zhuǎn)換為指定的Java類型，則會(huì)將這一錯(cuò)誤記錄在validation對(duì)象中，并使用默認(rèn)值代替。
HTTP to Java 高級(jí)綁定
簡(jiǎn)單類型
Java中所有基礎(chǔ)和常用類型，都可以自動(dòng)綁定：
int, long, boolean, char, byte, float, double, Integer, Long, Boolean, Char, String, Byte, Float, Double.
注意如果某個(gè)參數(shù)HTTP請(qǐng)求中沒(méi)有提供，或者自動(dòng)轉(zhuǎn)換失敗，則Object類型會(huì)被設(shè)為null，而基礎(chǔ)類型會(huì)被設(shè)為它們的默認(rèn)值。
Date
如果一個(gè)日期格式如下，則它可以自動(dòng)轉(zhuǎn)換并綁定：
- yyyy-MM-dd’T’hh:mm:ss’Z' // ISO8601 + timezone
- yyyy-MM-dd’T’hh:mm:ss" // ISO8601
- yyyy-MM-dd
- yyyyMMdd’T’hhmmss
- yyyyMMddhhmmss
- dd'/‘MM’/'yyyy
- dd-MM-yyyy
- ddMMyyyy
- MMddyy
- MM-dd-yy
- MM'/‘dd’/'yy
使用@As注解，我們可以指定日期格式。
例如：
- archives?from=21/12/1980
- public static void articlesSince(@As("dd/MM/yyyy") Date from) {
- List<Article> articles = Article.findBy("date >= ?", from);
- render(articles);
- }
我們可還以對(duì)不同的語(yǔ)種定義不同的格式，例如：
- public static void articlesSince(@As(lang={"fr,de","*"},
- value={"dd-MM-yyyy","MM-dd-yyyy"}) Date from) {
- List<Article> articles = Article.findBy("date >= ?", from);
- render(articles);
- }
在這個(gè)例子中，我們將法國(guó)和德國(guó)的日期定義為 dd-MM-yyyy ，其它都為 MM-dd-yyyy. 注意語(yǔ)種可用逗號(hào)分隔。注意參數(shù)lang的個(gè)數(shù)必須與value的個(gè)數(shù)相等。
如果沒(méi)有使用@As注解，則Play將使用你的區(qū)域?qū)?yīng)的默認(rèn)日期格式。我們可在“conf/application.conf”中使用“date.format”為key來(lái)配置該格式.
日歷(Calendar)
Calendar的綁定與date幾乎完全一樣，除了play將會(huì)根據(jù)你的區(qū)域設(shè)置選擇相應(yīng)的Calendar對(duì)象。@Bind注解也可在這里使用。
文件(File)
在Play中處理文件上傳非常簡(jiǎn)單。使用經(jīng) multipart/form-data 編碼的請(qǐng)求將文件post到服務(wù)器端，同時(shí)使用 java.io.File 來(lái)獲取文件：
- public static void create(String comment, File attachment) {
- String s3Key = S3.post(attachment);
- Document doc = new Document(comment, s3Key);
- doc.save();
- show(doc.id);
- }
Play將先取得上傳的文件，保存在臨時(shí)目錄下，并使用上傳的文件名。當(dāng)這個(gè)request結(jié)束后，該文件將被刪除，所以我們必須將它拷貝到一個(gè)安全的目錄中，否則就找不到了。
上傳的文件的MIME類型通常應(yīng)該在HTTP request的head中，以 Content-type 方式指定。但當(dāng)我們通過(guò)瀏覽器上傳文件時(shí)，一些不常見(jiàn)類型的文件不會(huì)指定。在這種情況下，我們可以使用 play.libs.MimeTypes 類將該文件的后綴名映射到一個(gè)MIME類型上。
- String mimeType = MimeTypes.getContentType(attachment.getName());
play.libs.MimeTypes 類在 $PLAY_HOME/framework/src/play/libs/mime-types.properties 中以文件的后綴為來(lái)尋找對(duì)應(yīng)的MIME類型。
你也可以 通過(guò) 自定義MIME類型 來(lái)增加你自己的類型。
數(shù)組或集合
所有支持的類型，都可以通過(guò)數(shù)組或集合的形式取得：
- public static void show(Long[] id) {
- …
- }
或者：
- public static void show(List<Long> id) {
- …
- }
或者：
- public static void show(Set<Long> id) {
- …
- }
Play還可以處理像Map<String, String>這樣的綁定：
- public static void show(Map<String, String> client) {
- …
- }
一個(gè)如下的query string：
- ?client.name=John&client.phone=111-1111&client.phone=222-2222
將會(huì)把變量client綁定到一個(gè)含有兩個(gè)元素的map上。第一個(gè)元素的key是 name ,值是 John ，第二個(gè)key是 phone 值是 111-1111, 222-2222.
POJO對(duì)象綁定
Play還可以使用簡(jiǎn)單的命名約定將參數(shù)綁定到一個(gè)pojo對(duì)象上。
- public static void create(Client client ) {
- client.save();
- show(client);
- }
可以使用像下面這樣的query string，來(lái)調(diào)用該action以創(chuàng)建一個(gè)client對(duì)象：
- ?client.name=Zenexity&client.email=contact@zenexity.fr
Play創(chuàng)建一個(gè)Client的實(shí)例，然后將HTTP參數(shù)中與Client對(duì)象屬性同名的值賦過(guò)去。無(wú)法處理的參數(shù)將被安全的忽略，類型不匹配的也將安全忽略。
參數(shù)綁定是遞歸的，我們可以通過(guò)query string來(lái)創(chuàng)建一個(gè)完全的對(duì)象圖：
- ?client.name=Zenexity
- &client.address.street=64+rue+taitbout
- &client.address.zip=75009
- &client.address.country=France
如果我們想更新一列對(duì)象，我們可以使用數(shù)組形式來(lái)引用對(duì)象的ID。舉例來(lái)說(shuō)，假設(shè)Client模型有一列Customer模型，并聲明為 List<Customer> customers 形式。為了更新這一列Customers，我們應(yīng)該提供一個(gè)如下的query string：
- ?client.customers[0].id=123
- &client.customers[1].id=456
- &client.customers[2].id=789
JPA對(duì)象綁定
我們可以將一個(gè)JPA對(duì)象與HTTP自動(dòng)綁定起來(lái)。
我們可以在HTTP參數(shù)中提供 user.id 字段。當(dāng)Play發(fā)現(xiàn)這個(gè)字段時(shí)，它會(huì)先到數(shù)據(jù)庫(kù)中取出相應(yīng)的實(shí)例，然后把HTTP請(qǐng)求中其它的參數(shù)賦過(guò)去。所以我們可以直接save它。
- public static void save(User user) {
- user.save(); // ok with 1.0.1
- }
我們可以使用同樣的方式來(lái)更新完整的對(duì)象圖，但是必須對(duì)每一個(gè)子對(duì)象提供ID：
- user.id = 1
- &user.name=morten
- &user.address.id=34
- &user.address.street=MyStreet
自定義綁定
綁定系統(tǒng)還支持自定義。
@play.data.binding.As
首先要講的是@play.data.binding.As這個(gè)新注解，使用它，我們可以配置一個(gè)綁定?？聪旅娴睦?，我們使用它來(lái)指定一個(gè)Date的格式（該格式將被 DateBinder 使用）：
- public static void update(@As("dd/MM/yyyy") Date updatedAt) {
- …
- }
@As注解同樣支持國(guó)際化，我們可以這樣使用：
- public static void update(
- @As(
- lang={"fr,de","en","*"},
- value={"dd/MM/yyyy","dd-MM-yyyy","MM-dd-yy"}
- )
- Date updatedAt
- ) {
- …
- }
@As注解可以與所有支持它的binder一起使用，包括你自己的定義的。例如，使用 ListBinder:
- public static void update(@As(",") List<String> items) {
- …
- }
它將會(huì)把一個(gè)以逗號(hào)分隔的字符串綁定到一個(gè) List 上。
@play.data.binding.NoBinding
新的@play.data.binding.NoBinding注解允許我們定義一些“不應(yīng)該被綁定”的字段，以防出現(xiàn)安全問(wèn)題。例如：
- public class User extends Model {
- @NoBinding("profile") public boolean isAdmin;
- @As("dd, MM yyyy") Date birthDate;
- public String name;
- }
- public static void editProfile(@As("profile") User user) {
- …
- }
在這種情況下， 在 editProfile action中，就算某個(gè)居心不良的用戶通過(guò)偽造請(qǐng)求提交了一個(gè)包含 user.isAdmin=true 的字段, isAdmin 字段也不會(huì)被綁定.
play.data.binding.TypeBinder
@As 注解同樣允許我們自定義一個(gè)完整的binder. 一個(gè)自定義的binder是 TypeBinder 的子類，我們可以在自己的項(xiàng)目中定義它。例如：
- public class MyCustomStringBinder implements TypeBinder<String> {
- public Object bind(String name, Annotation[] anns, String value, Class clazz) { return "!!"; } }
我們可以在任意一個(gè)action中使用它：
- public static void anyAction(@As(binder=MyCustomStringBinder.class)
- String name) {
- …
- }
@play.data.binding.Global
我們還可以自定義一個(gè)全局的binder來(lái)處理某一個(gè)特定的類型。比如，我們給 java.awt.Point 類定義了一個(gè)這樣的binder：
- @Global
- public class PointBinder implements TypeBinder<Point> {
- public Object bind(String name, Annotation[] anns, String value, Class class) {
- String[] values = value.split(“,”);
- return new Point( Integer.parseInt(values0), Integer.parseInt(values1) );
- }
- }
你可以看到這個(gè)全局binder是一個(gè)典型的binder，只是使用了*@play.data.binding.Global*注解。我們?cè)谕獠磕K中定義這種binder，以在不同的項(xiàng)目中復(fù)用。
結(jié)果類型
一個(gè)action方法必須產(chǎn)生一個(gè)HTTP響應(yīng)。最簡(jiǎn)單的方式就是生成一個(gè)Result對(duì)象。一旦某一個(gè)Result對(duì)象生成，該方法將立刻返回（后面的代碼將不會(huì)被執(zhí)行）。
舉例：
- public static void show(Long id) {
- Client client = Client.findById(id);
- render(client);
- System.out.println("This message will never be displayed !");
- }
render(…) 方法產(chǎn)生了一個(gè)Result對(duì)象，后面的代碼都不會(huì)被執(zhí)行。
返回一些文本內(nèi)容
renderText(…) 方法將產(chǎn)生一個(gè)簡(jiǎn)單的Result事件，該事件將直接向HTTP Response中寫(xiě)入一些文本數(shù)據(jù)。
舉例：
- public static void countUnreadMessages() {
- Integer unreadMessages = MessagesBox.countUnreadMessages();
- renderText(unreadMessages);
- }
你還可以使用Java的標(biāo)準(zhǔn)格式化語(yǔ)法來(lái)格式化文本信息：
- public static void countUnreadMessages() {
- Integer unreadMessages = MessagesBox.countUnreadMessages();
- renderText("There are %s unread messages", unreadMessages);
- }
返回二進(jìn)制內(nèi)容
為了處理如 存儲(chǔ)在服務(wù)器上的文件 這樣的二進(jìn)制數(shù)據(jù)，我們可使用 renderBinary 方法。例如，如果我們有一個(gè) User 模型，它有一個(gè) play.db.jpa.Blob photo 屬性, 我們可以使用以下方式使用保存的MIME類型向客戶端發(fā)送圖片數(shù)據(jù)：
- public static void userPhoto(long id) {
- final User user = User.findById(id);
- response.setContentTypeIfNotSet(user.photo.type());
- java.io.InputStream binaryData = user.photo.get();
- renderBinary(binaryData);
- }
把文件當(dāng)作附件下載
我們可以通過(guò)設(shè)置HTTP頭，來(lái)指導(dǎo)瀏覽器把二進(jìn)制數(shù)據(jù)當(dāng)作“附件”來(lái)保存。我們只需要在 renderBinary 方法中傳入一個(gè)文件名即可。Play會(huì)自動(dòng)在響應(yīng)頭中把文件名設(shè)給 Content-Disposition 。舉例來(lái)說(shuō)，前面例子中的 User 模型有一個(gè) photoFileName 屬性：
- renderBinary(binaryData, user.photoFileName);
執(zhí)行一個(gè)模板
如果需要產(chǎn)生的內(nèi)容很復(fù)雜，我們通常會(huì)在模板中來(lái)創(chuàng)建內(nèi)容：
- public class Clients extends Controller {
- public static void index() { render(); } }
這里有一個(gè)命名約定，Play會(huì)根據(jù)controller名和action名來(lái)尋找默認(rèn)的模板路徑。對(duì)于上例是：
- app/views/Clients/index.html
把數(shù)據(jù)加入到模板域中
模板通常都需要數(shù)據(jù)。我們可以把這些數(shù)據(jù)放在 renderArgs 對(duì)象中:
- public class Clients extends Controller {
- public static void show(Long id) {
- Client client = Client.findById(id);
- renderArgs.put(“client”, client); render();
- }
- }
當(dāng)執(zhí)行模板的時(shí)候，會(huì)自動(dòng)創(chuàng)建 client 變量。
例如，我們可在模板中使用client變量：
- <h1>Client ${client.name}</h1>
將數(shù)據(jù)加入到模板類中的更簡(jiǎn)單的方法
我們可以直接將數(shù)據(jù)傳入到 render(...) 中：
- public static void show(Long id) {
- Client client = Client.findById(id);
- render(client);
- }
在這種情況下，模板中也將有一個(gè)與action中的局部變量名一樣的變量(client)。
我們還可以傳入更多的變量：
- public static void show(Long id) {
- Client client = Client.findById(id);
- render(id, client);
- }
| 重要! |
你只能通過(guò)這種方式來(lái)傳入局部變量。
h4. 使用其它模板
如果你不想使用默認(rèn)模板，可以通過(guò)在 renderTemplate(…) 中的第一個(gè)參數(shù)中指定另一個(gè)模板名稱。
舉例：
- public static void show(Long id) {
- Client client = Client.findById(id);
- renderTemplate("Clients/showClient.html", id, client);
- }
重定向到另一個(gè)URL
redirect(…) 方法會(huì)產(chǎn)生一個(gè)重定向事件，接著會(huì)產(chǎn)生一個(gè)HTTP Redirect響應(yīng)。
- public static void index() {
- redirect("http://www.zenexity.fr");
- }
Action鏈
在play中沒(méi)有Servlet API forward 的等價(jià)物。每一個(gè)HTTP request只能調(diào)用一個(gè)action。如果我們需要調(diào)用另一個(gè)，必須通過(guò)重定向，讓瀏覽器訪問(wèn)另一個(gè)URL來(lái)訪問(wèn)它。這樣的話，瀏覽器的URL始終與被執(zhí)行的action保持一致，實(shí)現(xiàn) Back/Forward/Refresh 的管理就容易多了。
你可以發(fā)送到任何一個(gè)action的Redirect，只需要直接在Java中調(diào)用該action即可。該調(diào)用將會(huì)自動(dòng)被Play攔截，并生成一個(gè)HTTP重定向。
舉例：
- public class Clients extends Controller {
- public static void show(Long id) {
- Client client = Client.findById(id);
- render(client);
- }
- public static void create(String name) {
- Client client = new Client(name);
- client.save();
- show(client.id);
- }
- }
With these routes:
- GET /clients/{id} Clients.show
- POST /clients Clients.create
- 瀏覽器向 /clients URL發(fā)送一個(gè)POST。
- Router調(diào)用 Clients controller的 create action.
- Action方法直接調(diào)用 show 方法
- 該Java調(diào)用被攔截，Router根據(jù)它產(chǎn)生一個(gè)調(diào)用Clients.show(id)所需要的新URL。
- HTTP響應(yīng)為 302 Location:/clients/3132.
- 瀏覽器接著發(fā)送 GET /clients/3132.
- …
自定義編碼集
Play強(qiáng)調(diào)使用UTF-8，但有時(shí)候某些響應(yīng)，或者整個(gè)應(yīng)用的響應(yīng)，都必須使用一個(gè)不同的編碼集。
給當(dāng)前response定義encoding
要改變當(dāng)前response的編碼集，我們需要在controller中這樣做：
- response.encoding = "ISO-8859-1";
如果要使用一個(gè)與服務(wù)器默認(rèn)的不同的編碼集，我們必須在form中包含兩次encoding/charset。一次在 accept-charset 屬性中，一次在一個(gè)hidden類型的字段 _charset_ 中。 accept-charset 告訴瀏覽器使用哪種字符集，而 _charset_ 告訴play使用哪種字符集：
- <form action="@{application.index}" method="POST" accept-charset="ISO-8859-1">
- <input type="hidden" name="_charset_" value="ISO-8859-1">
- </form>
自定義整個(gè)程序的編碼集
配置application.web_encoding 來(lái)指定Play使用哪種編碼集。
攔截器(Interceptions)
一個(gè)controller可以定義多個(gè)攔截器方法。攔截器作用于一個(gè)controller及其所有子類的所有action方法上。對(duì)于定義一些所有action共用的操作時(shí)，使用攔截器非常有用，比如：檢查用戶是否已經(jīng)登錄（有沒(méi)有訪問(wèn)權(quán)），截入request范圍內(nèi)的數(shù)據(jù)，等等。
這些方法必須為static，但不一定是public。你必須給它們?cè)黾雍线m的注解以表明它們是攔截器。
@Before
如果方法上有@Before注解，則它將在該controller中的每一個(gè)action被調(diào)用前被執(zhí)行。
所以可以進(jìn)行一下安全檢查：
- public class Admin extends Application {
- @Before static void checkAuthentification() {
- if(session.get(“user”) == null) login();
- }
- public static void index() {
- List users = User.findAll();
- render(users);
- }
- …
- }
如果你想給某些方法開(kāi)綠燈，可按下面的方法排除一些action：
- public class Admin extends Application {
- @Before(unless=“login”)
- static void checkAuthentification() {
- if(session.get(“user”) == null) login();
- }
- public static void index() {
- List users = User.findAll();
- render(users);
- }
- …
- }
或者僅對(duì)于某些方法調(diào)用該攔截器，可使用“only”：
- public class Admin extends Application {
- @Before(only={“login”,“logout”})
- static void doSomething()
- {
- …
- }
- …
- }
@After, @Before 和 @Finally這三個(gè)注解，都提供了 unless 和 only 參數(shù)。
@After
使用@After注解的方法，將在該Controller中的每一個(gè)action之后被調(diào)用。
- public class Admin extends Application {
- @After static void log(){
- Logger.info(“Action executed ...”);
- }
- public static void index() {
- List users = User.findAll();
- render(users);
- }
- … }
@Catch
使用了@Catch注解的方法，將會(huì)在某個(gè)拋出了它所指定的異常時(shí)，被調(diào)用。異常類型將被傳入到@Catch方法的參數(shù)中。
- public class Admin extends Application {
- @Catch(IllegalStateException.class)
- public static void logIllegalState(Throwable throwable) {
- Logger.error(“Illegal state %s…”, throwable);
- }
- public static void index() { List users = User.findAll();
- if (users.size() == 0) {
- throw new IllegalStateException(“Invalid database - 0 users”);
- }
- render(users);
- }
- }
與Java的異常處理一樣，我們可以使用一個(gè)超類來(lái)捕獲更多的異常類型。如果我們有多個(gè)catch方法，可以通過(guò)指定其 priority 來(lái)定義它們的執(zhí)行順序（priority為1的最先執(zhí)行）。
- public class Admin extends Application {
- @Catch(value = Throwable.class, priority = 1)
- public static void logThrowable(Throwable throwable) {
- // Custom error logging… Logger.error(“EXCEPTION %s”, throwable);
- }
- @Catch(value = IllegalStateException.class, priority = 2)
- public static void logIllegalState(Throwable throwable) {
- Logger.error(“Illegal state %s…”, throwable);
- }
- public static void index() {
- List users = User.findAll();
- if(users.size() == 0) {
- throw new IllegalStateException(“Invalid database - 0 users”);
- }
- render(users); }
- }
@Finally
使用@Finally注解的方法，總是在該Controller中每一個(gè)action執(zhí)行完之后再執(zhí)行。不論action執(zhí)行成功或者失敗，它都將會(huì)被執(zhí)行。跟Java中finally的意思相同。
- public class Admin extends Application {
- @Finally static void log() {
- Logger.info(“Response contains : ” + response.out);
- }
- public static void index() {
- List users = User.findAll(); render(users);
- }
- …
- }
如果@Finally方法有一個(gè)Throwable類型的參數(shù)，則異常對(duì)象會(huì)被傳入（如果有的話）：
- public class Admin extends Application {
- @Finally static void log(Throwable e) {
- if( e == null ){
- Logger.info(“action call was successful”);
- }
- else
- {
- Logger.info(“action call failed”, e);
- }
- }
- public static void index() {
- List users = User.findAll(); render(users);
- }
- …
- }
Controller繼承
如果一個(gè)Controller類是另一個(gè)的子類，則父類中定義的攔截器同樣對(duì)子類有效。
通過(guò)@With注解，加入更多的攔截器
因?yàn)镴ava中沒(méi)有多重繼承，所以通過(guò)Controller繼承來(lái)共用攔截器很難。但是通過(guò)@With注解，我們可以把一些攔截器定義在一個(gè)完全不同的類中，然后在當(dāng)前Controller中使用它們。
舉例：
- public class Secure extends Controller {
- @Before static void checkAuthenticated() {
- if(!session.containsKey(“user”)) {
- unAuthorized();
- }
- }
- }
把它加到另一個(gè)Controller中：
- @With(Secure.class)
- public class Admin extends Application {
- … }
Session和Flash scopes
如果你打算在多個(gè)HTTP請(qǐng)求之間共用數(shù)據(jù)，可以把它們保存在Session或Flash域中。保存在Session中的數(shù)據(jù)，對(duì)于整個(gè)user session都可用，而保存在flash域中的數(shù)據(jù)，則僅僅在下一個(gè)請(qǐng)求可用。
有一點(diǎn)非常重要，需要理解的是，在play中，Session和Flash數(shù)據(jù)并沒(méi)有保存在服務(wù)器端，而是通過(guò)Cookie被加入到每一個(gè)HTTP請(qǐng)求中。所以能保存的數(shù)據(jù)量非常小(不超過(guò)4KB），并且只能保存字符串。
當(dāng)然，cookies都使用了一個(gè)密鑰進(jìn)行了加密，所以客戶端無(wú)法修改cookie數(shù)據(jù)（否則該數(shù)據(jù)將無(wú)效）。Play的session不是用來(lái)當(dāng)作數(shù)據(jù)緩存。如果我們需要緩存與session相關(guān)的某些數(shù)據(jù)，可以使用Play內(nèi)置的緩存機(jī)制，并使用 session.getId() 作為key來(lái)保存。
舉例：
- public static void index() {
- List messages = Cache.get(session.getId() + "-messages", List.class);
- if(messages == null) {
- // Cache miss
- messages = Message.findByUser(session.get("user"));
- Cache.set(session.getId() + "-messages", messages, "30mn");
- }
- render(messages);
- }
當(dāng)我們關(guān)閉瀏覽器時(shí)，session數(shù)據(jù)將過(guò)期，除非我們通過(guò) application.session.maxAge 進(jìn)行了配置。
緩存使用了與傳統(tǒng)Servlet HTTP session不同的定義，所以我們不能假設(shè)這些數(shù)據(jù)只是在cache中。這將強(qiáng)迫我們處理cache中沒(méi)有數(shù)據(jù)的情況，并強(qiáng)迫我們的程序是完全無(wú)狀態(tài)的。
原文鏈接：http://play-framework.herokuapp.com/zh/controllers
【編輯推薦】
