Yii 学習概要データアクセスオブジェクト (DAO)

この記事は、YII 学習まとめ記事の 2 つ目であり、主にデータ アクセス オブジェクト (DAO) について説明しています。必要に応じて参照してください。

Yii は、強力なデータベース プログラミング サポートを提供します。 。 Yii データ アクセス オブジェクト (DAO) は、PHP データ オブジェクト (PDO) 拡張機能に基づいて構築されており、単一の統一インターフェイスを介してさまざまなデータベース管理システム (DBMS) にアクセスできます。 Yii の DAO を使用して開発されたアプリケーションは、データ アクセス コードを変更することなく、別のデータベース管理システムの使用に簡単に切り替えることができます。

データ アクセス オブジェクト (DAO) は、さまざまなデータベース管理システム (DBMS) に保存されているデータにアクセスするための共通 A​​PI を提供します。 したがって、基盤となる DBMS を別の DBMS に変更する場合、DAO を使用してデータにアクセスするコードを変更する必要はありません。

Yii DAO は PHP データ オブジェクト (PDO) に基づいて構築されています。これは、MySQL、PostgreSQL など、多くの一般的な DBMS に統合されたデータ アクセスを提供する拡張機能です。したがって、Yii DAO を使用するには、PDO 拡張機能と特定の PDO データベースドライバー (PDO_MYSQL など) をインストールする必要があります。

Yii DAO には主に次の 4 つのクラスが含まれています:

CDbConnection: データベース接続を表します。
CDbCommand: データベースを通じて実行される SQL ステートメントを表します。
CDbDataReader: クエリ結果セットからの行の前方専用ストリームを表します。
CDbTransaction: データベース トランザクションを表します。
以下では、さまざまなシナリオでの Yii DAO のアプリケーションを紹介します。

1. データベース接続を確立する
データベース接続を確立するには、CDbConnection インスタンスを作成してアクティブ化します。 データベースに接続するには、接続情報を指定するデータ ソース名 (DSN) が必要です。ユーザー名とパスワードも使用できます。 データベースへの接続中にエラーが発生した場合 (たとえば、DSN が間違っている、ユーザー名/パスワードが無効であるなど)、例外がスローされます。

コードは次のとおりです:

$connection=new CDbConnection($dsn,$username,$password);
// 建立连接。你可以使用  try...catch 捕获可能抛出的异常
$connection->active=true;
......
$connection->active=false;  // 关闭连接

DSN の形式は、使用される PDO データベース ドライバーによって異なります。通常、DSN には PDO ドライバーの名前、コロン、ドライバー固有の接続構文が含まれます。詳細については、PDO ドキュメントを参照してください。 以下は、一般的に使用される DSN 形式のリストです。

コードは以下の通りです:

SQLite: sqlite:/path/to/dbfile
MySQL: mysql:host=localhost;dbname=testdb
PostgreSQL: pgsql:host=localhost;port=5432;dbname=testdb
SQL Server: mssql:host=localhost;dbname=testdb
Oracle: oci:dbname=//localhost:1521/testdb

CDbConnectionはCApplicationComponentを継承しているので、アプリケーションコンポーネントとしても使用できます。これを行うには、アプリケーション設定で db (または他の名前) アプリケーション コンポーネントを次のように設定してください:

コードは次のとおりです:

array(
    ......
    'components'=>array(
        ......
        'db'=>array(
            'class'=>'CDbConnection',
            'connectionString'=>'mysql:host=localhost;dbname=testdb',
            'username'=>'root',
            'password'=>'password',
            'emulatePrepare'=>true,  // needed by some MySQL installations
        ),
    ),
)

その後、Yii::app()- を通じてデータベースにアクセスできます。 >db 接続されました。 CDbConnection::autoConnect を false に特別に設定しない限り、これは自動的にアクティブ化されます。こうすることで、この単一の DB 接続をコード内の多くの場所で共有できます。

2. SQL ステートメントを実行する
データベース接続が確立されたら、CDbCommand を使用して SQL ステートメントを実行できます。 CDbCommand インスタンスを作成するには、指定した SQL ステートメントを引数として CDbConnection::createCommand() を呼び出します。

コードは次のとおりです:

$connection=Yii::app()->db;   // 假设你已经建立了一个 "db" 连接
// 如果没有，你可能需要显式建立一个连接：
// $connection=new CDbConnection($dsn,$username,$password);
$command=$connection->createCommand($sql);
// 如果需要，此 SQL 语句可通过如下方式修改：
// $command->text=$newSQL;

SQL ステートメントは、次の 2 つの方法で CDbCommand を通じて実行されます:

execute(): INSERT、UPDATE、DELETE などの非クエリ SQL ステートメントを実行します。成功すると、この実行によって影響を受けた行数が返されます。

query(): SELECT など、複数行のデータを返す SQL ステートメントを実行します。 成功すると、結果のデータ行を反復処理できる CDbDataReader インスタンスが返されます。簡単にするために、(Yii) はクエリ結果を直接返す一連の queryXXX() メソッドも実装します。

SQL ステートメントの実行時にエラーが発生した場合、例外がスローされます。

コードは次のとおりです:

