模型

Windwork MVC的模型是基于数据库的领域模型(包括业务逻辑+数据访问),采用Active Record架构模式,但保留了Model的命名方式。

Windwork模型集成了ORM的功能,它们既代表实体,包含业务逻辑,又是数据对象,并负责把自己存储到数据库中。Windwork模型有如下特性:

模型约定

文件夹为:src/module/{$mod}/model/;
命名空间:module\{$mod}\model;
类命名为:XxxModel,类名以大写开头,Model作为后缀,使用驼峰命名规则。
文件名为:XxxModel.php,类名后面加.php,大小写敏感;
需要继承:需要数据库读写的模型继承\wf\mvc\Model类,不需要数据存取的继承\wf\Object类;
对应表类:protected $table = '数据表名称';

ORM

加载数据到模型后,将自动映射到模型属性。

user表

CREATE TABLE `user` (
  `uid` int(11) unsigned NOT NULL PRIMARY KEY AUTO_INCREMENT,
  `uname` varchar(32) NOT NULL DEFAULT '',
  `upass` varchar(32) NOT NULL DEFAULT '',
  `email` varchar(32) NOT NULL DEFAULT ''
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

User模型

namespace module\user\model;

class UserModel extends \wf\mvc\Model { 
    protected $table = 'user';
}

user 表映射到User模型的属性

$user = new \module\user\model\UserModel();

// 加载uid=1的用户信息
if($user->setPkv(1)->load()) {
    // 模型加载一条记录后,自动映射到属性,我们可以通过属性来获取表中对应字段的值
    echo $user->uname; // 输出uname属性(字段)值
    echo $user->email; // 输出email属性(字段)值
} else {
    print '该用户不存在';
}

前面的案例是隐式映射表字段,即没有声明模型属性,自动把表字段映射成模型的属性。 如果已设置模型属性,我们需要设置属性对应的字段进行显式映射。 显式映射后,在模型数据从数据库加载时自动映射到类的属性;保存模型数据到数据库时,自动从模型属性获取数据存入数据库。

例如:

namespace module\user\model;

class UserModel extends \wf\mvc\Model { 
    protected $table = 'user';    

    /**
     * 属性和表字段的绑定
     * 
     * 设置表字段对应模型类的属性,以实现把类属性绑定到表字段,并且Model->toArray()方法可获取绑定属性的值。
     * 表字段名不分大小写,属性名大小写敏感。
     * 
     * @var array = [
     *     '表字段1' => '属性1',
     *     '表字段2' => '属性2',
     *     ...
     * ]
     */
    protected $fieldMap = [
        'uname' => 'name', // 把字段uname映射到name属性,属性名和字段名可以不一样
    ];

    private $name;
}

数据访问

模型封装数据访问方法:

Model::load(): 从数据库加载模型一条记录,并将记录映射到模型属性, Model::create(): 添加/新增模型数据到数据库 Model::update():更新模型数据 Model::delete():更新模型数据 Model::save():保存模型数据

原生SQL读写数据库

在模型中可执行原生SQL,通过self::getDb()获取数据库操作对象,更详细见 数据库操作组件,数据库操作对象可执行如下方法进行数据库读写:

    /**
     * 获取所有记录
     * 
     * @param string $sql
     * @param array $args = [] sql格式化参数值列表
     * @param bool $allowCache
     */
    public function getAll($sql, array $args = [], $allowCache = false);

    /**
     * 获取第一列
     * 
     * @param string $sql
     * @param array $args = []  sql格式化参数值列表
     * @param bool $allowCache
     */
    public function getRow($sql, array $args = [], $allowCache = false);

    /**
     * 获取第一列第一个字段
     * 
     * @param string $sql
     * @param array $args =[]  sql格式化参数值列表
     * @param bool $allowCache
     */
    public function getColumn($sql, array $args = [], $allowCache = false);

    /**
     * 执行写入SQL
     * 针对没有结果集合返回的写入操作,
     * 比如INSERT、UPDATE、DELETE等操作,它返回的结果是当前操作影响的列数。
     * 
     * @param string $sql
     * @param array $args = []  sql格式化参数值列表
     * @throws \wf\db\Exception
     * @return int
     */
    public function exec($sql, array $args = []);

    /**
     * 取得上一步 INSERT 操作产生的 ID
     *
     * @return string 
     */
    public function lastInsertId();

    /**
     * 插入多行数据
     * 过滤掉没有的字段
     *
     * @param array $rows
     * @param string $table  插入表
     * @param array $fields  允许插入的字段名
     * @param string $isReplace = false 是否使用 REPLACE INTO插入数据,false为使用 INSERT INTO
     */
    public function insertRows(array $rows, $table, $fields = [], $isReplace = false);

例如:

SQL防注入

直接使用SQL容易产生注入的安全问题,我们封装了SQL格式化的方式防注入。

以%作为标识,%后面的字符为格式化参数的数据类型。支持的类型有:

数据库操作类执行SQL的方法都支持SQL格式化。

// 从user表获取10个 is_valid = 1 的用户
$sql = "SELECCT * from %t WHERE is_valid = %i LIMIT 0,10";
$args = [
  'user', // %t 参数的值
  1,// %i 参数的值
];
self::getDb()->getAll($sql, $args);

使用事务

使用事务的前提是:你使用的引擎必须支持事务。MyISAM、MEMORY引擎不支持事务,InnoDB引擎支持事务。MySQL经过多年的发展,InnoDB引擎已经是MySQL引擎中最有优势的引擎,所以推荐你优先使用InnoDB引擎。

Windwork 模型中默认已启用事务,不需要另外启用。 可以嵌套启用事务,最终只在最上一级事务提交后才会真正执行事务。



## 模型表关联
为了保持代码简单可控,对于数据表关联的关系,我们没有实现到模型上进行自动处理,每个模型的表有关联数据表,需程序员自己实现业务处理。