https://github.com/rohitpshelar/quarkus_tutorials
learn quarkus
https://github.com/rohitpshelar/quarkus_tutorials
circuit-breaker cors cross-origin-resource-sharing fallback fault-tolerance hibernate-orm intellij java21 microprofile quarkus swagger-ui
Last synced: 7 days ago
JSON representation
learn quarkus
- Host: GitHub
- URL: https://github.com/rohitpshelar/quarkus_tutorials
- Owner: rohitpshelar
- Created: 2025-07-24T18:55:50.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-08-05T13:24:10.000Z (9 months ago)
- Last Synced: 2025-08-05T15:21:16.837Z (9 months ago)
- Topics: circuit-breaker, cors, cross-origin-resource-sharing, fallback, fault-tolerance, hibernate-orm, intellij, java21, microprofile, quarkus, swagger-ui
- Language: Java
- Homepage:
- Size: 49.8 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# quarkus_tutorials 🎥
https://youtube.com/playlist?list=PLzdlNxYnNoaf5bb-Pwb7MbWHGlRf28pVO&si=fUuG6enQWCokfN4t
## Spring Boot vs Quarkus Annotations Comparison 📊
| Annotation Type | Spring Boot | Quarkus |
|-----------------------|------------------------|-----------------------|
| **Main Class** | @SpringBootApplication | @QuarkusMain |
| **Dependency Inj.** | @Autowired | @Inject |
| **Components** | @Repository | @ApplicationScoped |
| | @Service | @ApplicationScoped |
| | @Component | @ApplicationScoped |
| **Data Access** | CrudRepository | PanacheRepository |
| | @Entity | @Entity |
| | @Transactional | @Transactional |
| **Web** | @RestController | @Path |
| | @GetMapping | @GET |
| | @PostMapping | @POST |
| **Testing** | @SpringBootTest | @QuarkusTest |
| | @MockBean | @InjectMock |
| **Configuration** | @Value | @ConfigProperty |
| **Caching** | @EnableCaching | @CacheResult |
| **Scheduling** | @Scheduled | @Scheduled |
| **Async** | @Async | @Blocking/@NonBlocking|
1. Support both
```
Imperative -> if ABC data fetched, it will search entire DB and bring record
Reactive -> If ABC is fetched, it will return data 1 by 1 as it gets.
```
2. Open source
3. Set JAVA_HOME
4. Download Maven https://maven.apache.org/download.cgi > Binary zip archive > keep in C:\Program Files (x86) > set path (C:\Program Files (x86)\apache-maven-3.9.11\bin) in "PATH"
5. Goto https://code.quarkus.io/
6. Dependency Selected
1. RESTEasy Classic
2. RESTEasy Classic Jackson
7. Add project to intellij
8. Add plugin in Intellij as > Quarkus Tools
9. run Project with command ```mvn quarkus:dev``` OR ```./mvnw quarkus:dev``` (Ref : [Quarkus_README.md](Quarkus_README.md) )
10. In 4th Lecture
11. To check Quarkus supported Extension/Dependencies -> ```mvn quarkus:list-extensions``` OR ```./mvnw quarkus:list-extensions```
12. To Add > ```./mvnw quarkus:add-extension -Dextensions="_____"``` OR ```mvn quarkus:add-extension -Dextensions="Mutiny"```
13. In 6th Part - All 4 API added [MobileResource.java](src/main/java/com/learn/resource/MobileResource.java) and their Postman collection [quarkus-tutorial-mvn.postman_collection.json](quarkus-tutorial-mvn.postman_collection.json)
14. In 7th Part - All 4 API updated with modal and 5th API ByNumber ([Mobile.java](src/main/java/com/learn/resource/Mobile.java)) and new resource [MobileResourcePart7.java](src/main/java/com/learn/resource/MobileResourcePart7.java) and their Postman collection [quarkus-tutorial-mvn.postman_collection.json](quarkus-tutorial-mvn.postman_collection.json)
15. In 8th Part -
1. Add swagger ```mvn quarkus:add-extension -Dextensions="quarkus-smallrye-openapi"```
2. Goto http://localhost:8080/q/swagger-ui/
3. To Change default swagger path (http://localhost:8080/q/swagger-ui/) to custom (http://localhost:8080/swag/)
```properties
quarkus.swagger-ui.path=/swag
```
4. To disable swagger UI Path
```properties
quarkus.swagger-ui.always-include=false
```
16. In 9th Part - Bring data from other Micro service
1. Add following extension/dependency :
1. "REST Client" to call remote API ```mvn quarkus:add-extension -Dextensions="quarkus-rest-client"```
2. "REST Client jackson" to call remote API ```mvn quarkus:add-extension -Dextensions="quarkus-rest-client-jackson"```
3. "quarkus-rest-jackson" to call remote API ```mvn quarkus:add-extension -Dextensions="quarkus-rest-jackson"```
4. Remove quarkus-resteasy and quarkus-resteasy-jackson due to conflict regards ( Caused by: jakarta.enterprise.inject.spi.DeploymentException: Mixing Quarkus REST and RESTEasy Classic server parts is not supported )
2. Use DUMMY client as https://www.tvmaze.com/api
1. Search TV show by Id - https://api.tvmaze.com/shows/169
2. Create Modal class for above response
17. In Part-10 : cors ( Cross Origin Resource Sharing ) - allow external service to access our service ( Open this from Browser : [Part-10.html](Part-10.html) )
```properties
quarkus.http.cors=true
quarkus.http.cors.origins=*
```
1. Allow only specific method
```properties
quarkus.http.cors.methodshs=GET, POST
```
18. In Part-11, 12 : Microprofile Fault Tolerance
1. Add following extension/dependency :
1. "Fault Tolerance" to call default method if remote API offline ```mvn quarkus:add-extension -Dextensions="quarkus-smallrye-fault-tolerance"```
2. Create Fallback Method
```java
@Fallback(fallbackMethod = "getTvSeriesByIdFallback")
```
3. Retry ```@Retry(maxRetries = 2)```
4. Timeout ```@Timeout(1000)```
5. Circuit Breaker
```java
@CircuitBreaker(
requestVolumeThreshold=2,
failureRatio=0.5,
delay = 10, delayUnit = ChronoUnit.SECONDS
)
```
6. Git Bash Script to hit URL in loop
```shell
while true; do sleep 1; curl http://localhost:8080/tvseries/260; echo -e '\n'; done
```
13. Part-13, 14 : Hibernate-ORM PanacheEntity with H2DB
1. "H2DB" - ```./mvnw quarkus:add-extension -Dextensions="io.quarkus:quarkus-jdbc-h2"```
2. "Hibernate ORM" - ```./mvnw quarkus:add-extension -Dextensions="io.quarkus:quarkus-hibernate-orm-panache"```
3. Two Types
1. Extend Entity Class with PanacheEntity
2. Implement with PanacheRepository
4. Mapping
1. One to One
- Add ```@OneToOne``` to secondary class
Table 1
T1_ID
T1_Name
Table 2
T2_ID
T2S_Name
T1_ID
- But here we can only find Table 1 from Table 2, So
- We will add ```@OneToOne``` to Primary class
Table 1
T1_ID
T1_Name
T2_ID
Table 2
T2_ID
T2S_Name
T1_ID
- But now we have two column on both table
- So to remove extra column from Primary class use in Primary class : ```@OneToOne(mappedBy = "<*Primary class*>")```
- To fetch both at once use Primary class : **fetch = FetchType.EAGER** : ```@OneToOne(mappedBy = "<*Primary class*>", fetch = FetchType.EAGER)```
- To fix ```Infinite recursion``` - which is due to both class has ```@OneToOne``` annotation
1. Add @JsonManagedReference in Primary class
2. Add @JsonBackReference in secondary class
- To save both at Once use in Primary class : **cascade = CascadeType.ALL** : ```@OneToOne(mappedBy = "laptop", fetch = FetchType.EAGER, cascade = CascadeType.ALL)```
19. Part 29 : Logging
1. Info - Method info
2. Debug - Data Info
3. warning
4. Error
20. Part- 30 : Exception -TODO
21. Part - 32 : MicroProfile Health
1. Add ``` mvn quarkus:add-extension -Dextensions="quarkus-smallrye-health"```
2. Two Type
1. Liveness [LivenessHealthCheck.java](src/main/java/com/learn/resource/part30_MicroProfile_health/LivenessHealthCheck.java) - To check Proxy/Client Connections
2. Readiness [ReadinessHealthCheck.java](src/main/java/com/learn/resource/part30_MicroProfile_health/ReadinessHealthCheck.java) - To check DB connection
3. Test URLs
1. http://localhost:8080/q/health-ui/
2. http://localhost:8080/q/health
3. http://localhost:8080/q/health/live
4. http://localhost:8080/q/health/ready
5. http://localhost:8080/q/health/started
6. http://localhost:8080/q/health/well
22. Part-33 How to use MicroProfile Metrics
1. Add ```mvn quarkus:add-extension -Dextensions="quarkus-smallrye-metrics"```
2. Types [Number.java](src/main/java/com/learn/resource/part33_microProfile_matrics/Number.java)
1. @Counted
```json
{
"com.learn.resource.part33_microProfile_matrics.Number.Count_checkIfPrimeNumber": 3
}
```
2. @Timed
```json
{
"com.learn.resource.part33_microProfile_matrics.Number.Time_checkIfPrimeNumber": {
"p99": 319201.0,
"min": 15200.0,
"max": 319201.0,
"mean": 156003.43605748552,
"p50": 15600.0,
"p999": 319201.0,
"stddev": 142029.00004744556,
"p95": 319201.0,
"p98": 319201.0,
"p75": 280601.0,
"fiveMinRate": 0.2032510706679223,
"fifteenMinRate": 0.2011018917421949,
"meanRate": 0.23204665475695216,
"count": 4,
"oneMinRate": 0.21471253794774184,
"elapsedTime": 630602.0
}
}
```
3. @Metered
```json5
{
"com.learn.resource.part33_microProfile_matrics.Number.Metered_checkIfPrimeNumber": {
"fiveMinRate": 0.38704854970388447,
"fifteenMinRate": 0.39559850366986254,
"meanRate": 0.1737586528638574,
"count": 4,
"oneMinRate": 0.34222396825043916
}
}
```
4. @Gauge(unit = MetricUnits.MILLISECONDS) - For Custom
```json
{
"com.learn.resource.part33_microProfile_matrics.Number.getHighestInputPrimeNumber": 2
}
```
3. 🧪 Test URLs - http://localhost:8080/q/metrics/application
24. Part-34 🔐 Authentication and Authorization using JWT Token and Roles-Based Access Control
1. Create two Module
1. App (Course) - All APIs - [course](course)
1. Run
```shell
cd .\course
mvn quarkus:add-extension -Dextensions="quarkus-smallrye-jwt"
```
2. Add in [application.properties](course/src/main/resources/application.properties)
```properties
mp.jwt.verify.issuer=jwt-token
mp.jwt.verify.publickey.location=../jwt/publicKey.pem
```
3. On Method Add ```@RolesAllowed({"teacher","admin"})```
2. JWT - Generate Token - [JWT](JWT)
1. Run
```shell
cd .\JWT
mvn quarkus:add-extension -Dextensions="quarkus-smallrye-jwt"
mvn quarkus:add-extension -Dextensions="quarkus-smallrye-jwt-build"
```
2. Add in [application.properties](jwt-token/src/main/resources/application.properties)
```properties
smallrye.jwt.sign.key.location=../jwt/privateKey.pem
```
3. Generate Key 🔐
1. Open GitBash
2. Run
```shell
mkdir jwt
openssl genrsa -out jwt/rsaPrivateKey.pem 2048
openssl rsa -pubout -in jwt/rsaPrivateKey.pem -out jwt/publicKey.pem
openssl pkcs8 -topk8 -nocrypt -inform pem -in jwt/rsaPrivateKey.pem -outform pem -out jwt/privateKey.pem
chmod 600 jwt/rsaPrivateKey.pem
chmod 600 jwt/privateKey.pem
```
3. Folder will be created as jwt ( [jwt](jwt) ), and it will contain following files
1. [privateKey.pem](jwt/privateKey.pem)
2. [publicKey.pem](jwt/publicKey.pem)
3. [rsaPrivateKey.pem](jwt/rsaPrivateKey.pem)
4. Fix `ignored POM.XML` file issue : Goto Settings > Build, Execution > Build Tools > Maven > IgnoreFiles > Untick Both Module
5. Validate barrier key in https://www.jwt.io/
25. Part-35 🔐 Authentication and Authorization using Keycloak Server
1. Goto https://www.keycloak.org/ and download > extract and goto bin folder
2. Open bin folder in cmd, run ```kc.bat start-dev```
3. Create New Realm(branch) by clinking on `master` i create as `iit`
4. Now goto Client and create New client -
1. I created clientID and name as `iit-pune`
2. Client Type = OpenId
3. Turn on Client Authentication and Authorization
4. ✅ Tick on Flow > Standard Flow, Direct Access Flow
5. Add java URL in > Root, Home
5. Now Roles to Client > click client 'iit-pune' > Roles Tab > Create Role
6. Now Create User > fill details > Role Mapping > add
7. Add Role to Java Method with ```@RolesAllowed({"student","professor","admin"})```
8. Run
```shell
cd .\part-35-Keycloa
mvn quarkus:add-extension -Dextensions="quarkus-oidc"
mvn quarkus:add-extension -Dextensions="quarkus-keycloak-authorization"
```
9. Add in [application.properties](part-35-Keycloak/src/main/resources/application.properties)
```properties
quarkus.oidc.auth-server-url=http://localhost:8080/realms/iit
quarkus.oidc.client-id=iit-pune
quarkus.oidc.credentials.secret=Ib1ua1DwqAAjLscpLmF6n66uWbWkpVIg
quarkus.oidc.authentication.user-info-required=true
```
26. Part-36 How to use Lombok library
1. ⚠️ Never use @DATA to Entity Class - it will give exception or @Oneto*** due to circular ref
2. ✨ @Data Contains every thing like @Getter, @Setter, @AllArgConst , @NoArgCons
27. Part-38 How to test secured Api
1. Add dependency ``` mvn quarkus:add-extension -Dextensions="quarkus-test-security"```
2. Test Class needs to be annotated with ```@QuarkusTest ``` and ```@TestMethodOrder(MethodOrderer.OrderAnnotation.class)```
3. Method with ```@Test```, Optional ```@Order(1)```
4. JWT security can be disabled by two ways: [MobileResourceTest.java](part-35-Keycloak/src/test/java/com/learn/part7/MobileResourceTest.java)
1. @TestSecurity(authorizationEnabled = false)
2. @TestSecurity(user = "test", roles = "student")
28. Part-37 How to convert Entity(DAO) >> DTO(Modal)(Data Transfer Object)
1. ⚠️ Issue is if we modify data in DAO after fetching and method is annotated with @Transactional then modified data gets saved in DB.
2. Add dependency ``` MapStruct, MapStruct-Processor, lombok-mapstruct-binding``` from MVN
29. Part-40 How to use Hibernate Validator Extension to validate Entities
1. Add dependency ``` mvn quarkus:add-extension -Dextensions="quarkus-hibernate-validator"```
2. Add Annotation to Entity (TODO : Need to check for DTO) [Citizen.java](trainig/src/main/java/com/learn/resource/part37_mapstruct/part13_hibernate_ORM/Citizen.java)
3. Catch validation message - Ref Add Method - [CitizenResource.java](trainig/src/main/java/com/learn/resource/part37_mapstruct/part13_hibernate_ORM/CitizenResource.java)
4. OR Add @VValid at input Method variable.
30. Part-41 How to debug
1. when ` mvn clean quarkus:dev` then default debug port is 5005
2. To start with Custom Port ``` mvn clean quarkus:dev -Ddebug=8121```
3. In Injellij > Run > Attach To Process > select port