$rowCount=$command->execute();   // 执行无查询 SQL
$dataReader=$command->query();   // 执行一个 SQL 查询
$rows=$command->queryAll();      // 查询并返回结果中的所有行
$row=$command->queryRow();       // 查询并返回结果中的第一行
$column=$command->queryColumn(); // 查询并返回结果中的第一列
$value=$command->queryScalar();  // 查询并返回结果中第一行的第一个字段

3. クエリ結果の取得
CDbCommand::query() が CDbDataReader インスタンスを生成した後、CDbDataReader::read() を繰り返し呼び出すことで結果の行を取得できます。 PHP の foreach 言語構造で CDbDataReader を使用して、データを行ごとに取得することもできます。

コードは次のとおりです:

$dataReader=$command->query();
// 重复调用 read() 直到它返回 false
while(($row=$dataReader->read())!==false) { ... }
// 使用 foreach 遍历数据中的每一行
foreach($dataReader as $row) { ... }
// 一次性提取所有行到一个数组
$rows=$dataReader->readAll();

注: query() とは異なり、すべての queryXXX() メソッドはデータを直接返します。 たとえば、queryRow() は、クエリ結果の最初の行を表す配列を返します。

4. トランザクションを使用する
アプリケーションが複数のクエリを実行する必要があり、各クエリでデータベースからの読み取りやデータベースへの情報の書き込みが必要な場合は、データベースが複数のクエリを残さず、他のクエリのみを実行するようにします。はとても重要です。 Yii では CDbTransaction インスタンスとして表されるトランザクションは、次の状況で開始される可能性があります:

トランザクションを開始する。
クエリを 1 つずつ実行する。データベースへの更新は外部からは見えません。
トランザクションを送信します。トランザクションが成功すると、更新が表示されます。
クエリの 1 つが失敗した場合、トランザクション全体がロールバックされます。
上記のワークフローは、次のコードを通じて実現できます:

コードは次のとおりです:

$transaction=$connection->beginTransaction();
try
{
    $connection->createCommand($sql1)->execute();
    $connection->createCommand($sql2)->execute();
    //.... other SQL executions
    $transaction->commit();
}
catch(Exception $e) // 如果有一条查询失败，则会抛出异常
{
    $transaction->rollBack();
}

5. 绑定参数
要避免 SQL 注入攻击 并提高重复执行的 SQL 语句的效率， 你可以 "准备（prepare）"一条含有可选参数占位符的 SQL 语句，在参数绑定时，这些占位符将被替换为实际的参数。

参数占位符可以是命名的 (表现为一个唯一的标记) 或未命名的 (表现为一个问号)。调用CDbCommand::bindParam() 或 CDbCommand::bindValue() 以使用实际参数替换这些占位符。 这些参数不需要使用引号引起来：底层的数据库驱动会为你搞定这个。 参数绑定必须在 SQL 语句执行之前完成。

代码如下:

// 一条带有两个占位符 ":username" 和 ":email"的 SQL
$sql="INSERT INTO tbl_user (username, email) VALUES(:username,:email)";
$command=$connection->createCommand($sql);
// 用实际的用户名替换占位符 ":username" 
$command->bindParam(":username",$username,PDO::PARAM_STR);
// 用实际的 Email 替换占位符 ":email" 
$command->bindParam(":email",$email,PDO::PARAM_STR);
$command->execute();
// 使用新的参数集插入另一行
$command->bindParam(":username",$username2,PDO::PARAM_STR);
$command->bindParam(":email",$email2,PDO::PARAM_STR);
$command->execute();

方法 bindParam() 和 bindValue() 非常相似。唯一的区别就是前者使用一个 PHP 变量绑定参数， 而后者使用一个值。对于那些内存中的大数据块参数，处于性能的考虑，应优先使用前者。

关于绑定参数的更多信息，请参考 相关的PHP文档。

6. 绑定列
当获取查询结果时，你也可以使用 PHP 变量绑定列。 这样在每次获取查询结果中的一行时就会自动使用最新的值填充。

代码如下:

$sql="SELECT username, email FROM tbl_user";
$dataReader=$connection->createCommand($sql)->query();
// 使用 $username 变量绑定第一列 (username) 
$dataReader->bindColumn(1,$username);
// 使用 $email 变量绑定第二列 (email) 
$dataReader->bindColumn(2,$email);
while($dataReader->read()!==false)
{
    // $username 和 $email 含有当前行中的 username 和 email 
}

7. 使用表前缀
从版本 1.1.0 起， Yii 提供了集成了对使用表前缀的支持。 表前缀是指在当前连接的数据库中的数据表的名字前面添加的一个字符串。 它常用于共享的服务器环境，这种环境中多个应用可能会共享同一个数据库，要使用不同的表前缀以相互区分。 例如，一个应用可以使用 tbl_ 作为表前缀而另一个可以使用 yii_。

要使用表前缀，配置 CDbConnection::tablePrefix 属性为所希望的表前缀。 然后，在 SQL 语句中使用{{TableName}} 代表表的名字，其中的 TableName 是指不带前缀的表名。 例如，如果数据库含有一个名为tbl_user 的表，而 tbl_ 被配置为表前缀，那我们就可以使用如下代码执行用户相关的查询：

代码如下:

$sql='SELECT * FROM {{user}}';
$users=$connection->createCommand($sql)->queryAll();