The English version of quarkus.io is the official project site. Translated sites are community supported on a best-effort basis.

Guides

Tutorials

Short and focused exercises to get you going quickly.

Collect metrics using Micrometer

Create an application that uses the Micrometer metrics library to collect runtime, extension and application metrics and expose them as a Prometheus (OpenMetrics) endpoint.

Creating a tutorial

Create a new tutorial that guides users through creating, running, and testing a Quarkus application that uses annotations from an imaginary extension.

Secure a Quarkus application with Basic authentication

Secure your Quarkus application endpoints by combining Quarkus built-in basic HTTP authentication with the JPA identity provider to enable role-based access control (RBAC).

使用我们的工具

探索Quarkus开发者工具链,让Quarkus开发如此快速和愉快。

创建你的第一个应用程序

了解如何创建您的第一个Quarkus应用程序。

响应式入门

了解有关使用Quarkus开发响应式应用程序的更多信息。

在你最喜欢的IDE中使用Quarkus工具

了解更多关于Quarkus在IDE中的整合。

构建一个原生可执行文件

用GraalVM或Mandrel构建原生可执行文件。

How-to Guides

Step-by-step guides to covering key tasks, real world operations and common problems.

Contribute to Quarkus documentation

Contribute to the documentation by using the recommended steps, workflow, and style guidance to ensure the content successfully renders on the Quarkus website portal.

Enable Basic authentication

Enable Basic authentication for your Quarkus project and allow users to authenticate with a username and password.

Concepts

Explanations of some of the larger concepts and technologies involved with Quarkus.

Basic Authentication

HTTP Basic Authentication is one of the least resource-demanding techniques that enforce access controls to the Web resources.

Quarkus Security overview

Quarkus Security是一个框架,它提供了架构、多种认证和授权机制以及其他工具,用来为开发者提供构建达到生产级别安全性质量保证的Quarkus应用程序。

Quarkus documentation content types

Quarkus documentation is structured into four distinct content types: concepts, how-tos, tutorials, and references.

内置的认证支持

The following section describes the Quarkus built-in authentication mechanisms for HTTP based FORM, BASIC, and Mutual TLS authentication.

参考文献

Technical Resource that covers tools, components, and commands. The encyclopedia for Quarkus.

Authorize web endpoints

Quarkus has an integrated pluggable web security layer.

Command Mode Applications

本参考指南解释了如何用Quarkus开发命令行应用程序。

Configuration Reference Guide

了解更多关于如何配置你的Quarkus应用程序。

Contexts and Dependency Injection

更深入地了解Quarkus对CDI的实现。

HTTP Reference

了解更多关于配置Quarkus基于Vert.x的HTTP层的信息–如果你使用servlets的话,还有Undertow。

Mailer Reference Guide

本参考指南更详细地解释了Quarkus Mailer的配置和使用。

Native Reference Guide

This guide is a companion to the Building a Native Executable, Using SSL With Native Images, and Writing Native Applications, guides.

OpenID Connect (OIDC) and OAuth2 Client and Filters Reference Guide

This reference guide explains how to use:

Quarkus style and content guidelines

Guidelines are provided to help you to contribute clear and consistent content that is also sourced in the required structure and composition of Quarkus documentation.

Qute Reference Guide

了解你需要知道的关于Qute模板引擎的一切。

Reactive Messaging RabbitMQ Connector Reference Documentation

This guide is the companion from the Getting Started with RabbitMQ.

Redis Extension Reference Guide

Redis is an in-memory data store used as a database, cache, streaming engine, and message broker.

Scheduler Reference Guide

了解更多关于Scheduler扩展的信息。

Stork Reference Guide

This guide is the companion from the Stork Getting Started Guide.

Vert.x参考指南

本参考指南提供了关于Quarkus使用的Vert.x实例的使用和配置的高级细节。

响应式消息AMQP 1.0连接器参考文档

This guide is the companion from the Getting Started with AMQP 1.0.

类加载参考

了解关于Quarkus类加载基础设施的更多信息。

General Guides

Other Quarkus Guides

AMQP的开发服务

在开发和测试模式下自动启动AMQP。

Amazon Lambda

本指南解释了如何部署基于Quarkus的Amazon Lambdas。

