Grails Tutorial Part 1

Transcript

1. Grails Tutorial Part.1 Shih-Peng Lin
2. GRAILS簡介
5. What is Grails? • “Groovy on Rails” • “Grails is an Open Source, full stack, web application framework for the JVM. “ – 「透過Groovy語言與慣例優先原則來提供一個 極具生產力並精簡的開發體驗。」 – 目標：極大地簡化企業級Java web application 的開發。 • 意思就是還是用那些企業級、受過歲月歷練的 framework，但希望能盡量的簡化使用的方式。
6. What is Grails? • Grails不只是一個開放原始碼的web framework，他也是一個完整的開發平台。 – Grails整合了web container, database, build system與test framework；我們只需要透過Grails 的開發流程，就盡得它們的好處。 – 1.0版於2008年2月發佈，曾掀起討論熱潮； 2011年12月發佈2.0版，目前stable release為4月 底發佈的2.2.2版。 • 下頁中所列目前Grails版本所整合的軟體可能在未來 持續變動。
7. Integrated Open Source • Groovy: 使用語言 • Spring Framework: J2EE API抽象化 • Hibernate: ORM • SiteMesh: web page layout framework • jQuery: ajax framework • Tomcat: web container • H2 Database: database • 透過mixin支援大量的test framework: 包括 JUnit 3, JUnit 4, Spock等
8. Grails stack
9. Why Grails? http://stackoverflow.com/questions/397228/is-grails-worth-it
10. http://stackoverflow.com/questions/397228/is-grails-worth-it
11. Features • Convention over configuration • Unit testing • Scaffolding • Object Relational Mapping • Plug-Ins
12. 安裝Grails • 需求： – 已安裝JDK 1.6或以上版本； – 設置環境變數JAVA_HOME。 – 不需要額外安裝Groovy。 • 安裝步驟： – 下載.zip檔並解壓縮到合適位置； • http://www.grails.org/download – 設置GRAILS_HOME； – 將%GRAILS_HOME%\bin加入PATH環境變數。 • 以> grails -–version確認安裝成功。
13. 開發流程與基本元件
14. 開發目標 • 透過建立一個簡單的“每日佳句” (“Quote of the Day”; qotd) application： – 可以新增、刪除、修改，並在網頁上每次瀏覽 都看到不同的佳句。 – 實際執行Grails所建議的開發流程； – 認識Grails專案中的各個必要元件。
15. Grails執行時期概觀 這是2008年出版書籍 “Beginning Groovy and Grails From Novice to Professional” 中的截圖，可以看到 當時版本的Grails使用的web container還是Jetty。
16. Grails專案的開發流程 1. 建立application。 2. 執行application。 3. 建立domain class。 3a. 實作測試程式碼。 3b. 執行測試並修改domain class至測試通過。 4. 建立controller/view與service。 4a. 實作與進行測試，直至通過。 5. 重複步驟3. ~ 4. 直到所有元件功能完成。
17. 1.~2.建立與執行GRAILS專案
18. 建立application • > grails create-app <app-name> • 要在Grails中建立各項元件，需在命令列中以 下列格式輸入Grails目標指令(target)與參數： > grails <target> <args> • 第一行的create-app即是一個目標指令；會 在當前目錄下建立一個名為<app-name>的 application，並在其中建立所需目錄與檔案。
19. 建立application • 在C:\GrailsWorkspace目錄中建立一個名為 qotd的Grails application。 • 假設Grails專案都置於 C:\GrailsWorkspace\下。
20. Applications • Grails專案稱為“application”；未來在專案製 作過程中若要使用grails工具執行任何與 專案內容相關的目標指令，都必須在該專 案目錄下進行。 – 例如建立data model或controller的指令； – 如果不處在任何一個專案中，這種指令無法執 行。
21. 互動模式 (interactive mode) • 當在專案目錄下時，可以輸入grails來進 入Grails的互動模式 (interactive mode)，迅 速地進行各項專案管理工作。 > grails – 因為不需要重新執行JVM。 • 在互動模式下可輸入quit離開。 grails> quit
22. 進入與離開Grails互動模式 • 在qotd下進入與離開Grails互動模式。
24. 執行application • > grails run-app 或 • grails> run-app • 也可以用server.port參數來指定要聆聽的 port number： > grails –Dserver.port=8090 run-app • 建議可以在互動模式下進行與專案操作相關的 指令，這樣指令執行的速度較快。要停止 application： grails> stop-app
25. 執行與停止application • 在qotd中執行與停止application。
26. 執行結果 • 執行qotd後，至http://127.0.0.1:8080/qotd/，可 看到Grails為專案預設建立的頁面。
27. 3. 建立DOMAIN CLASS
28. 建立domain class • Grails專案中的data model稱為domain；建 立data model的工作即為建立domain classes。 – Domain即MVC中的M。 – Grails中負責ORM的部分稱為GORM；GORM透 過Hibernate來完成類別與資料庫間的mapping 與transaction。 • 要建立domain class，在專案目錄中: grails> create-domain-class <domain-class-name>
29. 建立domain class • 在qotd專案中建立一個位於com.qotd套件， 名稱為Quote的domain class。 • 如果在建立domain class時沒有給予套件名 稱 (例如直接輸入Quote)，則Grails會將該 domain class放在一個與專案名稱相同的套 件下 (即：qotd.Quote)。
30. 建立domain class • 這個步驟會在專案目錄下的 grails- app/domain/com/qotd/ 目錄中產生一個 Quote.groovy 檔。 – 當然這個檔裡幾乎什麼都沒有:P
31. 建立domain class • create-domain-class也會在專案目錄下的 test/unit/com/qotd 目錄中產生一個名為 QuoteTests.groovy 的預設測試程式碼。
32. 屬性限制 • 修改Quote類別，以增加類別屬性還有屬性限制： – 類別名稱經過ORM的mapping後會成儲存這類資料 的資料表名稱 (table name)；
33. 屬性限制 – 屬性名稱即成為欄位名稱 (column name)，而屬性 限制成為欄位限制。 • 當然，這些資料表在建立時，GORM會自動建立如 primary key id及version欄位。 – 關於domain的屬性限制可參考 http://grails.org/doc/latest/guide/validation.html。 – blank代表空值不是null；屬性限制有另一項 nullable，而每個domain的nullable預設都是 false。
34. 設定data source • 原本Grails專案中對開發時使用的H2 database設定是 in-memory且每次drop的，將其改為persistent的： – 設定檔位置在grails-app/conf/DataSource.groovy
35. 使用Grails console • Grails console是一個可以在application之外利用 Groovy code與application互動的工具。 grails> console
36. 使用Grails console • 以Groovy code加入Quote：
37. 檢視資料庫內容 • 我們可以使用Grails預設的database console來檢視 資料庫內容。在run-app後瀏覽以下位址即可： http://<host>/qotd/dbconsole • JDBC URL欄位需使用DataSource.groovy中的 environments.development.dataSource.url。
38. 檢視資料庫內容
39. 檢視資料庫內容 可與前述的欄位限制稍做對照。
40. 4A. 建立CONTROLLER CLASS
41. 建立controller • Controller是用以處理頁面呈現與domain之間互動的 元件。 – 即MVC中的C，而且與其他framework相比，C很多。 – 注意，controller處理的是「UI互動」，複雜的商業邏輯 則應透過service實作。 • 要建立controller，在專案目錄中： grails> create-controller <domain-name> 由於Grails遵守domain-driven準則，建議在透過 上述指令建立controller時，給予的名稱為一個 domain class name，代表該controller所要互動 的domain。而Grails所自動產生的controller class name 則會在後面加上Controller。
42. 建立controller • 在qotd專案中建立一個位於com.qotd套件， 名稱為QuoteController的controller。 • 如果在建立controller class時沒有給予套件名稱 (例如直接輸入quote)，則Grails會將該controller class放在一個與專案名稱相同的套件下 (即： qotd.QuoteController)。
43. 建立controller • 這個步驟會在專案目錄下的 grails- app/controllers/com/qotd 目錄中建立一個 QuoteController.groovy 檔。 • 這也會在grails-apps/views/ 目錄下建立一個同名 的子目錄 (quote/)。 – 暗示你應該把和Quote相關的 網頁放在這邊。
44. 建立controller • 同樣的，也會在 test/unit/com/qotd/ 中建立 對應於該controller的預設測試程式碼： QuoteControllerTest.groovy。
45. 建立controller • 目前的QuoteController只有一個action method： index()；action method是實際處理HTTP request 的地方。 • Domain controller中的action method可以理解成 「用來操作某種資料 (domain) 的動作 (action)」， Grails的URL組成也遵從此理念，因此用以呼叫 index()的URL預設上為 http://<host>/qotd/quote/index – QuoteController與quote/這個URL portion的派送 對映在建立controller時grails就幫我們已預設方式設 定好，可直接使用。
46. Controller運作結果
47. 建立controller • Grails具有scaffolding功能，能自動產生： – 對特定domain進行CRUD操作的controller， – 進行操作所需的頁面，讓使用者可以立刻與domain互動。 • 要使用scaffolding功能，在controller中加入 scaffold屬性與要操作的domain name即可： – 最好先去掉index()，它會造成使用scaffold上的一點干 擾。
48. 建立controller • 修改完後，重啟server (stop-app then run-app)， 瀏覽http://<host>/qotd/quote。 – 會轉到qotd/quote/list，此頁面會秀出所有的 Quote，使用者也可在此進行操作。
49. 4B. 使用VIEW
50. 讓action產生回應 • 補上index()並實作下方程式碼，讓index()能對HTTP request做出簡單的文字回應。 • Controller action可利用render()方法建立回應，在此讓其僅 回傳一段簡單的HTML內容字串。 – 可以顯示純文字內容、後方敘述的views、以程式碼建立的html結 構等等。 – render()詳細用途可見 http://grails.org/doc/latest/ref/Controllers/render.html。
51. index()運作結果
52. Redirect user request • 加上home() action method並實作下方程式碼，讓使用者瀏覽 qotd/quote/home時會自動導到/index。 • Controller action可利用redirect()要求瀏覽器重發request重新 導向到另一個位置 – 可能是同一controller中的另一action、不同controller中的不同action、同 一application中的URI、其他任意URL。 – redirect()詳細用途可見 http://grails.org/doc/latest/ref/Controllers/redirect.html。
53. home()運作結果
54. 建立與controller action對應的view • Grails透過放置在grails-app/views/下的.gsp檔來 完成網頁設計與controller邏輯的分隔。 – 功能類似Django的templates，或Java web frameworks中 的.jsp檔。 – views/中的.gsp檔也會根據所放置位置，以及命名方 式的不同而有相異的用途。 • 現在加入以下兩頁程式碼： – 在index()加入如下頁的程式碼，讓 qotd/quote/index能隨機丟出佳句資料； – 在grails-app/views/quote/中加入index.gsp頁面。
55. grails-app/controllers/ com/qotd/QuoteController.groovy
56. grails-app/ views/quote/index.gsp
57. QuoteController.groovy • 5, 7行：現在QuoteController既有index()動作， 也有scaffolding 。 – 依舊可透過qotd/quote/list存取scaffolding的頁 面。
58. QuoteController.groovy • 8行： Quote.list() 會取出database中的所有Quote 紀錄，並包裝成Quote的list。 – Groovy會檢查所撰寫的literal是否為class name；若是， 將自動將其視為該類別的class屬性，因此 • Quote = Quote.class • Quote.list() = Quote.class.list() – Domain classes (即所有放在grails-app/domains/中的類 別) 有多個便於進行資料操作的方法，可參考 http://grails.org/doc/latest/ref/Domain%20Classes/Usage. html。 CoC得太徹底了，連繼承 或annotation都不用。
59. 建立與controller action對應的view • 10~21行：簡單且具可讀性的程式碼，此處的程式碼 皆可透過Grails console進行測試。 • 23行：Controller action會在grails- app/views/<domain-name>/下尋找名稱與action相 同的.gsp檔，嵌入action所給予的資料後回應給瀏覽 器。 – 雖然QuoteController中index()並沒有呼叫render或 response相關的方法，僅回傳了一個map，Grails會自動在 grails-app/views/quote/下尋找index.gsp，並在其中 嵌入map中的資料後回應給瀏覽器。
60. grails-app/views/quote/index.gsp • 一份.gsp檔的內容事實上就是一個巨大的GString， 其內容可隨時使用${...}來代換，用以代換的資料即 來自使用此.gsp的controller。
61. 執行結果
62. 使用view layout • 當application的規模變大，所使用的頁面數也會增 加，但同一application中的頁面其結構並不會變化 太大。 – 現在的網頁都會有navigation bar、header、footer、至 少一行的sidebar，以及放置內容的container等元素。 – 每個controller又都對應到一個頁面，重複不變的部分在 每個頁面中都是redundancy。 • Grails透過SiteMesh來支援網頁內容的decoration， 解決這個問題。
63. 建立view layout • Grails中的layout用以代表某個頁面的主要結構。 – 當頁面中有某些部份需要改變時，只需要抽換掉那個部分的 內容。 • 要建立layout，在grails-app/views/layouts/下建 立一個.gsp檔即可。 – 如果這個layout是給整個application用的，那應取名為 main.gsp。 • 所以grails-app/views/layouts/原本就有一個main.gsp，代 表的是網站預設頁面的layout。 – 如果這個layout只讓某個action使用，那應該命名為 <action-name>.gsp。 – 現在先製作一個quote.gsp。
64. grails-app/views/layouts/quote.gsp
65. grails-app/views/layouts/quote.gsp • 放在layouts/目錄下的.gsp都是action在建立回應時 使用的樣板，action會先計算完主要的頁面內容，再 檢查在layouts/中是否有樣板可用；如果有，則套 入並回應給瀏覽器。
66. 執行結果
67. GSP tags • index.gsp中出現了數個<g:xxx> tag；將一些與 web相關的工作包裝起來讓.gsp檔的內容盡量不 出現複雜的程式碼。 – 官方詳細說明請見 http://grails.org/doc/latest/guide/theWebLayer.ht ml#tags。 • 使用GSP tag時只需要在tag中使用g前綴，Grails會 自動視其為GSP tag；其它前綴則代表其它的tags。 – GSP完全捨棄了使用JSP STL(Standard Tag Library) 時的繁 複import，同時也不建議在.gsp中使用JSP STL。
68. GSP tags • g:layoutTitle – 輸出decorated .gsp的<title>內容。 • g:layoutBody – 輸出decorated .gsp的<body>內容。 • 這些都是用於負責layout decoration的GSP tag，可參考 http://grails.org/doc/latest/guide/theWebLayer.html#lay outs。
69. GSP tags • g:createLinkTo – 根據所給予的目錄與檔案名稱建立出連至該檔案的 relative URL。 – 這些目錄與檔案等靜態資源，應放置於<app- name>/web-app/目錄下，Grails在build專案時會自動 將其放置到合適位置。
70. grails-app/views/quote/index.gsp • 也可以在內容.gsp中加入<meta> tag，主動與Grails說 明此網頁被需要被decorated；<meta>中的content屬 性用以指定要使用的layout。 – 下方.gsp就會被套到layouts/main.gsp中
71. 執行結果 加上<meta>後套用的layout變成 了main.gsp；可以檢查 grails-app/views/下的 error.gsp與index.gsp檔，它 們也有<meta> tag。
72. 使用view layout views/layouts/quote.gsp views/quote/index.gsp
73. 使用view layout output HTML on the browser
74. 4B. 建立SERVICE
75. 建立service • Controller的工作應盡量的少而必要： – 僅用於取得request，透過合適的domain或service以 取得結果； – 並選擇與使用顯示的view。 • Service是專門用以放置複雜邏輯，database transaction的元件。 • 要建立service，在專案目錄中： grails> create-service <domain-name>
76. 建立service • 在qotd專案中建立一個位於com.qotd套件，名稱 為QuoteService的service。 grails-app/services/ com/qotd/QuoteService.gro ovy test/unit/com/qotd/QuoteS erviceTests.groovy
77. 建立service • Grails預設建立的server與其unit test程式碼如下所示。 • 現在將原本置於QuoteController中的程式碼如下頁 移至QuoteService中。 grails-app/services/ com/qotd/QuoteService.gro ovy test/unit/com/qotd/QuoteS erviceTests.groovy
78. grails-app/services/ com/qotd/QuoteService.groovy
79. 使用service • 為了在controller中使用service，對 QuoteController稍作修改。
80. 使用service • 第7行：在controller中使用service最需要注意的地 方是：Grails使用了Spring的dependency injection (DI)，因此我們不能明確的new出Service的實體。 – DI是一種弱化程式模組間相依性的pattern。 • 當class A有使用class B的需求時，只要透過某種方式讓外部知 道它有這個需求就好；當class A被執行/編譯時，外部 (某個 framework，或自己寫的工具) 會依據某些criteria選擇要注入 (inject) 的相依性類別 (dependencies)。 – 所以我們不直接new出QuoteService，而留至讓Grails 幫我們決定。 • 在這個小例子中.... 當然對功能性來說無所謂囉。
81. 執行結果
82. 執行測試
83. 執行測試 • Grails的best practice建議以Domain-Driven的 方式進行開發，而domain則最好以Test- Driven方式開發。 • 完整執行專案中的各項測試(包含單元、整 合與功能測試)： grails> test-app • 以瀏覽器開啟測試結果報表： grails> open test-report
84. 執行測試 • 完整進行qotd專案中的各項測試：
85. 檢視測試報表 • 以瀏覽器開啟qotd專案的測試結果：
86. Unit testing guidelines • Unit test的撰寫有幾個guideline可以遵守： – 所使用的功能來自於內建函式庫，不要測；例 如Date類別。 – 所寫的程式碼功能來自框架要求時，不要測， 因為專案若能順利執行就代表沒有問題；例如 domain的property。 – 自訂函式或方法，必測。 – 同理，controller、service、custom tags都必測。 只要是有實作商業邏輯的部分，都要以已知的 需求進行測試。
87. 實作測試程式碼
88. 發佈與部屬
89. 建立war檔 • grails> war – 後面可接要輸出的路徑與檔名；若不指定，會 放置在<app-name>/target/中。 • .....!!!!????
90. 建立war檔 • 這是因為Grails預設會幫application安裝 Database Migration Plugin；這個plugin要求 grails-app/中必須要存在一個migrations/ 目錄。 – 因此需在grails-app/中新增一個migrations/目 錄。 – 也能到grails-app/conf/BuildConfig.groovy 中直接把database migration移掉。
91. 專案狀態 • grails> stats 完成一個完整運用了Spring、 Hibernate、SiteMesh等 framework的web app，我們 只寫了46行code
92. Summary • Grails簡介 • 開發流程 • 建立與啟動專案 • 認識與建立domain、controller/views及 service。 • 建立war
93. THANKS