模型

thinkjs现在只对mysql做了封装，如果现在需要使用其他的数据库，可以直接require对应的模块。如：mongodb可以用mongoose模块。

在thinkjs中基础的模型类就是Model类，该类完成了基本的增删改查、连贯操作和统计查询，同时还有thenadd, countSelect等功能，更高级的功能封装在另外的模型扩展中。

模型定义

模型并非必须定义，只有当存在独立的业务逻辑或者属性的时候才需要定义

模型类通常都需要继承系统的Model类，如：

  1. //模型定义
  2. module.exports = Model(function(){
  3.     return {
  4.         //获取用户列表
  5.         getList: function(){
  7.         }
  8.     }
  9. })

该文件保存在：App/Lib/Model/UserModel.js。

模型类大多数情况下都是操作对应的数据表的，如果按照系统的规范来命名模型类，大多数情况下都可以自动关联到对应的数据表。

模型类的命名表现在对应的模型文件上，如上面的UserModel.js，那么该模型名称为UserModel。

模型类的命令采用驼峰时的规则，并且首字母大写，去除数据表的前缀。如：

  • UserModel 对应的数据表为think_user，这里的数据表前缀为think_
  • UserGroupModel 对应的数据表为think_user_group，数据表前缀也为think_

数据表定义

在模型中，有几个跟数据表名称相关的数据可以定义：

  • tablePrefix 表前缀，默认对应配置：db_prefix
  • tableName 表名称，默认情况下等于模型名称，即上面的User
  • trueTableName 包含前缀的数据表名称，也就是数据库中的实际表明，默认情况下不用设置。
  • dbName 数据库名称

默认属性

假设数据库test中有数据表think_user，那么对应的模型类名称为UserModel，对应的模型文件为：App/Lib/Model/UserModel.js。这时候计算出来的几个属性值为：

  • tablePrefix = think_
  • tableName = user
  • trueTableName = think_user
  • dbName = test

这几个值会自动计算，不用在Model类里设置。

自定义属性

假设另一个数据库test2中有数据表think2_users，但模型类文件为App/Lib/Model/UserModel.js，那么就要在模型类中作如下的定义：

  1. //自定义属性的模型
  2. module.exports = Model(function(){
  3.     return {
  4.         dbName: 'test2',
  5.         trueTableName: 'think2_users'
  6.     }
  7. })

模型实例化

直接实例化

  1. //通过thinkRequire加载UserModel对应的js文件
  2. var userModel = thinkRequire("UserModel");
  3. var instance = userModel();
  4. //传递参数实例化
  5. var newInstance = userModel("users", {db_prefix: "think2_"});

模型类实例化的时候可以传3个参数，分别是：模型名、详细配置，也可以在详细配置里指定数据表前缀。

D函数实例化

为了简化实例化模型的代码，提供一个全局的D函数:

  1. //实例化模型类
  2. var model = D('User');

效果和上面手工实例化是一样的，可以传入的参数也一致。

数据库

数据库支持

thinkjs目前还只支持mysql数据库，后续会支持更多的数据库。

数据库连接

模型实例化默认会读取如下的配置，需要在App/Conf/config.js中设置对应的值： ：

  1. //数据库连接信息
  2. db_type: "mysql", // 数据库类型
  3. db_host: "localhost", // 服务器地址
  4. db_port: "", // 端口
  5. db_name: "", // 数据库名
  6. db_user: "root", // 用户名
  7. db_pwd: "", // 密码
  8. db_prefix: "think_", // 数据库表前缀

如果使用其他的配置信息连接数据库，可以在模型实例化的时候传入对应的配置：

  1. //App/Conf/config.js里额外的数据库配置信息
  2. 'ext_db_config': {
  3.     db_type: "mysql", // 数据库类型
  4.     db_host: "localhost", // 服务器地址
  5.     db_port: "", // 端口
  6.     db_name: "", // 数据库名
  7.     db_user: "root", // 用户名
  8.     db_pwd: "", // 密码
  9.     db_prefix: "think_", // 数据库表前缀
  10. };
  11. //实例化时传入对应的配置
  12. var model = D('User', C('ext_db_config'));

链式调用

thinkjs的基础模型类提供了很多链式调用的方法（类似于jQuerylii的链式调用方式），可以有效的提高数据存取的代码清晰度和开发效率，并且支持所有的CURD操作。

链式调用是通过方法里返回this来实现的。

使用非常简单，如：要查询用户表中name为welefen的部分用户信息，可以用下面的方式：

  1. var promise = D('User').where({name: 'welefen'}).field('sex,date').find().then(function(data){
  2.     //data为当前查询到用户信息，如果没有匹配到相关的数据，那么data为一个空对象
  3. })

注意： 由于数据库操作都是异步的，执行find()方法后，并不能返回结果，而是返回一个promise，在promise.then方法里可以拿到对应的数据。

