Задайте значение не более одного раза с шаблоном построителя

Question

Существует ли стандартная практика Java при использовании шаблона построителя, чтобы гарантировать, что переменная-член установлена ​​не более одного раза. Мне нужно убедиться, что сеттер называется 0 или 1 раз, но не больше. Я хотел бы бросить RuntimeException какого-то типа, но я беспокоюсь о проблемах синхронизации, а также о лучших практиках в этой области.

Answer 1

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

Есть несколько способов сделать то, что вы описываете, позволяет исследовать их:

1. Просто позволяют пользователям делать то, что они хотят

   Одна хорошая вещь о строителей, они могут позвольте вам построить несколько разных объектов из одного и того же строителя:

   List<Person> jonesFamily = new ArrayList<>(); 
   Person.Builder builder = new Person.Builder().setLastName("Jones"); 
   
   for(String firstName : jonesFamilyFirstNames) { 
       family.add(builder.setFirstName(firstName).build()); 
   } 
   

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

2. возбудит исключение

   Вы предлагаете повысить исключение, и это, конечно, работать. Как я уже сказал, я не думаю, что это самое элегантное решение, но вот одна реализация (с использованием Guava «s Preconditions, для дополнительного удобства чтения):

   public class Builder { 
       private Object optionalObj = null; 
       // ... 
   
       public Builder setObject(Object setOnce) { 
       checkState(optionalObj == null, "Don't call setObject() more than once"); 
       optionalObj = setOnce; 
       } 
       // ... 
   } 
   

   Это поднимает IllegalStateException, так что вы можете просто позвонить throw new IllegalStateException() если вы не используете Guava (вы должны быть ... :)). Предполагая, что вы не передаете объекты-конструкторы вокруг потоков, у вас не должно быть проблем с синхронизацией. Если да, то вы должны подумать, почему вам нужен один и тот же строитель в разных потоках - это почти наверняка анти-шаблон.

3. Не предоставляйте метод на всех

   Это самый чистый, ясный способ запретить пользователю вызова метода вы не хотите, чтобы они - не дают его в первом место. Вместо этого переопределите конструктор строителя или метод build(), чтобы они могли необязательно передать значение в это время, но ни в какое другое время. Таким образом, вы четко гарантируете, что значение может быть установлено не более одного раза на построенный объект.

   public class Builder { 
       // ... 
   
       public Obj build() { ... } 
       public Obj build(Object onceOnly) { ... } 
   } 
   

4. Используйте различные типы разоблачить некоторые методы

   Я на самом деле не сделали этого, и это может быть более запутанной, чем она стоит (в частности, вы, вероятно, необходимо использовать self-bounding generic для методов в Builder), но это пришло мне в голову, когда я писал, и может быть очень явным для определенных случаев использования. Имейте свой ограниченный метод в подклассе строителя, и этот метод возвращает родительский тип, поэтому предотвращает повторный вызов вызывающего метода. Примером может помочь, если это не имело смысла:

   public class Builder { 
       // contains regular builder methods 
   } 
   
   public class UnsetBuilder extends Builder { 
       public Builder setValue(Object obj) { ... } 
   } 
   
   // the builder constructor actually returns an UnsetBuilder 
   public static UnsetBuilder builder() { ... } 
   

   Тогда мы можем назвать что-то вроде:

   builder().setValue("A").build(); 
   

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

   builder().setValue("A").setValue("B").build(); 
   

   setValue() потому, что возвращает Builder, в котором отсутствует метод setValue(), поэтому предотвращение второй случай. Это было бы сложно понять точно (что, если пользователь переводит Builder обратно в UnsetBuilder?), Но с некоторыми усилиями сделает то, что вы ищете.

Answer 2

Object objectToSet; 

boolean isObjectSet = false; 

void setObject(Object object) throws RuntimeException { 
    if(!isObjectSet) { 
     objectToSet=object; 
     isObjectSet=true; 
    } else { 
     throw new RuntimeException(); 
    } 

} 

Это стандартная практика.

Answer 3

Вы можете определить свою переменную как final.

final MyClass object; 

EDIT: Если он устанавливает более чем один раз вы получите ошибку компиляции.

---

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

public synchronized void setMyObject(Object object) 
{ 
    if (this.myObject == null) 
    { 
     this.myObject = object; 
    } else { 
     throw new RuntimeException(); 
    } 
} 

Используйте метод setter даже в конструкторе или в другом месте.

Примечание: Использование методов synchronized может привести к нестабильности производительности при огромной обработке.

Answer 4

Вы можете использовать шаблон Builder, обозначенный как Эффективная Java. Это не совсем соответствует вашим требованиям, но я думаю, что это должно соответствовать вашим потребностям. Дай мне знать.

class Foo { 
    private final Object objectToSet; 

    private Foo(Foo.Builder builder) { 
     objectToSet = builder.getObjectToSet(); 
    } 

    public static class Builder { 
     private Object objectToSet; 

     public Builder() { } 

     private Object getObjectToSet() { 
      return objectToSet; 
     } 

     public Builder objectToSet(Object objectToSet) { 
      this.objectToSet = objectToSet; 
      return this; 
     } 

     public Foo build() { 
      return new Foo(this); 
     } 
    } 
} 

Тогда позже:

Object someObject = 10; 
Foo foo = new Foo.Builder() 
    .objectToSet(someObject) 
    .build(); 
// A Foo's `objectToSet` can only be set once 

Это позволяет определить класс (этот случай Foo), который имеет свойства, которые могут быть установлены только один раз. В качестве бонуса вы можете сделать Foo действительно неизменным.