Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mvysny/beverage-buddy-jooq
Simple Example Web Application for Vaadin Flow
https://github.com/mvysny/beverage-buddy-jooq
Last synced: 28 days ago
JSON representation
Simple Example Web Application for Vaadin Flow
- Host: GitHub
- URL: https://github.com/mvysny/beverage-buddy-jooq
- Owner: mvysny
- License: mit
- Created: 2023-09-26T06:21:27.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-12T04:43:46.000Z (2 months ago)
- Last Synced: 2024-10-05T11:09:14.717Z (about 1 month ago)
- Language: Kotlin
- Size: 1.9 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://vaadinonkotlin.eu)
[](https://gitter.im/vaadin/vaadin-on-kotlin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
# Beverage Buddy App Starter for Vaadin
:coffee::tea::sake::baby_bottle::beer::cocktail::tropical_drink::wine_glass:
This is a [Vaadin](https://vaadin.com/) example application.
A full-stack app: uses the H2 database instead of a dummy service; uses [JOOQ](https://www.jooq.org/)
to access the database. Requires Java 21+. Does not run on Spring.
The Starter demonstrates the core Vaadin Flow concepts:
* [Building UIs in Kotlin](https://github.com/mvysny/karibu-dsl) with components
such as `TextField`, `Button`, `ComboBox`, `DatePicker`, `VerticalLayout` and `Grid` (see `CategoriesList`)
* [Creating forms with `Binder`](https://github.com/vaadin/free-starter-flow/blob/master/documentation/using-binder-in-review-editor-dialog.asciidoc) (`ReviewEditorDialog`)
* Making reusable Components on server side with `KComposite` (`AbstractEditorDialog`)
* [Creating Navigation with the Router API](https://github.com/vaadin/free-starter-flow/blob/master/documentation/using-annotation-based-router-api.asciidoc) (`MainLayout`, `ReviewsList`, `CategoriesList`)
* [Browserless testing](https://github.com/mvysny/karibu-testing): see the
[test suite package](src/test/kotlin/com/vaadin/starter/beveragebuddy/ui) for the complete test implementation.
On top of that, a very simple way of using JOOQ is demoed:
* Running the `db {}` function runs the block in a transaction. Pure simplicity :)
* `db` gives you access to `DSLContext`, so you can simply call `db { create.selectFrom(CATEGORY) ... }`
* `db { CategoryRecord(name = "Foo").attach().store() }` creates a new record in a database - the record is attached
to the current transaction, enabling `store()`, `delete()` and other JOOQ record functions.
* `CATEGORY.dao.findByName("Foo")` demoes the ability to write DAOs with useful finder methods.
On top of that, the JOOQ-Vaadin integration is demoed as well:
* See the `CategoryRowDataProvider` on how to return the outcome of a JOIN statement from Vaadin's `DataProvider`;
* See `JooqRecordDataProvider` for a generic DataProvider returning instances of any Record.
Very handy for using in combination with a `ComboBox`, see `ReviewEditorForm` for more details.
This version of Beverage Buddy demoes the possibility of developing a Vaadin
web application purely server-side in the Kotlin language. There is no
JavaScript code in this project. We use Vaadin to avoid touching JavaScript after all.
See the [online demo](https://v-herd.eu/beverage-buddy-jooq/).
## To run:
Run `Main.kt` `main()` function from your IDE, or run via `./gradlew run`.
# Documentation
Please see the [Vaadin Boot](https://github.com/mvysny/vaadin-boot#preparing-environment) documentation
on how you run, develop and package this Vaadin-Boot-based app.
## Database
Without the database, we could store the categories and reviews into session only, which would then be gone when the server rebooted.
We will use the JOOQ library to ease access to the SQL. To make things easy we'll
use in-memory H2 database which will be gone when the server is rebooted - *touche* :-D
We will use [Flyway](https://flywaydb.org/) for database migration. Check out [Bootstrap.kt](src/main/kotlin/com/vaadin/starter/beveragebuddy/Bootstrap.kt)
on how the [migration scripts](src/main/resources/db/migration) are ran when the app is initialized.
JOOQ records are generated in the [com.vaadin.starter.beveragebuddy.backend.jooq](src/main/kotlin/com/vaadin/starter/beveragebuddy/backend/jooq/)
package, including the `CategoryRecord` and `ReviewRecord`. See `JooqGenerator` on how to
generate the records. There are no DTOs - the records are passed around in the app and edited directly in the forms.
The records therefore contain jakarta.validation annotations to validate user input.
Careful when re-generating records, since those annotations will be lost.
The [simplejooq](src/main/kotlin/com/vaadin/starter/beveragebuddy/backend/simplejooq/)
package contains useful functions to access database without Spring:
* The `db{}` function runs given block in a transaction. You can't go simpler than that.
* The `DAO` collection of extension functions, allowing you to write `CATEGORY.dao.getById()` and similar.
* Validations
## Looking for jdbi-orm version?
See the [beverage-buddy-vok](https://github.com/mvysny/beverage-buddy-vok) version for an example
app using the [jdbi-orm](https://gitlab.com/mvysny/jdbi-orm) framework underneath.
Advantages of jdbi-orm:
* No generated classes. You write the entities yourself, with any utility functions you need.
No generator is going to overwrite those.
* You can override built-in methods, e.g. `delete()`, to perform additional cleanup (e.g. set foreign keys to null)
* Validation baked in and enabled by default: the entities are validated before they're saved or created.
Disadvantages:
* No generated classes - you need to write the entity classes yourself. However, you only
need to do that once.
* Very little support for writing SELECTs from Java code. You write those as Strings instead.