Amazon Lambda SnapStart Configuration

This document explains how to optimize your AWS Lambda application for SnapStart

Apache Camel on Quarkus

本指南包括与Apache Camel的系统集成

Apache Kafka参考指南

本参考指南深入介绍了Apache Kafka和Smallrye响应式消息传递框架。

Apicurio注册表的开发服务

在开发和测试模式下自动启动Apicurio仓库。

AppCDS

This reference guide explains how to enable AppCDS with Quarkus.

Application Data Caching

本指南解释了如何使用简单的注解来缓存CDI Bean中昂贵的方法调用。

Azure Functions (Serverless) with RESTEasy Reactive, Undertow, or Reactive Routes

本指南介绍了如何将Vert.x Web、Servlet或RESTEasy微服务部署为Azure Function。

Build, Sign and Encrypt JSON Web Tokens

According to RFC7519, JSON Web Token (JWT) is a compact, URL-safe means of representing claims which are encoded as a JSON object that is used as the payload of a JSON Web Signature (JWS) structure or as the plaintext of a JSON Web Encryption (JWE) structure, enabling the claims to be digitally signed or integrity protected with a Message Authentication Code(MAC) and/or encrypted.

Building Quarkus apps with Gradle

This guide covers: Gradle configuration, creating a new project, dealing with extensions, development mode, debugging, import in your IDE, building a native image, and build a container friendly executable

Building Quarkus apps with Quarkus Command Line Interface (CLI)

使用Quarkus CLI来创建、构建、运行和管理Quarkus项目的扩展。

Building applications with Maven

This guide covers: Maven configuration, creating a new project, dealing with extensions, development mode, debugging, import in your IDE, building a native image, and build a container friendly executable

Building my first extension

一步一步地学习如何构建一个简单的扩展。

CDI Integration Guide

了解如何将你的扩展与Quarkus的CDI容器集成。

Centralized log management (Graylog, Logstash, Fluentd)

本指南解释了如何使用Graylog扩展日志格式(GELF)用Logstash或Fluentd集中管理你的日志。

Command Mode with Picocli

用Picocli扩展简化了命令行应用程序的创建。

Compressing native executables using UPX

Ultimate Packer for eXecutables (UPX) is a compression tool reducing the size of executables.

Configuring Well-Known OpenID Connect Providers

Connecting to an Elasticsearch cluster

本指南涵盖了如何使用低级或高级的REST客户端来使用Elasticsearch集群。

Consuming a gRPC Service

本指南解释了如何在你的Quarkus应用程序中消费gRPC服务。

Container Images

了解如何使用Jib、S2I或Docker构建和推送容器镜像,作为Quarkus构建的一部分。

Context Propagation in Quarkus

了解更多关于如何利用SmallRye Context Propagation传递上下文信息的信息。

Cross-Site Request Forgery Prevention

Cross-Site Request Forgery (CSRF) is an attack that forces an end user to execute unwanted actions on a web application in which they are currently authenticated.

Datasources

使用Quarkus,你可以很容易地配置一个数据源,如果需要的话,也可以配置若干个。

Deploying on OpenShift

本指南涵盖了如何在OpenShift上部署一个原生应用程序。

Deploying to Google Cloud Platform (GCP)

本指南解释了如何将Quarkus应用程序部署到谷歌云。

Dev Services Overview

所有支持开发服务的扩展及其配置选项的列表。

Dev Services and UI for OpenID Connect (OIDC)

在开发和测试模式下自动启动Keycloak或其他提供者。

Dev Services for Databases

When testing or running in dev mode Quarkus can provide you with a zero-config database out of the box, a feature we refer to as Dev Services.

Dev Services for Elasticsearch

