Який найкращий спосіб побудувати рядок з обмеженими елементами на Java?

Працюючи в додатку Java, мені нещодавно потрібно було скласти список значень, розділених комами, щоб передати іншій веб-службі, не знаючи, скільки елементів буде заздалегідь. Найкраще, що я міг придумати з голови, було щось подібне:

public String appendWithDelimiter( String original, String addition, String delimiter ) {
    if ( original.equals( "" ) ) {
        return addition;
    } else {
        return original + delimiter + addition;
    }
}

String parameterString = "";
if ( condition ) parameterString = appendWithDelimiter( parameterString, "elementName", "," );
if ( anotherCondition ) parameterString = appendWithDelimiter( parameterString, "anotherElementName", "," );

Я усвідомлюю, що це не особливо ефективно, оскільки в усьому світі створюються рядки, але я зрозумів більше, ніж оптимізацію.

У Ruby я можу зробити щось подібне замість цього, що відчуває себе набагато елегантніше:

parameterArray = [];
parameterArray << "elementName" if condition;
parameterArray << "anotherElementName" if anotherCondition;
parameterString = parameterArray.join(",");

Але оскільки Java не вистачає команди приєднання, я не міг зрозуміти нічого еквівалентного.

Отже, який найкращий спосіб зробити це на Java?

Попередньо Java 8:

Тут є вашим другом Apache's commons lang - він забезпечує метод приєднання, дуже подібний до того, на який ви посилаєтесь у Ruby:

StringUtils.join(java.lang.Iterable,char)

Java 8:

Java 8 забезпечує з'єднання з коробки через StringJoinerі String.join(). Нижче наведені фрагменти показують, як ви можете їх використовувати:

StringJoiner

StringJoiner joiner = new StringJoiner(",");
joiner.add("01").add("02").add("03");
String joinedString = joiner.toString(); // "01,02,03"

String.join(CharSequence delimiter, CharSequence... elements))

String joinedString = String.join(" - ", "04", "05", "06"); // "04 - 05 - 06"

String.join(CharSequence delimiter, Iterable<? extends CharSequence> elements)

List<String> strings = new LinkedList<>();
strings.add("Java");strings.add("is");
strings.add("cool");
String message = String.join(" ", strings);
//message returned is: "Java is cool"

Ви можете написати невеликий утилітний метод приєднання, який працює на java.util.Lists

public static String join(List<String> list, String delim) {

    StringBuilder sb = new StringBuilder();

    String loopDelim = "";

    for(String s : list) {

        sb.append(loopDelim);
        sb.append(s);            

        loopDelim = delim;
    }

    return sb.toString();
}

Потім використовуйте його так:

    List<String> list = new ArrayList<String>();

    if( condition )        list.add("elementName");
    if( anotherCondition ) list.add("anotherElementName");

    join(list, ",");

Що стосується Android, клас StringUtils від commons недоступний, тому для цього я використовував

android.text.TextUtils.join(CharSequence delimiter, Iterable tokens)

http://developer.android.com/reference/android/text/TextUtils.html

У бібліотеці Google Guava є клас com.google.common.base.Joiner, який допомагає вирішувати такі завдання.

Зразки:

"My pets are: " + Joiner.on(", ").join(Arrays.asList("rabbit", "parrot", "dog")); 
// returns "My pets are: rabbit, parrot, dog"

Joiner.on(" AND ").join(Arrays.asList("field1=1" , "field2=2", "field3=3"));
// returns "field1=1 AND field2=2 AND field3=3"

Joiner.on(",").skipNulls().join(Arrays.asList("London", "Moscow", null, "New York", null, "Paris"));
// returns "London,Moscow,New York,Paris"

Joiner.on(", ").useForNull("Team held a draw").join(Arrays.asList("FC Barcelona", "FC Bayern", null, null, "Chelsea FC", "AC Milan"));
// returns "FC Barcelona, FC Bayern, Team held a draw, Team held a draw, Chelsea FC, AC Milan"

Ось стаття про струнні утиліти Guava .

У Java 8 ви можете використовувати String.join():

List<String> list = Arrays.asList("foo", "bar", "baz");
String joined = String.join(" and ", list); // "foo and bar and baz"

Перегляньте також цю відповідь на прикладі API Stream.

Ви можете узагальнити, але в Java немає приєднання, як ви добре говорите.

Це може працювати краще.

public static String join(Iterable<? extends CharSequence> s, String delimiter) {
    Iterator<? extends CharSequence> iter = s.iterator();
    if (!iter.hasNext()) return "";
    StringBuilder buffer = new StringBuilder(iter.next());
    while (iter.hasNext()) buffer.append(delimiter).append(iter.next());
    return buffer.toString();
}

