이 콘텐츠는 선택한 언어로 제공되지 않습니다.
Chapter 1. Getting Started with Red Hat build of Apache Camel for Quarkus
This guide introduces Red Hat build of Apache Camel for Quarkus, the various ways to create a project and how to get started building an application using Red Hat build of Apache Camel for Quarkus:
1.1. Red Hat build of Apache Camel for Quarkus overview 링크 복사링크가 클립보드에 복사되었습니다!
Red Hat build of Apache Camel for Quarkus brings the integration capabilities of Apache Camel and its vast component library to the Quarkus runtime.
The benefits of using Red Hat build of Apache Camel for Quarkus include the following:
- Enables users to take advantage of the performance benefits, developer joy and the container first ethos which Quarkus provides.
- Provides Quarkus extensions for many of the Apache Camel components.
- Takes advantage of the many performance improvements made in Camel, which results in a lower memory footprint, less reliance on reflection and faster startup times.
1.1.1. Languages 링크 복사링크가 클립보드에 복사되었습니다!
In Red Hat build of Apache Camel for Quarkus, you can define Camel routes using the following languages:
- Java DSL
- YAML
- XML IO
1.2. Tooling 링크 복사링크가 클립보드에 복사되었습니다!
1.2.1. IDE plugins 링크 복사링크가 클립보드에 복사되었습니다!
Quarkus has plugins for most of the popular development IDEs which provide Quarkus language support, code/configuration completion, project creation wizards and much more. The plugins are available at each respective IDE marketplace.
- VS Code extension
- Eclipse plugin (currently not supported)
- IntelliJ plugin (currently not supported)
Check the plugin documentation to discover how to create projects for your preferred IDE.
1.2.2. Camel content assist 링크 복사링크가 클립보드에 복사되었습니다!
The following plugins provide support for content assist when editing Camel routes and application.properties:
- VS Code Language support for Camel - a part of the Camel extension pack
Debug Adapter for Apache Camel to debug Camel integrations written in Java, YAML or XML locally.
- For more information about scope of development support, see Development Support Scope of Coverage
- Eclipse Desktop Language Support for Camel - a part of Jboss Tools
- Apache Camel IDEA plugin (not always up to date)
- Users of other IDEs supporting Language Server Protocol may choose to install and configure Camel Language Server manually
1.3. Building your first project with Red Hat build of Apache Camel for Quarkus 링크 복사링크가 클립보드에 복사되었습니다!
1.3.1. Overview 링크 복사링크가 클립보드에 복사되었습니다!
You can use code.quarkus.redhat.com to generate a Quarkus Maven project which automatically adds and configures the extensions that you want to use in your application.
This section walks you through the process of creating a Quarkus Maven project with Red Hat build of Apache Camel for Quarkus including:
- Creating the skeleton application using code.quarkus.redhat.com
- Adding a simple Camel route
- Exploring the application code
- Compiling the application in development mode
- Testing the application
1.3.2. Generating the skeleton application with code.quarkus.redhat.com 링크 복사링크가 클립보드에 복사되었습니다!
You can bootstrap and generate projects on code.quarkus.redhat.com.
The Red Hat build of Apache Camel for Quarkus extensions are located under the 'Integration' heading.
If you need additional extensions, use the 'search' field to find them.
Select the component extensions that you want to work with and click 'Generate your application' to download a basic skeleton project.
You can also push the project directly to GitHub.
For more information about using code.quarkus.redhat.com to generate Quarkus Maven projects, see Creating a Quarkus Maven project using code.quarkus.redhat.com in the Getting started with Red Hat build of Quarkus guide.
Procedure
In the code.quarkus.redhat.com website, select the following extensions:
-
camel-quarkus-rest -
camel-quarkus-jackson camel-quarkus-directNoteDo not compile the application on code.quarkus.redhat.com (in the final step of the procedure). Instead, use the compile command described in the Section 1.3.5, “Development mode” section below.
-
Navigate to the directory where you extracted the generated project files from the previous step:
cd <directory_name>
$ cd <directory_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.3.3. Explore the application code 링크 복사링크가 클립보드에 복사되었습니다!
The application has two compile dependencies which are managed within the com.redhat.quarkus.platform:quarkus-camel-bom that is imported in <dependencyManagement>.:
pom.xml
For more information about BOM dependency management, see Developing Applications with Red Hat build of Apache Camel for Quarkus
The application is configured by properties defined within src/main/resources/application.properties, for example, the camel.context.name can be set there.
1.3.4. Adding a simple Camel route 링크 복사링크가 클립보드에 복사되었습니다!
In this example, we use the simple example from the camel-quarkus-examples repository. It consists of the two simple classes Fruit.java, Legume.java and the route definitions Routes.java .
Procedure
-
Create a file named
Fruit.javain thesrc/main/java/org/acme/subfolder. Add the class as shown in the following code snippet:
Fruit.java
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Create a file named
Legume.javain thesrc/main/java/org/acme/subfolder. Add the class as shown in the following code snippet:
Legume.java
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Create a file named
Routes.javain thesrc/main/java/org/acme/subfolder. Add a Camel Rest route as shown in the following code snippet:
Routes.java
Copy to Clipboard Copied! Toggle word wrap Toggle overflow For more information about this example, see camel-quarkus-examples repository.
1.3.5. Development mode 링크 복사링크가 클립보드에 복사되었습니다!
mvn clean compile quarkus:dev
$ mvn clean compile quarkus:dev
This command compiles the project, starts your application, and lets the Quarkus tooling watch for changes in your workspace. Any modifications you make to your project will automatically take effect in the running application.
You can check the application in your browser. (For example, for the rest-json sample application, access http://localhost:8080/fruits)
If you change the application code, for example, change 'Apple' to 'Orange', your application automatically updates. To see the changes applied, refresh your browser.
Refer to Quarkus documentation Development mode section for more details about the development mode.
1.3.6. Testing 링크 복사링크가 클립보드에 복사되었습니다!
1.3.6.1. JVM mode 링크 복사링크가 클립보드에 복사되었습니다!
To test the Camel Rest route that we have created in JVM mode, add a test class as follows:
Procedure
-
Create a file named
RoutesTest.javain thesrc/test/java/org/acme/subfolder. Add the
RoutesTestclass as shown in the following code snippet:RoutesTest.java
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
The JVM mode tests are run by maven-surefire-plugin in the test Maven phase:
mvn clean test
$ mvn clean test
1.3.6.2. Native mode 링크 복사링크가 클립보드에 복사되었습니다!
To test the Camel Rest route that we have created in Native mode, add a test class as follows:
Procedure
-
Create a file named
NativeRoutesIT.javain thesrc/test/java/org/acme/subfolder. Add the
NativeRoutesITclass as shown in the following code snippet:NativeRoutesIT.java
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The native mode tests are verified by
maven-failsafe-pluginin theverifyphase.Pass the
nativeproperty to activate the profile that runs them:mvn clean verify -Pnative
$ mvn clean verify -PnativeCopy to Clipboard Copied! Toggle word wrap Toggle overflow
For more details, and how to use the CamelTestSupport style of testing, see Testing Camel Quarkus Extensions.
1.3.7. Packaging and running the application 링크 복사링크가 클립보드에 복사되었습니다!
1.3.7.1. JVM mode 링크 복사링크가 클립보드에 복사되었습니다!
Procedure
Run
mvn packageto prepare a thinjarfor running on a stock JVM:mvn clean package ls -lh target/quarkus-app ... -rw-r--r--. 1 user user 238K Oct 11 18:55 quarkus-run.jar ...
$ mvn clean package $ ls -lh target/quarkus-app ... -rw-r--r--. 1 user user 238K Oct 11 18:55 quarkus-run.jar ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteThe thin
jarcontains just the application code. You also need the dependencies intarget/quarkus-app/libto run it.Run the jar as follows:
java -jar target/quarkus-app/quarkus-run.jar ... [io.quarkus] (main) Quarkus started in 1.163s. Listening on: http://[::]:8080
$ java -jar target/quarkus-app/quarkus-run.jar ... [io.quarkus] (main) Quarkus started in 1.163s. Listening on: http://[::]:8080Copy to Clipboard Copied! Toggle word wrap Toggle overflow
The boot time should be around a second.
1.3.7.2. Native mode 링크 복사링크가 클립보드에 복사되었습니다!
Procedure
To prepare a native executable, do as follows:
Run the command
mvn clean package -Pnative:mvn clean package -Pnative ls -lh target ... -rwxr-xr-x. 1 user user 46M Oct 11 18:57 code-with-quarkus-1.0.0-SNAPSHOT-runner ...
$ mvn clean package -Pnative $ ls -lh target ... -rwxr-xr-x. 1 user user 46M Oct 11 18:57 code-with-quarkus-1.0.0-SNAPSHOT-runner ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteThe
runnerhas no.jarextension and has thex(executable) permission set. You can run it directly:./target/*-runner ... [io.quarkus] (main) Quarkus started in 0.013s. Listening on: http://[::]:8080 ...
$ ./target/*-runner ... [io.quarkus] (main) Quarkus started in 0.013s. Listening on: http://[::]:8080 ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow The application started in 13 milliseconds.
View the memory usage with the
ps -o rss,command -p $(pgrep code-with)command :ps -o rss,command -p $(pgrep code-with) RSS COMMAND 65852 ./target/code-with-quarkus-1.0.0-SNAPSHOT-runner
$ ps -o rss,command -p $(pgrep code-with) RSS COMMAND 65852 ./target/code-with-quarkus-1.0.0-SNAPSHOT-runnerCopy to Clipboard Copied! Toggle word wrap Toggle overflow The application uses 65 MB of memory.
See Producing a native executable in the Compiling your Quarkus applications to native executables guide for additional information about preparing a native executable.
Quarkus Native executable guide contains more details, including steps for creating a container image.
1.4. Testing Camel Quarkus Extensions 링크 복사링크가 클립보드에 복사되었습니다!
Testing offers a good way to ensure Camel routes behave as expected over time. If you haven’t already, read the Camel Quarkus user guide First Steps and the Quarkus documentation Testing your application section.
When it comes to testing a route in the context of Quarkus, the recommended approach is to write local integration tests. This has the advantage of covering both JVM and native mode.
In JVM mode, you can use the CamelTestSupport style of testing.
1.4.1. Running in JVM mode 링크 복사링크가 클립보드에 복사되었습니다!
In JVM mode, use the @QuarkusTest annotation to bootstrap Quarkus and start Camel routes before the @Test logic executes.
For example:
You can find a sample implementation in the Camel Quarkus source:
1.4.2. Running in native mode 링크 복사링크가 클립보드에 복사되었습니다!
Always test that your application works in native mode for all supported extensions.
You can reuse the test logic defined for JVM mode by inheriting the logic from the respective JVM mode class.
Add the @QuarkusIntegrationTest annotation to tell the Quarkus JUnit extension to compile the application under test to native image and start it before running the tests.
You can find a sample implementation in the Camel Quarkus source:
1.4.3. Differences between @QuarkusTest and @QuarkusIntegrationTest 링크 복사링크가 클립보드에 복사되었습니다!
A native executable does not need a JVM to run, and cannot run in a JVM, because it is native code, not bytecode.
There is no point in compiling tests to native code so they run using a traditional JVM.
This means that communication between tests and the application must go over the network (HTTP/REST, or any other protocol your application speaks), through watching filesystems (log files for example), or any other interprocess communication.
1.4.3.1. @QuarkusTest in JVM mode 링크 복사링크가 클립보드에 복사되었습니다!
In JVM mode, tests annotated with @QuarkusTest execute in the same JVM as the application under test.
This means you can use @Inject to add beans from the application into the test code.
You can also define new beans or even override the beans from the application using @jakarta.enterprise.inject.Alternative and @jakarta.annotation.Priority.
1.4.3.2. @QuarkusIntegrationTest in native mode 링크 복사링크가 클립보드에 복사되었습니다!
In native mode, tests annotated with @QuarkusIntegrationTest execute in a JVM hosted in a process separate from the running native application.
An important consequence of this, is that all communication between the tests and the native application, must take one or more of the following forms:
- Network calls. Typically, HTTP or any other network protocol your application supports.
-
Watching the filesystem for changes. (For example via Camel
fileendpoints.) - Any other kind of interprocess communication.
QuarkusIntegrationTest provides additional features that are not available through @QuarkusTest:
- In JVM mode, you can launch and test the runnable application JAR produced by the Quarkus build.
- In native mode, you can launch and test the native application produced by the Quarkus build.
- If you add a container image to the build, a container starts, and tests execute against it.
For more information about QuarkusIntegrationTest, see the Quarkus testing guide.
1.4.4. Testing with external services 링크 복사링크가 클립보드에 복사되었습니다!
1.4.4.1. Testcontainers 링크 복사링크가 클립보드에 복사되었습니다!
Sometimes your application needs to access some external resource, such as a messaging broker, a database, or other service.
If a container image is available for the service of interest, you can use Testcontainers to start and configure the services during testing.
1.4.4.1.1. Passing configuration data with QuarkusTestResourceLifecycleManager 링크 복사링크가 클립보드에 복사되었습니다!
For the application to work properly, it is often essential to pass the connection configuration data (host, port, user, password of the remote service) to the application before it starts.
In the Quarkus ecosystem, QuarkusTestResourceLifecycleManager serves this purpose.
You can start one or more Testcontainers in the start() method and return the connection configuration from the method in the form of a Map.
The entries of this map are then passed to the application in different ways depending on the mode:
-
Native mode: a command line (
-Dkey=value) - JVM Mode: a special MicroProfile configuration provider
Command line and MicroProfile settings have a higher precedence than the settings in the application.properties file.
Reference the defined test resource from the test classes with @QuarkusTestResource:
You can find a sample implementation in the Camel Quarkus source:
1.4.4.2. WireMock 링크 복사링크가 클립보드에 복사되었습니다!
Instead of having the tests connect to live endpoints, for example, if they are unavailable, unreliable, or expensive, you can stub HTTP interactions with third-party services & APIs.
You can use WireMock for mocking & recording HTTP interactions. It is used extensively throughout the Camel Quarkus test suite for various component extensions.
1.4.4.2.1. Setting up WireMock 링크 복사링크가 클립보드에 복사되었습니다!
Procedure
Set up the WireMock server.
NoteAlways configure the Camel component under test to pass any HTTP interactions through the WireMock proxy. You can achieve this by configuring a component property that determines the API endpoint URL.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Ensure your test class has the
@QuarkusTestResourceannotation with the appropriate test resource class specified as the value. The WireMock server will be started before all tests are executed and will be shut down when all tests are finished.
The WireMock server starts before all tests execute and shuts down when all tests finish.
You can find a sample implementation in the Camel Quarkus integration test source tree:
1.4.5. CamelTestSupport style of testing with CamelQuarkusTestSupport 링크 복사링크가 클립보드에 복사되었습니다!
Since Camel Quarkus 2.13.0, you can use CamelQuarkusTestSupport for testing. It is a replacement for CamelTestSupport, which does not work well with Quarkus.
CamelQuarkusTestSupport only works in JVM mode. If you need to test in native mode, then use one of the alternate test strategies described above.
1.4.5.1. Testing with CamelQuarkusTestSupport in JVM mode 링크 복사링크가 클립보드에 복사되었습니다!
Add the following dependency into your module (preferably in the test scope):
<dependency>
<groupId>org.apache.camel.quarkus</groupId>
<artifactId>camel-quarkus-junit5</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.camel.quarkus</groupId>
<artifactId>camel-quarkus-junit5</artifactId>
<scope>test</scope>
</dependency>
You can use CamelQuarkusTestSupport in your test like this:
@QuarkusTest
@TestProfile(SimpleTest.class) //necessary only if "newly created" context is required for the test (worse performance)
public class SimpleTest extends CamelQuarkusTestSupport {
...
}
@QuarkusTest
@TestProfile(SimpleTest.class) //necessary only if "newly created" context is required for the test (worse performance)
public class SimpleTest extends CamelQuarkusTestSupport {
...
}
1.4.5.2. Customizing the CamelContext for testing 링크 복사링크가 클립보드에 복사되었습니다!
You can customize the CamelContext for testing with configuration profiles, CDI beans, observers, mocks etc. You can also override the createCamelContext method and interact directly with the CamelContext.
When using createCamelContext you MUST NOT instantiate and return a new CamelContext. Instead, invoke super.createCamelContext() and modify the returned CamelContext as needed. Failing to follow this rule will result in an exception being thrown.
1.4.5.3. Configuring routes for testing 링크 복사링크가 클립보드에 복사되었습니다!
Any classes that extend RouteBuilder in your application will have their routes automatically added to the CamelContext. Similarly, any XML or YAML routes configured from camel.main.routes-include-pattern will also be loaded.
This may not always be desirable for your tests. You control which routes get loaded at test time with configuration properties:
-
quarkus.camel.routes-discovery.include-patterns -
quarkus.camel.routes-discovery.exclude-patterns, -
camel.main.routes-include-pattern -
camel.main.routes-exclude-pattern.
You can also define test specific routes per test class by overriding createRouteBuilder:
1.4.5.4. CamelContext test lifecycle 링크 복사링크가 클립보드에 복사되었습니다!
One of the main differences in CamelQuarkusTestSupport compared to CamelTestSupport is how the CamelContext lifecycle is managed.
On Camel Quarkus, a single CamelContext is created for you automatically by the runtime. By default, this CamelContext is shared among all tests and remains started for the duration of the entire test suite execution.
This can potentially have some unintended side effects for your tests. If you need to have the CamelContext restarted between tests, then you can create a custom test profile, which will force the application under test to be restarted.
For example, to define a test profile:
@QuarkusTest
class MyTestProfile implements QuarkusTestProfile {
...
}
@QuarkusTest
class MyTestProfile implements QuarkusTestProfile {
...
}
Then reference it on the test class with @TestProfile:
You cannot manually restart the CamelContext by invoking its stop() and start() methods. This will result in an exception.
1.4.5.5. Examples 링크 복사링크가 클립보드에 복사되었습니다!
1.4.5.5.1. Simple RouteBuilder and test class 링크 복사링크가 클립보드에 복사되었습니다!
Simple RouteBuilder:
Test sending a message payload to the direct:start endpoint:
1.4.5.5.2. Using AdviceWith 링크 복사링크가 클립보드에 복사되었습니다!
1.4.5.5.3. Explicitly enabling advice 링크 복사링크가 클립보드에 복사되었습니다!
When explicitly enabling advice you must invoke startRouteDefinitions when completing your AdviceWith setup.
Invoking startRouteDefinitions is only required if you have routes configured that are NOT being advised.
1.4.5.6. Limitations 링크 복사링크가 클립보드에 복사되었습니다!
1.4.5.6.1. Test lifecycle methods inherited from CamelTestSupport 링크 복사링크가 클립보드에 복사되었습니다!
CamelQuarkusTestSupport inherits some test lifecycle methods from CamelTestSupport. However, they should not be used and instead are replaced with equivalent methods in CamelQuarkusTestSupport.
| CamelTestSupport lifecycle methods | CamelQuarkusTestSupport equivalent |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
1.4.5.6.2. Creating a custom Camel registry is not supported 링크 복사링크가 클립보드에 복사되었습니다!
The CamelQuarkusTestSupport implementation of createCamelRegistry will throw UnsupportedOperationException.
If you need to bind or unbind objects to the Camel registry, then you can do it by one of the following methods.
Produce named CDI beans
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
Override
createCamelContext(see example above) and invokecamelContext.getRegistry().bind("foo", fooBean) Use the
@BindToRegistryannotation@QuarkusTest class SimpleTest extends CamelQuarkusTestSupport { @BindToRegistry("myBean") MyBean myBean = new MyBean(); }@QuarkusTest class SimpleTest extends CamelQuarkusTestSupport { @BindToRegistry("myBean") MyBean myBean = new MyBean(); }Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteBeans bound to the Camel registry from individual test classes, will persist for the duration of the test suite execution. This could have unintended consequences, depending on your test expectations. You can use test profiles to restart the
CamelContextto avoid this.