ZenStack快速入门与实践指南

ZenStack快速入门与实践指南

zenstack Build scalable web apps with minimum code by defining authorization and validation rules inside the data schema, closer to the database 项目地址: https://gitcode.com/gh_mirrors/ze/zenstack

---

项目介绍

ZenStack是一个专为简化Web应用程序后端开发设计的Node.js/TypeScript工具包。它通过增强Prisma ORM来提供一个灵活的授权层，并自动生成类型安全的API和前端钩子，全面释放全栈开发潜能。其核心目标在于减少样板代码的编写时间，让开发者能够集中精力于业务功能的构建。ZenStack引入了“ZModel”数据建模语言，扩展了Prisma模式语言，加入了自定义属性和函数，以支持更为灵活的数据访问控制策略。

项目快速启动

环境准备

确保你的系统中已安装Node.js和npm。

初始化项目

1. 克隆ZenStack到本地:

   git clone https://github.com/zenstackhq/zenstack.git
   

2. 安装依赖: 进入项目目录并执行安装命令。

   cd zenstack
   npm install 或者 yarn
   

3. 运行示例应用: ZenStack提供了快速启动脚本，可以立即体验基础功能。

   npm run start:example 或者 yarn start:example
   

   这将启动一个内含基本CRUD操作的应用实例。

创建一个简单模型

编辑或创建一个新的zmodel文件，比如models/myModel.zmodel，定义模型及权限规则。然后，使用ZenStack CLI将其转换为Prisma兼容模式。

model MyModel {
  id        Int      @id @default(autoincrement())
  name      String
  // 示例权限规则，仅作者可查看
  @@allow('read', author == auth())
}

之后，使用CLI命令更新Prisma模式：

zenstack gen-prisma-schema

结合Prisma客户端进行查询，展示如何利用授权层：

import { enhance } from '@zenstackhq/runtime';
// 假设prisma是已初始化的PrismaClient实例
const enhancedPrisma = enhance(prisma, { user: getCurrentUser() });
enhancedPrisma.myModel.findMany();

应用案例和最佳实践

在实际开发中， ZenStack非常适合构建具有复杂权限管理需求的应用。例如，在一个多租户系统中，每个租户数据仅对其自身可见。通过ZModel定义租户级别的权限规则，保证数据隔离，可以实现高效的多租户解决方案。

最佳实践包括：

• 利用ZModel清晰地表达业务模型与权限逻辑。
• 结合Next.js或Nuxt.js等框架，通过ZenStack的Server Adapter轻松搭建后端服务。
• 使用自动生成的类型安全API和React/Vue的前端Hook，以零配置集成前后端。

典型生态项目

ZenStack与许多现代技术栈无缝集成，如Next.js、ExpressJS、Nuxt.js等。在社区中，你可以找到多个基于ZenStack的模板项目，例如：

• Next.js全栈应用：展示了如何在Next.js中设置ZenStack，包括自动化的API和前端数据访问控制。
• 多租户Todo应用：演示了如何在应用中实现多层次的权限控制，适用于多用户环境。

这些案例通常可以在ZenStack的GitHub页面或官方文档中找到详细的部署和配置指导，帮助开发者快速上手并将ZenStack融入到自己的项目中去。

通过以上步骤和建议，开发者可以迅速启动基于ZenStack的项目，享受高效且安全的全栈开发流程。记住，加入ZenStack的Discord社区以获取即时反馈和支持，加速你的开发旅程。

zenstack Build scalable web apps with minimum code by defining authorization and validation rules inside the data schema, closer to the database 项目地址: https://gitcode.com/gh_mirrors/ze/zenstack