в Java 8 це можна зробити так:

list.stream().map(Object::toString)
        .collect(Collectors.joining(delimiter));

якщо в списку є нулі, ви можете використовувати:

list.stream().map(String::valueOf)
        .collect(Collectors.joining(delimiter))

він також підтримує префікс і суфікс:

list.stream().map(String::valueOf)
        .collect(Collectors.joining(delimiter, prefix, suffix));

Використовуйте підхід, заснований на java.lang.StringBuilder! ("Змінна послідовність символів.")

Як ви згадали, всі ці рядкові конкатенації створюють рядки в усьому. StringBuilderне зробить цього.

Чому StringBuilderзамість StringBuffer? Від StringBuilderjavadoc:

Там, де це можливо, рекомендується використовувати цей клас у перевазі StringBuffer, оскільки він буде швидшим у більшості реалізацій.

Я б користувався колекціями Google. Є приємний об'єкт приєднання.
http://google-collections.googlecode.com/svn/trunk/javadoc/index.html?com/google/common/base/Join.html

Але якщо я хотів написати це самостійно,

package util;

import java.util.ArrayList;
import java.util.Iterable;
import java.util.Collections;
import java.util.Iterator;

public class Utils {
    // accept a collection of objects, since all objects have toString()
    public static String join(String delimiter, Iterable<? extends Object> objs) {
        if (objs.isEmpty()) {
            return "";
        }
        Iterator<? extends Object> iter = objs.iterator();
        StringBuilder buffer = new StringBuilder();
        buffer.append(iter.next());
        while (iter.hasNext()) {
            buffer.append(delimiter).append(iter.next());
        }
        return buffer.toString();
    }

    // for convenience
    public static String join(String delimiter, Object... objs) {
        ArrayList<Object> list = new ArrayList<Object>();
        Collections.addAll(list, objs);
        return join(delimiter, list);
    }
}

Я думаю, що це краще працює з колекцією об'єктів, оскільки тепер вам не доведеться перетворювати свої об'єкти в рядки, перш ніж приєднуватися до них.

Apache commons клас StringUtils має метод з'єднання.

Java 8

stringCollection.stream().collect(Collectors.joining(", "));

Для цього можна використовувати StringBuilderтип Java . Є також StringBuffer, але вона містить додаткову логіку безпеки потоку, яка часто є непотрібною.

І мінімальний (якщо ви не хочете включати Apache Commons або Gauva в залежність від проекту лише заради приєднання рядків)

/**
 *
 * @param delim : String that should be kept in between the parts
 * @param parts : parts that needs to be joined
 * @return  a String that's formed by joining the parts
 */
private static final String join(String delim, String... parts) {
    StringBuilder builder = new StringBuilder();
    for (int i = 0; i < parts.length - 1; i++) {
        builder.append(parts[i]).append(delim);
    }
    if(parts.length > 0){
        builder.append(parts[parts.length - 1]);
    }
    return builder.toString();
}

Використовуйте StringBuilder і клас Separator

StringBuilder buf = new StringBuilder();
Separator sep = new Separator(", ");
for (String each : list) {
    buf.append(sep).append(each);
}

Сепаратор загортає роздільник. Розмежувач повертається методом роздільника toString, якщо тільки при першому виклику, який повертає порожню рядок!

Вихідний код для класу Separator

public class Separator {

    private boolean skipFirst;
    private final String value;

    public Separator() {
        this(", ");
    }

    public Separator(String value) {
        this.value = value;
        this.skipFirst = true;
    }

    public void reset() {
        skipFirst = true;
    }

    public String toString() {
        String sep = skipFirst ? "" : value;
        skipFirst = false;
        return sep;
    }

}

Чому б не написати власний метод join ()? В якості колекції параметрів буде взято рядки рядків і розділовий рядок. У рамках методу перегляньте колекцію та накопичіть результат у StringBuffer.

Якщо ви використовуєте Spring MVC, ви можете спробувати наступні кроки.

import org.springframework.util.StringUtils;

List<String> groupIds = new List<String>;   
groupIds.add("a");    
groupIds.add("b");    
groupIds.add("c");

String csv = StringUtils.arrayToCommaDelimitedString(groupIds.toArray());

Це призведе до a,b,c

Якщо ви використовуєте Eclipse Collection , ви можете використовувати makeString()або appendString().

makeString()повертає Stringпредставлення, подібне до toString().

Він має три форми

• makeString(start, separator, end)
• makeString(separator) за замовчуванням починаються і закінчуються порожні рядки
• makeString()за замовчуванням роздільник на ", "(кома та пробіл)

