para

para

开源多租户后端框架助力快速应用开发

Para是开源多租户后端框架,专注对象存储和检索。提供RESTful API、全文搜索、分布式缓存,支持多种数据库和搜索引擎。可独立部署或集成JVM应用,加速开发。框架文档完善,有多语言客户端,获Erudika长期支持。适用于快速构建可扩展的云端应用后端。

Para后端框架多租户可扩展REST API对象存储Github开源项目

Logo

一个可扩展的、多租户的云后端

Docker 下载量 Maven Central 加入 Gitter 聊天

Para 是一个可扩展的、多租户的后端服务器/框架,用于对象持久化和检索。它通过处理后端操作,帮助您更快地构建和原型化应用程序。它可以作为您基于 JVM 的应用程序的一部分,也可以作为独立的、多租户的 API 服务器部署,多个应用程序和客户端可以连接到它。

"pára"在保加利亚语中意为"蒸汽"。就像蒸汽用来驱动事物一样,您可以使用 Para 来驱动您的移动或 Web 应用程序后端。

看看 Para 如何与其他开源后端框架相比较

这个项目由 Erudika 全额资助和支持 - 一家独立的、自力更生的公司。

特性

  • 使用亚马逊 Signature V4 算法保护的 RESTful JSON API
  • 与数据库无关,为可扩展的数据存储设计(DynamoDB、Cassandra、MongoDB 等)
  • 全文搜索(Lucene、Elasticsearch)
  • 分布式和本地对象缓存(Hazelcast、Caffeine)
  • 多租户 - 每个应用都有自己的表、索引和缓存
  • 带签名负载的 Webhooks
  • 基于 Spring Security 的灵活安全性(LDAP、SAML、社交登录、CSRF 保护等)
  • 使用 JSON Web 令牌(JWT)的无状态客户端认证
  • 简单但有效的客户端访问控制资源权限
  • 基于 JSR-303 和 Hibernate Validator 的强大约束验证机制
  • 对持久化、索引和缓存操作的每个对象控制
  • 支持乐观锁定和事务(由每个 DAO 原生实现)
  • 高级序列化和反序列化功能(Jackson)
  • 用于监控和诊断的完整指标(Dropwizard)
  • 由 Google Guice 驱动的模块化设计和插件支持
  • 用于翻译语言包和处理货币的国际化工具
  • 带有嵌入式 Jetty 的独立可执行 JAR
  • Para Web 控制台 - 管理员用户界面

架构

<pre> +----------------------------------------------------------+ | ____ ___ _ ____ ___ _ | | / __ \/ __` / ___/ __` / | | / /_/ / /_/ / / / /_/ / | | / .___/\__,_/_/ \__,_/ +-------------+ | /_/ | 持久化 | +-------------------+ +-----------------+ +-------------+ | REST API | | 搜索 |---| 缓存 | +---------+---------+--+--------+--------+---+------+------+ | | | +---------+---------+ +--------+--------+ +------+------+ | 签名请求和 | | 搜索索引 | | 数据存储 | | JWT 令牌 | | (任意) | | (任意) | +----+---------^----+ +-----------------+ +-------------+ | | +----v---------+-------------------------------------------+ | 客户端:JavaScript、PHP、Java、C#、Android、iOS 等 | +----------------------------------------------------------+ </pre>

文档

阅读文档

博客

在我们的博客上阅读更多关于 Para 的内容

托管

我们在 paraio.com 提供托管和高级支持,您可以在那里使用免费的开发者账户在线试用 Para。通过 Web 控制台,只需几次点击即可浏览和管理您的用户和对象、执行备份和编辑权限。通过升级到高级账户,您将能够在几秒钟内扩展或缩小您的项目,并管理多个应用程序。

快速开始

  1. 下载最新的可执行JAR包
  2. 在JAR包所在的同一目录下创建配置文件 application.conf
  3. 使用以下命令启动Para:java -jar -Dconfig.file=./application.conf para-*.jar
  4. 通过 npm install -g para-cli 安装 Para CLI
  5. 为您的项目创建一个新的专用应用程序并保存访问密钥:
# 运行设置并将端点设置为 'http://localhost:8080' 或 'https://paraio.com'
# 根应用程序的密钥位于 application.conf 中
$ para-cli setup
$ para-cli new-app "myapp" --name "My App"

或者,您可以使用 Para Web控制台 来管理数据, 或者使用下面的API客户端之一将Para直接集成到您的项目中。

Docker

Para的标记Docker镜像位于Docker Hub的 erudikaltd/para强烈建议您只拉取发布镜像,如 :1.45.1:latest_stable, 因为 :latest 标签可能存在问题或不稳定。 首先,创建一个 application.conf 文件和一个 data 文件夹,然后启动Para容器:

