云开发json怎么配置数据库

云开发JSON配置数据库：从零开始数据存储核心技巧

在云开发（CloudBase）体系中，数据库是应用数据存储的核心组件，与传统数据库不同，云开发数据库采用JSON文档型存储，无需复杂建表语句，通过配置JSON即可灵活定义数据结构、权限规则和索引，本文将带你从零开始，系统云开发JSON配置数据库的方法，包括数据结构设计、权限控制、索引优化等核心技巧。

初识云开发数据库：JSON文档型存储的优势

云开发数据库（基于腾讯云TDSQL-C或MongoDB）采用文档型（Document）存储模型，每条数据以JSON格式存储，结构灵活，无需预定义严格的表结构，这种设计特别适合现代应用场景：

• 灵活扩展：无需修改表结构即可新增字段，适配快速迭代的产品需求；
• 原生JSON支持：直接存储嵌套对象、数组等复杂数据类型，无需序列化转换；
• 权限细粒度控制：通过JSON配置可实现字段级、操作级权限管理；
• 与云开发生态无缝集成：配合云函数、云存储等组件，快速构建全栈应用。

数据库JSON配置的核心：集合（Collection）与文档（Document）

在云开发数据库中,数据以集合（Collection）为单位组织，类似传统数据库的“表”；集合内的每条数据称为文档（Document），即一个JSON对象，配置数据库的核心，就是通过JSON定义集合的结构、权限和索引。

集合创建与基础JSON结构

在云开发控制台或通过SDK创建集合时,本质是在定义集合的元数据（Metadata），核心JSON结构如下（以腾讯云云开发为例）：

{
  "collectionName": "user", // 集合名称（必填，建议小写+下划线）
  "shardKey": "openid",    // 分片键（必填，用于数据分片，建议用唯一字段如openid）
  "defaultPermission": {   // 默认权限（可选，覆盖全局权限）
    "read": "auth",        // 读权限：'auth'仅登录用户可读，'custom'自定义规则
    "write": "auth"        // 写权限：'auth'仅登录用户可写
  },
  "fields": [              // 字段定义（核心，每个字段的类型和约束）
    {
      "name": "_id",       // 系统字段，文档唯一ID，无需手动配置
      "type": "string",
      "desc": "文档ID",
      "required": true,
      "default": "$db.server ObjectId()"
    },
    {
      "name": "openid",    // 用户唯一标识，分片键
      "type": "string",
      "desc": "用户openid",
      "required": true,
      "default": "$auth.uid" // 自动从登录态获取
    },
    {
      "name": "nickname",
      "type": "string",
      "desc": "用户昵称",
      "required": false,
      "maxLength": 50       // 字符串最大长度
    },
    {
      "name": "age",
      "type": "int",
      "desc": "年龄",
      "required": false,
      "min": 0,             // 最小值
      "max": 150            // 最大值
    },
    {
      "name": "tags",
      "type": "array",      // 数组类型
      "desc": "用户标签",
      "required": false,
      "elementType": "string" // 数组元素类型（string/int/bool/object）
    },
    {
      "name": "profile",
      "type": "object",     // 对象类型（嵌套JSON）
      "desc": "用户详细信息",
      "required": false,
      "properties": {       // 对象属性定义
        "gender": {"type": "string", "enum": ["male", "female"]}, // 枚举值
        "height": {"type": "int", "min": 0}
      }
    },
    {
      "name": "createTime",
      "type": "timestamp",
      "desc": "创建时间",
      "required": true,
      "default": "$db.server Date()" // 自动生成当前时间
    }
  ]
}

关键字段解析：

• collectionName：集合名称，全局唯一，建议用业务前缀（如user_、order_）避免冲突。
• shardKey：分片键，用于数据库分片和查询优化，必须选择高基数、唯一或接近唯一的字段（如openid、orderId），避免用age、status等低基数字段。
• fields：字段定义，每个字段需明确type（类型）、required（是否必填）、约束条件（如maxLength、min、enum等）。
  • 类型支持：string（字符串）、int（整数）、bool（布尔值）、array（数组）、object（对象）、timestamp（时间戳）、geopoint（地理位置）等。
  • 默认值：支持动态表达式，如$auth.uid（当前用户ID）、$db.server Date()（当前服务器时间）。

权限控制：JSON配置“谁能读写”

数据库权限是安全的核心,云开发通过JSON配置实现集合级、字段级、操作级的细粒度控制，权限配置分为默认权限（defaultPermission）和自定义权限规则（permission）。

（1）默认权限：简单场景快速配置

在集合元数据中,通过defaultPermission定义全局读写权限，支持以下值：

• "open"：所有人可读/写（公开数据，如文章评论）；
• "auth"：仅登录用户可读/写（用户个人数据）；
• "custom"：自定义规则（需配合permission字段详细定义）。

示例：

"defaultPermission": {
  "read": "open",   // 所有人可读（如公开文章）
  "write": "auth"   // 仅登录用户可写
}

（2）自定义权限规则：复杂场景精准控制

当默认权限无法满足需求时（如“用户仅能修改自己的数据”），需通过permission字段定义自定义规则，使用表达式（Expression）实现动态权限判断。

示例：用户集合user的权限配置，要求“用户仅能查看和修改自己的数据”：

"permission": {
  "read": {
    "expression": "doc.openid == $auth.uid" // 仅当文档的openid等于当前用户ID时允许读
  },
  "write": {
    "expression": "doc.openid == $auth.uid" // 仅当文档的openid等于当前用户ID时允许写
  }
}

常用表达式变量：

• $auth.uid：当前登录用户ID；
• $doc：当前文档对象（如doc.openid、doc.age`）；
• $db.server Date()：当前服务器时间；
• $request.param.xxx：请求参数（如$request.param.orderId）。

字段级权限：控制特定字段的读写权限

若仅需限制部分字段（如“用户仅能修改昵称，不能修改openid”），可在字段定义中添加permission：

"fields": [
  {
    "name": "openid",
    "type": "string",
    "permission": {
      "read": "auth",       // 登录用户可读openid
      "write": "deny"       // 禁止修改openid（系统自动生成）
    }
  },
  {
    "name": "nickname",
    "permission": {
      "read": "open",       // 所有人可读昵称
      "write": "auth"       // 登录用户可修改昵称
    }
  }
]

索引配置：提升查询性能

当数据量增大时,查询性能会显著下降，需通过索引（Index）优化查询效率，索引配置JSON需明确索引字段、索引类型和唯一性。

（1）单字段索引：基础查询优化

示例：为user集合的nickname字段创建普通索引，支持按昵称模糊查询：

"indexes": [
  {
    "name": "idx_nickname", // 索引名称（建议字段名前缀+idx）
    "fields": ["nickname"], // 索引字段（数组，支持多字段）
    "type": "normal"        // 索引类型：normal（普通）、unique（唯一）、geopoint（地理位置）
  }
]

（2）复合索引：多条件查询优化

若查询需同时关联多个字段（如“查询年龄