Приклад коду:

MutableList<Integer> list = FastList.newListWith(1, 2, 3);
assertEquals("[1/2/3]", list.makeString("[", "/", "]"));
assertEquals("1/2/3", list.makeString("/"));
assertEquals("1, 2, 3", list.makeString());
assertEquals(list.toString(), list.makeString("[", ", ", "]"));

appendString()подібний до makeString(), але він додається до Appendable(як StringBuilder) і є void. Він має такі ж три форми, з додатковим першим аргументом - додаток.

MutableList<Integer> list = FastList.newListWith(1, 2, 3);
Appendable appendable = new StringBuilder();
list.appendString(appendable, "[", "/", "]");
assertEquals("[1/2/3]", appendable.toString());

Якщо ви не можете перетворити свою колекцію у тип Eclipse Collections, просто адаптуйте її за допомогою відповідного адаптера.

List<Object> list = ...;
ListAdapter.adapt(list).makeString(",");

Примітка. Я є прихильником колекцій Eclipse.

Java 8 Рідний тип

List<Integer> example;
example.add(1);
example.add(2);
example.add(3);
...
example.stream().collect(Collectors.joining(","));

Спеціальний об’єкт Java 8:

List<Person> person;
...
person.stream().map(Person::getAge).collect(Collectors.joining(","));

Ви, ймовірно, повинні використовувати a StringBuilderз appendметодом для побудови результату, але в іншому випадку це так добре, як рішення, яке може запропонувати Java.

Чому ви не зробите в Java те саме, що ви робите в рубіні, це створити розділений рядок від роздільника лише після того, як ви додали всі фрагменти до масиву?

ArrayList<String> parms = new ArrayList<String>();
if (someCondition) parms.add("someString");
if (anotherCondition) parms.add("someOtherString");
// ...
String sep = ""; StringBuffer b = new StringBuffer();
for (String p: parms) {
    b.append(sep);
    b.append(p);
    sep = "yourDelimiter";
}

Ви можете перенести це цикл в окремий допоміжний метод, а також використовувати StringBuilder замість StringBuffer ...

Редагувати : виправлено порядок додавань.

Із змінними аргументами Java 5, тому вам не доведеться чітко вкладати всі рядки в колекцію чи масив:

import junit.framework.Assert;
import org.junit.Test;

public class StringUtil
{
    public static String join(String delim, String... strings)
    {
        StringBuilder builder = new StringBuilder();

        if (strings != null)
        {
            for (String str : strings)
            {
                if (builder.length() > 0)
                {
                    builder.append(delim).append(" ");
                }
                builder.append(str);
            }
        }           
        return builder.toString();
    }
    @Test
    public void joinTest()
    {
        Assert.assertEquals("", StringUtil.join(",", null));
        Assert.assertEquals("", StringUtil.join(",", ""));
        Assert.assertEquals("", StringUtil.join(",", new String[0]));
        Assert.assertEquals("test", StringUtil.join(",", "test"));
        Assert.assertEquals("foo, bar", StringUtil.join(",", "foo", "bar"));
        Assert.assertEquals("foo, bar, x", StringUtil.join(",", "foo", "bar", "x"));
    }
}

Для тих, хто у весняному контексті їх StringUtils клас також корисний:

Є багато корисних ярликів, таких як:

• collectionToCommaDelimitedString (Колекція coll)
• collectionToDelimitedString (Колекція coll, String delim)
• arrayToDelimitedString (Object [] arr, строка розділена)

та багато інших.

Це може бути корисно, якщо ви вже не використовуєте Java 8 і вже перебуваєте у контексті весни.

Я вважаю за краще це проти Apache Commons (хоча і дуже добре) за підтримку колекції, яка простіша:

// Encoding Set<String> to String delimited 
String asString = org.springframework.util.StringUtils.collectionToDelimitedString(codes, ";");

// Decoding String delimited to Set
Set<String> collection = org.springframework.util.StringUtils.commaDelimitedListToSet(asString);

Ви можете спробувати щось подібне:

StringBuilder sb = new StringBuilder();
if (condition) { sb.append("elementName").append(","); }
if (anotherCondition) { sb.append("anotherElementName").append(","); }
String parameterString = sb.toString();

Тому в основному щось подібне:

public static String appendWithDelimiter(String original, String addition, String delimiter) {

if (original.equals("")) {
    return addition;
} else {
    StringBuilder sb = new StringBuilder(original.length() + addition.length() + delimiter.length());
        sb.append(original);
        sb.append(delimiter);
        sb.append(addition);
        return sb.toString();
    }
}

