Symfony資料校驗方法分析

本篇文章用實例分析了Symfony資料校驗方法，在這裡分享給大家以供參考，有興趣的小夥伴可以看一下

校驗在web應用程式中是一個常見的任務。資料輸入到表單需要被校驗。資料在寫入資料庫之前或傳入一個webservice時也需要被校驗。

Symfony2 配備了一個Validator 元件，它讓校驗工作變得簡單易懂。該元件是基於JSR303 Bean校驗規範。一個Java規格用在PHP中。

基本驗證

理解校驗的最好方法是看它的表現。首先，假設你已經創建了一個用於你應用程式某個地方的PHP物件。

程式碼如下:

//src/Acme/BlogBundle/Entity/Author.php
namespace Acme\BlogBundle\Entity;
class Author
{
public $name;
}

到現在為止，它只是個服務於你應用程式的某些目的的普通的類別。而校驗的目的就是要告訴你物件的資料是否合法。為了這個目的，你需要配置一個物件必須遵守規則或約束清單來讓自己的資料合法。這些規則可以被描述成多種不同的格式的（例如，YAML，XML，類別聲明或PHP）。例如，我們保證屬性$name不能為空，來加入下面的規則：

YAML格式：

程式碼如下:

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
properties:
name:
- NotBlank: ~

類別聲明格式：

程式碼如下：

// src/Acme/BlogBundle/Entity/Author.php
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\NotBlank()
*/
public $name;
}

XML格式：

#程式碼如下:

<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

PHP程式碼格式：

#程式碼如下:

// src/Acme/BlogBundle/Entity/Author.php
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints\NotBlank;
class Author
{
public $name;

public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('name', new NotBlank());
}
}

Protected和private屬性以及getter方法也都可以被校驗。

使用validator服務：​​

接下來，使用validator服務的validate方法來真正的校驗Author物件。 validator的工作很簡單：讀取一個類別的約束規則來校驗一個物件的資料是否符合這些規則約束。如果校驗失敗，一個錯誤數組將會被傳回。現在我們在一個controller中來執行它：

程式碼如下:

use Symfony\Component\HttpFoundation\Response;
use Acme\BlogBundle\Entity\Author;
//...
public function indexAction()
{
$author = new Author();
//... 对$auother对象做些什么

$validator = $this->get('validator');
$errors = $validator->validate($author);
if(count($errors) >0){
return new Response(print_r($errors, true));
}else{
return new Response('The author is valid! Yes!');
}
}

如果$name 屬性為空，你會看到下面的錯誤訊息：

Acme\BlogBu​​ndle\Author.name:
This value should not be blank

如果你為$name屬性插入一個值，那麼你會獲得快樂的成功資訊.

大多時候，你不需要直接跟validator服務交流或根本不需要擔心印出錯誤。

大多數情況下，你會在處理提交表單資料時間接使用校驗。

你也可以傳遞一個錯誤訊息集合到一個模版：

程式碼如下:

if(count($errors)>0){
return $this->render('AcmeBlogBundle:Author:validate.html.twig',array(
'errors' => $errors,
));
}else{
//...
}

在模版中，你可以根據需要精確的輸出錯誤清單：

Twig格式：

程式碼如下：

