Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sombriks/sample-htmx-spring
Simple htmx project using spring boot with thymeleaf as backend
https://github.com/sombriks/sample-htmx-spring
bld gradle htmx java liquibase maven spring spring-webflux study-project thymeleaf
Last synced: 1 day ago
JSON representation
Simple htmx project using spring boot with thymeleaf as backend
- Host: GitHub
- URL: https://github.com/sombriks/sample-htmx-spring
- Owner: sombriks
- Created: 2024-03-12T20:40:00.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-06-23T11:23:56.000Z (5 months ago)
- Last Synced: 2024-06-23T20:16:59.566Z (5 months ago)
- Topics: bld, gradle, htmx, java, liquibase, maven, spring, spring-webflux, study-project, thymeleaf
- Language: Java
- Homepage:
- Size: 173 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [sample-htmx-spring][repo]
[](https://github.com/sombriks/sample-htmx-spring/actions/workflows/maven.yml)
[](https://github.com/sombriks/sample-htmx-spring/actions/workflows/gradle.yml)
[](https://github.com/sombriks/sample-htmx-spring/actions/workflows/bld.yml)
Simple [htmx][htmx] project using spring boot with thymeleaf as backend.
Generated by [spring initializr][initializr].
See [HELP.md][help] for further details.
## Requirements
- maven 3.9
- java 17
- htmx 2.0 (webjar)
- spring 3.2 with webflux
## How to build
```bash
./mvnw clean package
```
## How to test
```bash
./mvnw test
```
## How to run
```bash
./mvnw spring-boot:run
```
Or:
```bash
java -jar target/sample-htmx-spring-0.0.1-SNAPSHOT.jar
```
## Noteworthy
- Used [functional endpoints][webflux] instead of traditional [web mvc][webmvc]
to make this sample more similar to the [other][javalin] [ones][koa].
- `RouterFunctions` demands specific routes to be declared first, this is why
the configuration function looks slightly different from its kotlin and node
counterparts.
- Spring webflux is built on top of [project reactor][reactive] and demands a
functional thinking way, therefore the difference in controller code.
- [Spring repositories][repository] are a formidable abstraction.
- Liquibase defaults in spring configuration renders a broken project because it
does [assume a root changelog][changelog-master] but it does not assume the
[changelog format][changelog-format].
- [Thymeleaf is a little picky][thymeleaf-include] regarding the templates
"includes".
- Added additional java build tooling, so we can compare maven, gradle and
[bld][bld]. It's a nice comparison and all three tools can produce a valid
spring boot jar.
## Benchmark results
The following results for the same test applied
[against the other versions][k6-benchmark].
```bash
/\ |‾‾| /‾‾/ /‾‾/
/\ / \ | |/ / / /
/ \/ \ | ( / ‾‾\
/ \ | |\ \ | (‾) |
/ __________ \ |__| \__\ \_____/ .io
execution: local
script: benchmark-javalin.js
output: -
scenarios: (100.00%) 1 scenario, 10 max VUs, 1m0s max duration (incl. graceful stop):
* default: 10 looping VUs for 30s (gracefulStop: 30s)
✓ 200 ok
checks.........................: 100.00% ✓ 153779 ✗ 0
data_received..................: 121 MB 4.0 MB/s
data_sent......................: 12 MB 410 kB/s
http_req_blocked...............: avg=3.01µs min=992ns med=2.66µs max=693.98µs p(90)=3.89µs p(95)=4.87µs
http_req_connecting............: avg=15ns min=0s med=0s max=308.55µs p(90)=0s p(95)=0s
http_req_duration..............: avg=1.84ms min=377.23µs med=934.47µs max=1.15s p(90)=2.44ms p(95)=6.02ms
{ expected_response:true }...: avg=1.84ms min=377.23µs med=934.47µs max=1.15s p(90)=2.44ms p(95)=6.02ms
http_req_failed................: 0.00% ✓ 0 ✗ 153779
http_req_receiving.............: avg=40.23µs min=12.31µs med=34.68µs max=4.91ms p(90)=53.7µs p(95)=68.91µs
http_req_sending...............: avg=12.65µs min=4.27µs med=11.03µs max=5.88ms p(90)=17.57µs p(95)=21.96µs
http_req_tls_handshaking.......: avg=0s min=0s med=0s max=0s p(90)=0s p(95)=0s
http_req_waiting...............: avg=1.78ms min=348.98µs med=887.93µs max=1.15s p(90)=2.36ms p(95)=5.92ms
http_reqs......................: 153779 5125.8185/s
iteration_duration.............: avg=1.93ms min=446.6µs med=1.02ms max=1.15s p(90)=2.57ms p(95)=6.23ms
iterations.....................: 153779 5125.8185/s
vus............................: 10 min=10 max=10
vus_max........................: 10 min=10 max=10
running (0m30.0s), 00/10 VUs, 153779 complete and 0 interrupted iterations
default ✓ [======================================] 10 VUs 30s
```
[repo]: https://github.com/sombriks/sample-htmx-spring
[htmx]: https://htmx.org/
[initializr]: https://start.spring.io/#!type=maven-project&language=java&platformVersion=3.2.3&packaging=jar&jvmVersion=17&groupId=sample.htmx&artifactId=sample-htmx-spring&name=sample-htmx-spring&description=Demo%20project%20for%20HTMX%20with%20Spring%20Boot%20%2F%20Thymeleaf&packageName=sample.htmx.spring&dependencies=webflux,thymeleaf,data-jpa,h2,liquibase
[help]: ./HELP.md
[webflux]: https://docs.spring.io/spring-framework/reference/web/webflux-functional.html
[webmvc]: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#web
[javalin]: https://github.com/sombriks/sample-htmx-javalin
[koa]: https://github.com/sombriks/sample-htmx-koa
[reactive]: https://projectreactor.io/docs/core/release/reference/#intro-reactive
[repository]: https://docs.spring.io/spring-data/jpa/reference/jpa/query-methods.html#jpa.query-methods.query-creation
[changelog-master]: ./src/main/resources/db/changelog/db.changelog-master.yaml
[changelog-format]: https://docs.liquibase.com/concepts/changelogs/home.html
[thymeleaf-include]: https://stackoverflow.com/a/77436286/420096
[k6-benchmark]: https://github.com/sombriks/node-vs-kotlin-k6-benchmark
[bld]: https://rife2.com/bld