Не знаєте, чи справді це краще, але принаймні це за допомогою StringBuilder, що може бути дещо ефективніше.

Нижче внизу є більш загальний підхід, якщо ви можете скласти список параметрів перед тим, як робити будь-які параметри.

// Answers real question
public String appendWithDelimiters(String delimiter, String original, String addition) {
    StringBuilder sb = new StringBuilder(original);
    if(sb.length()!=0) {
        sb.append(delimiter).append(addition);
    } else {
        sb.append(addition);
    }
    return sb.toString();
}


// A more generic case.
// ... means a list of indeterminate length of Strings.
public String appendWithDelimitersGeneric(String delimiter, String... strings) {
    StringBuilder sb = new StringBuilder();
    for (String string : strings) {
        if(sb.length()!=0) {
            sb.append(delimiter).append(string);
        } else {
            sb.append(string);
        }
    }

    return sb.toString();
}

public void testAppendWithDelimiters() {
    String string = appendWithDelimitersGeneric(",", "string1", "string2", "string3");
}

Ваш підхід не надто поганий, але вам слід використовувати StringBuffer замість знака +. + Має великий мінус у тому, що для кожної операції створюється новий екземпляр String. Чим довше стає ваша струна, тим більша накладні витрати. Тож використання StringBuffer має бути найшвидшим способом:

public StringBuffer appendWithDelimiter( StringBuffer original, String addition, String delimiter ) {
        if ( original == null ) {
                StringBuffer buffer = new StringBuffer();
                buffer.append(addition);
                return buffer;
        } else {
                buffer.append(delimiter);
                buffer.append(addition);
                return original;
        }
}

Після закінчення створення рядка просто зателефонуйте до toString () на поверненому StringBuffer.

Замість використання рядкового конкатенації слід використовувати StringBuilder, якщо ваш код не є потоковим, і StringBuffer, якщо він є.

Ти робиш це трохи складніше, ніж це має бути. Почнемо з кінця вашого прикладу:

String parameterString = "";
if ( condition ) parameterString = appendWithDelimiter( parameterString, "elementName", "," );
if ( anotherCondition ) parameterString = appendWithDelimiter( parameterString, "anotherElementName", "," );

З невеликою зміною використання StringBuilder замість String це стає:

StringBuilder parameterString = new StringBuilder();
if (condition) parameterString.append("elementName").append(",");
if (anotherCondition) parameterString.append("anotherElementName").append(",");
...

Коли ви закінчите (я припускаю, що ви також повинні перевірити кілька інших умов), просто переконайтесь, що ви вилучили кома з хвостами з такою командою:

if (parameterString.length() > 0) 
    parameterString.deleteCharAt(parameterString.length() - 1);

І нарешті, знайдіть потрібну струну

parameterString.toString();

Ви також можете замінити "," у другому дзвінку, щоб додати загальний рядок розділення, який можна встановити на що завгодно. Якщо у вас є список речей, які ви знаєте, що потрібно додати (без умовних умов), ви можете помістити цей код всередину методу, який містить список рядків.

//Note: if you have access to Java5+, 
//use StringBuilder in preference to StringBuffer.  
//All that has to be replaced is the class name.  
//StringBuffer will work in Java 1.4, though.

appendWithDelimiter( StringBuffer buffer, String addition, 
    String delimiter ) {
    if ( buffer.length() == 0) {
        buffer.append(addition);
    } else {
        buffer.append(delimiter);
        buffer.append(addition);
    }
}


StringBuffer parameterBuffer = new StringBuffer();
if ( condition ) { 
    appendWithDelimiter(parameterBuffer, "elementName", "," );
}
if ( anotherCondition ) {
    appendWithDelimiter(parameterBuffer, "anotherElementName", "," );
}

//Finally, to return a string representation, call toString() when returning.
return parameterBuffer.toString(); 

Отже, кілька речей, які ви можете зробити, щоб відчути, ніби ви шукаєте:

1) Розширити клас списку - і додати до нього метод з'єднання. Метод приєднання просто зробив би роботу з об'єднання та додавання роздільника (що може бути параметом методу приєднання)

2) Схоже, що Java 7 додає до Java методи розширення - що дозволяє просто приєднати конкретний метод до класу: щоб ви могли написати цей метод приєднання та додати його як метод розширення до Список або навіть до Колекція.

Рішення 1, мабуть, є єдиним реалістичним, хоча, оскільки Java 7 ще не вийшов :) Але воно має працювати чудово.

Щоб використовувати обидва ці пункти, потрібно просто додати всі свої предмети до Списку або Колекції, як зазвичай, а потім зателефонувати за новим спеціальним методом, щоб "приєднатися" до них.