系统支持的链式调用有：

  • where, 用于查询或者更新条件的定义
  • table, 用于定义要操作的数据表名称
  • alias, 用于给当前数据表定义别名
  • data, 用于新增或者更新数据之前的数据对象赋值
  • field, 用于定义要查询的字段，也支持字段排除
  • order, 用于对结果进行排序
  • limit, 用于限制查询结果数据
  • page, 用于查询分页，生成sql语句时会自动转换为limit
  • group, 用于对查询的group支持
  • having, 用于对查询的having支持
  • join, 用于对查询的join支持
  • union, 用于对查询的union支持
  • distinct, 用于对查询的distinct支持
  • cache 用于查询缓存

对于每个方法的具体使用请见 API里的详细文档。

CURD操作

添加数据

模型里添加数据使用add方法，示例如下：

  1. D("User").add({
  2.     name: "welefen",
  3.     pwd: "xxx",
  4.     email: "welefen@gmail.com"
  5. }).then(function(insertId){
  6.     //insertId为插入到数据库中的id
  7. }).catch(function(err){
  8.     //插入异常，比如：email已经存在
  9. })

也可以一次添加多条数据，使用addAll方法，示例如下：

  1. D('User').addAll([{
  2.     name: "welefen",
  3.     email: "welefen@gmail.com"
  4. }, {
  5.     name: "suredy",
  6.     email: "suredy@gmail.com"
  7. }]).then(function(insertId){
  9. })

注意：这里的一次插入多条数据最终拼成的sql语句只有一条，不会智能切割。如果数据量非常大（如：>1W条）的话，一次插入可能会导致报错，请自行切割分块插入。

更新数据

更新数据使用update方法，如：

  1. //更新email为welefen@gmail.com用户的密码
  2. D('User').where({email: "welefen@gmail.com"}).update({
  3.     pwd: "xxx"
  4. }).then(function(affectedRows){
  5.     //affectedRows为影响的行数
  6. })

查询数据

在thinkjs中读取数据的方式有多种，通常分为：读取单条数据、读取多条数据和读取字段值。

数据查询方法支持很多的连贯操作方法，如：where, table, field, order, group, having, join, cache等。

  1. //查询id=1的用户数据，只需要name,email字段值
  2. D('User').where({id: 1}).field('name,email').find().then(function(data){
  3.     //如果数据存在data为{name: "welefen", "email": "welefen@gmail.com"}
  4.     //数据不存在data为{}
  5. });
  6. //查询score>1000的10条用户数据，按score降序
  7. D('User').where({score: ['>', 1000]}).order('score DESC').limit(10).select().then(function(data){
  8.     //data为一个数组，数组里每一项为一个用户的详细信息
  9.     //如果没有数据，那么data为空数组
  10. })
  11. //查询所有的用户数据
  12. D('User').count().then(function(count){
  13.     //count为具体的用户数
  14. })

删除数据

删除数据的方法为delete，如：

  1. //删除id为1的数据
  2. D('User').where({id: 1}).delete().then(function(affectedRows){
  3.     //affectedRows为影响的行数
  4. });

thenAdd

数据库设计时，我们经常需要把某个字段设为唯一，表示这个字段值不能重复。那我们添加数据的时候只能先去查询下这个数据值是否存在，如果不存在才进行插入操作。

为了让使用者更加方便，这里提供了thenAdd的方法来简化这个问题的处理逻辑。

  1. //第二个参数为插入条件，当使用这个插入条件查询时，如果没有查到相关的数据，则进行插入操作。
  2. //表示数据库中没有email为`welefen@gmail.com`数据时才进行插入操作
  3. D('User').thenAdd({
  4.     name: "welefen",
  5.     email: "welefen@gmail.com"
  6. }, {
  7.     email: "welefen@gmail.com"
  8. }).then(function(id){
  9.     //id为exist id或者是insert id
  10.     //如果需要返回详细的数据，可以传入第三个参数true，那么返回的数据格式为{type: "exist", id: "123"} type值为exist或者add
  11. });

countSelect

页面中经常遇到按分页来展现某些数据，这种情况下就需要先查询总的条数，然后在查询当前分页下的数据。查询完数据后还要计算有多少页。

为了方便开发者使用，thinkjs提供了countSelect的方法。

  1. //按每页20条数据来展现文件
  2. D('Article').page(this.get("page"), 20).countSelect().then(function(data){
  3.     //data的数据格式为
  4.     {
  5.         count: 123, //总条数
  6.         total: 10, //总页数
  7.         page: 1, //当前页
  8.         num: 20, //每页显示多少条
  9.         data: [{}, {}] //详细的数据
  10.     }
  11. });
  12. //如果传入一个不存在的页数，比如：总页数只有10页，如果传入的页数为20，默认情况下返回的数据为空
  13. //可以传入参数来修正这个值
  14. //countSelect(true)  修正到第一页
  15. //countSelect(false) 修正到最后一页

关于模型接口的详细使用说明请见 API - Model 。