scalatra forms下載 - scalatra forms原始碼下載

scalatra forms

其他類別

1.0.0

下載

scalatra 形式

用於驗證和映射 Scalatra 請求參數的函式庫。

注意：該項目已合併到Scalatra中，不再維護！請參閱 Scalatra 文件以了解詳細資訊。

入門

首先，將以下依賴項新增至 build.sbt 以使用 scalatra-forms。

libraryDependencies += " io.github.gitbucket " %% " scalatra-forms " % " 1.1.0 "

接下來，將ValidationJavaScriptProvider加入 Scalatra 應用程式的 Bootstrap 中。

 import io . github . gitbucket . scalatra . forms . _

class ScalatraBootstrap extends LifeCycle {
  override def init ( context : ServletContext ) {
    ...
    context.mount( new ValidationJavaScriptProvider , " /assets/js/* " )
    ...
  }
}

scalatra-forms 現已準備就緒。

定義表單映射。它與 Play2 類似，但 scalatra-forms 更靈活。

 import io . github . gitbucket . scalatra . forms . _
 
case class RegisterForm ( name : String , description : String )

val form = mapping(
  " name "        -> text(required, maxlength( 40 )), 
  " description " -> text()
)( RegisterForm .apply)

接下來，建立一個擴充 ScalatraServlet（或 ScalatraFilter）的 servlet（或過濾器）。它也混合在FormSupport或ClientSideValidationFormSupport中。映射請求參數的物件作為操作的參數傳遞。

 class RegisterServlet extends ScalatraServlet with ClientSideValidationFormSupport {
  post( " /register " , form) { form : RegisterForm =>
    ...
  }
}

在 HTML 中，您必須執行以下兩件事。

新增<script>來導入validation.js所需的jQuery
新增<script>導入validation.js，這有助於ValidationJavaScriptProvider提供的客戶端驗證
將validation="true"加入您的<form>

scalatra-forms 註冊一個提交事件監聽器來驗證表單內容。此監聽器將所有表單內容發佈到FORM_ACTION/validate 。此操作由 scalatra-forms 自動註冊以驗證表單內容。它以 JSON 形式傳回驗證結果。

在客戶端，scalatra-forms 將錯誤訊息放入span#error-FIELD_NAME中。

< script src = " http://code.jquery.com/jquery-2.0.3.min.js " ></ script >
< script src = " /assets/js/validation.js " ></ script >
...
< form method = " POST " action = " /register " validation = " true " >
  Name : < input type = " name " type = " text " >
  < span class = " error " id = " error-name " ></ span >
  < br />
  Description : < input type = " description " type = " text " >
  < span class = " error " id = " error-description " ></ span >
  < br />
  < input type = " submit " value = " Register " />
</ form >

自訂驗證

您可以建立自訂Constraint 。

 def identifier : Constraint = new Constraint (){
  override def validate ( name : String , value : String ) : Option [ String ] =
    if ( ! value.matches( " ^[a-zA-Z0-9 \ -_]+$ " )){
      Some ( s " ${name} contains invalid character. " )
    } else {
      None
    }
}

val form = mapping(
  " name "        -> text(required, identifier), 
  " description " -> text()
)( RegisterForm .apply)

您也可以透過重寫validate(String, String, Map[String, String])建立多重欄位驗證器。可以透過params查找其他欄位值。

創建多字段驗證器的其他方法是呼叫映射verifying 。您可以給函數驗證映射的案例類別。此函數採用映射值並傳回包含錯誤或Nil Seq[(String, String)] 。

 val form = mapping(
  " reason "      -> number(required), 
  " description " -> optional(text)
)( ReasonForm .apply).verifying { value =>
  if (value.reason == 4 && value.descripsion){
    Seq ( " description " -> " If reason is 'Other' then description is required. " )
  } else {
    Nil
  }
}

阿賈克斯

對於 Ajax 操作，請使用ajaxGet或ajaxPost而不是get或post 。由ajaxGet或ajaxPost定義的操作將驗證結果作為 JSON 回應傳回。

 class RegisterServlet extends ScalatraServlet with ClientSideValidationFormSupport {
  ajaxPost( " /register " , form) { form : RegisterForm =>
    ...
  }
}

在客戶端，您可以使用displayErrors()呈現錯誤訊息。

 $ ( '#register' ) . click ( function ( e ) {
  $ . ajax ( $ ( this ) . attr ( 'action' ) , {
    type : 'POST' ,
    data : {
      name       : $ ( '#name' ) . val ( ) ,
      description : $ ( '#description' ) . val ( )
    }
  } )
  . done ( function ( data ) {
    $ ( '#result' ) . text ( 'Registered!' ) ;
  } )
  . fail ( function ( data , status ) {
    displayErrors ( $ . parseJSON ( data . responseText ) ) ;
  } ) ;
} ) ;