{# src/Acme/BlogBundle/Resources/views/Author/validate.html.twig #}
The author has the following errros
{% for error in errors %}
{{ error.message }}
{% endfor %}

校驗和表單

# #validator服務可以被用於任何時候校驗任何物件。 事實上，你將經常在處理表單時間接使用validator。 Symfony的表單類別庫間接使用validator服務在資料被提交和綁定後校驗底層物件。對象違反約束資訊將被轉換到FieldError對象，該對象可以很容易的被展示在你的表單中。在一個controller中的傳統表單提交流程如下：

程式碼如下：

use Acme\BlogBundle\Entity\Author;
use Acme\BlogBundle\Form\AuthorType;
use Acme\Component\HttpFoundation\Request;
//...
public function updateAction(Request $request)
{
$author = new Acme\BlogBundle\Entity\Author();
$form = $this->createForm(new AuthorType(),$author);
if($request->getMethod() =='POST'){
$form->bindRequest($request);

if($form->isvalid()){
//对$author做一些操作
return $this->redirect($this->generateUrl('...'));
}
}
return $this->render('BlogBundle:Author:form.html.twig',array(
'form' => $form->createView(),
));
}

配置：

Symfony2 的validator預設情況下是可用的。但如果你使用了生命方法來指定你的約束，那麼你需要顯式的開啟宣告功能：

YAML格式：

程式碼如下：

# app/config/config.yml
framework:
validation: {enable_annotations: true }

XML格式：

程式碼如下：

#PHP程式碼格式：

程式碼如下:

// app/config/config.php
$contianer->loadFromExtension('framework',array('validation'=> array(
'enable_annotations'=>true,
)));

約束規則

Validator是設計了用來依照約束規則校驗物件的。為了校驗一個對象，只需要映射一個或多個約束到它要校驗的類別然後把它傳遞給validator服務。

本質上，一個限制條件就是一個簡單的PHP對象，它可以產生一個決斷語句。 在現實生活中，一個約束可以是"蛋糕不能烤焦了" 這樣的規則約束。在Symfony2中，約束都差不多：他們決斷某個條件是否成立。給定一個值，約束會告訴你這個值是否遵守了你的約束規則。

Symfony2 支援的約束規則

首先是基礎約束規則：使用他們來決斷非常基本的事，例如你物件屬性的值或方法的回傳值。

NotBlank，Blank，NotNull，Null，True,False,Type

　　字串約束：Email,MinLength,MaxLength,Url,Regex,Ip等

　　數字約束：Max，Min
　　日期限制：Date,DateTime和Time

　　集合限制：Choice，Collection，UniqueEntity，Language，Locale和Country等。

　　檔案約束：File,Image
　　其它約束：Callback,All,Valid

你也可以建立自己的自訂約束。

約束配置：

一些約束，例如NotBlank,很簡單，但是其它的例如Choice約束，有許多配置項需要設定。假設Author類別有另外一個屬性，gener可以被設定為”male"或"female":

YAML格式：

##程式碼如下：

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
properties:
gener:
- Choice: { choices: [male, female], message: Choos a valid gender. }

類別宣告格式：

程式碼如下:

// src/Acme/BlogBundle/Entity/Author.php
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Choice(
* choices = {"male","female"},
* message = "Choose a valid gender."
* )
*/
public $gender;
}

#XML格式：

程式碼如下:

<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

PHP程式碼格式：

程式碼如下:

// src/Acme/BlogBundle/Entity/Author.php
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints\NotBlank;
class Author
{
public $gender;
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('gender', new Choice(array(
'choices' => array('male', 'female'),
'message' => 'Choose a valid gender.',
)));
}
}

一个约束的选项通常都是通过一个数组来传递的。有些约束也允许你传递一个值。"default"在数组中是可选的。在Choice约束时，choices选项就可以通过这种方式指定。

YAML格式：

代码如下:

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
properties:
gender:
- Choice: [male, female]

类声明格式：

代码如下:

// src/Acme/BlogBundle/Entity/Author.php
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\Choice({"male", "female"})
*/
protected $gender;
}

XML格式：

代码如下:

<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
male
female

PHP格式：

代码如下:

// src/Acme/BlogBundle/Entity/Author.php
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints\Choice;
class Author
{
protected $gender;
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('gender', new Choice(array('male', 'female')));
}
}

约束目标

约束可以被用于一个类的属性或者一个公共的getter方法。属性约束最常用也最简单，而公共的getter方法约束则允许你指定一个复杂的约束规则。

属性约束：

校验类的属性石一个最常规的校验技术。Symfony2允许你校验private,protected或者public属性。下面代码显示如何配置Author对象的$firstName属性至少有3个字符：

YAML格式：

代码如下:

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
properties:
firstName:
- NotBlank: ~
- MinLength: 3

类声明格式：

代码如下:

// Acme/BlogBundle/Entity/Author.php
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\NotBlank()
* @Assert\MinLength(3)
*/
private $firstName;
}

XML格式：

代码如下:

3

PHP代码格式：

代码如下:

// src/Acme/BlogBundle/Entity/Author.php
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\MinLength;
class Author
{
private $firstName;
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('firstName', new NotBlank());
$metadata->addPropertyConstraint('firstName', new MinLength(3));
}
}

Getters

约束也可以应用于一个方法的返回值。Symfony2 允许你添加一个约束到任何"get"或者 "is"开头的public方法。该技术的好处是允许你动态的校验你的对象。比如，假设你想确认密码字段不匹配用户的first name(因为安全原因)。你可以通过创建一个idPasswordLegal 方法，然后决断这个方法必须返回true:

YAML格式：

代码如下:

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\Author:
getters:
passwordLegal:
- "True": { message: "The password cannot match your first name" }

类声明格式：

代码如下:

// src/Acme/BlogBundle/Entity/Author.php
use Symfony\Component\Validator\Constraints as Assert;
class Author
{
/**
* @Assert\True(message = "The password cannot match your first name")
*/
public function isPasswordLegal()
{
// return true or false
}
}

XML格式:

代码如下:

PHP代码格式：

代码如下:

// src/Acme/BlogBundle/Entity/Author.php
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints\True;
class Author
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addGetterConstraint('passwordLegal', new True(array(
'message' => 'The password cannot match your first name',
)));
}
}

