Chaîne multiligne en Java

Question

Venant de Perl, je suis sûr que le moyen "here-document" pour créer une chaîne de plusieurs lignes dans le code source me manque :

$string = <<"EOF"  # create a three-line string
text
text
text
EOF

En Java, je suis obligé d'avoir des guillemets et des signes plus encombrants sur chaque ligne lorsque je concatène ma chaîne multiligne à partir de zéro.

Quelles sont les meilleures alternatives ? Définir ma chaîne dans un fichier de propriétés ?

Modifier : Deux réponses disent que StringBuilder.append() est préférable à la notation plus. Quelqu'un peut-il expliquer pourquoi il le pense ? Cela ne me semble pas du tout préférable. Je cherche un moyen de contourner le fait que les chaînes multilignes ne sont pas une construction de langage de première classe, ce qui signifie que je ne veux absolument pas remplacer une construction de langage de première classe (concaténation de chaînes avec plus) par des appels de méthode.

Modifier : Pour clarifier davantage ma question, je ne suis pas du tout préoccupé par les performances. Je suis préoccupé par la maintenabilité et les problèmes de conception.

Answer 1

On dirait que vous voulez faire un littéral multiligne, ce qui n'existe pas en Java.

Votre meilleure alternative est d'utiliser des cordes qui sont juste + ensemble. Les autres options mentionnées (StringBuilder, String.format, String.join) ne sont préférables que si vous commencez avec un tableau de chaînes.

Considérez ceci :

String s = "It was the best of times, it was the worst of times,\n"
         + "it was the age of wisdom, it was the age of foolishness,\n"
         + "it was the epoch of belief, it was the epoch of incredulity,\n"
         + "it was the season of Light, it was the season of Darkness,\n"
         + "it was the spring of hope, it was the winter of despair,\n"
         + "we had everything before us, we had nothing before us";

Versus StringBuilder :

String s = new StringBuilder()
           .append("It was the best of times, it was the worst of times,\n")
           .append("it was the age of wisdom, it was the age of foolishness,\n")
           .append("it was the epoch of belief, it was the epoch of incredulity,\n")
           .append("it was the season of Light, it was the season of Darkness,\n")
           .append("it was the spring of hope, it was the winter of despair,\n")
           .append("we had everything before us, we had nothing before us")
           .toString();

Versus String.format() :

String s = String.format("%s\n%s\n%s\n%s\n%s\n%s"
         , "It was the best of times, it was the worst of times,"
         , "it was the age of wisdom, it was the age of foolishness,"
         , "it was the epoch of belief, it was the epoch of incredulity,"
         , "it was the season of Light, it was the season of Darkness,"
         , "it was the spring of hope, it was the winter of despair,"
         , "we had everything before us, we had nothing before us"
);

Versus Java8 String.join() :

String s = String.join("\n"
         , "It was the best of times, it was the worst of times,"
         , "it was the age of wisdom, it was the age of foolishness,"
         , "it was the epoch of belief, it was the epoch of incredulity,"
         , "it was the season of Light, it was the season of Darkness,"
         , "it was the spring of hope, it was the winter of despair,"
         , "we had everything before us, we had nothing before us"
);

Si vous voulez que la nouvelle ligne soit adaptée à votre système particulier, vous devez soit utiliser System.lineSeparator() ou vous pouvez utiliser %n sur String.format .

Une autre option est de placer la ressource dans un fichier texte, et de lire simplement le contenu de ce fichier. Cette solution est préférable pour les chaînes de caractères très volumineuses afin d'éviter d'alourdir inutilement vos fichiers de classe.

Answer 2

Dans Eclipse, si vous activez l'option "Escape text when pasting into a string literal" (dans Préférences > Java > Editeur > Typing) et que vous collez une chaîne de caractères à plusieurs lignes entre guillemets, le système ajoutera automatiquement les éléments suivants " et \n" + pour toutes vos lignes.

String str = "paste your text here";

Answer 3

Stephen Colebourne a créé un proposition pour ajouter des chaînes de caractères multi-lignes dans Java 7.

En outre, Groovy prend déjà en charge chaînes de caractères multi-lignes .

Answer 4

Il s'agit d'un vieux sujet, mais une nouvelle solution assez élégante (avec seulement 4 ou 3 petits inconvénients) consiste à utiliser une annotation personnalisée.

Vérifiez : http://www.adrianwalker.org/2011/12/java-multiline-string.html

Un projet inspiré de ce travail est hébergé sur GitHub :

https://github.com/benelog/multiline

Exemple de code Java :

import org.adrianwalker.multilinestring.Multiline;
...
public final class MultilineStringUsage {

  /**
  <html>
    <head/>
    <body>
      <p>
        Hello<br/>
        Multiline<br/>
        World<br/>
      </p>
    </body>
  </html>
  */
  @Multiline
  private static String html;

  public static void main(final String[] args) {
    System.out.println(html);
  }
}

Les inconvénients sont les suivants

1. que vous devez activer le processeur d'annotation (fourni) correspondant. processeur.
2. que la variable String ne peut pas être définie comme variable locale Vérifier Projet sur les littéraux de chaîne bruts où vous pouvez définir les variables comme des variables locales
3. que String ne peut pas contenir d'autres variables comme dans Visual Basic .Net avec un littéral XML ( <%= variable %> ) :-)
4. que le littéral String est délimité par le commentaire JavaDoc (/**)

Et vous devez probablement configurer Eclipse/Intellij-Idea pour ne pas reformater automatiquement vos commentaires Javadoc.

On peut trouver cela bizarre (les commentaires Javadoc ne sont pas conçus pour intégrer autre chose que des commentaires), mais comme cette absence de chaîne de caractères multiligne en Java est vraiment ennuyeuse au final, je trouve que c'est la moins mauvaise des solutions.

Answer 5

Une autre option peut être de stocker les longues chaînes de caractères dans un fichier externe et de lire le fichier dans une chaîne de caractères.