устранение дубликата кода Enum - PullRequest
Новая
       24

устранение дубликата кода Enum

22 голосов
/ 17 сентября 2008

У меня есть большое количество Enums, которые реализуют этот интерфейс: 

/**
 * Interface for an enumeration, each element of which can be uniquely identified by it's code
 */
public interface CodableEnum {

    /**
     * Get the element with a particular code
     * @param code
     * @return
     */
    public CodableEnum getByCode(String code);

    /**
     * Get the code that identifies an element of the enum
     * @return
     */
    public String getCode();
}

Типичный пример: 

public enum IMType implements CodableEnum {

    MSN_MESSENGER("msn_messenger"),
    GOOGLE_TALK("google_talk"),
    SKYPE("skype"),
    YAHOO_MESSENGER("yahoo_messenger");

    private final String code;

    IMType (String code) {
        this.code = code;
    }

    public String getCode() {
        return code;
    }   

    public IMType getByCode(String code) {
        for (IMType e : IMType.values()) {
            if (e.getCode().equalsIgnoreCase(code)) {
                return e;
            }
        }
    }
}

Как вы можете себе представить, эти методы практически идентичны во всех реализациях CodableEnum. Я хотел бы устранить это дублирование, но, честно говоря, не знаю как. Я пытался использовать такой класс, как следующий: 

public abstract class DefaultCodableEnum implements CodableEnum {

    private final String code;

    DefaultCodableEnum(String code) {
        this.code = code;
    }

    public String getCode() {
        return this.code;
    }   

    public abstract CodableEnum getByCode(String code);  
}

Но это оказывается довольно бесполезным, потому что:

  1. Перечисление не может расширять класс
  2. Элементы перечисления (SKYPE, GOOGLE_TALK и т. Д.) Не могут расширять класс
  3. Я не могу предоставить реализацию getByCode () по умолчанию, потому что DefaultCodableEnum сам по себе не является Enum. Я попытался изменить DefaultCodableEnum для расширения java.lang.Enum, но это не разрешено.

Есть предложения, которые не основаны на размышлениях? Спасибо, Дон

Ответы [ 15 ]

13 голосов
/ 17 сентября 2008

Вы можете преобразовать дублирующийся код в класс CodeableEnumHelper: 

public class CodeableEnumHelper {
    public static CodeableEnum getByCode(String code, CodeableEnum[] values) {
        for (CodeableEnum e : values) {
            if (e.getCode().equalsIgnoreCase(code)) {
                return e;
            }
        }
        return null;
    }
}

Каждый класс CodeableEnum должен был бы реализовать метод getByCode, но фактическая реализация метода была, по крайней мере, централизована в одном месте. 

public enum IMType implements CodeableEnum {
    ...
    public IMType getByCode(String code) {
        return (IMType)CodeableEnumHelper.getByCode(code, this.values());
    } 
}
7 голосов
/ 17 сентября 2008

Абстрактные перечисления потенциально очень полезны (и в настоящее время не допускаются). Но есть предложение и прототип, если вы хотите побудить кого-то в Sun добавить его:

http://freddy33.blogspot.com/2007/11/abstract-enum-ricky-carlson-way.html

ВС RFE:

http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6570766

5 голосов
/ 17 сентября 2008

Чтобы привести в порядок код Дэйва: 

public class CodeableEnumHelper {
    public static <E extends CodeableEnum> E getByCode(
        String code, E[] values
    ) {
        for (E e : values) {
            if (e.getCode().equalsIgnoreCase(code)) {
                return e;
            }
        }
        return null;
    }
}

public enum IMType implements CodableEnum {
    ...
    public IMType getByCode(String code) {
        return CodeableEnumHelper.getByCode(code, values());
    } 
}

Или более эффективно: 

public class CodeableEnumHelper {
    public static <E extends CodeableEnum> Map<String,E> mapByCode(
        E[] values
    ) {
        Map<String,E> map = new HashMap<String,E>();
        for (E e : values) {
            map.put(e.getCode().toLowerCase(Locale.ROOT), value) {
        }
        return map;
    }
}

public enum IMType implements CodableEnum {
    ...
    private static final Map<String,IMType> byCode =
        CodeableEnumHelper.mapByCode(values());
    public IMType getByCode(String code) {
        return byCode.get(code.toLowerCase(Locale.ROOT));
    } 
}
2 голосов
/ 17 сентября 2008

У меня была похожая проблема с компонентом локализации, который я написал. Мой компонент предназначен для доступа к локализованным сообщениям с константами enum, которые индексируются в пакет ресурсов, а это не сложная проблема.

Я обнаружил, что я копировал и вставлял один и тот же код-шаблон "enum" повсеместно. Моим решением избежать дублирования является генератор кода, который принимает файл конфигурации XML с именами констант enum и аргументами конструктора. В результате получается исходный код Java с «дублированным» поведением.

Теперь я сохраняю файлы конфигурации и генератор, а не весь дублированный код. Везде, где у меня был бы исходный код enum, теперь есть файл конфигурации XML. Мои сценарии сборки обнаруживают устаревшие сгенерированные файлы и вызывают генератор кода для создания кода перечисления.

Вы можете увидеть этот компонент здесь . Шаблон, который я копировал и вставлял, был добавлен в таблицу стилей XSLT . Генератор кода выполняет преобразование таблицы стилей. Входной файл весьма сжат по сравнению с сгенерированным исходным кодом enum.

НТН,
Грег

1 голос
/ 20 марта 2011

Здесь у меня есть другое решение: 

interface EnumTypeIF {
String getValue();

EnumTypeIF fromValue(final String theValue);

EnumTypeIF[] getValues();

class FromValue {
  private FromValue() {
  }

