LiteOrm在线文档

导航

本文档是 LiteOrm 主要内容介绍。如需深入学习,请参考以下导航:

入门篇 / Getting Started

中文 English 说明
概览 Overview 框架介绍与适用场景
安装 Installation 安装步骤与环境配置
配置 Configuration 服务注册与配置
示例 First Example 完整使用示例

核心使用篇 / Core Usage

中文 English 说明
实体映射 Entity Mapping 实体定义与映射
视图模型 View Models 视图模型与服务层
Expr 使用指南 Expr Guide Expr 构造、组合与语义规则
查询指南 Query Guide 查询方式选型与常见入口
CRUD指南 CRUD Guide 增删改查操作
关联查询 Associations 表关联与 JOIN
Lambda 与 Expr 组合 Lambda & Expr Mixing 在强类型 Lambda 中复用动态 Expr
CTE 指南 CTE Guide 公共表表达式与注意事项

高级特性篇 / Advanced Topics

中文 English 说明
事务 Transactions 事务与并发控制
分表分库 Sharding 分表策略与路由
性能 Performance 性能调优建议
窗口函数 Window Functions 窗口函数支持
自定义分页 Custom Paging 分页方案扩展
权限过滤 Permission Filtering 用户范围过滤与访问控制
日志与诊断 Logging & Diagnostics ServiceLog、Log 特性与慢查询日志
安全性 Security SQL 注入防护与安全机制

扩展开发篇 / Extensibility

中文 English 说明
表达式扩展 Expression Extension 自定义表达式
验证器 Function Validator 函数验证机制
SqlBuilder SqlBuilder SQL 方言扩展
Expr 序列化格式 Expr Serialization Format JSON 简洁模式与正常模式对比
前端 QueryString 查询 Frontend QueryString 用 URL 参数驱动后端 Expr 查询
前端原生 Expr 查询 Frontend Native Expr 按 LiteOrm 序列化格式提交 Expr JSON
泛型 Controller 与动态生成 Generic Controller 泛型基类 Controller 与动态 Controller 生成

参考文档 / Reference

中文 English 说明
配置参考 Config Reference 配置项说明
API索引 API Index API 快速索引
术语表 Glossary 术语解释
AI指南 AI Guide AI 辅助开发
示例索引 Example Index 示例代码索引
SQL示例 SQL Examples SQL 生成示例
兼容性 Compatibility 各数据库差异
资源 Resource
Demo 项目 Demo project
源代码 Source code
单元测试 Unit tests
性能报告 Benchmark report

推荐阅读路径

  1. 第一次接触 LiteOrm:先看”入门篇”的四篇文档。
  2. 准备接入业务项目:继续阅读”核心使用篇”,建立实体、查询、写入和关联的整体认识。
  3. 涉及事务、分表、性能或数据库方言差异:继续阅读”高级特性篇”。
  4. 需要扩展框架能力:查阅”扩展开发篇”。
  5. 需要快速确认配置项、接口名或术语:直接查阅”参考篇”。