现在我们创建一个isPasswordLegal()方法，并且包含你需要逻辑：

代码如下:

public function isPasswordLegal()
{
return ($this->firstName != $this->password);
}

眼尖的人可能会注意到getter的前缀("get"或者"is")在映射时被忽略了。这允许你在不改变校验规则的前提下，把一个约束移动到一个具有同名属性上，反之亦然。

类：

一些约束应用到整个类被校验上面。比如，Callback约束是一个通用约束，它可以应用到类自身。当类被校验时，被约束描述的方法只是被执行这样每一个可以提供更个性化的校验。

校验分组

到目前为止，你已经能够添加约束到类并询问是否该类传入所有定义的约束规则。一些情况下，你只需要使用该类的其中某些规则来校验一个对象。要做到这些，你可以组织每一个约束到一个或者多个校验组中，然后应用使用其中一组校验。比如，假设你有一个User类，它会在用户注册和用户更新他们的联系信息时使用。

YAML格式：

代码如下:

# src/Acme/BlogBundle/Resources/config/validation.yml
Acme\BlogBundle\Entity\User:
properties:
email:
- Email: { groups: [registration] }
password:
- NotBlank: { groups: [registration] }
- MinLength: { limit: 7, groups: [registration] }
city:
- MinLength: 2

类声明格式：

代码如下:

// src/Acme/BlogBundle/Entity/User.php
namespace Acme\BlogBundle\Entity;
use Symfony\Component\Security\Core\User\UserInterface;
use Symfony\Component\Validator\Constraints as Assert;
class User implements UserInterface
{
/**
* @Assert\Email(groups={"registration"})
*/
private $email;
/**
* @Assert\NotBlank(groups={"registration"})
* @Assert\MinLength(limit=7, groups={"registration"})
*/
private $password;
/**
* @Assert\MinLength(2)
*/
private $city;
}

XML格式：

代码如下:

7

PHP代码格式：

代码如下:

// src/Acme/BlogBundle/Entity/User.php
namespace Acme\BlogBundle\Entity;
use Symfony\Component\Validator\Mapping\ClassMetadata;
use Symfony\Component\Validator\Constraints\Email;
use Symfony\Component\Validator\Constraints\NotBlank;
use Symfony\Component\Validator\Constraints\MinLength;
class User
{
public static function loadValidatorMetadata(ClassMetadata $metadata)
{
$metadata->addPropertyConstraint('email', new Email(array(
'groups' => array('registration')
)));
$metadata->addPropertyConstraint('password', new NotBlank(array(
'groups' => array('registration')
)));
$metadata->addPropertyConstraint('password', new MinLength(array(
'limit' => 7,
'groups' => array('registration')
)));
$metadata->addPropertyConstraint('city', new MinLength(3));
}
}

这里我们配置了两个校验组：
default默认组： 包括所有没有分配到任何组的约束规则
registration: 只包含了email和password字段的校验规则

告诉validator使用指定的校验组，传一个或者多个组名作为validate()方法的第二个参数即可：

代码如下:

$errors = $validator->validate($author,array('registration'));

值和数组校验

到目前为止，我们已经看了如何校验整个对象。但是有时候，我们可能想值校验一个单独的值，比如校验一个字符串是不是一个合法的email地址。这非常简单，在Controller类中进行如下：

代码如下:

// 在controller类前引用相应的校验命名空间
use Symfony\Component\Validator\Constraints\Email;
public function addEmailAction($email)
{
$emailConstraint = new Email();
// 所有的校验选项（options）都可以这样设置
$emailConstraint->message = 'Invalid email address';
// 使用validator来校验一个值
$errorList = $this->get('validator')->validateValue($email, $emailConstraint);
if (count($errorList) == 0) {
// 这是一个合法的email地址，可以做些什么
} else {
// 这是一个非法的email地址
$errorMessage = $errorList[0]->getMessage()
// 做一些错误处理
}
// ...
}

通过调用validator的validateValue方法，你可以传入一个原始值和一个你要使用的校验对象。该方法会返回一个ConstraintViolationList对象，它扮演的只是一个错误信息数组的角色。集合中的每一个错误是一个ConstraintViolation对象，使用对象的getMessage方法可以获取错误信息。

总结：

Symfony2 的validator是一个强大的工具，它可以被用来保证任何对象数据的合法性。它的强大来源于约束规则，你可以把它们应用于你对象的属性和getter方法。其实，你大多数情况下都是在使用表单时，间接的应用了校验框架，记住它可以被应用于任何地方校验任何对象。

相关推荐：

Symfony查询方法小结分享

Symfony2针对输入时间进行查询实例详解

详解Symfony2框架表单的用法

以上是Symfony資料校驗方法分析的詳細內容。更多資訊請關注PHP中文網其他相關文章！