Java – good programming practice for structuring java project

designjavapatterns-and-practicesswing

I have a Java project that is getting to be relatively large (a few thousand lines in all, I'd say). It's definitely a lot larger than what I've dealt with before, being that I am still a relatively new programmer.

I have a class structure with my swing components and other classes I have made that, more and more, is becoming confusing. Even as a beginner, I can tell this wouldn't be considered "good programming practice". It's somewhat difficult to explain, and I cannot simply copy/paste code, as this is really dealing with the whole program. But I will do my best to explain…

As an example, I have a "Minion" class, and Minion objects will sometimes do something that needs to update a "levelGUI", an extended JPanel. How do they access this levelGUI? I will tell them something like "Game.getLevelGUI().someMethod()" and that just looks sloppy. Am I wrong?

The problem is that I have gotten ahead of myself in actual programming, relative to my understand of how the structure of said program works. I think what I will end up with, if I continue down this path, is a program that works as I intended, but with poor readability and great difficulty in altering down the road.

If this seems a difficult question to answer, links to articles which could explain how a large hierarchy of objects effectively "interact" or something to that effect… would be VERY helpful (I'm not being lazy, I have looked and looked, trying to find something).

Best Answer

My all-time favorites resources about organizing guis are by Martin Fowler

http://martinfowler.com/eaaDev/uiArchs.html

http://martinfowler.com/eaaDev/OrganizingPresentations.html

and the patterns described there

Related Solutions

Java MVC – Using MVC in a Java Application

This is all very subjective as multiple different technologies will be able to serve your needs.

Like others, I'll probably just recommend the technology I'd personally prefer for such a project, which would be JavaFX.

Reasons I would recommend JavaFX are:

In-built properties and binding make it easy to wire up parts of your GUI for automatic updates.
Quality graphical design tool.
Separation of UI component layout from control logic using FXML.
High quality, hardware accelerated, platform independent rendering architecture.
Wide variety of supported platforms and systems.
Support for touch interaction.
Separation of style from code using CSS.
SceneGraph based retained rendering model rather than a direct draw model.
Quality documentation and support forums plus help available via StackOverflow and a web blogging community.
Wide variety of quality pre-built controls.
Media support.
Modern, performant HTML5 engine.
Embeddable in Swing applications if needed, so you can still make use of Swing based frameworks.
Embeddable in SWT applications if needed, so you can still make us of SWT based frameworks.
Ability to support immediate mode rendering if required.
Effects framework.
Animation framework.
Graphing framework.
Open source development.
Excellent sample program.
Public issue tracker and responsive developers, doing active, on-going development so that new features and bugs get addressed in a timely way.
Backing of a major company prepared to invest considerable resources to make the project successful.
Deployable via native platform installers and executables.
Able to utilize all of the features of the massive JDK and java based libraries and projects.
Can be used from a variety of programming languages, such as Scala, Groovy and Ruby.
Nice interactive development and debugging utilities as well as the ability to use a standard Java debugger to debug your program.
Quality layout managers.
JavaFX has been designed to take advantage of Java 8 lambdas.
JavaFX applications are deployable to commercial app stores.
JavaFX can be programmed using the best IDEs in the world.
Strong concurrency utilities.

OK, I guess the above is a bit of a tangent, but I like to promote JavaFX ;-)

Anyway, to address the specific points in your question:

JavaFX is a cross-platform GUI framework (currently Mac/Windows/Linux).
JavaFX has inbuilt, high quality multiple threading support (the core framework itself is single-threaded as is just about every other GUI platform out there, but you can define your own tasks to be executed concurrently off the GUI thread so that the GUI thread remains responsive).
A well written JavaFX program should have no issues performing well enough to visualize fairly large quantities of data. Here is a sample JavaFX project which does that.
The ability to style the application via css, make use of visual effects and animation, allows you to work with designers to make your app look great or do it yourself if you have the skills.
JavaFX has a TableView and a TreeView you can use. There is also a combined TreeTable control which has been developed in preparation for the Java 8 release.
The custom figure drawing widget could use scene graph shapes or a direct draw canvas - it's really just a matter of coding style and preference.
JavaFX's properties and binding facilities coupled with it's event listener frameworks makes it trivial to modify data using one control and have the changes immediately reflected in other controls.
For MVC style development, you can write your model using plain java objects, define your view using the FXML markup language (created using the SceneBuilder graphical layout tool if desired) and define your control logic in Java (or another scripting language if you prefer), plus you should separate your style from your logic by using CSS.
As you have limited exposure to Java, the learning curve will be significant. There are excellent Java tutorials in addition to the JavaFX tutorials I linked to earlier which can help with this. JavaFX core code uses only facilities available in the JDK, so to use JavaFX you don't need to learn a lot of additional libraries and frameworks (as you would if you were learning JavaEE for instance). So those two tuotorial sites provide most information you need to get up to speed.
For app organization, if you have a complex application and need the backing of a complete, proven client application framework and don't mind doing a lot of extra learning, then you can embed JavaFX in the Eclipse RCP or NetBeans RCP, which, according to their pages could save you years of development time. I'd only advise looking at such platforms if your needs justify it though, because for small to medium size projects, it will probably be simpler to code the stuff up directly in JavaFX without the complex client platform frameworks such as Eclipse and NetBeans.
As to whether you should use Swing or JavaFX, I'm not really the most objective person to answer that. JavaFX definitely has shortcomings which would become apparent to you as you start to use it (as does Swing).
For online tutorials, I've linked to most relevant ones. There is a nice tutorial set for a complete app.
The books Pro JavaFX 2 and JavaFX 2.0 Introduction by Example are highly rated.

Java Swing – Frustration with Java Swing Layout Managers

What I would like to be able to do is jave a simple JFrame and then for each component (like JLabel) simply specify X and Y coordinates where I want it to be situated -- done deal.

You can do that with null layout:

jPanel.setLayout(null);
jLabel.setBounds(5, 5, 200, 300);
jPanel.add(jLabel);
jFrame.add(jPanel);

Best Answer

Related Solutions

Java MVC – Using MVC in a Java Application

Java Swing – Frustration with Java Swing Layout Managers

Related Topic