  public static EnumTypeIF valueOf(final String theValue, EnumTypeIF theEnumClass) {

    for (EnumTypeIF c : theEnumClass.getValues()) {
      if (c.getValue().equals(theValue)) {
        return c;
      }
    }
    throw new IllegalArgumentException(theValue);
  }
}

Хитрость в том, что внутренний класс может использоваться для хранения "глобальных методов".

Работал довольно хорошо для меня. Хорошо, вы должны реализовать 3 метода, но эти методы, просто делегаты.

1 голос
/ 17 сентября 2008

Создайте типобезопасный служебный класс, который будет загружать перечисления по коду:

Интерфейс сводится к: 

public interface CodeableEnum {
    String getCode();
}

Класс полезности: 

import java.lang.reflect.InvocationTargetException;


public class CodeableEnumUtils {
    @SuppressWarnings("unchecked")
    public static <T extends CodeableEnum>  T getByCode(String code, Class<T> enumClass) throws IllegalArgumentException, SecurityException, IllegalAccessException, InvocationTargetException, NoSuchMethodException {
        T[] allValues = (T[]) enumClass.getMethod("values", new Class[0]).invoke(null, new Object[0]);
        for (T value : allValues) {
            if (value.getCode().equals(code)) {
                return value;
            }
        }
        return null;
}

}

Тестовый пример, демонстрирующий использование: 

import junit.framework.TestCase;


public class CodeableEnumUtilsTest extends TestCase {
    public void testWorks() throws Exception {
    assertEquals(A.ONE, CodeableEnumUtils.getByCode("one", A.class));
      assertEquals(null, CodeableEnumUtils.getByCode("blah", A.class));
    }

enum A implements CodeableEnum {
    ONE("one"), TWO("two"), THREE("three");

    private String code;

    private A(String code) {
        this.code = code;
    }

    public String getCode() {
        return code;
    }   
}
}

Теперь вы дублируете только метод getCode (), а метод getByCode () находится в одном месте. Возможно, было бы неплохо обернуть все исключения в одну RuntimeException:)

1 голос
/ 17 сентября 2008

К сожалению, я не думаю, что есть способ сделать это. Лучше всего было бы полностью отказаться от emums и использовать обычное расширение класса и статические члены. В противном случае, привыкните к дублированию этого кода. К сожалению.

0 голосов
/ 19 мая 2010

На мой взгляд, это был бы самый простой способ, без размышлений и без добавления какой-либо дополнительной обертки к вашему перечислению.

Вы создаете интерфейс, который реализует ваш enum: 

public interface EnumWithId {

    public int getId();

}

Затем в классе помощника вы просто создаете метод, подобный этому: 

public <T extends EnumWithId> T getById(Class<T> enumClass, int id) {
    T[] values = enumClass.getEnumConstants();
    if (values != null) {
        for (T enumConst : values) {
            if (enumConst.getId() == id) {
                return enumConst;
            }
        }
    }

    return null;
}

Этот метод может быть использован следующим образом: 

MyUtil.getInstance().getById(MyEnum.class, myEnumId);
0 голосов
/ 18 марта 2010

Другим решением было бы не помещать что-либо в сам enum, а просто предоставлять двунаправленную карту Enum <-> Code для каждого enum. Вы могли бы, например, для этого используйте ImmutableBiMap из Google Collections.

Таким образом, дублирующего кода вообще не будет.

Пример: 

public enum MYENUM{
  VAL1,VAL2,VAL3;
}

/** Map MYENUM to its ID */
public static final ImmutableBiMap<MYENUM, Integer> MYENUM_TO_ID = 
new ImmutableBiMap.Builder<MYENUM, Integer>().
put(MYENUM.VAL1, 1).
put(MYENUM.VAL2, 2).
put(MYENUM.VAL3, 3).
build();
0 голосов
/ 17 сентября 2008

В вашем конкретном случае методы getCode () / getByCode (String code) кажутся очень закрытыми (с точки зрения эвфемизма) поведению методов toString () / valueOf (String value), предоставляемых всем перечислением. Почему вы не хотите их использовать?

Страница:
...