If any Elasticsearch-related extension is present (e.g.

Dev Services for Kogito

If any Kogito process-related extension is present (e.g.

Dev Services for Kubernetes

Start a Kubernetes API server automatically in dev and test modes.

Dev Services for RabbitMQ

Dev Services for RabbitMQ automatically starts a RabbitMQ broker in dev mode and when running tests.

Extension Capabilities

在Quarkus中如何实现和使用功能。

Extension codestart

Provide users with initial code for extensions when generating Quarkus applications on code.quarkus.io and all the Quarkus tooling.

Extension for Spring Data API

虽然我们鼓励你使用Hibernate ORM与Panache作为你的数据层,但Quarkus以spring-data-jpa扩展的形式为Spring Data JPA提供了一个兼容层。

Extension for Spring Data REST

Spring Data REST简化了基于我们Spring Data兼容层的CRUD应用程序的创建。

Funqy

本指南解释了Funqy框架的基础知识,这是一个简单的可移植的跨供应商的云功能API。

Funqy Amazon Lambda Binding

本指南解释了Funqy的Amazon Lambda绑定。

Funqy Google Cloud Functions

本指南解释了Funqy的Google Cloud Platform Functions绑定。

Funqy HTTP Binding (Standalone)

本指南解释了Funqy的HTTP绑定。

Funqy HTTP Binding with Amazon Lambda�

本指南解释了Funqy的Amazon Lambda HTTP绑定。

Funqy HTTP Binding with Azure Functions

本指南解释了Funqy的Azure Functions HTTP绑定。

Funqy HTTP Binding with Google Cloud Functions

本指南解释了Funqy的Google Cloud Platform Functions HTTP绑定。

Funqy Knative Events Binding

本指南解释了Funqy的Knative Events绑定。

Generating JAX-RS resources with Panache

运用Panache来操作Hibernate ORM REST数据,简化了基于JAX-RS和Hibernate ORM的CRUD应用程序的创建。

Getting Started to SmallRye Reactive Messaging with RabbitMQ

本指南演示了您的 Quarkus 应用程序如何利用 SmallRye响应式消息传递与RabbitMQ进行交互。

Getting Started with SmallRye Stork

The essence of distributed systems resides in the interaction between services.

Google Cloud Functions (Serverless)

本指南解释了如何部署基于Quarkus的Google Cloud Functions。

Google Cloud Functions (Serverless) with RESTEasy Reactive, Undertow, or Reactive Routes

本指南介绍了如何将Vert.x Web、Servlet或RESTEasy微服务部署为Google Cloud Function。

Hibernate Search guide

Hibernate Search允许你在Elasticsearch集群中索引你的实体,并在你所有基于Hibernate ORM的应用程序中轻松提供全文搜索。

Implementing a gRPC Service

本指南解释了如何在你的Quarkus应用程序中实现gRPC服务。

Infinispan Client

Infinispan is an in memory data grid that allows running in a server outside of application processes.

Contexts and Dependency Injection for Java 2.0 specification.

" keywords="" categories="core" origin="" >

Introduction to Contexts and Dependency Injection

Quarkus DI solution is based on the Contexts and Dependency Injection for Java 2.0 specification.

Kafka Dev UI

Dev UI extension for Apache Kafka for development purposes.

Kafka开发服务(Dev Services)

在开发和测试模式下自动启动Apache Kafka。

Kubernetes Client

本指南演示了如何使用Fabric8 Kubernetes客户端与你的Kubernetes集群互动。

Kubernetes Config

使用ConfigMaps作为Quarkus应用程序的配置源。

Kubernetes extension

本指南涵盖了如何在Kubernetes上部署一个原生应用程序。

Mapping configuration to objects

将多个配置属性分组到一个对象中。

Micrometer Metrics

本指南展示了你的Quarkus应用程序如何使用Micrometer扩展来收集指标。

Migrating to RESTEasy Reactive

Migrating from RESTEasy Classic to RESTEasy Reactive is straightforward in most cases, however there are a few cases that require some attention.

Mutiny - Async for bare mortal

Mutiny is an intuitive, reactive programming library.

Narayana LRA Participant Support

本指南涵盖了使用LRA来协调跨服务的活动。

OpenID Connect (OIDC) authorization code flow mechanism

This guide demonstrates how to use the OpenID Connect Extension to protect your web application based on the Authorization Code Flow using Quarkus.

OpenID Connect Client and Token Propagation Quickstart

本指南解释了如何使用OpenID Connect和OAuth2客户端和过滤器来获取、刷新和传播访问令牌。

OptaPlanner - Using AI to optimize a schedule with OptaPlanner

本指南将引导你完成用OptaPlanner的约束解决人工智能(AI)创建Quarkus应用程序的过程。

Packaging And Releasing With JReleaser

This guide covers packaging and releasing CLI applications using the JReleaser tool.

Quarkus Extension Metadata

Quarkus extensions are distributed as Maven JAR artifacts that application and other libraries may depend on.

Quarkus Extension Registry

了解更多关于扩展仓库的概念,以及如何使用自己的扩展仓库。

Quarkus Extension for Spring Cache API

虽然我们鼓励你使用Cache扩展来进行应用级缓存,但Quarkus以spring-cache扩展的形式为Spring Cache提供了一个兼容层。

Quarkus Extension for Spring DI API

虽然我们鼓励你使用CDI注解进行注入,但Quarkus以spring-di扩展的形式为Spring依赖注入提供了一个兼容层。

Quarkus Extension for Spring Security API

虽然我们鼓励你使用Quarkus安全层来保护你的应用程序,但Quarkus以spring-security扩展的形式为Spring Security提供了一个兼容层。

Quarkus Extension for Spring Web API

虽然我们鼓励你使用JAX-RS注解来定义REST端点,但Quarkus以spring-web扩展的形式为Spring Web提供了一个兼容层。

Quarkus Maven Plugin

The Quarkus Maven Plugin builds the Quarkus applications, and provides helpers to launch dev mode or build native executables.

Quarkus Reactive Architecture

了解关于Quarkus响应式架构的更多信息。

Quarkus对SpringSpring Scheduling API 的扩展

虽然我们鼓励你使用Scheduler或Quartz扩展来安排任务,但Quarkus以spring-scheduled扩展的形式为Spring Scheduled提供了一个兼容层。

Quarkus运行时基础镜像

To ease the containerization of native executables, Quarkus provides a base image providing the requirements to run these executables.

Qute Templating Engine

了解更多关于如何利用Qute模板引擎在你的应用程序中使用模板。

RESTEasy Classic

Redis的Dev Services

在开发和测试模式下自动启动Redis。

Scheduling Periodic Tasks with Quartz

你的计划任务需要集群支持?本指南解释了如何使用Quartz扩展来实现这一点。

Scripting with Quarkus

用jbang轻松实现基于Quarkus的脚本。

Security Tips and Tricks

Sending emails using SMTP

了解更多关于如何使用我们的响应式电子邮件客户端从Quarkus应用程序发送电子邮件。

SmallRye Fault Tolerance

本指南展示了你的Quarkus应用程序如何通过SmallRye容错扩展来利用SmallRye容错规范。

SmallRye GraphQL

本指南解释了如何利用SmallRye GraphQL来实现GraphQL服务。

SmallRye GraphQL Client

本指南解释了如何利用SmallRye GraphQL客户端来消费GraphQL服务。

SmallRye Health

本指南展示了您的Quarkus应用程序如何利用SmallRye Health扩展。

SmallRye Metrics

本指南展示了你的Quarkus应用程序如何利用SmallRye Metrics扩展。

SmallRye响应式消息与AMQP 1.0入门

本指南展示了你的Quarkus应用程序如何利用SmallRye响应式消息传递与AMQP进行交互。

Using Keycloak Admin Client

The Quarkus Keycloak Admin Client and its reactive twin support Keycloak Admin Client which can be used to configure a running Keycloak server.

Using Liquibase

本指南涵盖了如何使用Liquibase扩展来管理你的模式迁移。

Using Liquibase MongoDB

Liquibase is an open source tool for database schema change management, it allows managing MongoDB databases via it’s MongoDB Extension.

Using Podman with Quarkus

Podman is a daemonless and rootless container engine for developing, managing, and running OCI Containers on your Linux system or other OS.

Using Security with an LDAP Realm

本指南展示了你的Quarkus应用程序如何使用LDAP目录来存储你的用户身份。

Using Software Transactional Memory in Quarkus

本指南涵盖了软件事务性内存(STM)的使用。

Using Stork with Kubernetes

This guide explains how to use Stork with Kubernetes for service discovery and load balancing.

Using a Credentials Provider

本指南解释了如何使用Vault凭证提供者或实现你自己的自定义凭证。

Using the Cassandra Client

本指南包括如何在Quarkus中使用Apache Cassandra NoSQL数据库。

Using the REST Client

本指南解释了如何使用RESTEasy REST客户端,以便用很少的精力与REST API(JSON和其他)进行交互。

Using the REST Client Reactive

本指南解释了如何使用RESTEasy Reactive REST客户端。

Using xDS gRPC

This page explains how to enable xDS gRPC usage in your Quarkus application.

Writing REST Services with RESTEasy Reactive

Discover how to develop highly scalable reactive REST services with JAX-RS and RESTEasy Reactive.

Writing simpler reactive REST services with Quarkus Virtual Thread support

This guide explains how to benefit from Java 19 virtual threads when writing REST services in Quarkus.

YAML Configuration

YAML 作为配置源。

gRPC

一切gRPC的总入口。

从 Spring Cloud 配置服务器中读取配置属性

Quarkus以spring-cloud-config-client扩展的形式为Spring Cloud Config提供了一个兼容层。

使用.properties文件的安全性

本指南展示了你的Quarkus应用程序如何使用.properties文件来存储你的用户身份。

使用Apache Kafka Streams

本指南展示了你的Quarkus应用如何利用Apache Kafka Streams API来实现基于Apache Kafka的流处理应用。

使用Apache Kafka与模式仓库和Avro

使用Apache Kafka,Avro序列化记录,并连接到一个模式注册中心。

使用Blaze-Persistence

本指南解释了如何使用Blaze-Persistence来简化你的数据和DTO层。

使用Flyway

本指南包括如何使用Flyway扩展来管理你的模式迁移。

使用Hibernate ORM和JPA

Hibernate ORM is the de facto JPA implementation and offers you the full breath of an Object Relational Mapper.

使用Hibernate响应式

Hibernate Reactive is a reactive API for Hibernate ORM, supporting non-blocking database drivers and a reactive style of interaction with the database.

使用JDBC的安全性

本指南展示了你的Quarkus应用程序如何使用数据库来存储你的用户身份。

使用JMS

本指南演示了你的Quarkus应用程序如何使用AMQP 1.0的Apache Qpid JMS,或使用Apache ActiveMQ Artemis JMS进行JMS信息传递。

使用JWT RBAC

This guide explains how your application can utilize SmallRye JWT to provide secured access to the JAX-RS endpoints.

使用Kogito DMN支持为应用程序添加决策自动化功能

使用Kogito来增加业务自动化,并通过DMN决策支持为其提供动力。

使用Kogito为应用程序添加业务自动化功能

本指南演示了你的Quarkus应用程序如何使用Kogito来添加业务自动化,从而为其提供业务流程和规则。

使用Kogito为应用程序添加规则引擎功能

使用Kogito来添加带有规则的DRL文件。

使用Kogito为应用程序添加预测功能

使用Kogito来添加业务自动化,为其提供预测的动力。

使用Kotlin

本指南解释了如何使用Kotlin。

使用MongoDB客户端

本指南包括如何在Quarkus中使用MongoDB。

使用Multipart的REST客户端

本指南介绍如何使用RESTEasy REST客户端发送多部分REST请求,通常是为了上传文档。

使用OAuth2 RBAC

本指南解释了你的Quarkus应用程序如何利用OAuth2令牌来提供对JAX-RS端点的安全访问。

使用OpenAPI和Swagger UI

本指南解释了如何使用OpenAPI扩展来生成OpenAPI描述符,并获得一个Swagger UI前端来测试你的REST端点。

使用OpenID Connect(OIDC)多租户

本指南演示了你的OpenID Connect应用程序如何支持多租户,这样你就可以从一个应用程序中为多个租户提供服务。

使用OpenID连接(OIDC)与Keycloak来做集中式授权

本指南展示了你的Quarkus应用程序如何使用Keycloak授权服务来授权访问受保护的资源。

使用OpenTelemetry

本指南解释了你的Quarkus应用程序如何利用OpenTelemetry来为交互式Web应用程序提供分布式跟踪。

使用OpenTracing

本指南解释了你的Quarkus应用程序如何利用OpenTracing来为交互式网络应用程序提供分布式跟踪。

使用Panache简化Hibernate ORM

Hibernate ORM is the de facto JPA implementation and offers you the full breadth of an Object Relational Mapper.

使用Panache简化Hibernate Reactive

基于Hibernate 响应式的简化响应式ORM层。

使用Panache简化MongoDB

本指南涵盖了MongoDB使用活动记录和存储库的用法。

使用Redis客户端

本指南包括如何在Quarkus中使用Redis数据存储。

@ConfigurationProperties ,代替MicroProfile配置注解

" keywords="" categories="compatibility" origin="" >

使用Spring Boot属性API访问应用程序属性

使用Spring Boot的 @ConfigurationProperties ,代替MicroProfile配置注解

使用WebAuthn的安全性

本指南演示了你的Quarkus应用程序如何使用WebAuthn认证来代替密码。

使用WebSockets

This guide explains how your Quarkus application can utilize web sockets to create interactive web applications.

使用事件总线

本指南解释了不同的Bean如何使用事件总线进行交互。

使用响应式路由

本指南演示了如何使用响应式路由。

响应式SQL客户端

本指南涵盖了如何在Quarkus中使用响应式SQL客户端。

在Quarkus中使用事务

Quarkus comes with a Transaction Manager and uses it to coordinate and expose transactions to your applications.

在Quarkus应用程序中使用Eclipse Vert.x API

本指南解释了如何在Quarkus中使用Vert.x来构建响应式应用程序。

在原生可执行文件中使用SSL

In this guide, we will discuss how you can get your native images to support SSL, as native images don’t support it out of the box.

安全测试

This document describes how to test Quarkus Security.

安排周期性任务

Modern applications often need to run specific tasks periodically.

带有RESTEasy Reactive、Undertow或Reactive Routes的Amazon Lambda

本指南介绍了如何将Vert.x Web、Servlet或RESTEasy微服务部署为Amazon Lambda。

平台

了解更多关于Quarkus 世界中我们称之为平台的东西。

应用程序的初始化和终止

You often need to execute custom actions when the application starts and clean up everything when the application stops.

开发模式与生产应用程序有何不同

开发模式与生产应用程序有何不同

开发用户界面

了解如何让你的扩展为Dev UI贡献功能。

开始使用Apache Kafka的SmallRye响应式消息传递

本指南演示了您的Quarkus应用程序如何利用SmallRye响应式消息传递与Apache Kafka进行交互。

开始使用gRPC

本指南解释了如何在你的Quarkus应用程序中开始使用gRPC。

所有配置选项

列出每个扩展的所有配置属性

扩展配置支持

扩展和定制配置。

持续测试

通过持续测试获得早期测试反馈。

条件性扩展的依赖性

基于特定条件触发包含附加扩展。

构建项目

探索你可以在你的扩展中消费/提供的所有BuildItems。

测试你的应用程序

This guide covers testing in JVM mode, native mode, and injection of resources into tests

测量你的测试的覆盖率

本指南解释了如何测量你的Quarkus应用程序的测试覆盖率。

用Hibernate验证器进行验证

本指南包括如何在REST服务中使用Hibernate验证器/Bean验证。

用OpenID Connect(OIDC)来保护使用不记名令牌授权的服务应用

This guide demonstrates how your Quarkus application can use Keycloak to protect your JAX-RS applications using bearer token authorization, where these tokens are issued by a Keycloak server.

用Panache和Kotlin简化Hibernate ORM

This explains the specifics of using Hibernate ORM with Panache in a Kotlin project.

用Panache和Kotlin简化MongoDB

本指南涵盖了在Kotlin项目中使用活动记录和存储库的MongoDB的用法。

编写JSON REST服务

JSON is now the lingua franca between microservices.

编写原生应用程序的提示

本指南收集了一些提示,帮助你解决将应用程序编译为原生可执行文件时遇到的问题。

编写您自己的扩展

Quarkus extensions optimize your applications by pushing as much work as possible to the build operation.

衡量性能

本指南解释了如何最好地测量Quarkus应用程序的占用空间。

部署到Heroku

在Heroku上部署你的Quarkus应用程序。

部署到微软Azure云

本指南解释了如何将Quarkus应用程序部署到Microsoft Azure云中。

配置你的应用程序

Hardcoded values in your code is a no go (even if we all did it at some point ;-)).

配置日志

本指南解释了日志记录以及如何配置它。

重新增强Quarkus应用程序

使用易变的jars来重建具有不同构建时间配置的应用程序。