README.zh-cn.md

English | 简体中文

Cell

Cell 是基于 TypeScript 的 Serverless First、组件化、平台无关的渐进式应用框架。

特点

• 零配置：开箱即用，减少配置复杂性。
• 基于 TypeScript：提供强类型支持，提升开发效率。
• AI 支持：提供了 AI 基础抽象和多厂商模型服务接口适配。
• 无服务器优先：优化 Serverless 应用开发。
• 跨平台：不依赖具体平台，灵活部署。
• 全栈支持：前后端一体化，兼容多种前端框架。
• 微服务架构：支持构建和管理微服务。
• 组件化：模块化设计，便于扩展和维护。
• 插件化工具：命令行工具支持插件，增强功能。
• 依赖注入：简化组件之间的依赖管理。
• 面向切面编程 (AOP)：实现横切关注点的模块化。
• 集成 ORM：使用装饰器进行事务管理，简化数据库操作。
• 认证与授权：支持 OIDC 认证和 OAuth2 授权。
• 状态管理：采用 rxjs 管理应用状态。
• 多接口风格：同时支持 REST 和 RPC 接口。

快速开始

# 安装命令行工具
npm install -g @celljs/cli

# 初始化项目
cell init -o project-name
cd project-name            # 进入项目根目录

# 运行项目
cell serve

# 部署项目
cell deploy -m scf      # 部署到腾讯云云函数（SCF）
cell deploy -m fc       # 部署到阿里云函数计算（FC）
cell deploy -m lambda   # 部署到 AWS Lambda

示例

• Backend 示例
• React 示例
• Vue 示例
• Shedule 示例
• Microservice 示例
• Accounts 示例

文档

• 介绍
• 创建第一个应用
• 命令行工具
• 控制器
• 数据库操作
• 微服务
• 认证与授权
• 云平台适配
• 依赖注入
• 组件设计
• 前端架构
• React 开发
• 前后端一体化开发

依赖注入

// 类对象注入
@Component()
export class A {

}

@Component()
export class B {
    @Autowired()
    protected a: A;
}

// 配置属性注入
@Component()
export class C {
    @Value('foo') // 支持 EL 表达式语法，如 @Value('obj.xxx')、@Value('arr[1]') 等等
    protected foo: string;
}

数据库操作

import { Controller, Get, Param, Delete, Put, Post, Body } from '@celljs/mvc/lib/node';
import { Transactional, OrmContext } from '@celljs/typeorm/lib/node';
import { User } from './entity';
@Controller('users')
export class UserController {
    
    @Get()
    @Transactional({ readOnly: true })
    list(): Promise<User[]> {
        const repo = OrmContext.getRepository(User);
        return repo.find();
    }
    @Get(':id')
    @Transactional({ readOnly: true })
    get(@Param('id') id: number): Promise<User | undefined> {
        const repo = OrmContext.getRepository(User);
        return repo.findOne(id);
    }
    @Delete(':id')
    @Transactional()
    async remove(@Param('id') id: number): Promise<void> {
        const repo = OrmContext.getRepository(User);
        await repo.delete(id);
    }
    @Put()
    @Transactional()
    async modify(@Body() user: User): Promise<void> {
        const repo = OrmContext.getRepository(User);
        await repo.update(user.id, user);
    }
    @Post()
    @Transactional()
    create(@Body() user: User): Promise<User> {
        const repo = OrmContext.getRepository(User);
        return repo.save(user);
    }
}

交流群

状态