Red Hat Summit Red Hat SummitSuporteConsoleDesenvolvedoresComeçar um testeContato

Este conteúdo não está disponível no idioma selecionado.

Chapter 18. Development

18.1. Methodology Overview
Copiar o link

The diagram below explains the overall structure of the OptaPlanner source code:

methodologyOverview
View larger image
methodologyOverview

In the diagram above, it’s important to understand the clear separation between the configuration and runtime classes.

The development philosophy includes:

  • Reuse: The examples are reused as integration tests, stress tests and demos. The documentation images are reused as slides.
  • Consistent terminology: Each example has a class App (executable class), Dao (Data Access Object) and Panel (swing UI).
  • Consistent structure: Each example has the same packages: domain, persistence, app, solver and swingui.
  • Real world usefulness: Every feature is used in an example. Most examples are real world use cases with real world constraints, often with real world data.
  • Automated testing: There are unit tests, integration tests, performance regressions tests and stress tests. The test coverage is high.
  • Fail fast with an understandable error message: Invalid states are checked as early as possible.

18.2. Development guidelines
Copiar o link

  1. Fail fast. There are several levels of fail fast, from better to worse:

    1. Fail Fast at compile time. For example: Don’t accept an Object as parameter if it needs to be a String or an Integer.
    2. Fail Fast at startup time. For example: if the configuration parameter needs to be a positive int and it’s negative, fail fast
    3. Fail Fast at runtime. For example: if the request needs to contain a double between 0.0 and 1.0 and it’s bigger than 1.0, fail fast.
    4. Fail Fast at runtime in assertion mode if the detection performance cost is high. For example: If, after every low level iteration, the variable A needs to be equal to the square root of B, check it if and only if an assert flag is set to true (usually controlled by the EnvironmentMode).

  2. Exception messages

    1. The Exception message must include the name and state of each relevant variable. For example: 

      if (fooSize < 0) {
    throw new IllegalArgumentException("The fooSize (" + fooSize + ") of bar (" + this + ") must be positive.");
}
      Copy to Clipboard Toggle word wrap

      Notice that the output clearly explains what’s wrong: 

      Exception in thread "main" java.lang.IllegalArgumentException: The fooSize (-5) of bar (myBar) must be positive.
    at ...
      Copy to Clipboard Toggle word wrap
    2. Whenever possible, the Exception message must include context.

    3. Whenever the fix is not obvious, the Exception message should include advice. Advice normally starts with the word maybe on a new line: 

      Exception in thread "main" java.lang.IllegalStateException: The valueRangeDescriptor (fooRange) is nullable, but not countable (false).
Maybe the member (getFooRange) should return CountableValueRange.
    at ...
      Copy to Clipboard Toggle word wrap

      The word maybe is to indicate that the advice is not guaranteed to be right in all cases.

  3. Generics. The Solution class is often passed as a generic type parameter to subsystems. The PlanningEntity class(es) are rarely passed as a generic type parameter.
Voltar ao topo
Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2025 Red Hat