$ touch application.conf && mkdir data
$ docker run -ti -p 8080:8080 --rm -v $(pwd)/data:/para/data \
  -v $(pwd)/application.conf:/para/application.conf \
  -e JAVA_OPTS="-Dconfig.file=/para/application.conf" erudikaltd/para:latest_stable

环境变量

JAVA_OPTS - Java系统属性,例如 -Dpara.port=8000 BOOT_SLEEP - 启动延迟,以秒为单位

插件

要使用插件,创建一个新的 Dockerfile-plugins,进行多阶段构建,如下所示:

# 将X.Y.Z更改为您想要使用的版本
FROM erudikaltd/para:v1.XY.Z-base AS base
FROM erudikaltd/para-search-lucene:1.XY.Z AS search
FROM erudikaltd/para-dao-mongodb:1.XY.Z AS dao
FROM base AS final
COPY --from=search /para/lib/*.jar /para/lib
COPY --from=dao /para/lib/*.jar /para/lib

然后只需运行 $ docker build -f Dockerfile-plugins -t para-mongo .

构建Para

Para可以使用JDK 8+编译:

要编译它,您需要Maven。获得Maven后,只需克隆并构建:

$ git clone https://github.com/erudika/para.git && cd para $ mvn install -DskipTests=true

要生成可执行的"fat-jar",运行 $ mvn package,它将位于 ./para-jar/target/para-x.y.z-SNAPSHOT.jar。 总共将生成两个JAR文件 - fat版本的体积会稍大一些。

要构建不包含插件的基础包(不包括 para-dao-sqlpara-search-lucene),运行:

$ cd para-jar && mvn -Pbase package

要运行Para的本地实例进行开发,使用:

$ mvn -Dconfig.file=./application.conf spring-boot:run

独立服务器

您可以通过下载可执行JAR包并执行以下命令来运行Para作为独立服务器:

$ java -jar para-X.Y.Z.jar

然后您可以通过 Para Web控制台 console.paraio.org 浏览您的对象。 只需将API端点更改为您的本地服务器并连接您的访问密钥即可。 管理界面仅在客户端运行,您的密钥永远不会通过网络发送。相反, 系统会在本地生成JWT访问令牌,并在每次请求时发送到服务器。

或者,您可以构建WAR文件并将其部署到您喜欢的servlet容器中:

$ cd para-war && mvn package

下载JAR包

Maven依赖

您还可以通过将Para添加为依赖项来将其集成到您的项目中。Para托管在Maven Central上。 以下是要包含在 pom.xml 中的Maven代码段:

<dependency> <groupId>com.erudika</groupId> <artifactId>para-server</artifactId> <version>{见上方绿色版本徽章}</version> </dependency>

对于构建轻量级仅客户端应用程序连接到Para,仅包含客户端模块:

<dependency> <groupId>com.erudika</groupId> <artifactId>para-client</artifactId> <version>{见上方绿色版本徽章}</version> </dependency>

命令行工具

$ npm install -g para-cli

API客户端

使用以下客户端库快速将Para集成到您的项目中:

数据库集成

使用以下DAO实现连接到不同的数据库:

  • DynamoDB: AWSDynamoDAO(包含在para-server中)
  • MongoDB: para-dao-mongodb
  • Cassandra: para-dao-cassandra
  • SQL(H2/MySQL/SQL Server/PostgreSQL等): para-dao-sql H2DAO是默认的DAO,它是SQL插件的一部分(与JAR文件打包在一起)

搜索引擎集成

Search接口由以下实现:

缓存集成

Cache接口由以下实现:

  • Caffeine: 默认对象在本地缓存(包含在para-server中)
  • Hazelcast: para-cache-hazelcast(分布式)

队列实现

Queue接口由以下实现:

  • AWS SQS: 在AWSQueue类中
  • LocalQueue用于单主机部署和本地开发

使用Para的项目

愿望清单/路线图

  • Para 2.0 - 迁移到Quarkus,仅支持Java 13+,原生镜像
  • GraphQL支持

获取帮助

  • 有问题? - 在Gitter上提问
  • 发现bug? - 在此提交bug报告
  • 在Stack Overflow上使用para标签提问
  • 对于Scoold相关的问题,在Stack Overflow上使用para标签

贡献

  1. Fork此仓库并将fork克隆到您的机器上
  2. 创建一个分支(git checkout -b my-new-feature
  3. 实现新功能或修复bug,并添加一些测试
  4. 提交您的更改(git commit -am '添加了新功能'
  5. 将分支推送到GitHub上您的forkgit push origin my-new-feature
  6. 从您的fork创建新的Pull Request

请尽量遵守此项目的代码风格。要检查您的代码,请通过样式检查器运行它:

mvn validate

更多信息请参阅 CONTRIBUTING.md

许可证

Apache 2.0

编辑推荐精选

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多