Il modo migliore per impedire ad altri programmatori di chiamare -init

Question

Quando si progetta una gerarchia di classi, a volte la sottoclasse ha aggiunto un nuovo metodo initWithSomeNewParam e sarebbe desiderabile disabilitare le chiamate al vecchio metodo init ereditato dalla superclasse.

Prima di tutto, ho letto la questione here, dove le alternative proposte sono o esclusione init un'eccezione in fase di esecuzione, o ignorare e impostare i valori predefiniti per le proprietà. Nel mio caso, non voglio fornire valori predefiniti, e voglio indicare chiaramente che il vecchio metodo non dovrebbe essere chiamato, e invece dovrebbe essere usato il nuovo metodo con parametri.

Quindi l'eccezione di runtime va bene, ma a meno che il codice non sia debuggato, non c'è modo per altri programmatori del team di notare che il vecchio metodo non è più destinato ad essere utilizzato.

Se ho ragione, non c'è modo di contrassegnare un metodo come "privato". Quindi, a parte l'aggiunta di commenti, c'è un modo per farlo?

Grazie in anticipo.

Answer 1

è possibile contrassegnare in modo esplicito il tuo init come non disponibile nel file di intestazione:

- (id) init __unavailable; 

o:

- (id) init __attribute__((unavailable)); 

con la sintassi più tardi, si può anche dare una ragione:

- (id) init __attribute__((unavailable("Must use initWithFoo: instead."))); 

Il compilatore invia quindi un errore (non un avviso) se qualcuno tenta di chiamarlo.

Answer 2

Segnala deprecato? Gli sviluppatori saranno sviluppatori, non puoi fermarci tutti! ;-)

How do I flag a method as deprecated in Objective-C 2.0?

Answer 3

initWith: Stuff e: OtherStuff non deve mai essere più di semplici costruttori.

In che modo efficace devono chiamare

self = [self init]; 

if(self) 
{ 
    self.stuff = Stuff; 
    self.other = OtherStuff; 
} 

così [init oggetto] restituisce sempre un oggetto in uno stato predefinito, e [oggetto initWithStuff: roba] restituirà l'oggetto nello stato predefinito con roba ignorato .

Fondamentalmente quello che sto ottenendo è, la sua cattiva pratica per scoraggiare [oggetto init] soprattutto quando qualcuno sottoclasse la sottoclasse in futuro ....

Answer 4

È possibile una sorta di contrassegnare un metodo come "privato" definendo un private extension nella classe.

Nel vostro .h:

@interface MyClassName 
- (void)initWithSomeNewParam:(id)param; 

Nella tua.m:

@interface MyClassName() 
- (void)init; 
@end 

Si potrebbe anche aggiungere un NSLog dichiarazione in modo che quando qualcuno è in esecuzione il progetto con una sessione di XCode allegato, vedranno l'uscita della console simile a "Si prega di non utilizzare init, utilizzare initWithSomeNewParam: invece. " Si noti che questo è l'approccio che Apple stessa ha storicamente adottato per le chiamate API deprecate (oltre che per la marcatura deprecata nei propri documenti).

Answer 5

da aggiungere a quanto @DarkDust pubblicato, è possibile in alternativa utilizzare UNAVAILABLE_ATTRIBUTE

- (id)init UNAVAILABLE_ATTRIBUTE; 

Questo genera un errore quando un utente tenta di chiamare init su un'istanza di questa classe.