What I learnt developing a small JavaFX App

Tue, 26 Jun 2018 11:18:38 +0000

Introduction

This is a collection of the things I learnt developing a simple JavaFX app over the last month or two. My background is very much in Java EE with decades of experience building high end, high-performance ticketing systems. This means that my expectation from a development environment is relatively high. There are many optional components in here that I find worthwhile setting up at the start, but are not necessary

Tools

Maven

One of the most useful tools I have found while working with Java is maven. If maven isn't a part of your build, have a look at it and re-evaluate that. I have no doubt that maven has saved me hundreds, if not thousands of hours over the last few years.

JavaFX Scene Builder

While this one has a bunch of issues and serious limitations, it can still be a helpful tool. It helped me get a handle on the components available and placing items.

Libraries

Testing

I use junit5, but there are other options like test-ng which are equally good. I use **Mockito **for mocking, but there are many other options like PowerMock, JMockit, EasyMock, etc.

For UI Testing, you can use TestFX. I don't like UI work, so haven't done much work with this.

    org.junit.platform
    junit-platform-launcher
    1.2.0
    test


    org.junit.jupiter
    junit-jupiter-engine
    5.2.0
    test


    org.junit.vintage
    junit-vintage-engine
    5.2.0
    test



    org.mockito
    mockito-core
    2.18.3
    test

Logging

I can’t live without logging in any application. It can make troubleshooting much easier, particularly when you’ve deployed your app. log4j2 is the main logging framework out there. You can choose another one if you like, but I strongly recommend having and using one.

    org.apache.logging.log4j
    log4j-slf4j-impl
    2.11.0


    org.apache.logging.log4j
    log4j-api
    2.11.0


    org.apache.logging.log4j
    log4j-core
    2.11.0

Dependency Injection

If you have working the Java EE Environment, you have almost certainly come across Inversion of Control, particularly in the form of Dependency Injection. I love dependency injection. It helps with decoupling components and with testing. I looked at various frameworks including Dagger 2, Spring, Guice.

Dagger

The fully static (compile time) nature of Dagger 2 means that it doesn't gel well with JavaFX which is very dynamic.

Spring

I had worked with Spring many years ago and didn't want to tangle with a behemoth for a small project. There are many components and loads of functionality in spring and if you building a large and complex project, it might be worth it.

Google Guice

Google Guice is the framework that I ended up going with. It does have some dependencies like Guava, but as it turned out, I Guava comes in handy for JavaFX anyway. We don't need an entry in the pom.xml for this because of the following dependency.

Gluon Ignite

Gluon Ignite was released by gluon labs to integrate Dependency Injection frameworks with JavaFX. In other words, it ties in the DI framework with the FXMLLoader so that it will load the correct controller instances. Since I am using Guice, I needed the ignore-guice module. If you add this into your pom.xml, it will also pull in google guice. Easy eh? ;)

    com.gluonhq
    ignite-guice
    1.0.2

If you don't want to add another dependency, you could take a look at the code in this module. It's fairly straightforward to integrate that manually into your app. It's just easier to add in the dependency and let it do the magic

Event / Publisher / Subscriber Framework

It is likely that you will need an event framework or a publisher/subscriber framework. The nature of GUI design and work is that it is an easy and simple solution for a number of problems you will come across. Fortunately, we already have an event framework in place within Guava which is a dependency of Google Guice.

Project Lombok

Don't you love adding in a getter and a setter for each field? When you change your fields, don't you love going in and updating all the getters and setters? How about defining the long, pita to type types with generics of variables that you are assigning from a method call? I mean the compiler can't possibly figure that out by itself, right? How about writing out the toString, equals and hashCode for each class? What do you mean no, you don't? You don't love these tedious repetitive tasks of development? Good! You will love Lombok. Unfortunately, with Lombok, it's not as simple as adding it into your pom.xml. Check out the install instructions on their website for you IDE etc. You also need it in your pom.xml.

    org.projectlombok
    lombok
    1.18.0
    provided

There is some controversy around Lombok. There is a good post on stackoverflow that covers some of these things in a reasonable fashion.

Apache Commons

Last but certainly not least, we have apache commons. This is a collection of libraries rather than a single one. You know all those bits of code you write over and over. Chances are that there is something in here that does it better and in a simpler way.

Persistence

TBC

Packaging

TBC

yertoob

Mon, 25 Jun 2018 00:00:00 +0000

YerToob is an app that I am developing to alleviate the tedium of uploading videos to YouTube. YerToob works by automating large parts of the YouTube upload process.

I currently upload a few videos a week and this involves:

Copying and pasting various bits of text for:
- The description
- The title
Copying and pasting in the tags, and adding any additional ones
Scheduling the video
Adding to playlist
Generating and uploading a thumbnail
Scheduling a tweet

YerToob tries to automate all of the above. It works by defining templates for the description and the title using tags.

Title Template Example

``` Ep[episode:number] - [episode:name] | [playlist:name] | Let's Play Space Engineers ```

Description Template Example

``` [episode:synopsis] --------- A lone space engineer wakes up in his small ship, far away from a home he once knew. There are only a handful of people still awake, with a few thousand people across a few factions in cryo-sleep. A capital ship is being built to house these cryo chambers. Several engineers have been sent out into the galaxies to build a base. Their mission is to colonise planets, ideally multiple planets, for each of the three factions. With a few hundred to a thousand people in each faction. Once all the habitats have been built, the engineer is to send a radio signal and await the arrival of the cargo. With the heavy burden of this mission on their shoulders, this space engineer wakes up, caught in the gravitational pull of a blue planet. --------- Blog Post: https://drone-ah.com/2018/03/19/lets-play-space-engineers-pilot-series/ Playlist: https://www.youtube.com/playlist?list=PLQb-fOWHIdUzyM-bJllq3QpWdVGDBhC98 Twitter: https://twitter.com/drone_ah Space Engineers Genome: https://www.genomised.com/games/space-engineers Games like Space Engineers: https://www.gamecupid.com/games/space-engineers/games-like Website: http://www.spaceengineersgame.com/ [episode:addendum1] --------- Credits https://freesound.org/people/kasa90/sounds/143203/ [episode:addendum2] ```

Schedule

You can select which days of the week a video should be uploaded in each playlist. You also select the time at which it should be published.

The app will then schedule them accordingly.

Playlist

Each video is added to the relevant playlist automatically.

Thumbnails

The app will pick up a screenshot from one folder, put the specified overlay image on top, and then scan and overlay another image on top based on the episode number. The thumbnail is then set against the video.

You define a tweet template:

``` #LetsPlay @SpaceEngineersG | Ep [episode:number] - [episode:title]| https://youtu.be/[episode:videoId] | #pcgaming ```

Link up your Twitter account, and it will post that tweet at the scheduled time.

Finding Videos to Upload

For each playlist, you specify which folder the app should scan for new videos. Each video in that folder is then uploaded. Each video needs to be tagged with an episode number. For example, the 50th episode could be:

``` [50] The 50th Episode.mp4 ```

If you haven’t already defined the episode details in the app, it will create a new episode with the title of “The 50th Episode” by removing the episode number tag and the file extension.

This can be useful if you don’t have much episode-specific information.

Current Status

I am currently testing this app. If you are interested in further updates, please follow me on Twitter.

Yertoob on despatches