管理平台有一个设置的功能，有些时候在不同部门的同事可能因为一件事情在同一时间编辑这个设置功能，然而结果肯定是一个覆盖另外一个，如果不是仔细的分析具体原因，根本不知道是为什么发生如此的问题。

而乐观锁解决了此问题。

原理

数据库字段中有一个存储版本的字段，每编辑一次就+1，这样后提交的人的版本就会落后与最新的版本，从而达到防治覆盖错误的效果。

案例

wiki

  1. CREATE TABLE `wiki` (
  2.   `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  3.   `title` varchar(30) NOT NULL COMMENT '标题',
  4.   `content` varchar(255) NOT NULL COMMENT '内容',
  5.   `version` bigint(20) NOT NULL DEFAULT '0' COMMENT '乐观锁版本标识',
  6.   PRIMARY KEY (`id`)
  7. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

model

  1. <?php
  2. namespace common\models;
  4. use yii\behaviors\OptimisticLockBehavior;
  6. /**
  7.  * This is the model class for table "{{%wiki}}".
  8.  *
  9.  * @property int $id
  10.  * @property string $title 标题
  11.  * @property string $content 内容
  12.  * @property int $version 乐观锁版本标识
  13.  */
  14. class Wiki extends \yii\db\ActiveRecord
  15. {
  17.     public function behaviors ()
  18.     {
  19.         return [
  20.       // 这个行为类在 2.0.16 版本加入
  21.             OptimisticLockBehavior::className()
  22.         ];
  23.     }
  25.     /**
  26.      * 重写 optimisticLock，暴露版本字段
  27.      *
  28.      * {@inheritdoc}
  29.      * @see \yii\db\BaseActiveRecord::optimisticLock()
  30.      */
  31.     public function optimisticLock ()
  32.     {
  33.         return 'version';
  34.     }
  36.     /**
  37.      *
  38.      * {@inheritdoc}
  39.      */
  40.     public static function tableName ()
  41.     {
  42.         return '{{%wiki}}';
  43.     }
  45.     /**
  46.      *
  47.      * {@inheritdoc}
  48.      */
  49.     public function rules ()
  50.     {
  51.         return [
  52.             [
  53.                 [
  54.                     'title',
  55.                     'content'
  56.                 ],
  57.                 'required'
  58.             ],
  59.             [
  60.                 [
  61.                     'version'
  62.                 ],
  63.                 'integer'
  64.             ],
  65.             [
  66.                 [
  67.                     'title'
  68.                 ],
  69.                 'string',
  70.                 'max' => 30
  71.             ],
  72.             [
  73.                 [
  74.                     'content'
  75.                 ],
  76.                 'string',
  77.                 'max' => 255
  78.             ]
  79.         ];
  80.     }
  82.     /**
  83.      *
  84.      * {@inheritdoc}
  85.      */
  86.     public function attributeLabels ()
  87.     {
  88.         return [
  89.             'id' => 'ID',
  90.             'title' => '标题',
  91.             'content' => '内容',
  92.             'version' => '乐观锁版本标识'
  93.         ];
  94.     }
  95. }

controller

  1. <?php
  2. namespace backend\controllers;
  4. use common\models\Wiki;
  5. use yii\base\UserException;
  6. use yii\db\StaleObjectException;
  7. use yii\web\Controller;
  9. class WikiController extends Controller
  10. {
  12.     public function actionEdit ($id)
  13.     {
  14.         $model = Wiki::findOne($id);
  15.         if(empty($model))
  16.         {
  17.             throw new UserException('未找到wiki信息');
  18.         }
  20.         // 2.0.36 版本之后才可以使用 $this->request
  21.         if($this->request->isPost)
  22.         {
  23.             if($model->load($this->request->post()) && $model->validate())
  24.             {
  25.                 try
  26.                 {
  27.                     $res = $model->save();
  28.                 }
  29.                 catch(StaleObjectException $e)
  30.                 {
  31.                     throw new UserException('有他人已经编辑过了，你的文档过于陈旧，请刷新后重新编辑');
  32.                 }
  33.                 // 保存成功
  34.                 if(false !== $res)
  35.                 {
  36.                     return json_encode([
  37.                         'code' => 0,
  38.                         'message' => '保存成功'
  39.                     ]);
  40.                 }
  41.             }
  43.             throw new UserException('数据验证失败：' . json_encode($model->errors));
  44.         }
  46.         return $this->render('edit', [
  47.             'model' => $model
  48.         ]);
  49.     }
  50. }

view

  1. <html lang="en">
  2. <head>
  3. <meta charset="utf-8">
  4. <title><?= $model->title?></title>
  5. </head>
  7. <body>
  8.     <form name="/wiki/edit?id=<?=$model->id?>" method="post">
  9.         <input name="Wiki[title]" value="<?=$model->title?>" />
  10.         <br>
  11.         <textarea name="Wiki[content]">
  12.           <?=$model->content?> 
  13.         </textarea>
  14.         <br>
  15.         <input type="hidden" name="_csrf-backend" value="<?= Yii::$app->request->csrfToken ?>" />
  16.         <input type="hidden" name="Wiki[version]" value="<?=$model->version?>" />
  17.         <button type="submit">提交</button>
  18.     </form>
  19. </body>
  20. </html>

效果

后编辑提交的会得到错误提示。

image.png